class which allows the Gipsa/Listic Labs model to be used with OpenCV. More...

Inheritance diagram for OpenCVForUnity.BioinspiredModule.Retina:

Public Member Functions
Size	getInputSize ()
	Retreive retina input buffer size. More...

Size	getOutputSize ()
	Retreive retina output buffer size that can be different from the input if a spatial log transformation is applied. More...

void	setup (string retinaParameterFile, bool applyDefaultSetupOnFailure)
	Try to open an XML retina parameters file to adjust current retina instance setup. More...

void	setup (string retinaParameterFile)
	Try to open an XML retina parameters file to adjust current retina instance setup. More...

void	setup ()
	Try to open an XML retina parameters file to adjust current retina instance setup. More...

string	printSetup ()
	Outputs a string showing the used parameters setup. More...

void	write (string fs)
	Write xml/yml formated parameters information. More...

void	setupOPLandIPLParvoChannel (bool colorMode, bool normaliseOutput, float photoreceptorsLocalAdaptationSensitivity, float photoreceptorsTemporalConstant, float photoreceptorsSpatialConstant, float horizontalCellsGain, float HcellsTemporalConstant, float HcellsSpatialConstant, float ganglionCellsSensitivity)
	Setup the OPL and IPL parvo channels (see biologocal model) More...

void	setupOPLandIPLParvoChannel (bool colorMode, bool normaliseOutput, float photoreceptorsLocalAdaptationSensitivity, float photoreceptorsTemporalConstant, float photoreceptorsSpatialConstant, float horizontalCellsGain, float HcellsTemporalConstant, float HcellsSpatialConstant)
	Setup the OPL and IPL parvo channels (see biologocal model) More...

void	setupOPLandIPLParvoChannel (bool colorMode, bool normaliseOutput, float photoreceptorsLocalAdaptationSensitivity, float photoreceptorsTemporalConstant, float photoreceptorsSpatialConstant, float horizontalCellsGain, float HcellsTemporalConstant)
	Setup the OPL and IPL parvo channels (see biologocal model) More...

void	setupOPLandIPLParvoChannel (bool colorMode, bool normaliseOutput, float photoreceptorsLocalAdaptationSensitivity, float photoreceptorsTemporalConstant, float photoreceptorsSpatialConstant, float horizontalCellsGain)
	Setup the OPL and IPL parvo channels (see biologocal model) More...

void	setupOPLandIPLParvoChannel (bool colorMode, bool normaliseOutput, float photoreceptorsLocalAdaptationSensitivity, float photoreceptorsTemporalConstant, float photoreceptorsSpatialConstant)
	Setup the OPL and IPL parvo channels (see biologocal model) More...

void	setupOPLandIPLParvoChannel (bool colorMode, bool normaliseOutput, float photoreceptorsLocalAdaptationSensitivity, float photoreceptorsTemporalConstant)
	Setup the OPL and IPL parvo channels (see biologocal model) More...

void	setupOPLandIPLParvoChannel (bool colorMode, bool normaliseOutput, float photoreceptorsLocalAdaptationSensitivity)
	Setup the OPL and IPL parvo channels (see biologocal model) More...

void	setupOPLandIPLParvoChannel (bool colorMode, bool normaliseOutput)
	Setup the OPL and IPL parvo channels (see biologocal model) More...

void	setupOPLandIPLParvoChannel (bool colorMode)
	Setup the OPL and IPL parvo channels (see biologocal model) More...

void	setupOPLandIPLParvoChannel ()
	Setup the OPL and IPL parvo channels (see biologocal model) More...

void	setupIPLMagnoChannel (bool normaliseOutput, float parasolCells_beta, float parasolCells_tau, float parasolCells_k, float amacrinCellsTemporalCutFrequency, float V0CompressionParameter, float localAdaptintegration_tau, float localAdaptintegration_k)
	Set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel. More...

void	setupIPLMagnoChannel (bool normaliseOutput, float parasolCells_beta, float parasolCells_tau, float parasolCells_k, float amacrinCellsTemporalCutFrequency, float V0CompressionParameter, float localAdaptintegration_tau)
	Set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel. More...

void	setupIPLMagnoChannel (bool normaliseOutput, float parasolCells_beta, float parasolCells_tau, float parasolCells_k, float amacrinCellsTemporalCutFrequency, float V0CompressionParameter)
	Set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel. More...

void	setupIPLMagnoChannel (bool normaliseOutput, float parasolCells_beta, float parasolCells_tau, float parasolCells_k, float amacrinCellsTemporalCutFrequency)
	Set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel. More...

void	setupIPLMagnoChannel (bool normaliseOutput, float parasolCells_beta, float parasolCells_tau, float parasolCells_k)
	Set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel. More...

void	setupIPLMagnoChannel (bool normaliseOutput, float parasolCells_beta, float parasolCells_tau)
	Set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel. More...

void	setupIPLMagnoChannel (bool normaliseOutput, float parasolCells_beta)
	Set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel. More...

void	setupIPLMagnoChannel (bool normaliseOutput)
	Set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel. More...

void	setupIPLMagnoChannel ()
	Set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel. More...

void	run (Mat inputImage)
	Method which allows retina to be applied on an input image,. More...

void	applyFastToneMapping (Mat inputImage, Mat outputToneMappedImage)
	Method which processes an image in the aim to correct its luminance correct backlight problems, enhance details in shadows. More...

void	getParvo (Mat retinaOutput_parvo)
	Accessor of the details channel of the retina (models foveal vision). More...

void	getParvoRAW (Mat retinaOutput_parvo)
	Accessor of the details channel of the retina (models foveal vision). More...

void	getMagno (Mat retinaOutput_magno)
	Accessor of the motion channel of the retina (models peripheral vision). More...

void	getMagnoRAW (Mat retinaOutput_magno)
	Accessor of the motion channel of the retina (models peripheral vision). More...

Mat	getMagnoRAW ()

Mat	getParvoRAW ()

void	setColorSaturation (bool saturateColors, float colorSaturationValue)
	Activate color saturation as the final step of the color demultiplexing process -> this saturation is a sigmoide function applied to each channel of the demultiplexed image. More...

void	setColorSaturation (bool saturateColors)
	Activate color saturation as the final step of the color demultiplexing process -> this saturation is a sigmoide function applied to each channel of the demultiplexed image. More...

void	setColorSaturation ()
	Activate color saturation as the final step of the color demultiplexing process -> this saturation is a sigmoide function applied to each channel of the demultiplexed image. More...

void	clearBuffers ()
	Clears all retina buffers. More...

void	activateMovingContoursProcessing (bool activate)
	Activate/desactivate the Magnocellular pathway processing (motion information extraction), by default, it is activated. More...

void	activateContoursProcessing (bool activate)
	Activate/desactivate the Parvocellular pathway processing (contours information extraction), by default, it is activated. 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 Retina	__fromPtr__ (IntPtr addr)

static Retina	create (Size inputSize)

static Retina	create (Size inputSize, bool colorMode, int colorSamplingMethod, bool useRetinaLogSampling, float reductionFactor, float samplingStrength)
	Constructors from standardized interfaces : retreive a smart pointer to a Retina instance. More...

static Retina	create (Size inputSize, bool colorMode, int colorSamplingMethod, bool useRetinaLogSampling, float reductionFactor)
	Constructors from standardized interfaces : retreive a smart pointer to a Retina instance. More...

static Retina	create (Size inputSize, bool colorMode, int colorSamplingMethod, bool useRetinaLogSampling)
	Constructors from standardized interfaces : retreive a smart pointer to a Retina instance. More...

static Retina	create (Size inputSize, bool colorMode, int colorSamplingMethod)
	Constructors from standardized interfaces : retreive a smart pointer to a Retina instance. More...

static Retina	create (Size inputSize, bool colorMode)
	Constructors from standardized interfaces : retreive a smart pointer to a Retina instance. 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 allows the Gipsa/Listic Labs model to be used with OpenCV.

This retina model allows spatio-temporal image processing (applied on still images, video sequences). As a summary, these are the retina model properties:

It applies a spectral whithening (mid-frequency details enhancement)
high frequency spatio-temporal noise reduction
low frequency luminance to be reduced (luminance range compression)
local logarithmic luminance compression allows details to be enhanced in low light conditions

USE : this model can be used basically for spatio-temporal video effects but also for : _using the getParvo method output matrix : texture analysiswith enhanced signal to noise ratio and enhanced details robust against input images luminance ranges _using the getMagno method output matrix : motion analysis also with the previously cited properties

for more information, reer to the following papers : Benoit A., Caplier A., Durette B., Herault, J., "USING HUMAN VISUAL SYSTEM MODELING FOR BIO-INSPIRED LOW LEVEL IMAGE PROCESSING", Elsevier, Computer Vision and Image Understanding 114 (2010), pp. 758-773, DOI: http://dx.doi.org/10.1016/j.cviu.2010.01.011 Vision: Images, Signals and Neural Networks: Models of Neural Processing in Visual Perception (Progress in Neural Processing),By: Jeanny Herault, ISBN: 9814273686. WAPI (Tower ID): 113266891.

The retina filter includes the research contributions of phd/research collegues from which code has been redrawn by the author : take a look at the retinacolor.hpp module to discover Brice Chaix de Lavarene color mosaicing/demosaicing and the reference paper: B. Chaix de Lavarene, D. Alleysson, B. Durette, J. Herault (2007). "Efficient demosaicing through recursive filtering", IEEE International Conference on Image Processing ICIP 2007 take a look at imagelogpolprojection.hpp to discover retina spatial log sampling which originates from Barthelemy Durette phd with Jeanny Herault. A Retina / V1 cortex projection is also proposed and originates from Jeanny's discussions. more informations in the above cited Jeanny Heraults's book.

Member Function Documentation

◆ fromPtr()

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

static

◆ activateContoursProcessing()

void OpenCVForUnity.BioinspiredModule.Retina.activateContoursProcessing ( bool activate )

Activate/desactivate the Parvocellular pathway processing (contours information extraction), by default, it is activated.

Parameters

activate true if Parvocellular (contours information extraction) output should be activated, false if not... if activated, the Parvocellular output can be retrieved using the Retina::getParvo methods

◆ activateMovingContoursProcessing()

void OpenCVForUnity.BioinspiredModule.Retina.activateMovingContoursProcessing ( bool activate )

Activate/desactivate the Magnocellular pathway processing (motion information extraction), by default, it is activated.

Parameters

activate true if Magnocellular output should be activated, false if not... if activated, the Magnocellular output can be retrieved using the getMagno methods

◆ applyFastToneMapping()

void OpenCVForUnity.BioinspiredModule.Retina.applyFastToneMapping	(	Mat	inputImage,
		Mat	outputToneMappedImage
	)

Method which processes an image in the aim to correct its luminance correct backlight problems, enhance details in shadows.

This method is designed to perform High Dynamic Range image tone mapping (compress >8bit/pixel images to 8bit/pixel). This is a simplified version of the Retina Parvocellular model (simplified version of the run/getParvo methods call) since it does not include the spatio-temporal filter modelling the Outer Plexiform Layer of the retina that performs spectral whitening and many other stuff. However, it works great for tone mapping and in a faster way.

Check the demos and experiments section to see examples and the way to perform tone mapping using the original retina model and the method.

Parameters

inputImage	the input image to process (should be coded in float format : CV_32F, CV_32FC1, CV_32F_C3, CV_32F_C4, the 4th channel won't be considered).
outputToneMappedImage	the output 8bit/channel tone mapped image (CV_8U or CV_8UC3 format).

◆ clearBuffers()

void OpenCVForUnity.BioinspiredModule.Retina.clearBuffers ( )

Clears all retina buffers.

(equivalent to opening the eyes after a long period of eye close ;o) whatchout the temporal transition occuring just after this method call.

◆ create() [1/6]

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

static

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ create() [2/6]

static Retina OpenCVForUnity.BioinspiredModule.Retina.create	(	Size	inputSize,
		bool	colorMode,
		int	colorSamplingMethod,
		bool	useRetinaLogSampling,
		float	reductionFactor,
		float	samplingStrength
	)

static

Constructors from standardized interfaces : retreive a smart pointer to a Retina instance.

Parameters

inputSize	the input frame size
colorMode	the chosen processing mode : with or without color processing
colorSamplingMethod	specifies which kind of color sampling will be used : cv::bioinspired::RETINA_COLOR_RANDOM: each pixel position is either R, G or B in a random choice cv::bioinspired::RETINA_COLOR_DIAGONAL: color sampling is RGBRGBRGB..., line 2 BRGBRGBRG..., line 3, GBRGBRGBR... cv::bioinspired::RETINA_COLOR_BAYER: standard bayer sampling
useRetinaLogSampling	activate retina log sampling, if true, the 2 following parameters can be used
reductionFactor	only usefull if param useRetinaLogSampling=true, specifies the reduction factor of the output frame (as the center (fovea) is high resolution and corners can be underscaled, then a reduction of the output is allowed without precision leak
samplingStrength	only usefull if param useRetinaLogSampling=true, specifies the strength of the log scale that is applied

◆ create() [3/6]

static Retina OpenCVForUnity.BioinspiredModule.Retina.create	(	Size	inputSize,
		bool	colorMode,
		int	colorSamplingMethod,
		bool	useRetinaLogSampling,
		float	reductionFactor
	)

static

Constructors from standardized interfaces : retreive a smart pointer to a Retina instance.

Parameters

inputSize	the input frame size
colorMode	the chosen processing mode : with or without color processing
colorSamplingMethod	specifies which kind of color sampling will be used : cv::bioinspired::RETINA_COLOR_RANDOM: each pixel position is either R, G or B in a random choice cv::bioinspired::RETINA_COLOR_DIAGONAL: color sampling is RGBRGBRGB..., line 2 BRGBRGBRG..., line 3, GBRGBRGBR... cv::bioinspired::RETINA_COLOR_BAYER: standard bayer sampling
useRetinaLogSampling	activate retina log sampling, if true, the 2 following parameters can be used
reductionFactor	only usefull if param useRetinaLogSampling=true, specifies the reduction factor of the output frame (as the center (fovea) is high resolution and corners can be underscaled, then a reduction of the output is allowed without precision leak
samplingStrength	only usefull if param useRetinaLogSampling=true, specifies the strength of the log scale that is applied

◆ create() [4/6]

static Retina OpenCVForUnity.BioinspiredModule.Retina.create	(	Size	inputSize,
		bool	colorMode,
		int	colorSamplingMethod,
		bool	useRetinaLogSampling
	)

static

Constructors from standardized interfaces : retreive a smart pointer to a Retina instance.

Parameters

inputSize	the input frame size
colorMode	the chosen processing mode : with or without color processing
colorSamplingMethod	specifies which kind of color sampling will be used : cv::bioinspired::RETINA_COLOR_RANDOM: each pixel position is either R, G or B in a random choice cv::bioinspired::RETINA_COLOR_DIAGONAL: color sampling is RGBRGBRGB..., line 2 BRGBRGBRG..., line 3, GBRGBRGBR... cv::bioinspired::RETINA_COLOR_BAYER: standard bayer sampling
useRetinaLogSampling	activate retina log sampling, if true, the 2 following parameters can be used
reductionFactor	only usefull if param useRetinaLogSampling=true, specifies the reduction factor of the output frame (as the center (fovea) is high resolution and corners can be underscaled, then a reduction of the output is allowed without precision leak
samplingStrength	only usefull if param useRetinaLogSampling=true, specifies the strength of the log scale that is applied

◆ create() [5/6]

static Retina OpenCVForUnity.BioinspiredModule.Retina.create	(	Size	inputSize,
		bool	colorMode,
		int	colorSamplingMethod
	)

static

Constructors from standardized interfaces : retreive a smart pointer to a Retina instance.

Parameters

inputSize	the input frame size
colorMode	the chosen processing mode : with or without color processing
colorSamplingMethod	specifies which kind of color sampling will be used : cv::bioinspired::RETINA_COLOR_RANDOM: each pixel position is either R, G or B in a random choice cv::bioinspired::RETINA_COLOR_DIAGONAL: color sampling is RGBRGBRGB..., line 2 BRGBRGBRG..., line 3, GBRGBRGBR... cv::bioinspired::RETINA_COLOR_BAYER: standard bayer sampling
useRetinaLogSampling	activate retina log sampling, if true, the 2 following parameters can be used
reductionFactor	only usefull if param useRetinaLogSampling=true, specifies the reduction factor of the output frame (as the center (fovea) is high resolution and corners can be underscaled, then a reduction of the output is allowed without precision leak
samplingStrength	only usefull if param useRetinaLogSampling=true, specifies the strength of the log scale that is applied

◆ create() [6/6]

static Retina OpenCVForUnity.BioinspiredModule.Retina.create	(	Size	inputSize,
		bool	colorMode
	)

static

Constructors from standardized interfaces : retreive a smart pointer to a Retina instance.

Parameters

inputSize	the input frame size
colorMode	the chosen processing mode : with or without color processing
colorSamplingMethod	specifies which kind of color sampling will be used : cv::bioinspired::RETINA_COLOR_RANDOM: each pixel position is either R, G or B in a random choice cv::bioinspired::RETINA_COLOR_DIAGONAL: color sampling is RGBRGBRGB..., line 2 BRGBRGBRG..., line 3, GBRGBRGBR... cv::bioinspired::RETINA_COLOR_BAYER: standard bayer sampling
useRetinaLogSampling	activate retina log sampling, if true, the 2 following parameters can be used
reductionFactor	only usefull if param useRetinaLogSampling=true, specifies the reduction factor of the output frame (as the center (fovea) is high resolution and corners can be underscaled, then a reduction of the output is allowed without precision leak
samplingStrength	only usefull if param useRetinaLogSampling=true, specifies the strength of the log scale that is applied

◆ Dispose()

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

protectedvirtual

Reimplemented from OpenCVForUnity.CoreModule.Algorithm.

◆ getInputSize()

Size OpenCVForUnity.BioinspiredModule.Retina.getInputSize ( )

Retreive retina input buffer size.

Returns: the retina input buffer size

◆ getMagno()

void OpenCVForUnity.BioinspiredModule.Retina.getMagno ( Mat retinaOutput_magno )

Accessor of the motion channel of the retina (models peripheral vision).

Warning, getMagnoRAW methods return buffers that are not rescaled within range [0;255] while the non RAW method allows a normalized matrix to be retrieved.

Parameters

retinaOutput_magno

the output buffer (reallocated if necessary), format can be :

a Mat, this output is rescaled for standard 8bits image processing use in OpenCV
RAW methods actually return a 1D matrix (encoding is M1, M2,... Mn), this output is the original retina filter model output, without any quantification or rescaling.

See also: getMagnoRAW

◆ getMagnoRAW() [1/2]

void OpenCVForUnity.BioinspiredModule.Retina.getMagnoRAW ( Mat retinaOutput_magno )

Accessor of the motion channel of the retina (models peripheral vision).

See also: getMagno

◆ getMagnoRAW() [2/2]

Mat OpenCVForUnity.BioinspiredModule.Retina.getMagnoRAW ( )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ getOutputSize()

Size OpenCVForUnity.BioinspiredModule.Retina.getOutputSize ( )

Retreive retina output buffer size that can be different from the input if a spatial log transformation is applied.

Returns: the retina output buffer size

◆ getParvo()

void OpenCVForUnity.BioinspiredModule.Retina.getParvo ( Mat retinaOutput_parvo )

Accessor of the details channel of the retina (models foveal vision).

Warning, getParvoRAW methods return buffers that are not rescaled within range [0;255] while the non RAW method allows a normalized matrix to be retrieved.

Parameters

retinaOutput_parvo

the output buffer (reallocated if necessary), format can be :

a Mat, this output is rescaled for standard 8bits image processing use in OpenCV
RAW methods actually return a 1D matrix (encoding is R1, R2, ... Rn, G1, G2, ..., Gn, B1, B2, ...Bn), this output is the original retina filter model output, without any quantification or rescaling.

See also: getParvoRAW

◆ getParvoRAW() [1/2]

void OpenCVForUnity.BioinspiredModule.Retina.getParvoRAW ( Mat retinaOutput_parvo )

Accessor of the details channel of the retina (models foveal vision).

See also: getParvo

◆ getParvoRAW() [2/2]

Mat OpenCVForUnity.BioinspiredModule.Retina.getParvoRAW ( )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ printSetup()

string OpenCVForUnity.BioinspiredModule.Retina.printSetup ( )

Outputs a string showing the used parameters setup.

Returns: a string which contains formated parameters information

◆ run()

void OpenCVForUnity.BioinspiredModule.Retina.run ( Mat inputImage )

Method which allows retina to be applied on an input image,.

after run, encapsulated retina module is ready to deliver its outputs using dedicated acccessors, see getParvo and getMagno methods

Parameters

inputImage the input Mat image to be processed, can be gray level or BGR coded in any format (from 8bit to 16bits)

◆ setColorSaturation() [1/3]

void OpenCVForUnity.BioinspiredModule.Retina.setColorSaturation	(	bool	saturateColors,
		float	colorSaturationValue
	)

Activate color saturation as the final step of the color demultiplexing process -> this saturation is a sigmoide function applied to each channel of the demultiplexed image.

Parameters

saturateColors	boolean that activates color saturation (if true) or desactivate (if false)
colorSaturationValue	the saturation factor : a simple factor applied on the chrominance buffers

◆ setColorSaturation() [2/3]

void OpenCVForUnity.BioinspiredModule.Retina.setColorSaturation ( bool saturateColors )

Activate color saturation as the final step of the color demultiplexing process -> this saturation is a sigmoide function applied to each channel of the demultiplexed image.

Parameters

saturateColors	boolean that activates color saturation (if true) or desactivate (if false)
colorSaturationValue	the saturation factor : a simple factor applied on the chrominance buffers

◆ setColorSaturation() [3/3]

void OpenCVForUnity.BioinspiredModule.Retina.setColorSaturation ( )

Activate color saturation as the final step of the color demultiplexing process -> this saturation is a sigmoide function applied to each channel of the demultiplexed image.

Parameters

saturateColors	boolean that activates color saturation (if true) or desactivate (if false)
colorSaturationValue	the saturation factor : a simple factor applied on the chrominance buffers

◆ setup() [1/3]

void OpenCVForUnity.BioinspiredModule.Retina.setup	(	string	retinaParameterFile,
		bool	applyDefaultSetupOnFailure
	)

Try to open an XML retina parameters file to adjust current retina 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

retinaParameterFile	the parameters filename
applyDefaultSetupOnFailure	set to true if an error must be thrown on error You can retrieve the current parameters structure using the method Retina::getParameters and update it before running method Retina::setup.

◆ setup() [2/3]

void OpenCVForUnity.BioinspiredModule.Retina.setup ( string retinaParameterFile )

Try to open an XML retina parameters file to adjust current retina 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

retinaParameterFile	the parameters filename
applyDefaultSetupOnFailure	set to true if an error must be thrown on error You can retrieve the current parameters structure using the method Retina::getParameters and update it before running method Retina::setup.

◆ setup() [3/3]

void OpenCVForUnity.BioinspiredModule.Retina.setup ( )

Try to open an XML retina parameters file to adjust current retina 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

retinaParameterFile	the parameters filename
applyDefaultSetupOnFailure	set to true if an error must be thrown on error You can retrieve the current parameters structure using the method Retina::getParameters and update it before running method Retina::setup.

◆ setupIPLMagnoChannel() [1/9]

void OpenCVForUnity.BioinspiredModule.Retina.setupIPLMagnoChannel	(	bool	normaliseOutput,
		float	parasolCells_beta,
		float	parasolCells_tau,
		float	parasolCells_k,
		float	amacrinCellsTemporalCutFrequency,
		float	V0CompressionParameter,
		float	localAdaptintegration_tau,
		float	localAdaptintegration_k
	)

Set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel.

this channel processes signals output from OPL processing stage in peripheral vision, it allows motion information enhancement. It is decorrelated from the details channel. See reference papers for more details.

Parameters

normaliseOutput	specifies if (true) output is rescaled between 0 and 255 of not (false)
parasolCells_beta	the low pass filter gain used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), typical value is 0
parasolCells_tau	the low pass filter time constant used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), unit is frame, typical value is 0 (immediate response)
parasolCells_k	the low pass filter spatial constant used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), unit is pixels, typical value is 5
amacrinCellsTemporalCutFrequency	the time constant of the first order high pass fiter of the magnocellular way (motion information channel), unit is frames, typical value is 1.2
V0CompressionParameter	the compression strengh of the ganglion cells local adaptation output, set a value between 0.6 and 1 for best results, a high value increases more the low value sensitivity... and the output saturates faster, recommended value: 0.95
localAdaptintegration_tau	specifies the temporal constant of the low pas filter involved in the computation of the local "motion mean" for the local adaptation computation
localAdaptintegration_k	specifies the spatial constant of the low pas filter involved in the computation of the local "motion mean" for the local adaptation computation

◆ setupIPLMagnoChannel() [2/9]

void OpenCVForUnity.BioinspiredModule.Retina.setupIPLMagnoChannel	(	bool	normaliseOutput,
		float	parasolCells_beta,
		float	parasolCells_tau,
		float	parasolCells_k,
		float	amacrinCellsTemporalCutFrequency,
		float	V0CompressionParameter,
		float	localAdaptintegration_tau
	)

Set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel.

this channel processes signals output from OPL processing stage in peripheral vision, it allows motion information enhancement. It is decorrelated from the details channel. See reference papers for more details.

Parameters

normaliseOutput	specifies if (true) output is rescaled between 0 and 255 of not (false)
parasolCells_beta	the low pass filter gain used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), typical value is 0
parasolCells_tau	the low pass filter time constant used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), unit is frame, typical value is 0 (immediate response)
parasolCells_k	the low pass filter spatial constant used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), unit is pixels, typical value is 5
amacrinCellsTemporalCutFrequency	the time constant of the first order high pass fiter of the magnocellular way (motion information channel), unit is frames, typical value is 1.2
V0CompressionParameter	the compression strengh of the ganglion cells local adaptation output, set a value between 0.6 and 1 for best results, a high value increases more the low value sensitivity... and the output saturates faster, recommended value: 0.95
localAdaptintegration_tau	specifies the temporal constant of the low pas filter involved in the computation of the local "motion mean" for the local adaptation computation
localAdaptintegration_k	specifies the spatial constant of the low pas filter involved in the computation of the local "motion mean" for the local adaptation computation

◆ setupIPLMagnoChannel() [3/9]

void OpenCVForUnity.BioinspiredModule.Retina.setupIPLMagnoChannel	(	bool	normaliseOutput,
		float	parasolCells_beta,
		float	parasolCells_tau,
		float	parasolCells_k,
		float	amacrinCellsTemporalCutFrequency,
		float	V0CompressionParameter
	)

Set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel.

this channel processes signals output from OPL processing stage in peripheral vision, it allows motion information enhancement. It is decorrelated from the details channel. See reference papers for more details.

Parameters

normaliseOutput	specifies if (true) output is rescaled between 0 and 255 of not (false)
parasolCells_beta	the low pass filter gain used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), typical value is 0
parasolCells_tau	the low pass filter time constant used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), unit is frame, typical value is 0 (immediate response)
parasolCells_k	the low pass filter spatial constant used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), unit is pixels, typical value is 5
amacrinCellsTemporalCutFrequency	the time constant of the first order high pass fiter of the magnocellular way (motion information channel), unit is frames, typical value is 1.2
V0CompressionParameter	the compression strengh of the ganglion cells local adaptation output, set a value between 0.6 and 1 for best results, a high value increases more the low value sensitivity... and the output saturates faster, recommended value: 0.95
localAdaptintegration_tau	specifies the temporal constant of the low pas filter involved in the computation of the local "motion mean" for the local adaptation computation
localAdaptintegration_k	specifies the spatial constant of the low pas filter involved in the computation of the local "motion mean" for the local adaptation computation

◆ setupIPLMagnoChannel() [4/9]

void OpenCVForUnity.BioinspiredModule.Retina.setupIPLMagnoChannel	(	bool	normaliseOutput,
		float	parasolCells_beta,
		float	parasolCells_tau,
		float	parasolCells_k,
		float	amacrinCellsTemporalCutFrequency
	)

Set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel.

this channel processes signals output from OPL processing stage in peripheral vision, it allows motion information enhancement. It is decorrelated from the details channel. See reference papers for more details.

Parameters

normaliseOutput	specifies if (true) output is rescaled between 0 and 255 of not (false)
parasolCells_beta	the low pass filter gain used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), typical value is 0
parasolCells_tau	the low pass filter time constant used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), unit is frame, typical value is 0 (immediate response)
parasolCells_k	the low pass filter spatial constant used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), unit is pixels, typical value is 5
amacrinCellsTemporalCutFrequency	the time constant of the first order high pass fiter of the magnocellular way (motion information channel), unit is frames, typical value is 1.2
V0CompressionParameter	the compression strengh of the ganglion cells local adaptation output, set a value between 0.6 and 1 for best results, a high value increases more the low value sensitivity... and the output saturates faster, recommended value: 0.95
localAdaptintegration_tau	specifies the temporal constant of the low pas filter involved in the computation of the local "motion mean" for the local adaptation computation
localAdaptintegration_k	specifies the spatial constant of the low pas filter involved in the computation of the local "motion mean" for the local adaptation computation

◆ setupIPLMagnoChannel() [5/9]

void OpenCVForUnity.BioinspiredModule.Retina.setupIPLMagnoChannel	(	bool	normaliseOutput,
		float	parasolCells_beta,
		float	parasolCells_tau,
		float	parasolCells_k
	)

Set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel.

this channel processes signals output from OPL processing stage in peripheral vision, it allows motion information enhancement. It is decorrelated from the details channel. See reference papers for more details.

Parameters

normaliseOutput	specifies if (true) output is rescaled between 0 and 255 of not (false)
parasolCells_beta	the low pass filter gain used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), typical value is 0
parasolCells_tau	the low pass filter time constant used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), unit is frame, typical value is 0 (immediate response)
parasolCells_k	the low pass filter spatial constant used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), unit is pixels, typical value is 5
amacrinCellsTemporalCutFrequency	the time constant of the first order high pass fiter of the magnocellular way (motion information channel), unit is frames, typical value is 1.2
V0CompressionParameter	the compression strengh of the ganglion cells local adaptation output, set a value between 0.6 and 1 for best results, a high value increases more the low value sensitivity... and the output saturates faster, recommended value: 0.95
localAdaptintegration_tau	specifies the temporal constant of the low pas filter involved in the computation of the local "motion mean" for the local adaptation computation
localAdaptintegration_k	specifies the spatial constant of the low pas filter involved in the computation of the local "motion mean" for the local adaptation computation

◆ setupIPLMagnoChannel() [6/9]

void OpenCVForUnity.BioinspiredModule.Retina.setupIPLMagnoChannel	(	bool	normaliseOutput,
		float	parasolCells_beta,
		float	parasolCells_tau
	)

Set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel.

this channel processes signals output from OPL processing stage in peripheral vision, it allows motion information enhancement. It is decorrelated from the details channel. See reference papers for more details.

Parameters

normaliseOutput	specifies if (true) output is rescaled between 0 and 255 of not (false)
parasolCells_beta	the low pass filter gain used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), typical value is 0
parasolCells_tau	the low pass filter time constant used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), unit is frame, typical value is 0 (immediate response)
parasolCells_k	the low pass filter spatial constant used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), unit is pixels, typical value is 5
amacrinCellsTemporalCutFrequency	the time constant of the first order high pass fiter of the magnocellular way (motion information channel), unit is frames, typical value is 1.2
V0CompressionParameter	the compression strengh of the ganglion cells local adaptation output, set a value between 0.6 and 1 for best results, a high value increases more the low value sensitivity... and the output saturates faster, recommended value: 0.95
localAdaptintegration_tau	specifies the temporal constant of the low pas filter involved in the computation of the local "motion mean" for the local adaptation computation
localAdaptintegration_k	specifies the spatial constant of the low pas filter involved in the computation of the local "motion mean" for the local adaptation computation

◆ setupIPLMagnoChannel() [7/9]

void OpenCVForUnity.BioinspiredModule.Retina.setupIPLMagnoChannel	(	bool	normaliseOutput,
		float	parasolCells_beta
	)

Set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel.

this channel processes signals output from OPL processing stage in peripheral vision, it allows motion information enhancement. It is decorrelated from the details channel. See reference papers for more details.

Parameters

normaliseOutput	specifies if (true) output is rescaled between 0 and 255 of not (false)
parasolCells_beta	the low pass filter gain used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), typical value is 0
parasolCells_tau	the low pass filter time constant used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), unit is frame, typical value is 0 (immediate response)
parasolCells_k	the low pass filter spatial constant used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), unit is pixels, typical value is 5
amacrinCellsTemporalCutFrequency	the time constant of the first order high pass fiter of the magnocellular way (motion information channel), unit is frames, typical value is 1.2
V0CompressionParameter	the compression strengh of the ganglion cells local adaptation output, set a value between 0.6 and 1 for best results, a high value increases more the low value sensitivity... and the output saturates faster, recommended value: 0.95
localAdaptintegration_tau	specifies the temporal constant of the low pas filter involved in the computation of the local "motion mean" for the local adaptation computation
localAdaptintegration_k	specifies the spatial constant of the low pas filter involved in the computation of the local "motion mean" for the local adaptation computation

◆ setupIPLMagnoChannel() [8/9]

void OpenCVForUnity.BioinspiredModule.Retina.setupIPLMagnoChannel ( bool normaliseOutput )

Set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel.

this channel processes signals output from OPL processing stage in peripheral vision, it allows motion information enhancement. It is decorrelated from the details channel. See reference papers for more details.

Parameters

normaliseOutput	specifies if (true) output is rescaled between 0 and 255 of not (false)
parasolCells_beta	the low pass filter gain used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), typical value is 0
parasolCells_tau	the low pass filter time constant used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), unit is frame, typical value is 0 (immediate response)
parasolCells_k	the low pass filter spatial constant used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), unit is pixels, typical value is 5
amacrinCellsTemporalCutFrequency	the time constant of the first order high pass fiter of the magnocellular way (motion information channel), unit is frames, typical value is 1.2
V0CompressionParameter	the compression strengh of the ganglion cells local adaptation output, set a value between 0.6 and 1 for best results, a high value increases more the low value sensitivity... and the output saturates faster, recommended value: 0.95
localAdaptintegration_tau	specifies the temporal constant of the low pas filter involved in the computation of the local "motion mean" for the local adaptation computation
localAdaptintegration_k	specifies the spatial constant of the low pas filter involved in the computation of the local "motion mean" for the local adaptation computation

◆ setupIPLMagnoChannel() [9/9]

void OpenCVForUnity.BioinspiredModule.Retina.setupIPLMagnoChannel ( )

Set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel.

this channel processes signals output from OPL processing stage in peripheral vision, it allows motion information enhancement. It is decorrelated from the details channel. See reference papers for more details.

Parameters

normaliseOutput	specifies if (true) output is rescaled between 0 and 255 of not (false)
parasolCells_beta	the low pass filter gain used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), typical value is 0
parasolCells_tau	the low pass filter time constant used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), unit is frame, typical value is 0 (immediate response)
parasolCells_k	the low pass filter spatial constant used for local contrast adaptation at the IPL level of the retina (for ganglion cells local adaptation), unit is pixels, typical value is 5
amacrinCellsTemporalCutFrequency	the time constant of the first order high pass fiter of the magnocellular way (motion information channel), unit is frames, typical value is 1.2
V0CompressionParameter	the compression strengh of the ganglion cells local adaptation output, set a value between 0.6 and 1 for best results, a high value increases more the low value sensitivity... and the output saturates faster, recommended value: 0.95
localAdaptintegration_tau	specifies the temporal constant of the low pas filter involved in the computation of the local "motion mean" for the local adaptation computation
localAdaptintegration_k	specifies the spatial constant of the low pas filter involved in the computation of the local "motion mean" for the local adaptation computation