Activity states depend on having signal lying in specific regions of an image. Signal is presumably in image pixels. More...

Inheritance diagram for imageRegions:

[legend]

Collaboration diagram for imageRegions:

[legend]

Public Member Functions
def	__init__ (self, imRegions=None, processor=None)
	Constructor for imageRegions class. More...

def	addRegionByMask (self, regMask)
	Provide a masked region to use for defining a new state. More...

def	addRegionByPolygon (self, regPoly, imsize=None)
	Add a region by specifying the polygon boundary. More...

def	buildFromPolygons (imsize, thePolygons)
	Construct an imageRegions instance with provided polygon regions. More...

def	calibrateFromPolygonMouseInputOverImageRGB (theImage, theFile, initRegions=None)
	Calibrate a region detector by requesting closed polygon input from user. More...

def	emptyRegions (self)
	Delete regions image if exists and return to uninitialized state. More...

def	initRegions (self, imsize)
	Initialize regions by providing target image dimensions. More...

def	measure (self, zsig)

def	printState (self)
	Print current region detection state (as string). More...

def	regions_close_cv (self, window_name="Activity Regions")
	Close the region image window. More...

def	regions_display_cv (self, ratio=1, window_name="Activity Regions")
	Display the region image to see labels. More...

def	saveTo (self, fPtr, relpath="activity.byRegion")
	Empty method for saving internal information to HDF5 file. More...

def	setRegions (self, imRegions)
	Provide a label image where the pixel label indicates the raw activity label. More...

def	specifyPolyRegionsFromImageRGB (self, theImage, doClear=False)
	Given an image, get user input as polygons that define the different regions. More...

def	stringState (self)
	Convert current region detection state to string. More...

def	wipeRegions (self)
	Clear the regions image. More...

Public Member Functions inherited from fromState
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	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...

Static Public Member Functions
def	load (fileName, relpath=None)
	Outer method for loading file given as a string (with path). More...

def	loadFrom (fptr, relpath="activity.byRegion")
	Inner method for loading internal information from HDF5 file. More...

Static Public Member Functions inherited from Base
def	loadFrom (fPtr)
	Empty method for loading internal information from HDF5 file. More...

Public Attributes
	imRegions
	Image regions array. More...

	isInit
	Flag specifying initialization state. More...

	lMax
	Max label associated to image regions. More...

	z

Public Attributes inherited from fromState
	processor
	Pre-processor or similar. More...

	z
	The detection outcome. More...

Public Attributes inherited from Base
	x
	Detection state. More...

Detailed Description

Activity states depend on having signal lying in specific regions of an image. Signal is presumably in image pixels.

The presumption is that the regions are disjoint so that each pixel maps to either 1 or 0 activity/event states. The signals can be pixel coordinates (2D) or it can be pixel coordinates plus depth or height (3D), but up to the underlying class implementation to work out whether that extra coordinate matters and its meaning.

Chosen not to be a sub-class of inImage due to the fact that these operate differently. Activity recognition checks for presence of signal location in a particular region of the image. Image-based detection checks for presence of target features throughout the entire image.

Note: Can code both disjoint and overlap. Disjoint = single image region label. Overlapping requires list/array of region masks. Multiple states can be triggered at once. State is a set/list then, not a scalar.

Constructor & Destructor Documentation

◆ init()

def __init__	(	self,
		imRegions = `None`,
		processor = `None`
	)

Constructor for imageRegions class.

Parameters

[in] imRegions If the regions are known already, provide them.

Member Function Documentation

◆ addRegionByMask()

def addRegionByMask	(	self,
		regMask
	)

Provide a masked region to use for defining a new state.

No check to see if it wipes out existing states.

If the masked region has no true values, then no new region is added. If multiple slices of masks are given (3rd dimension), then will add each slice.

Parameters

[in] regMask Region mask, should match size of internal image.

◆ addRegionByPolygon()

def addRegionByPolygon	(	self,
		regPoly,
		imsize = `None`
	)

Add a region by specifying the polygon boundary.

The polygon should be closed. If it is not closed, then it will be closed by appending the first point in the polygon vertex list. Also, image regions should be initialized or the target shape given in imsize.

The polygon should be column-wise in (x,y) coordinates.

Parameters

[in]	regPoly	The polygon region to add. If None, does nothing.
[in]	imsize	The image dimensions, if not yet initialized (optional)

◆ buildFromPolygons()

def buildFromPolygons	(	imsize,
		thePolygons
	)

Construct an imageRegions instance with provided polygon regions.

Parameters

[in]	imsize	The image size.
[in]	thePolygons	List of polygons as column array of coordinates.

Returns: Instantiated object.

◆ calibrateFromPolygonMouseInputOverImageRGB()

def calibrateFromPolygonMouseInputOverImageRGB	(	theImage,
		theFile,
		initRegions = `None`
	)

Calibrate a region detector by requesting closed polygon input from user.

Calibration routines save the information for loading in the future. They do not return an instantiated object.

This version has two modes, one of which is to specify from scratch. Another takes a pre-existing activity region image (basically a label image). Recall that there is no check to see if user input is wiping out a previously existing or previously enetered activity region.

◆ emptyRegions()

def emptyRegions ( self )

Delete regions image if exists and return to uninitialized state.

◆ initRegions()

def initRegions	(	self,
		imsize
	)

Initialize regions by providing target image dimensions.

There will be no regions of interest assigned.

Parameters

[in] imsize The image dimensions/shape. Only first two important.

◆ 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. Overloaded to invoke coorect 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 from Base.

◆ loadFrom()

def loadFrom	(	fptr,
		relpath = `"activity.byRegion"`
	)

static

Inner method for loading internal information from HDF5 file.

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

◆ measure()

def measure	(	self,
		zsig
	)

@brief  Compare signal to expected image region states. 

@param[in]  zsig  The 2D pixel coords / 3D pixel coords + depth value.

Reimplemented from fromState.

◆ printState()

def printState ( self )

Print current region detection state (as string).

◆ regions_close_cv()

def regions_close_cv	(	self,
		window_name = `"Activity Regions"`
	)

Close the region image window.

Parameters

[in] window_name Window name to use.

◆ regions_display_cv()

def regions_display_cv	(	self,
		ratio = `1`,
		window_name = `"Activity Regions"`
	)

Display the region image to see labels.

Parameters

[in]	ratio	Display scaling.
[in]	window_name	Window name to use.

◆ saveTo()

def saveTo	(	self,
		fPtr,
		relpath = `"activity.byRegion"`
	)

Empty method for saving internal information to HDF5 file.

Save data to given HDF5 pointer. Puts in root.

Parameters

[in]	fPtr	HDF5 file pointer.
[in]	relpath	Group name relative to current HDF5 path.

◆ setRegions()

def setRegions	(	self,
		imRegions
	)

Provide a label image where the pixel label indicates the raw activity label.

Semantic meaning is up to the outer scope.

There is no sanity checking to make sure that the image is properly given. Region image just gets used as is, with label possibilities defined by max label value, hence they should be ordered from 1 to max label value.

Parameters

[in] imRegions Label-type image.

◆ specifyPolyRegionsFromImageRGB()

def specifyPolyRegionsFromImageRGB	(	self,
		theImage,
		doClear = `False`
	)

Given an image, get user input as polygons that define the different regions.

If some regions lie interior to others, then they should be given after. Order matters.

Overrides any existing specification.

Parameters

[in]	theImage	The source image to provide region context.
[in]	doClear	Optional: clear existing imregions?

◆ stringState()

def stringState ( self )

Convert current region detection state to string.

Returns: Region detection state string.

◆ wipeRegions()

def wipeRegions ( self )

Clear the regions image.

There will be no regions of interest assigned. Remains initialized is it was to being with.

Member Data Documentation

◆ imRegions

imRegions

Image regions array.

◆ isInit

isInit

Flag specifying initialization state.

◆ lMax

lMax

Max label associated to image regions.

◆ z

z

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

/home/pvela/python/detector/detector/activity/byRegion.py

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ addRegionByMask()

◆ addRegionByPolygon()

◆ buildFromPolygons()

◆ calibrateFromPolygonMouseInputOverImageRGB()

◆ emptyRegions()

◆ initRegions()

◆ load()

◆ loadFrom()

◆ measure()

◆ printState()

◆ regions_close_cv()

◆ regions_display_cv()

◆ saveTo()

◆ setRegions()

◆ specifyPolyRegionsFromImageRGB()

◆ stringState()

◆ wipeRegions()

Member Data Documentation

◆ imRegions

◆ isInit

◆ lMax

◆ z

◆ init()