Public Member Functions | |
| def | __init__ (self, theConfig, theProcessor=None) |
| def | adapt (self) |
| Does nothing. More... | |
| def | correct (self, fg) |
| Does nothing. More... | |
| def | detect (self, img) |
| def | get (self, fname) |
| def | getBackgroundImage (self) |
| Get the background image in RGB, based on the background GMM model. More... | |
| def | getDebug (self) |
| Get latest detection result stored in memory. More... | |
| def | getState (self) |
| Get latest detection result stored in memory. More... | |
| def | loadModel (self, fName) |
| Load MOG2 model to file and overwrite current model. More... | |
| def | measure (self, I) |
| Does nothing. More... | |
| def | process (self, img) |
| Process image through OpenCV background subtractor. More... | |
| def | save (self, fileName, datFileName=None) |
| Outer method for saving to a file given as a string. More... | |
| def | saveModel (self, fName) |
| Save current MOG2 model parameters to file. More... | |
| def | saveTo (self, fPtr, fName) |
| Save current MOG2 model to file. More... | |
| def | set (self, fname, fval) |
| Check the documentation for what can be set. More... | |
 Public Member Functions inherited from bgImage | |
| def | __init__ (self, processor=None) |
| Public Member Functions inherited from inImage | |
| def | info (self) |
| Provide information about the current class implementation. More... | |
| Public Member Functions inherited from Base | |
| def | __init__ (self) |
| Instantiate a detector Base activity class object. More... | |
| def | correct (self) |
| Reconcile prediction and measurement as fitting. More... | |
| def | emptyDebug (self) |
| Return empty debug state information. More... | |
| def | emptyState (self) |
| Return empty state. More... | |
| def | predict (self) |
| Predict next state from current state. More... | |
| def | save (self, fileName) |
| Outer method for saving to a file given as a string. More... | |
| def | saveTo (self, fPtr) |
| Empty method for saving internal information to HDF5 file. More... | |
Static Public Member Functions | |
| def | buildAndCalibrateFromConfigRGB (theConfig, theStream, incVis=False) |
| def | buildAndCalibrateFromConfigRGBD (theConfig, theStream, incVis=False) |
| def | load (fileName) |
| Load GMM instance from saved file. More... | |
| def | loadFrom (fPtr) |
| Load GMM instance from details saved in HDF5 file. More... | |
| Static Public Member Functions inherited from Base | |
| def | load (fileName, relpath=None) |
| Outer method for loading file given as a string (with path). More... | |
Public Attributes | |
| adapt_rate | |
| bgSubtractor | |
| config | |
| detResult | |
| fg_mask | |
| shadow_mask | |
| Public Attributes inherited from inImage | |
| Ip | |
| processor | |
| Public Attributes inherited from Base | |
| x | |
| Detection state. More... | |
Detailed Description
@brief GMM Background Substraction method MOG2 from OpenCV library. Wrapper for the OpenCV Gaussian mixture model foreground detection implementation. This model involves two parts, one is an estimator, and the other is a change detector. The estimator is a static prediction observer on the mean and variance with fixed udpate gains. The change detector is threshold-based. The detection algorithm will first use the GMM to detect a potential foreground mask, each pixel of which will be checked for the color distort and the intensity decay. The shadow detection method is from [paper](http://personal.ee.surrey.ac.uk/Personal/R.Bowden/publications/avbs01/avbs01.pdf) based on [OpenCV code](https://github.com/opencv/opencv/blob/master/modules/video/src/bgfg_gaussmix2.cpp#L477-L520).
Constructor & Destructor Documentation
◆ __init__()
| def __init__ | ( | self, | |
| theConfig, | |||
theProcessor = None |
|||
| ) |
Member Function Documentation
◆ adapt()
| def adapt | ( | self | ) |
◆ buildAndCalibrateFromConfigRGB()
|
static |
◆ buildAndCalibrateFromConfigRGBD()
|
static |
◆ correct()
| def correct | ( | self, | |
| fg | |||
| ) |
Does nothing.
Incompatible with OpenCV interface.
◆ detect()
| def detect | ( | self, | |
| img | |||
| ) |
@brief Apply detection w/correction but do not adapt background model. Overrides the learning rate (alpha) in the configuration by simply ignoring it and passing on no learning to the OpenCV implementation.
Reimplemented from Base.
◆ get()
| def get | ( | self, | |
| fname | |||
| ) |
Check the [documentation](https://docs.opencv.org/3.4/d7/d7b/classcv_1_1BackgroundSubtractorMOG2.html#acdb85152b349d70561fecc4554ad76e6)
what parameters to get.
@param[in] fname Name of parameter to get. Invoke get+fname for opencv MOG2
example:
det = bgmodelGMM_cv()
det.get("History") # will invode getHistory() function from the link
◆ getBackgroundImage()
| def getBackgroundImage | ( | self | ) |
Get the background image in RGB, based on the background GMM model.
The image will be the weighted mean of the Gaussians' means
- Returns
- Background RGB image; bgImg (H, W, 3).
◆ getDebug()
| def getDebug | ( | self | ) |
Get latest detection result stored in memory.
Reimplemented from Base.
◆ getState()
| def getState | ( | self | ) |
Get latest detection result stored in memory.
Reimplemented from Base.
◆ load()
|
static |
Load GMM instance from saved file.
- Parameters
-
[in] fileName Source file name.
- Note
- This code is untested.
◆ loadFrom()
|
static |
◆ loadModel()
| def loadModel | ( | self, | |
| fName | |||
| ) |
Load MOG2 model to file and overwrite current model.
Uses the native/OpenCV implementation, thus it requires a filename and not a filepointer. Will load from the specified file.
- Note
- This code is untested. Assumes that OpenCV python API mirrors the actual C++ implementation.
◆ measure()
| def measure | ( | self, | |
| I | |||
| ) |
◆ process()
| def process | ( | self, | |
| img | |||
| ) |
Process image through OpenCV background subtractor.
This is only way to invoke entire process. There is no ability to call the intermediate processes (measure, correct, adapt, etc.). Do not call the other member functions as they do nothing.
Reimplemented from Base.
◆ save()
| def save | ( | self, | |
| fileName, | |||
datFileName = None |
|||
| ) |
Outer method for saving to a file given as a string.
Opens file, preps for saving, invokes save routine, then closes. Usually not overloaded. Overload the saveTo member function.
◆ saveModel()
| def saveModel | ( | self, | |
| fName | |||
| ) |
Save current MOG2 model parameters to file.
Uses the native/OpenCV implementation, thus it requires a filename and not a filepointer. Will save to the specified file.
- Note
- This code is untested. Assumes that OpenCV python API mirrors the actual C++ implementation.
◆ saveTo()
| def saveTo | ( | self, | |
| fPtr, | |||
| fName | |||
| ) |
Save current MOG2 model to file.
Uses the native/OpenCV implementation, thus it requires a filename and not a filepointer. Will save to the specified file. Also stored in the HDF5 file for loading later on.
- Parameters
-
[in] fPtr HDF5 file pointer (opened and ready). [in] fName Filename to save GMM model to.
- Note
- This code is untested. Assumes that OpenCV python API mirrors the actual C++ implementation.
◆ set()
| def set | ( | self, | |
| fname, | |||
| fval | |||
| ) |
Check the documentation for what can be set.
- Parameters
-
[in] fname Name of parameter to set. Invoke set+fname for opencv MOG2 [in] fval Value to set
Example:
det = bgmodelGMM_cv() det.set("History", 200) # will invoke setHistory(200) function from the link
Member Data Documentation
◆ adapt_rate
| adapt_rate |
◆ bgSubtractor
| bgSubtractor |
◆ config
| config |
◆ detResult
| detResult |
◆ fg_mask
| fg_mask |
◆ shadow_mask
| shadow_mask |
The documentation for this class was generated from the following file:
- /home/pvela/python/detector/detector/bgmodel/GMM.py
