Retina (OpenCV 4.1.2 Java documentation)

java.lang.Object
- org.opencv.core.Algorithm
- - org.opencv.bioinspired.Retina

```
public class Retina
extends Algorithm
```
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.

Field Summary
- Fields inherited from class org.opencv.core.Algorithm
  nativeObj

Constructor Summary

Constructors
Modifier Constructor and Description

protected Retina(long addr)

Constructors
Modifier	Constructor and Description
`protected`	`Retina(long addr)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Retina`	`__fromPtr__(long addr)`
`void`	`activateContoursProcessing(boolean activate)` Activate/desactivate the Parvocellular pathway processing (contours information extraction), by default, it is activated
`void`	`activateMovingContoursProcessing(boolean activate)` Activate/desactivate the Magnocellular pathway processing (motion information extraction), by default, it is activated
`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.
`void`	`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.
`static Retina`	`create(Size inputSize)`
`static Retina`	`create(Size inputSize, boolean colorMode)` Constructors from standardized interfaces : retreive a smart pointer to a Retina instance
`static Retina`	`create(Size inputSize, boolean colorMode, int colorSamplingMethod)` Constructors from standardized interfaces : retreive a smart pointer to a Retina instance
`static Retina`	`create(Size inputSize, boolean colorMode, int colorSamplingMethod, boolean useRetinaLogSampling)` Constructors from standardized interfaces : retreive a smart pointer to a Retina instance
`static Retina`	`create(Size inputSize, boolean colorMode, int colorSamplingMethod, boolean useRetinaLogSampling, float reductionFactor)` Constructors from standardized interfaces : retreive a smart pointer to a Retina instance
`static Retina`	`create(Size inputSize, boolean colorMode, int colorSamplingMethod, boolean useRetinaLogSampling, float reductionFactor, float samplingStrenght)` Constructors from standardized interfaces : retreive a smart pointer to a Retina instance
`protected void`	`finalize()`
`Size`	`getInputSize()` Retreive retina input buffer size
`void`	`getMagno(Mat retinaOutput_magno)` Accessor of the motion channel of the retina (models peripheral vision).
`Mat`	`getMagnoRAW()`
`void`	`getMagnoRAW(Mat retinaOutput_magno)` Accessor of the motion channel of the retina (models peripheral vision).
`Size`	`getOutputSize()` Retreive retina output buffer size that can be different from the input if a spatial log transformation is applied
`void`	`getParvo(Mat retinaOutput_parvo)` Accessor of the details channel of the retina (models foveal vision).
`Mat`	`getParvoRAW()`
`void`	`getParvoRAW(Mat retinaOutput_parvo)` Accessor of the details channel of the retina (models foveal vision).
`String`	`printSetup()` Outputs a string showing the used parameters setup
`void`	`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
`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.
`void`	`setColorSaturation(boolean 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.
`void`	`setColorSaturation(boolean 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.
`void`	`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 You can retrieve the current parameters structure using the method Retina::getParameters and update it before running method Retina::setup.
`void`	`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
`void`	`setup(String retinaParameterFile, boolean 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
`void`	`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.
`void`	`setupIPLMagnoChannel(boolean 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.
`void`	`setupIPLMagnoChannel(boolean 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.
`void`	`setupIPLMagnoChannel(boolean 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.
`void`	`setupIPLMagnoChannel(boolean 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.
`void`	`setupIPLMagnoChannel(boolean 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.
`void`	`setupIPLMagnoChannel(boolean 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.
`void`	`setupIPLMagnoChannel(boolean 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.
`void`	`setupIPLMagnoChannel(boolean 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.
`void`	`setupOPLandIPLParvoChannel()` Setup the OPL and IPL parvo channels (see biologocal model) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision.
`void`	`setupOPLandIPLParvoChannel(boolean colorMode)` Setup the OPL and IPL parvo channels (see biologocal model) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision.
`void`	`setupOPLandIPLParvoChannel(boolean colorMode, boolean normaliseOutput)` Setup the OPL and IPL parvo channels (see biologocal model) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision.
`void`	`setupOPLandIPLParvoChannel(boolean colorMode, boolean normaliseOutput, float photoreceptorsLocalAdaptationSensitivity)` Setup the OPL and IPL parvo channels (see biologocal model) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision.
`void`	`setupOPLandIPLParvoChannel(boolean colorMode, boolean normaliseOutput, float photoreceptorsLocalAdaptationSensitivity, float photoreceptorsTemporalConstant)` Setup the OPL and IPL parvo channels (see biologocal model) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision.
`void`	`setupOPLandIPLParvoChannel(boolean colorMode, boolean normaliseOutput, float photoreceptorsLocalAdaptationSensitivity, float photoreceptorsTemporalConstant, float photoreceptorsSpatialConstant)` Setup the OPL and IPL parvo channels (see biologocal model) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision.
`void`	`setupOPLandIPLParvoChannel(boolean colorMode, boolean normaliseOutput, float photoreceptorsLocalAdaptationSensitivity, float photoreceptorsTemporalConstant, float photoreceptorsSpatialConstant, float horizontalCellsGain)` Setup the OPL and IPL parvo channels (see biologocal model) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision.
`void`	`setupOPLandIPLParvoChannel(boolean colorMode, boolean normaliseOutput, float photoreceptorsLocalAdaptationSensitivity, float photoreceptorsTemporalConstant, float photoreceptorsSpatialConstant, float horizontalCellsGain, float HcellsTemporalConstant)` Setup the OPL and IPL parvo channels (see biologocal model) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision.
`void`	`setupOPLandIPLParvoChannel(boolean colorMode, boolean normaliseOutput, float photoreceptorsLocalAdaptationSensitivity, float photoreceptorsTemporalConstant, float photoreceptorsSpatialConstant, float horizontalCellsGain, float HcellsTemporalConstant, float HcellsSpatialConstant)` Setup the OPL and IPL parvo channels (see biologocal model) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision.
`void`	`setupOPLandIPLParvoChannel(boolean colorMode, boolean 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) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision.
`void`	`write(String fs)` Write xml/yml formated parameters information

Methods inherited from class org.opencv.core.Algorithm
clear, empty, getDefaultName, getNativeObjAddr, save

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Retina
```
protected Retina(long addr)
```
- Method Detail
  - __fromPtr__
```
public static Retina __fromPtr__(long addr)
```
  - getMagnoRAW
```
public Mat getMagnoRAW()
```
  - getParvoRAW
```
public Mat getParvoRAW()
```
  - create
```
public static Retina create(Size inputSize,
                            boolean colorMode,
                            int colorSamplingMethod,
                            boolean useRetinaLogSampling,
                            float reductionFactor,
                            float samplingStrenght)
```
    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
    
    samplingStrenght - only usefull if param useRetinaLogSampling=true, specifies the strenght of the log scale that is applied
  Returns:
  
  automatically generated
- create
```
public static Retina create(Size inputSize,
                            boolean colorMode,
                            int colorSamplingMethod,
                            boolean useRetinaLogSampling,
                            float reductionFactor)
```
  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 the log scale that is applied
Returns:

automatically generated

create
```
public static Retina create(Size inputSize,
                            boolean colorMode,
                            int colorSamplingMethod,
                            boolean useRetinaLogSampling)
```
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 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 the log scale that is applied

Returns:

automatically generated

create
```
public static Retina create(Size inputSize,
                            boolean colorMode,
                            int colorSamplingMethod)
```
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 be used 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 the log scale that is applied
Returns:

automatically generated

create
```
public static Retina create(Size inputSize,
                            boolean colorMode)
```
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
- 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 be used 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 the log scale that is applied
Returns:

automatically generated

create

public static Retina create(Size inputSize)

getInputSize
```
public Size getInputSize()
```
Retreive retina input buffer size

Returns:

the retina input buffer size

getOutputSize
```
public Size 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

printSetup
```
public String printSetup()
```
Outputs a string showing the used parameters setup

Returns:

a string which contains formated parameters information

activateContoursProcessing
```
public void activateContoursProcessing(boolean 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
```
public void activateMovingContoursProcessing(boolean 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
```
public 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. 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
```
public void 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.

getMagno
```
public void 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: getMagnoRAW

getMagnoRAW
```
public void getMagnoRAW(Mat retinaOutput_magno)
```
Accessor of the motion channel of the retina (models peripheral vision). SEE: getMagno

Parameters:

retinaOutput_magno - automatically generated

getParvo
```
public void 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: getParvoRAW

getParvoRAW
```
public void getParvoRAW(Mat retinaOutput_parvo)
```
Accessor of the details channel of the retina (models foveal vision). SEE: getParvo

Parameters:

retinaOutput_parvo - automatically generated

run
```
public void 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
```
public void setColorSaturation(boolean 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
```
public void setColorSaturation(boolean 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) buffers

setColorSaturation
```
public 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. buffers

setup
```
public void setup(String retinaParameterFile,
                  boolean 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
```
public void 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

You can retrieve the current parameters structure using the method Retina::getParameters and update it before running method Retina::setup.

setup
```
public void 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
You can retrieve the current parameters structure using the method Retina::getParameters and update it before running method Retina::setup.

setupIPLMagnoChannel
```
public void setupIPLMagnoChannel(boolean 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
```
public void setupIPLMagnoChannel(boolean 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 in the computation of the local "motion mean" for the local adaptation computation

setupIPLMagnoChannel
```
public void setupIPLMagnoChannel(boolean 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 involved in the computation of the local "motion mean" for the local adaptation computation in the computation of the local "motion mean" for the local adaptation computation

setupIPLMagnoChannel
```
public void setupIPLMagnoChannel(boolean 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 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 involved in the computation of the local "motion mean" for the local adaptation computation in the computation of the local "motion mean" for the local adaptation computation

setupIPLMagnoChannel
```
public void setupIPLMagnoChannel(boolean 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 the magnocellular way (motion information channel), unit is frames, typical value is 1.2 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 involved in the computation of the local "motion mean" for the local adaptation computation in the computation of the local "motion mean" for the local adaptation computation

setupIPLMagnoChannel
```
public void setupIPLMagnoChannel(boolean 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) at the IPL level of the retina (for ganglion cells local adaptation), unit is pixels, typical value is 5 the magnocellular way (motion information channel), unit is frames, typical value is 1.2 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 involved in the computation of the local "motion mean" for the local adaptation computation in the computation of the local "motion mean" for the local adaptation computation

setupIPLMagnoChannel
```
public void setupIPLMagnoChannel(boolean 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 at the IPL level of the retina (for ganglion cells local adaptation), unit is frame, typical value is 0 (immediate response) at the IPL level of the retina (for ganglion cells local adaptation), unit is pixels, typical value is 5 the magnocellular way (motion information channel), unit is frames, typical value is 1.2 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 involved in the computation of the local "motion mean" for the local adaptation computation in the computation of the local "motion mean" for the local adaptation computation

setupIPLMagnoChannel
```
public void setupIPLMagnoChannel(boolean 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) IPL level of the retina (for ganglion cells local adaptation), typical value is 0 at the IPL level of the retina (for ganglion cells local adaptation), unit is frame, typical value is 0 (immediate response) at the IPL level of the retina (for ganglion cells local adaptation), unit is pixels, typical value is 5 the magnocellular way (motion information channel), unit is frames, typical value is 1.2 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 involved in the computation of the local "motion mean" for the local adaptation computation in the computation of the local "motion mean" for the local adaptation computation

setupIPLMagnoChannel
```
public void 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. IPL level of the retina (for ganglion cells local adaptation), typical value is 0 at the IPL level of the retina (for ganglion cells local adaptation), unit is frame, typical value is 0 (immediate response) at the IPL level of the retina (for ganglion cells local adaptation), unit is pixels, typical value is 5 the magnocellular way (motion information channel), unit is frames, typical value is 1.2 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 involved in the computation of the local "motion mean" for the local adaptation computation in the computation of the local "motion mean" for the local adaptation computation

setupOPLandIPLParvoChannel
```
public void setupOPLandIPLParvoChannel(boolean colorMode,
                                       boolean 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) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision. See reference papers for more informations. for more informations, please have a look at the paper 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

Parameters:

colorMode - specifies if (true) color is processed of not (false) to then processing gray level image

normaliseOutput - specifies if (true) output is rescaled between 0 and 255 of not (false)

photoreceptorsLocalAdaptationSensitivity - the photoreceptors sensitivity renage is 0-1 (more log compression effect when value increases)

photoreceptorsTemporalConstant - the time constant of the first order low pass filter of the photoreceptors, use it to cut high temporal frequencies (noise or fast motion), unit is frames, typical value is 1 frame

photoreceptorsSpatialConstant - the spatial constant of the first order low pass filter of the photoreceptors, use it to cut high spatial frequencies (noise or thick contours), unit is pixels, typical value is 1 pixel

horizontalCellsGain - gain of the horizontal cells network, if 0, then the mean value of the output is zero, if the parameter is near 1, then, the luminance is not filtered and is still reachable at the output, typicall value is 0

HcellsTemporalConstant - the time constant of the first order low pass filter of the horizontal cells, use it to cut low temporal frequencies (local luminance variations), unit is frames, typical value is 1 frame, as the photoreceptors

HcellsSpatialConstant - the spatial constant of the first order low pass filter of the horizontal cells, use it to cut low spatial frequencies (local luminance), unit is pixels, typical value is 5 pixel, this value is also used for local contrast computing when computing the local contrast adaptation at the ganglion cells level (Inner Plexiform Layer parvocellular channel model)

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

setupOPLandIPLParvoChannel
```
public void setupOPLandIPLParvoChannel(boolean colorMode,
                                       boolean normaliseOutput,
                                       float photoreceptorsLocalAdaptationSensitivity,
                                       float photoreceptorsTemporalConstant,
                                       float photoreceptorsSpatialConstant,
                                       float horizontalCellsGain,
                                       float HcellsTemporalConstant,
                                       float HcellsSpatialConstant)
```
Setup the OPL and IPL parvo channels (see biologocal model) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision. See reference papers for more informations. for more informations, please have a look at the paper 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

Parameters:

colorMode - specifies if (true) color is processed of not (false) to then processing gray level image

normaliseOutput - specifies if (true) output is rescaled between 0 and 255 of not (false)

photoreceptorsLocalAdaptationSensitivity - the photoreceptors sensitivity renage is 0-1 (more log compression effect when value increases)

photoreceptorsTemporalConstant - the time constant of the first order low pass filter of the photoreceptors, use it to cut high temporal frequencies (noise or fast motion), unit is frames, typical value is 1 frame

photoreceptorsSpatialConstant - the spatial constant of the first order low pass filter of the photoreceptors, use it to cut high spatial frequencies (noise or thick contours), unit is pixels, typical value is 1 pixel

horizontalCellsGain - gain of the horizontal cells network, if 0, then the mean value of the output is zero, if the parameter is near 1, then, the luminance is not filtered and is still reachable at the output, typicall value is 0

HcellsTemporalConstant - the time constant of the first order low pass filter of the horizontal cells, use it to cut low temporal frequencies (local luminance variations), unit is frames, typical value is 1 frame, as the photoreceptors

HcellsSpatialConstant - the spatial constant of the first order low pass filter of the horizontal cells, use it to cut low spatial frequencies (local luminance), unit is pixels, typical value is 5 pixel, this value is also used for local contrast computing when computing the local contrast adaptation at the ganglion cells level (Inner Plexiform Layer parvocellular channel model) 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.7

setupOPLandIPLParvoChannel
```
public void setupOPLandIPLParvoChannel(boolean colorMode,
                                       boolean normaliseOutput,
                                       float photoreceptorsLocalAdaptationSensitivity,
                                       float photoreceptorsTemporalConstant,
                                       float photoreceptorsSpatialConstant,
                                       float horizontalCellsGain,
                                       float HcellsTemporalConstant)
```
Setup the OPL and IPL parvo channels (see biologocal model) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision. See reference papers for more informations. for more informations, please have a look at the paper 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

Parameters:

colorMode - specifies if (true) color is processed of not (false) to then processing gray level image

normaliseOutput - specifies if (true) output is rescaled between 0 and 255 of not (false)

photoreceptorsLocalAdaptationSensitivity - the photoreceptors sensitivity renage is 0-1 (more log compression effect when value increases)

photoreceptorsTemporalConstant - the time constant of the first order low pass filter of the photoreceptors, use it to cut high temporal frequencies (noise or fast motion), unit is frames, typical value is 1 frame

photoreceptorsSpatialConstant - the spatial constant of the first order low pass filter of the photoreceptors, use it to cut high spatial frequencies (noise or thick contours), unit is pixels, typical value is 1 pixel

horizontalCellsGain - gain of the horizontal cells network, if 0, then the mean value of the output is zero, if the parameter is near 1, then, the luminance is not filtered and is still reachable at the output, typicall value is 0

HcellsTemporalConstant - the time constant of the first order low pass filter of the horizontal cells, use it to cut low temporal frequencies (local luminance variations), unit is frames, typical value is 1 frame, as the photoreceptors horizontal cells, use it to cut low spatial frequencies (local luminance), unit is pixels, typical value is 5 pixel, this value is also used for local contrast computing when computing the local contrast adaptation at the ganglion cells level (Inner Plexiform Layer parvocellular channel model) 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.7

setupOPLandIPLParvoChannel
```
public void setupOPLandIPLParvoChannel(boolean colorMode,
                                       boolean normaliseOutput,
                                       float photoreceptorsLocalAdaptationSensitivity,
                                       float photoreceptorsTemporalConstant,
                                       float photoreceptorsSpatialConstant,
                                       float horizontalCellsGain)
```
Setup the OPL and IPL parvo channels (see biologocal model) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision. See reference papers for more informations. for more informations, please have a look at the paper 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

Parameters:

colorMode - specifies if (true) color is processed of not (false) to then processing gray level image

normaliseOutput - specifies if (true) output is rescaled between 0 and 255 of not (false)

photoreceptorsLocalAdaptationSensitivity - the photoreceptors sensitivity renage is 0-1 (more log compression effect when value increases)

photoreceptorsTemporalConstant - the time constant of the first order low pass filter of the photoreceptors, use it to cut high temporal frequencies (noise or fast motion), unit is frames, typical value is 1 frame

photoreceptorsSpatialConstant - the spatial constant of the first order low pass filter of the photoreceptors, use it to cut high spatial frequencies (noise or thick contours), unit is pixels, typical value is 1 pixel

horizontalCellsGain - gain of the horizontal cells network, if 0, then the mean value of the output is zero, if the parameter is near 1, then, the luminance is not filtered and is still reachable at the output, typicall value is 0 horizontal cells, use it to cut low temporal frequencies (local luminance variations), unit is frames, typical value is 1 frame, as the photoreceptors horizontal cells, use it to cut low spatial frequencies (local luminance), unit is pixels, typical value is 5 pixel, this value is also used for local contrast computing when computing the local contrast adaptation at the ganglion cells level (Inner Plexiform Layer parvocellular channel model) 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.7

setupOPLandIPLParvoChannel
```
public void setupOPLandIPLParvoChannel(boolean colorMode,
                                       boolean normaliseOutput,
                                       float photoreceptorsLocalAdaptationSensitivity,
                                       float photoreceptorsTemporalConstant,
                                       float photoreceptorsSpatialConstant)
```
Setup the OPL and IPL parvo channels (see biologocal model) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision. See reference papers for more informations. for more informations, please have a look at the paper 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

Parameters:

colorMode - specifies if (true) color is processed of not (false) to then processing gray level image

normaliseOutput - specifies if (true) output is rescaled between 0 and 255 of not (false)

photoreceptorsLocalAdaptationSensitivity - the photoreceptors sensitivity renage is 0-1 (more log compression effect when value increases)

photoreceptorsTemporalConstant - the time constant of the first order low pass filter of the photoreceptors, use it to cut high temporal frequencies (noise or fast motion), unit is frames, typical value is 1 frame

photoreceptorsSpatialConstant - the spatial constant of the first order low pass filter of the photoreceptors, use it to cut high spatial frequencies (noise or thick contours), unit is pixels, typical value is 1 pixel the output is zero, if the parameter is near 1, then, the luminance is not filtered and is still reachable at the output, typicall value is 0 horizontal cells, use it to cut low temporal frequencies (local luminance variations), unit is frames, typical value is 1 frame, as the photoreceptors horizontal cells, use it to cut low spatial frequencies (local luminance), unit is pixels, typical value is 5 pixel, this value is also used for local contrast computing when computing the local contrast adaptation at the ganglion cells level (Inner Plexiform Layer parvocellular channel model) 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.7

setupOPLandIPLParvoChannel
```
public void setupOPLandIPLParvoChannel(boolean colorMode,
                                       boolean normaliseOutput,
                                       float photoreceptorsLocalAdaptationSensitivity,
                                       float photoreceptorsTemporalConstant)
```
Setup the OPL and IPL parvo channels (see biologocal model) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision. See reference papers for more informations. for more informations, please have a look at the paper 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

Parameters:

colorMode - specifies if (true) color is processed of not (false) to then processing gray level image

normaliseOutput - specifies if (true) output is rescaled between 0 and 255 of not (false)

photoreceptorsLocalAdaptationSensitivity - the photoreceptors sensitivity renage is 0-1 (more log compression effect when value increases)

photoreceptorsTemporalConstant - the time constant of the first order low pass filter of the photoreceptors, use it to cut high temporal frequencies (noise or fast motion), unit is frames, typical value is 1 frame the photoreceptors, use it to cut high spatial frequencies (noise or thick contours), unit is pixels, typical value is 1 pixel the output is zero, if the parameter is near 1, then, the luminance is not filtered and is still reachable at the output, typicall value is 0 horizontal cells, use it to cut low temporal frequencies (local luminance variations), unit is frames, typical value is 1 frame, as the photoreceptors horizontal cells, use it to cut low spatial frequencies (local luminance), unit is pixels, typical value is 5 pixel, this value is also used for local contrast computing when computing the local contrast adaptation at the ganglion cells level (Inner Plexiform Layer parvocellular channel model) 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.7

setupOPLandIPLParvoChannel
```
public void setupOPLandIPLParvoChannel(boolean colorMode,
                                       boolean normaliseOutput,
                                       float photoreceptorsLocalAdaptationSensitivity)
```
Setup the OPL and IPL parvo channels (see biologocal model) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision. See reference papers for more informations. for more informations, please have a look at the paper 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

Parameters:

colorMode - specifies if (true) color is processed of not (false) to then processing gray level image

normaliseOutput - specifies if (true) output is rescaled between 0 and 255 of not (false)

photoreceptorsLocalAdaptationSensitivity - the photoreceptors sensitivity renage is 0-1 (more log compression effect when value increases) the photoreceptors, use it to cut high temporal frequencies (noise or fast motion), unit is frames, typical value is 1 frame the photoreceptors, use it to cut high spatial frequencies (noise or thick contours), unit is pixels, typical value is 1 pixel the output is zero, if the parameter is near 1, then, the luminance is not filtered and is still reachable at the output, typicall value is 0 horizontal cells, use it to cut low temporal frequencies (local luminance variations), unit is frames, typical value is 1 frame, as the photoreceptors horizontal cells, use it to cut low spatial frequencies (local luminance), unit is pixels, typical value is 5 pixel, this value is also used for local contrast computing when computing the local contrast adaptation at the ganglion cells level (Inner Plexiform Layer parvocellular channel model) 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.7

setupOPLandIPLParvoChannel
```
public void setupOPLandIPLParvoChannel(boolean colorMode,
                                       boolean normaliseOutput)
```
Setup the OPL and IPL parvo channels (see biologocal model) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision. See reference papers for more informations. for more informations, please have a look at the paper 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

Parameters:

colorMode - specifies if (true) color is processed of not (false) to then processing gray level image

normaliseOutput - specifies if (true) output is rescaled between 0 and 255 of not (false) (more log compression effect when value increases) the photoreceptors, use it to cut high temporal frequencies (noise or fast motion), unit is frames, typical value is 1 frame the photoreceptors, use it to cut high spatial frequencies (noise or thick contours), unit is pixels, typical value is 1 pixel the output is zero, if the parameter is near 1, then, the luminance is not filtered and is still reachable at the output, typicall value is 0 horizontal cells, use it to cut low temporal frequencies (local luminance variations), unit is frames, typical value is 1 frame, as the photoreceptors horizontal cells, use it to cut low spatial frequencies (local luminance), unit is pixels, typical value is 5 pixel, this value is also used for local contrast computing when computing the local contrast adaptation at the ganglion cells level (Inner Plexiform Layer parvocellular channel model) 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.7

setupOPLandIPLParvoChannel
```
public void setupOPLandIPLParvoChannel(boolean colorMode)
```
Setup the OPL and IPL parvo channels (see biologocal model) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision. See reference papers for more informations. for more informations, please have a look at the paper 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

Parameters:

colorMode - specifies if (true) color is processed of not (false) to then processing gray level image (more log compression effect when value increases) the photoreceptors, use it to cut high temporal frequencies (noise or fast motion), unit is frames, typical value is 1 frame the photoreceptors, use it to cut high spatial frequencies (noise or thick contours), unit is pixels, typical value is 1 pixel the output is zero, if the parameter is near 1, then, the luminance is not filtered and is still reachable at the output, typicall value is 0 horizontal cells, use it to cut low temporal frequencies (local luminance variations), unit is frames, typical value is 1 frame, as the photoreceptors horizontal cells, use it to cut low spatial frequencies (local luminance), unit is pixels, typical value is 5 pixel, this value is also used for local contrast computing when computing the local contrast adaptation at the ganglion cells level (Inner Plexiform Layer parvocellular channel model) 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.7

setupOPLandIPLParvoChannel
```
public void setupOPLandIPLParvoChannel()
```
Setup the OPL and IPL parvo channels (see biologocal model) OPL is referred as Outer Plexiform Layer of the retina, it allows the spatio-temporal filtering which withens the spectrum and reduces spatio-temporal noise while attenuating global luminance (low frequency energy) IPL parvo is the OPL next processing stage, it refers to a part of the Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision. See reference papers for more informations. for more informations, please have a look at the paper 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 level image (more log compression effect when value increases) the photoreceptors, use it to cut high temporal frequencies (noise or fast motion), unit is frames, typical value is 1 frame the photoreceptors, use it to cut high spatial frequencies (noise or thick contours), unit is pixels, typical value is 1 pixel the output is zero, if the parameter is near 1, then, the luminance is not filtered and is still reachable at the output, typicall value is 0 horizontal cells, use it to cut low temporal frequencies (local luminance variations), unit is frames, typical value is 1 frame, as the photoreceptors horizontal cells, use it to cut low spatial frequencies (local luminance), unit is pixels, typical value is 5 pixel, this value is also used for local contrast computing when computing the local contrast adaptation at the ganglion cells level (Inner Plexiform Layer parvocellular channel model) 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.7

write
```
public void 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

finalize

protected void finalize()
                 throws Throwable

Overrides:: finalize in class Algorithm
Throws:: Throwable

Class Retina

Field Summary

Fields inherited from class org.opencv.core.Algorithm

Constructor Summary

Method Summary

Methods inherited from class org.opencv.core.Algorithm

Methods inherited from class java.lang.Object

Constructor Detail

Retina

Method Detail

__fromPtr__

getMagnoRAW

getParvoRAW

create

create

create

create

create

create

getInputSize

getOutputSize

printSetup

activateContoursProcessing

activateMovingContoursProcessing

applyFastToneMapping

clearBuffers

getMagno

getMagnoRAW

getParvo

getParvoRAW

run

setColorSaturation

setColorSaturation

setColorSaturation

setup

setup

setup

setupIPLMagnoChannel

setupIPLMagnoChannel

setupIPLMagnoChannel

setupIPLMagnoChannel

setupIPLMagnoChannel

setupIPLMagnoChannel

setupIPLMagnoChannel

setupIPLMagnoChannel

setupIPLMagnoChannel

setupOPLandIPLParvoChannel

setupOPLandIPLParvoChannel

setupOPLandIPLParvoChannel

setupOPLandIPLParvoChannel

setupOPLandIPLParvoChannel

setupOPLandIPLParvoChannel

setupOPLandIPLParvoChannel

setupOPLandIPLParvoChannel

setupOPLandIPLParvoChannel

setupOPLandIPLParvoChannel

write

finalize

fromPtr