Base Class Reference

Base or root implementation of detector class. More...

Inheritance diagram for Base:

Collaboration diagram for Base:

Public Member Functions
def	__init__ (self)
	Instantiate a detector Base activity class object. More...
def	adapt (self)
	Adapt any internal parameters based on activity state, signal, and any other historical information. More...
def	correct (self)
	Reconcile prediction and measurement as fitting. More...
def	detect (self, signal)
	Run detection only processing pipeline (no adaptation). 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	getState (self)
	Return current/latest state. More...
def	measure (self, signal)
	Generate measurement of activity state from passed signal. More...
def	predict (self)
	Predict next state from current state. More...
def	process (self, signal)
	Process the new incoming signal on full detection pipeline. 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	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...

Public Attributes
	x
	Detection state. More...

Detailed Description

Base or root implementation of detector class.

Constructor & Destructor Documentation

__init__()

def __init__

(

self

)

Instantiate a detector Base activity class object.

Reimplemented in Planar.

Member Function Documentation

adapt()

def adapt

(

self

)

Adapt any internal parameters based on activity state, signal, and any other historical information.

Base method does not have adaptation. Should be customized to the implementation of the class.

Reimplemented in bgConical, inCornerEstimator, bgGaussian, fgGaussian, bgmodelGMM_cv, onWorkspace, fgDifferences, bgmodelGMM, fromState, and Planar.

correct()

def correct

(

self

)

Reconcile prediction and measurement as fitting.

Correct state based on measurement and prediction states. Base method does not have correction.

Reimplemented in bgGaussian, fgGaussian, onWorkspace, fgDifferences, Planar, and fromState.

detect()

def detect	(		self,
			signal
	)

Run detection only processing pipeline (no adaptation).

Good to have if there is a calibration scheme that uses adaptation, then freezes the parameters during deployment. Running detect rather than process prevents further model updating while still running the rest of the process in a single call.

Reimplemented in fromState, and bgmodelGMM_cv.

emptyDebug()

def emptyDebug

(

self

)

Return empty debug state information.

Useful if contents needed beforehand.

Reimplemented in fgGaussian, bgGaussian, onWorkspace, and fgDifferences.

emptyState()

def emptyState

(

self

)

Return empty state.

Useful if contents needed beforehand.

Reimplemented in fgGaussian, bgGaussian, onWorkspace, fgDifferences, and fgAppearance.

getDebug()

def getDebug

(

self

)

Return current/latest debug state information.

Usually the debug state consists of internally computed information that is useful for debugging purposes and can help to isolate problems within the implemented class or with downstream processing that may rely on assumptions built into this implemented class.

Reimplemented in fgGaussian, bgGaussian, bgmodelGMM_cv, onWorkspace, and fgDifferences.

getState()

def getState

(

self

)

Return current/latest state.

Reimplemented in fgGaussian, bgGaussian, bgmodelGMM_cv, onWorkspace, fromState, and fgAppearance.

load()

def load (   fileName,   relpath = None  )

static

Outer method for loading file given as a string (with path).

Opens file, preps for loading, invokes loadFrom routine, then closes. Overload to invoke sub-class loadFrom member function.

Parameters

[in]	fileName	The full or relative path filename.
[in]	relpath	The hdf5 (relative) path name to use for loading. Usually class has default, this is to override.

Reimplemented in imageOccupancy, and imageRegions.

loadFrom()

def loadFrom (   fPtr )

static

Empty method for loading internal information from HDF5 file.

Load data from given HDF5 pointer. Assumes in root from current file pointer location.

Reimplemented in bgConical, fgGaussian, bgmodelGMM_cv, bgGaussian, inCorner, and onWorkspace.

measure()

def measure	(		self,
			signal
	)

Generate measurement of activity state from passed signal.

Parameters

[in]

signal

Current signal of interest for activity detection.

Reimplemented in imageRegions, fromState, Planar, bgConical, imageOccupancy, inCornerEstimator, inCorner, bgGaussian, bgmodelGMM_cv, bgmodelGMM, onWorkspace, targetSG, targetNeon, inImage, inImageRGBD, targetCorner, and targetMagenta.

predict()

def predict

(

self

)

Predict next state from current state.

If transition model known, generate state prediction. Else it is most likely a static transition model, which does nothing / keeps prior state. The base method employs a static state assumption.

Reimplemented in bgGaussian, fgGaussian, fgDifferences, onWorkspace, Planar, fromState, and FromSketch.

process()

def process	(		self,
			signal
	)

Process the new incoming signal on full detection pipeline.

Running the full detection pipeline includes adaptation.

Reimplemented in fromState, Planar, bgmodelGMM_cv, bgmodelGMM, fgGaussian, bgGaussian, onWorkspace, and fgDifferences.

save()

def save	(		self,
			fileName
	)

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.

saveTo()

def saveTo	(		self,
			fPtr
	)

Empty method for saving internal information to HDF5 file.

Save data to given HDF5 pointer. Puts in root.

Reimplemented in bgConical, fgGaussian, bgGaussian, inCorner, onWorkspace, and fromState.

Member Data Documentation

x

x

Detection state.

---

The documentation for this class was generated from the following file:

• /home/pvela/python/detector/detector/base.py