OpenCV 2.4.8 components for OpenCVgrabber.
[mmanager-3rdparty.git] / OpenCV2.4.8 / build / include / opencv2 / contrib / retina.hpp
1 /*#******************************************************************************
2  ** IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING.
3  **
4  ** By downloading, copying, installing or using the software you agree to this license.
5  ** If you do not agree to this license, do not download, install,
6  ** copy or use the software.
7  **
8  **
9  ** HVStools : interfaces allowing OpenCV users to integrate Human Vision System models. Presented models originate from Jeanny Herault's original research and have been reused and adapted by the author&collaborators for computed vision applications since his thesis with Alice Caplier at Gipsa-Lab.
10  ** Use: extract still images & image sequences features, from contours details to motion spatio-temporal features, etc. for high level visual scene analysis. Also contribute to image enhancement/compression such as tone mapping.
11  **
12  ** Maintainers : Listic lab (code author current affiliation & applications) and Gipsa Lab (original research origins & applications)
13  **
14  **  Creation - enhancement process 2007-2011
15  **      Author: Alexandre Benoit (benoit.alexandre.vision@gmail.com), LISTIC lab, Annecy le vieux, France
16  **
17  ** Theses algorithm have been developped by Alexandre BENOIT since his thesis with Alice Caplier at Gipsa-Lab (www.gipsa-lab.inpg.fr) and the research he pursues at LISTIC Lab (www.listic.univ-savoie.fr).
18  ** Refer to the following research paper for more information:
19  ** 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
20  ** This work have been carried out thanks to Jeanny Herault who's research and great discussions are the basis of all this work, please take a look at his book:
21  ** 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.
22  **
23  ** The retina filter includes the research contributions of phd/research collegues from which code has been redrawn by the author :
24  ** _take a look at the retinacolor.hpp module to discover Brice Chaix de Lavarene color mosaicing/demosaicing and the reference paper:
25  ** ====> B. Chaix de Lavarene, D. Alleysson, B. Durette, J. Herault (2007). "Efficient demosaicing through recursive filtering", IEEE International Conference on Image Processing ICIP 2007
26  ** _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.
27  ** ====> more informations in the above cited Jeanny Heraults's book.
28  **
29  **                          License Agreement
30  **               For Open Source Computer Vision Library
31  **
32  ** Copyright (C) 2000-2008, Intel Corporation, all rights reserved.
33  ** Copyright (C) 2008-2011, Willow Garage Inc., all rights reserved.
34  **
35  **               For Human Visual System tools (hvstools)
36  ** Copyright (C) 2007-2011, LISTIC Lab, Annecy le Vieux and GIPSA Lab, Grenoble, France, all rights reserved.
37  **
38  ** Third party copyrights are property of their respective owners.
39  **
40  ** Redistribution and use in source and binary forms, with or without modification,
41  ** are permitted provided that the following conditions are met:
42  **
43  ** * Redistributions of source code must retain the above copyright notice,
44  **    this list of conditions and the following disclaimer.
45  **
46  ** * Redistributions in binary form must reproduce the above copyright notice,
47  **    this list of conditions and the following disclaimer in the documentation
48  **    and/or other materials provided with the distribution.
49  **
50  ** * The name of the copyright holders may not be used to endorse or promote products
51  **    derived from this software without specific prior written permission.
52  **
53  ** This software is provided by the copyright holders and contributors "as is" and
54  ** any express or implied warranties, including, but not limited to, the implied
55  ** warranties of merchantability and fitness for a particular purpose are disclaimed.
56  ** In no event shall the Intel Corporation or contributors be liable for any direct,
57  ** indirect, incidental, special, exemplary, or consequential damages
58  ** (including, but not limited to, procurement of substitute goods or services;
59  ** loss of use, data, or profits; or business interruption) however caused
60  ** and on any theory of liability, whether in contract, strict liability,
61  ** or tort (including negligence or otherwise) arising in any way out of
62  ** the use of this software, even if advised of the possibility of such damage.
63  *******************************************************************************/
64
65 #ifndef __OPENCV_CONTRIB_RETINA_HPP__
66 #define __OPENCV_CONTRIB_RETINA_HPP__
67
68 /*
69  * Retina.hpp
70  *
71  *  Created on: Jul 19, 2011
72  *      Author: Alexandre Benoit
73  */
74
75 #include "opencv2/core/core.hpp" // for all OpenCV core functionalities access, including cv::Exception support
76 #include <valarray>
77
78 namespace cv
79 {
80
81 enum RETINA_COLORSAMPLINGMETHOD
82 {
83     RETINA_COLOR_RANDOM, //!< each pixel position is either R, G or B in a random choice
84     RETINA_COLOR_DIAGONAL,//!< color sampling is RGBRGBRGB..., line 2 BRGBRGBRG..., line 3, GBRGBRGBR...
85     RETINA_COLOR_BAYER//!< standard bayer sampling
86 };
87
88 class RetinaFilter;
89
90 /**
91  * @class Retina a wrapper class which allows the Gipsa/Listic Labs model to be used.
92  * This retina model allows spatio-temporal image processing (applied on still images, video sequences).
93  * As a summary, these are the retina model properties:
94  * => It applies a spectral whithening (mid-frequency details enhancement)
95  * => high frequency spatio-temporal noise reduction
96  * => low frequency luminance to be reduced (luminance range compression)
97  * => local logarithmic luminance compression allows details to be enhanced in low light conditions
98  *
99  * USE : this model can be used basically for spatio-temporal video effects but also for :
100  *      _using the getParvo method output matrix : texture analysiswith enhanced signal to noise ratio and enhanced details robust against input images luminance ranges
101  *      _using the getMagno method output matrix : motion analysis also with the previously cited properties
102  *
103  * for more information, reer to the following papers :
104  * 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
105  * 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.
106  *
107  * The retina filter includes the research contributions of phd/research collegues from which code has been redrawn by the author :
108  * _take a look at the retinacolor.hpp module to discover Brice Chaix de Lavarene color mosaicing/demosaicing and the reference paper:
109  * ====> B. Chaix de Lavarene, D. Alleysson, B. Durette, J. Herault (2007). "Efficient demosaicing through recursive filtering", IEEE International Conference on Image Processing ICIP 2007
110  * _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.
111  * ====> more informations in the above cited Jeanny Heraults's book.
112  */
113 class CV_EXPORTS Retina {
114
115 public:
116
117     // parameters structure for better clarity, check explenations on the comments of methods : setupOPLandIPLParvoChannel and setupIPLMagnoChannel
118     struct RetinaParameters{
119         struct OPLandIplParvoParameters{ // Outer Plexiform Layer (OPL) and Inner Plexiform Layer Parvocellular (IplParvo) parameters
120                OPLandIplParvoParameters():colorMode(true),
121                                  normaliseOutput(true),
122                                  photoreceptorsLocalAdaptationSensitivity(0.7f),
123                                  photoreceptorsTemporalConstant(0.5f),
124                                  photoreceptorsSpatialConstant(0.53f),
125                                  horizontalCellsGain(0.0f),
126                                  hcellsTemporalConstant(1.f),
127                                  hcellsSpatialConstant(7.f),
128                                  ganglionCellsSensitivity(0.7f){};// default setup
129                bool colorMode, normaliseOutput;
130                float photoreceptorsLocalAdaptationSensitivity, photoreceptorsTemporalConstant, photoreceptorsSpatialConstant, horizontalCellsGain, hcellsTemporalConstant, hcellsSpatialConstant, ganglionCellsSensitivity;
131            };
132            struct IplMagnoParameters{ // Inner Plexiform Layer Magnocellular channel (IplMagno)
133                IplMagnoParameters():
134                           normaliseOutput(true),
135                           parasolCells_beta(0.f),
136                           parasolCells_tau(0.f),
137                           parasolCells_k(7.f),
138                           amacrinCellsTemporalCutFrequency(1.2f),
139                           V0CompressionParameter(0.95f),
140                           localAdaptintegration_tau(0.f),
141                           localAdaptintegration_k(7.f){};// default setup
142                bool normaliseOutput;
143                float parasolCells_beta, parasolCells_tau, parasolCells_k, amacrinCellsTemporalCutFrequency, V0CompressionParameter, localAdaptintegration_tau, localAdaptintegration_k;
144            };
145             struct OPLandIplParvoParameters OPLandIplParvo;
146             struct IplMagnoParameters IplMagno;
147     };
148
149     /**
150      * Main constructor with most commun use setup : create an instance of color ready retina model
151      * @param inputSize : the input frame size
152      */
153     Retina(Size inputSize);
154
155     /**
156      * Complete Retina filter constructor which allows all basic structural parameters definition
157          * @param inputSize : the input frame size
158      * @param colorMode : the chosen processing mode : with or without color processing
159      * @param colorSamplingMethod: specifies which kind of color sampling will be used
160      * @param useRetinaLogSampling: activate retina log sampling, if true, the 2 following parameters can be used
161      * @param 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
162      * @param samplingStrenght: only usefull if param useRetinaLogSampling=true, specifies the strenght of the log scale that is applied
163      */
164     Retina(Size inputSize, const bool colorMode, RETINA_COLORSAMPLINGMETHOD colorSamplingMethod=RETINA_COLOR_BAYER, const bool useRetinaLogSampling=false, const double reductionFactor=1.0, const double samplingStrenght=10.0);
165
166     virtual ~Retina();
167
168     /**
169     * retreive retina input buffer size
170     */
171     Size inputSize();
172
173     /**
174     * retreive retina output buffer size
175     */
176     Size outputSize();
177
178     /**
179      * try to open an XML retina parameters file to adjust current retina instance setup
180      * => if the xml file does not exist, then default setup is applied
181      * => warning, Exceptions are thrown if read XML file is not valid
182      * @param retinaParameterFile : the parameters filename
183          * @param applyDefaultSetupOnFailure : set to true if an error must be thrown on error
184      */
185     void setup(std::string retinaParameterFile="", const bool applyDefaultSetupOnFailure=true);
186
187
188     /**
189      * try to open an XML retina parameters file to adjust current retina instance setup
190      * => if the xml file does not exist, then default setup is applied
191      * => warning, Exceptions are thrown if read XML file is not valid
192      * @param fs : the open Filestorage which contains retina parameters
193      * @param applyDefaultSetupOnFailure : set to true if an error must be thrown on error
194      */
195     void setup(cv::FileStorage &fs, const bool applyDefaultSetupOnFailure=true);
196
197     /**
198      * try to open an XML retina parameters file to adjust current retina instance setup
199      * => if the xml file does not exist, then default setup is applied
200      * => warning, Exceptions are thrown if read XML file is not valid
201      * @param newParameters : a parameters structures updated with the new target configuration
202          * @param applyDefaultSetupOnFailure : set to true if an error must be thrown on error
203      */
204     void setup(RetinaParameters newParameters);
205
206     /**
207      * @return the current parameters setup
208      */
209     Retina::RetinaParameters getParameters();
210
211     /**
212      * parameters setup display method
213      * @return a string which contains formatted parameters information
214      */
215     const std::string printSetup();
216
217     /**
218      * write xml/yml formated parameters information
219      * @rparam fs : the filename of the xml file that will be open and writen with formatted parameters information
220      */
221     virtual void write( std::string fs ) const;
222
223
224     /**
225      * write xml/yml formated parameters information
226      * @param fs : a cv::Filestorage object ready to be filled
227          */
228     virtual void write( FileStorage& fs ) const;
229
230     /**
231      * setup the OPL and IPL parvo channels (see biologocal model)
232      * 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)
233      * IPL parvo is the OPL next processing stage, it refers to Inner Plexiform layer of the retina, it allows high contours sensitivity in foveal vision.
234      * 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
235      * @param colorMode : specifies if (true) color is processed of not (false) to then processing gray level image
236      * @param normaliseOutput : specifies if (true) output is rescaled between 0 and 255 of not (false)
237      * @param photoreceptorsLocalAdaptationSensitivity: the photoreceptors sensitivity renage is 0-1 (more log compression effect when value increases)
238      * @param 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
239      * @param 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
240      * @param 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
241      * @param 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
242      * @param 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)
243      * @param ganglionCellsSensitivity: the compression strengh of the ganglion cells local adaptation output, set a value between 160 and 250 for best results, a high value increases more the low value sensitivity... and the output saturates faster, recommended value: 230
244      */
245     void setupOPLandIPLParvoChannel(const bool colorMode=true, const bool normaliseOutput = true, const float photoreceptorsLocalAdaptationSensitivity=0.7, const float photoreceptorsTemporalConstant=0.5, const float photoreceptorsSpatialConstant=0.53, const float horizontalCellsGain=0, const float HcellsTemporalConstant=1, const float HcellsSpatialConstant=7, const float ganglionCellsSensitivity=0.7);
246
247     /**
248      * set parameters values for the Inner Plexiform Layer (IPL) magnocellular channel
249      * this channel processes signals outpint from OPL processing stage in peripheral vision, it allows motion information enhancement. It is decorrelated from the details channel. See reference paper for more details.
250      * @param normaliseOutput : specifies if (true) output is rescaled between 0 and 255 of not (false)
251      * @param 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
252      * @param 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)
253      * @param 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
254      * @param amacrinCellsTemporalCutFrequency: the time constant of the first order high pass fiter of the magnocellular way (motion information channel), unit is frames, tipicall value is 5
255      * @param V0CompressionParameter: the compression strengh of the ganglion cells local adaptation output, set a value between 160 and 250 for best results, a high value increases more the low value sensitivity... and the output saturates faster, recommended value: 200
256      * @param 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
257      * @param 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
258      */
259     void setupIPLMagnoChannel(const bool normaliseOutput = true, const float parasolCells_beta=0, const float parasolCells_tau=0, const float parasolCells_k=7, const float amacrinCellsTemporalCutFrequency=1.2, const float V0CompressionParameter=0.95, const float localAdaptintegration_tau=0, const float localAdaptintegration_k=7);
260
261     /**
262      * 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
263      * @param inputImage : the input cv::Mat image to be processed, can be gray level or BGR coded in any format (from 8bit to 16bits)
264      */
265     void run(const Mat &inputImage);
266
267     /**
268      * accessor of the details channel of the retina (models foveal vision)
269      * @param retinaOutput_parvo : the output buffer (reallocated if necessary), this output is rescaled for standard 8bits image processing use in OpenCV
270      */
271     void getParvo(Mat &retinaOutput_parvo);
272
273     /**
274      * accessor of the details channel of the retina (models foveal vision)
275      * @param retinaOutput_parvo : the output buffer (reallocated if necessary), this output is the original retina filter model output, without any quantification or rescaling
276      */
277     void getParvo(std::valarray<float> &retinaOutput_parvo);
278
279     /**
280      * accessor of the motion channel of the retina (models peripheral vision)
281      * @param retinaOutput_magno : the output buffer (reallocated if necessary), this output is rescaled for standard 8bits image processing use in OpenCV
282      */
283     void getMagno(Mat &retinaOutput_magno);
284
285     /**
286      * accessor of the motion channel of the retina (models peripheral vision)
287      * @param retinaOutput_magno : the output buffer (reallocated if necessary), this output is the original retina filter model output, without any quantification or rescaling
288      */
289     void getMagno(std::valarray<float> &retinaOutput_magno);
290
291     // original API level data accessors : get buffers addresses...
292     const std::valarray<float> & getMagno() const;
293     const std::valarray<float> & getParvo() const;
294
295     /**
296      * activate color saturation as the final step of the color demultiplexing process
297      * -> this saturation is a sigmoide function applied to each channel of the demultiplexed image.
298      * @param saturateColors: boolean that activates color saturation (if true) or desactivate (if false)
299      * @param colorSaturationValue: the saturation factor
300      */
301     void setColorSaturation(const bool saturateColors=true, const float colorSaturationValue=4.0);
302
303     /**
304      * clear all retina buffers (equivalent to opening the eyes after a long period of eye close ;o)
305      */
306     void clearBuffers();
307
308     /**
309     * Activate/desactivate the Magnocellular pathway processing (motion information extraction), by default, it is activated
310     * @param activate: true if Magnocellular output should be activated, false if not
311     */
312     void activateMovingContoursProcessing(const bool activate);
313
314     /**
315     * Activate/desactivate the Parvocellular pathway processing (contours information extraction), by default, it is activated
316     * @param activate: true if Parvocellular (contours information extraction) output should be activated, false if not
317     */
318     void activateContoursProcessing(const bool activate);
319
320 protected:
321     // Parameteres setup members
322     RetinaParameters _retinaParameters; // structure of parameters
323
324         // Retina model related modules
325     std::valarray<float> _inputBuffer; //!< buffer used to convert input cv::Mat to internal retina buffers format (valarrays)
326
327     // pointer to retina model
328     RetinaFilter* _retinaFilter; //!< the pointer to the retina module, allocated with instance construction
329
330     /**
331      * exports a valarray buffer outing from HVStools objects to a cv::Mat in CV_8UC1 (gray level picture) or CV_8UC3 (color) format
332      * @param grayMatrixToConvert the valarray to export to OpenCV
333      * @param nbRows : the number of rows of the valarray flatten matrix
334      * @param nbColumns : the number of rows of the valarray flatten matrix
335      * @param colorMode : a flag which mentions if matrix is color (true) or graylevel (false)
336      * @param outBuffer : the output matrix which is reallocated to satisfy Retina output buffer dimensions
337      */
338     void _convertValarrayBuffer2cvMat(const std::valarray<float> &grayMatrixToConvert, const unsigned int nbRows, const unsigned int nbColumns, const bool colorMode, Mat &outBuffer);
339
340     /**
341      *
342      * @param inputMatToConvert : the OpenCV cv::Mat that has to be converted to gray or RGB valarray buffer that will be processed by the retina model
343      * @param outputValarrayMatrix : the output valarray
344      * @return the input image color mode (color=true, gray levels=false)
345      */
346         bool _convertCvMat2ValarrayBuffer(const cv::Mat inputMatToConvert, std::valarray<float> &outputValarrayMatrix);
347
348     //! private method called by constructors, gathers their parameters and use them in a unified way
349     void _init(const Size inputSize, const bool colorMode, RETINA_COLORSAMPLINGMETHOD colorSamplingMethod=RETINA_COLOR_BAYER, const bool useRetinaLogSampling=false, const double reductionFactor=1.0, const double samplingStrenght=10.0);
350
351
352 };
353
354 }
355 #endif /* __OPENCV_CONTRIB_RETINA_HPP__ */