Basic detector from state vector input. More...
Public Member Functions | |
| def | __init__ (self, processor=None) |
| Constructor for fromState instance. More... | |
| def | adapt (self) |
| Adapt detection model, if implemented. More... | |
| def | correct (self) |
| Correct detection state estimate, if implemented. More... | |
| def | detect (self, x) |
| Perform detection only, which basically keeps the model static if it would normally update. More... | |
| def | getState (self) |
| Get the current detection state estimate. More... | |
| def | measure (self, x) |
| Generate detection outcome from state signal. More... | |
| def | predict (self) |
| Predict detection state outcome, if implemented. More... | |
| def | process (self, x) |
| Run entire processing pipeline. More... | |
| def | saveTo (self, fPtr) |
| Save configuration or other data to HDF5 file. More... | |
 Public Member Functions inherited from Base | |
| def | __init__ (self) |
| Instantiate a detector Base activity class object. More... | |
| def | emptyDebug (self) |
| Return empty debug state information. More... | |
| def | emptyState (self) |
| Return empty state. More... | |
| def | getDebug (self) |
| Return current/latest debug state information. More... | |
| def | save (self, fileName) |
| Outer method for saving to a file given as a string. More... | |
Public Attributes | |
| processor | |
| Pre-processor or similar. More... | |
| z | |
| The detection outcome. More... | |
| Public Attributes inherited from Base | |
| x | |
| Detection state. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Base | |
| def | load (fileName, relpath=None) |
| Outer method for loading file given as a string (with path). More... | |
| def | loadFrom (fPtr) |
| Empty method for loading internal information from HDF5 file. More... | |
Detailed Description
Basic detector from state vector input.
Should be overloaded, but simple detectors can be created with the right pre/post processor.
Constructor & Destructor Documentation
◆ __init__()
| def __init__ | ( | self, | |
processor = None |
|||
| ) |
Constructor for fromState instance.
- Parameters
-
[in] processor A state processor.
Reimplemented in SortActivity, SolveActivity, PuzzleActivities, CosolveActivity, SolveActivity, SortActivityDepth, SortActivity, and CoSolveActivity.
Member Function Documentation
◆ adapt()
| def adapt | ( | self | ) |
◆ correct()
| def correct | ( | self | ) |
◆ detect()
| def detect | ( | self, | |
| x | |||
| ) |
Perform detection only, which basically keeps the model static if it would normally update.
Detection consists of predict, measure, and correct. No adaptation. At least if there is a measurement. If no measurement, then only predict is executed since there is no measurement to interpret and correct.
Reimplemented from Base.
◆ getState()
| def getState | ( | self | ) |
Get the current detection state estimate.
Reimplemented from Base.
◆ measure()
| def measure | ( | self, | |
| x | |||
| ) |
Generate detection outcome from state signal.
- Parameters
-
[in] x External signal to detect with.
Reimplemented from Base.
Reimplemented in imageRegions, PuzzleActivities, SolveActivity, SortActivityDepth, SortActivity, and Planar.
◆ predict()
| def predict | ( | self | ) |
◆ process()
| def process | ( | self, | |
| x | |||
| ) |
Run entire processing pipeline.
The entire pipeline consists of predict, measure, correct, and adapt. At least if there is a measurement. If no measurement, then only predict is executed since there is no measurement to interpret, correct, and adapt with.
Reimplemented from Base.
Reimplemented in SortActivity, SolveActivity, PuzzleActivities, CosolveActivity, SolveActivity, SortActivityDepth, SortActivity, CoSolveActivity, and Planar.
◆ saveTo()
| def saveTo | ( | self, | |
| fPtr | |||
| ) |
Save configuration or other data to HDF5 file.
- Note
- Currently not implemented. Should not get here. Triggers warning.
Reimplemented from Base.
Member Data Documentation
◆ processor
| processor |
Pre-processor or similar.
[partially implemented]
◆ z
| z |
The detection outcome.
The documentation for this class was generated from the following file:
- /home/mary/python/detector/detector/fromState.py
