OpenCVForUnity.BioinspiredModule.TransientAreasSegmentationModule Class Reference

class which provides a transient/moving areas segmentation module More...

Inheritance diagram for OpenCVForUnity.BioinspiredModule.TransientAreasSegmentationModule:

Public Member Functions
Size	getSize ()
	return the sze of the manage input and output images More...
void	setup (string segmentationParameterFile, bool applyDefaultSetupOnFailure)
	try to open an XML segmentation parameters file to adjust current segmentation instance setup More...
void	setup (string segmentationParameterFile)
	try to open an XML segmentation parameters file to adjust current segmentation instance setup More...
void	setup ()
	try to open an XML segmentation parameters file to adjust current segmentation instance setup More...
string	printSetup ()
	parameters setup display method More...
void	write (string fs)
	write xml/yml formated parameters information More...
void	run (Mat inputToSegment, int channelIndex)
	main processing method, get result using methods getSegmentationPicture() More...
void	run (Mat inputToSegment)
	main processing method, get result using methods getSegmentationPicture() More...
void	getSegmentationPicture (Mat transientAreas)
	access function return the last segmentation result: a boolean picture which is resampled between 0 and 255 for a display purpose More...
void	clearAllBuffers ()
	cleans all the buffers of the instance More...
Public Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
IntPtr	getNativeObjAddr ()
virtual void	clear ()
	Clears the algorithm state. More...
virtual bool	empty ()
	Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read. More...
void	save (string filename)
virtual string	getDefaultName ()
Public Member Functions inherited from OpenCVForUnity.DisposableObject
void	Dispose ()
void	ThrowIfDisposed ()

Static Public Member Functions
static new TransientAreasSegmentationModule	__fromPtr__ (IntPtr addr)
static TransientAreasSegmentationModule	create (Size inputSize)
	allocator More...
Static Public Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
static Algorithm	__fromPtr__ (IntPtr addr)
Static Public Member Functions inherited from OpenCVForUnity.DisposableObject
static IntPtr	ThrowIfNullIntPtr (IntPtr ptr)

Protected Member Functions
override void	Dispose (bool disposing)
Protected Member Functions inherited from OpenCVForUnity.DisposableOpenCVObject
	DisposableOpenCVObject ()
	DisposableOpenCVObject (IntPtr ptr)
	DisposableOpenCVObject (bool isEnabledDispose)
	DisposableOpenCVObject (IntPtr ptr, bool isEnabledDispose)
Protected Member Functions inherited from OpenCVForUnity.DisposableObject
	DisposableObject ()
	DisposableObject (bool isEnabledDispose)

Additional Inherited Members
Properties inherited from OpenCVForUnity.DisposableObject
bool	IsDisposed [get, protected set]
bool	IsEnabledDispose [get, set]

Detailed Description

class which provides a transient/moving areas segmentation module

perform a locally adapted segmentation by using the retina magno input data Based on Alexandre BENOIT thesis: "Le système visuel humain au secours de la vision par ordinateur"

3 spatio temporal filters are used:

• a first one which filters the noise and local variations of the input motion energy
• a second (more powerfull low pass spatial filter) which gives the neighborhood motion energy the segmentation consists in the comparison of these both outputs, if the local motion energy is higher to the neighborhood otion energy, then the area is considered as moving and is segmented
• a stronger third low pass filter helps decision by providing a smooth information about the "motion context" in a wider area

Member Function Documentation

__fromPtr__()

static new TransientAreasSegmentationModule OpenCVForUnity.BioinspiredModule.TransientAreasSegmentationModule.__fromPtr__ ( IntPtr  addr )

static

clearAllBuffers()

void OpenCVForUnity.BioinspiredModule.TransientAreasSegmentationModule.clearAllBuffers

(

)

cleans all the buffers of the instance

create()

static TransientAreasSegmentationModule OpenCVForUnity.BioinspiredModule.TransientAreasSegmentationModule.create ( Size  inputSize )

static

allocator

Parameters

inputSize

: size of the images input to segment (output will be the same size)

Dispose()

override void OpenCVForUnity.BioinspiredModule.TransientAreasSegmentationModule.Dispose ( bool  disposing )

protectedvirtual

Reimplemented from OpenCVForUnity.CoreModule.Algorithm.

getSegmentationPicture()

void OpenCVForUnity.BioinspiredModule.TransientAreasSegmentationModule.getSegmentationPicture

(

Mat

transientAreas

)

access function return the last segmentation result: a boolean picture which is resampled between 0 and 255 for a display purpose

getSize()

Size OpenCVForUnity.BioinspiredModule.TransientAreasSegmentationModule.getSize

(

)

return the sze of the manage input and output images

printSetup()

string OpenCVForUnity.BioinspiredModule.TransientAreasSegmentationModule.printSetup

(

)

parameters setup display method

Returns

a string which contains formatted parameters information

run() [1/2]

void OpenCVForUnity.BioinspiredModule.TransientAreasSegmentationModule.run	(	Mat	inputToSegment,
		int	channelIndex
	)

main processing method, get result using methods getSegmentationPicture()

Parameters

inputToSegment	: the image to process, it must match the instance buffer size !
channelIndex	: the channel to process in case of multichannel images

run() [2/2]

void OpenCVForUnity.BioinspiredModule.TransientAreasSegmentationModule.run

(

Mat

inputToSegment

)

main processing method, get result using methods getSegmentationPicture()

Parameters

inputToSegment	: the image to process, it must match the instance buffer size !
channelIndex	: the channel to process in case of multichannel images

setup() [1/3]

void OpenCVForUnity.BioinspiredModule.TransientAreasSegmentationModule.setup	(	string	segmentationParameterFile,
		bool	applyDefaultSetupOnFailure
	)

try to open an XML segmentation parameters file to adjust current segmentation instance setup

• if the xml file does not exist, then default setup is applied
• warning, Exceptions are thrown if read XML file is not valid

  Parameters

  segmentationParameterFile	: the parameters filename
  applyDefaultSetupOnFailure	: set to true if an error must be thrown on error

setup() [2/3]

void OpenCVForUnity.BioinspiredModule.TransientAreasSegmentationModule.setup

(

string

segmentationParameterFile

)

try to open an XML segmentation parameters file to adjust current segmentation instance setup

• if the xml file does not exist, then default setup is applied
• warning, Exceptions are thrown if read XML file is not valid

  Parameters

  segmentationParameterFile	: the parameters filename
  applyDefaultSetupOnFailure	: set to true if an error must be thrown on error

setup() [3/3]

void OpenCVForUnity.BioinspiredModule.TransientAreasSegmentationModule.setup

(

)

try to open an XML segmentation parameters file to adjust current segmentation instance setup

• if the xml file does not exist, then default setup is applied
• warning, Exceptions are thrown if read XML file is not valid

  Parameters

  segmentationParameterFile	: the parameters filename
  applyDefaultSetupOnFailure	: set to true if an error must be thrown on error

write()

void OpenCVForUnity.BioinspiredModule.TransientAreasSegmentationModule.write

(

string

fs

)

write xml/yml formated parameters information

Parameters

fs	: the filename of the xml file that will be open and writen with formatted parameters information

---

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

• OpenCVForUnity/Assets/OpenCVForUnity/org/opencv_contrib/bioinspired/TransientAreasSegmentationModule.cs