Activity states depend on having true image values lying in specific regions of an image. Signal is a full image. More...

Inheritance diagram for imageOccupancy:

[legend]

Collaboration diagram for imageOccupancy:

[legend]

Public Member Functions
def	__init__ (self, imRegions=None)

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

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

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

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

def	display_close_cv (self, window_name="Occupancy Regions")

def	display_cv (self, ratio=1, window_name="Occupancy Regions")

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, I)

def	printState (self)

def	replaceRegionMask (self, regMask, iSlice)
	Provide a replacement masked region for an existing region specification. 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 occupancy regions. More...

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

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	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	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, relpath="activity.byRegion")
	Empty 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 of interest (along 3rd dimension) More...

	Ip

	isInit
	Is instance initialized? More...

	tau
	Area threshold(s) for region(s). More...

	z
	Occupancy status. More...

Public Attributes inherited from inImage
	Ip

	processor

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

Detailed Description

Activity states depend on having true image values lying in specific regions of an image. Signal is a full image.

Unlike imageRegions, here the regions may overlap, but it is the responsibility of the outer context to make sense of the overlap. This class behaves like a switch, triggering a true state for some given region if there are true/non-zero pixels in the specified region (or sufficient such pixels if a lower bound is given).

This is a sub-class of inImage precisely because the objective is to check for the presence of specific pixel values throughout the entire image against a set of target regions (internally specified as binary masks).

Constructor & Destructor Documentation

◆ init()

def __init__	(	self,
		imRegions = `None`
	)

Reimplemented from inImage.

Member Function Documentation

◆ 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)

◆ addRegionMask()

def addRegionMask	(	self,
		regMask
	)

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

Outer context should parse properly is overlaps with other states.

If the masked region has no true values, it stil gets added since the presumption is that the outer context is doing so intentionally. It may even replace the slice with a non-zero region sometime in the future. Likewise, it might even zero out a particular region slice in the future.

Parameters

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

◆ buildFromPolygons()

def buildFromPolygons	(	imsize,
		thePolygons
	)

Construct an imageOccupancy 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 occupancy 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 region (or multiple, possibly overlapping).

◆ display_close_cv()

def display_close_cv	(	self,
		window_name = `"Occupancy Regions"`
	)

◆ display_cv()

def display_cv	(	self,
		ratio = `1`,
		window_name = `"Occupancy Regions"`
	)

◆ 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

Empty method for loading internal information from HDF5 file.

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

Default reference is "activity.byRegion/imOccupancy". If that's not correct, then need to overload the relpath. Name of source data cannot be changed (from "imOccupancy").

◆ measure()

def measure	(	self,
		I
	)

@brief  Compare input binary mask image to image mask regions.

@param[in]  I   Input image. If not binary, then improcessor should binarize.

Reimplemented from inImage.

◆ printState()

def printState ( self )

◆ replaceRegionMask()

def replaceRegionMask	(	self,
		regMask,
		iSlice
	)

Provide a replacement masked region for an existing region specification.

Parameters

[in]	regMask	Region mask, should match size of internal image.
[in]	iSlice	Should be an existing slice index along 3rd axis.

◆ 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.

Default reference is "activity.byRegion/imOccupancy". If that's not correct, then need to overload the relpath. Name of source data cannot be changed (from "imOccupancy").

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. A single image is a single region. Multiple image slices along 3rd dimension indicate multiple regions. Gets re-cast to binary just in case.

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 occupancy 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?

◆ wipeRegions()

def wipeRegions ( self )

Clear the regions image.

There will be no regions of interest assigned.

Member Data Documentation

◆ imRegions

imRegions

Image regions of interest (along 3rd dimension)

◆ Ip

Ip

◆ isInit

isInit

Is instance initialized?

◆ tau

tau

Area threshold(s) for region(s).

◆ z

z

Occupancy status.

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

◆ addRegionByPolygon()

◆ addRegionMask()

◆ buildFromPolygons()

◆ calibrateFromPolygonMouseInputOverImageRGB()

◆ display_close_cv()

◆ display_cv()

◆ emptyRegions()

◆ initRegions()

◆ load()

◆ loadFrom()

◆ measure()

◆ printState()

◆ replaceRegionMask()

◆ saveTo()

◆ setRegions()

◆ specifyPolyRegionsFromImageRGB()

◆ wipeRegions()

Member Data Documentation

◆ imRegions

◆ Ip

◆ isInit

◆ tau

◆ z

◆ init()