From 80e65e08b558736d7ffb17dc57a5faab65e30445 Mon Sep 17 00:00:00 2001 From: alexandre benoit Date: Tue, 30 Apr 2013 14:40:03 +0200 Subject: [PATCH] updated doc and interface code to solve compile warnings and errors --- .../contrib/retina_model/retina_model.rst | 131 +++++++++++---------- modules/contrib/doc/retina/index.rst | 32 ++--- modules/contrib/src/retina.cpp | 6 +- 3 files changed, 81 insertions(+), 88 deletions(-) diff --git a/doc/tutorials/contrib/retina_model/retina_model.rst b/doc/tutorials/contrib/retina_model/retina_model.rst index 60b0cb8..e866035 100644 --- a/doc/tutorials/contrib/retina_model/retina_model.rst +++ b/doc/tutorials/contrib/retina_model/retina_model.rst @@ -21,7 +21,7 @@ In this tutorial you will learn how to: General overview ================ -The proposed model originates from Jeanny Herault's research at `Gipsa `_. It is involved in image processing applications with `Listic `_ (code maintainer and user) lab. This is not a complete model but it already present interesting properties that can be involved for enhanced image processing experience. The model allows the following human retina properties to be used : +The proposed model originates from Jeanny Herault's research [herault2010]_ at `Gipsa `_. It is involved in image processing applications with `Listic `_ (code maintainer and user) lab. This is not a complete model but it already present interesting properties that can be involved for enhanced image processing experience. The model allows the following human retina properties to be used : * spectral whitening that has 3 important effects: high spatio-temporal frequency signals canceling (noise), mid-frequencies details enhancement and low frequencies luminance energy reduction. This *all in one* property directly allows visual signals cleaning of classical undesired distortions introduced by image sensors and input luminance range. @@ -37,7 +37,7 @@ In the figure below, the OpenEXR image sample *CrissyField.exr*, a High Dynamic :alt: A High dynamic range image linearly rescaled within range [0-255]. :align: center -In the following image, as your retina does, local luminance adaptation, spatial noise removal and spectral whitening work together and transmit accurate information on lower range 8bit data channels. On this picture, noise in significantly removed, local details hidden by strong luminance contrasts are enhanced. Output image keeps its naturalness and visual content is enhanced. +In the following image, applying the ideas proposed in [benoit2010]_, as your retina does, local luminance adaptation, spatial noise removal and spectral whitening work together and transmit accurate information on lower range 8bit data channels. On this picture, noise in significantly removed, local details hidden by strong luminance contrasts are enhanced. Output image keeps its naturalness and visual content is enhanced. Color processing is based on the color multiplexing/demultiplexing method proposed in [chaix2007]_. .. image:: images/retina_TreeHdr_retina.jpg :alt: A High dynamic range image compressed within range [0-255] using the retina. @@ -86,19 +86,23 @@ This model can be used basically for spatio-temporal video effects but also in t * performing motion analysis also taking benefit of the previously cited properties. +Literature +========== For more information, refer 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 +.. [benoit2010] 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 * Please have a look at the reference work of Jeanny Herault that you can read in his book : -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. +.. [herault2010] 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. This retina filter code 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 phD color mosaicing/demosaicing and his 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 the *retinacolor.hpp* module to discover Brice Chaix de Lavarene phD color mosaicing/demosaicing and his reference paper: -* 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 information in the above cited Jeanny Heraults's book. +.. [chaix2007] 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. Code tutorial ============= @@ -229,67 +233,67 @@ Now, everything is ready to run the retina model. I propose here to allocate a r .. code-block:: cpp - // pointer to a retina object - cv::Ptr myRetina; + // pointer to a retina object + cv::Ptr myRetina; - // if the last parameter is 'log', then activate log sampling (favour foveal vision and subsamples peripheral vision) - if (useLogSampling) - { - myRetina = cv::createRetina(inputFrame.size(), true, cv::RETINA_COLOR_BAYER, true, 2.0, 10.0); - } - else// -> else allocate "classical" retina : - myRetina = cv::createRetina(inputFrame.size()); + // if the last parameter is 'log', then activate log sampling (favour foveal vision and subsamples peripheral vision) + if (useLogSampling) + { + myRetina = cv::createRetina(inputFrame.size(), true, cv::RETINA_COLOR_BAYER, true, 2.0, 10.0); + } + else// -> else allocate "classical" retina : + myRetina = cv::createRetina(inputFrame.size()); Once done, the proposed code writes a default xml file that contains the default parameters of the retina. This is useful to make your own config using this template. Here generated template xml file is called *RetinaDefaultParameters.xml*. .. code-block:: cpp - // save default retina parameters file in order to let you see this and maybe modify it and reload using method "setup" - myRetina->write("RetinaDefaultParameters.xml"); + // save default retina parameters file in order to let you see this and maybe modify it and reload using method "setup" + myRetina->write("RetinaDefaultParameters.xml"); In the following line, the retina attempts to load another xml file called *RetinaSpecificParameters.xml*. If you created it and introduced your own setup, it will be loaded, in the other case, default retina parameters are used. .. code-block:: cpp - // load parameters if file exists - myRetina->setup("RetinaSpecificParameters.xml"); + // load parameters if file exists + myRetina->setup("RetinaSpecificParameters.xml"); It is not required here but just to show it is possible, you can reset the retina buffers to zero to force it to forget past events. .. code-block:: cpp - // reset all retina buffers (imagine you close your eyes for a long time) - myRetina->clearBuffers(); + // reset all retina buffers (imagine you close your eyes for a long time) + myRetina->clearBuffers(); Now, it is time to run the retina ! First create some output buffers ready to receive the two retina channels outputs .. code-block:: cpp - // declare retina output buffers - cv::Mat retinaOutput_parvo; - cv::Mat retinaOutput_magno; + // declare retina output buffers + cv::Mat retinaOutput_parvo; + cv::Mat retinaOutput_magno; Then, run retina in a loop, load new frames from video sequence if necessary and get retina outputs back to dedicated buffers. .. code-block:: cpp - // processing loop with no stop condition - while(true) - { - // if using video stream, then, grabbing a new frame, else, input remains the same - if (videoCapture.isOpened()) - videoCapture>>inputFrame; - - // run retina filter on the loaded input frame - myRetina->run(inputFrame); - // Retrieve and display retina output - myRetina->getParvo(retinaOutput_parvo); - myRetina->getMagno(retinaOutput_magno); - cv::imshow("retina input", inputFrame); - cv::imshow("Retina Parvo", retinaOutput_parvo); - cv::imshow("Retina Magno", retinaOutput_magno); - cv::waitKey(10); - } + // processing loop with no stop condition + while(true) + { + // if using video stream, then, grabbing a new frame, else, input remains the same + if (videoCapture.isOpened()) + videoCapture>>inputFrame; + + // run retina filter on the loaded input frame + myRetina->run(inputFrame); + // Retrieve and display retina output + myRetina->getParvo(retinaOutput_parvo); + myRetina->getMagno(retinaOutput_magno); + cv::imshow("retina input", inputFrame); + cv::imshow("Retina Parvo", retinaOutput_parvo); + cv::imshow("Retina Magno", retinaOutput_magno); + cv::waitKey(10); + } That's done ! But if you want to secure the system, take care and manage Exceptions. The retina can throw some when it sees irrelevant data (no input frame, wrong setup, etc.). Then, i recommend to surround all the retina code by a try/catch system like this : @@ -322,28 +326,28 @@ Once done open the configuration file *RetinaDefaultParameters.xml* generated by .. code-block:: cpp - - - - 1 - 1 - 7.5e-01 - 9.0e-01 - 5.7e-01 - 0.01 - 0.5 - 7. - 7.5e-01 - - 1 - 0. - 0. - 7. - 2.0e+00 - 9.5e-01 - 0. - 7. - + + + + 1 + 1 + 7.5e-01 + 9.0e-01 + 5.7e-01 + 0.01 + 0.5 + 7. + 7.5e-01 + + 1 + 0. + 0. + 7. + 2.0e+00 + 9.5e-01 + 0. + 7. + Here are some hints but actually, the best parameter setup depends more on what you want to do with the retina rather than the images input that you give to retina. Apart from the more specific case of High Dynamic Range images (HDR) that require more specific setup for specific luminance compression objective, the retina behaviors should be rather stable from content to content. Note that OpenCV is able to manage such HDR format thanks to the OpenEXR images compatibility. @@ -410,4 +414,3 @@ Once image information is cleaned, this channel acts as a high pass temporal fil * **localAdaptintegration_tau** generally set to 0, no real use here actually * **localAdaptintegration_k** specifies the size of the area on which local adaptation is performed. Low values lead to short range local adaptation (higher sensitivity to noise), high values secure log compression. - diff --git a/modules/contrib/doc/retina/index.rst b/modules/contrib/doc/retina/index.rst index de4f6f9..27e9ea7 100644 --- a/modules/contrib/doc/retina/index.rst +++ b/modules/contrib/doc/retina/index.rst @@ -98,9 +98,10 @@ For more information, refer to the following papers : This retina filter code 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 phD color mosaicing/demosaicing and his reference paper: + .. [chaix2007] 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. +* 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. Demos and experiments ! ======================= @@ -184,31 +185,31 @@ Retina::getParvo ++++++++++++++++ .. ocv:function:: void Retina::getParvo( Mat & retinaOutput_parvo ) -.. ocv:function:: void Retina::getParvo( std::valarray & retinaOutput_parvo ) -.. ocv:function:: const std::valarray & Retina::getParvo() const +.. ocv:function:: void Retina::getParvoRAW( std::valarray & retinaOutput_parvo ) +.. ocv:function:: const Mat Retina::getParvoRAW() const - Accessor of the details channel of the retina (models foveal vision) + 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. :param 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 - * a 1D std::valarray Buffer (encoding is R1, R2, ... Rn), this output is the original retina filter model output, without any quantification or rescaling + * 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. Retina::getMagno ++++++++++++++++ .. ocv:function:: void Retina::getMagno( Mat & retinaOutput_magno ) -.. ocv:function:: void Retina::getMagno( std::valarray & retinaOutput_magno ) -.. ocv:function:: const std::valarray & Retina::getMagno() const +.. ocv:function:: void Retina::getMagnoRAW( std::valarray & retinaOutput_magno ) +.. ocv:function:: const Mat Retina::getMagnoRAW() const - Accessor of the motion channel of the retina (models peripheral vision) + 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. :param 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 - * a 1D std::valarray Buffer (encoding is R1, R2, ... Rn), this output is the original retina filter model output, without any quantification or rescaling + * 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. Retina::getParameters +++++++++++++++++++++ @@ -219,19 +220,6 @@ Retina::getParameters :return: the current parameters setup -Retina::getParvo/getMagno -+++++++++++++++++++++++++ - -.. ocv:function:: void getParvo(Mat parvoOutput) -.. ocv:function:: void getParvoRAW(Mat parvoOutput) -.. ocv:function:: Mat getParvoRAW() - Retrieve the Parvocellular channel (details with color) output normalized between range [0;255] if not 'RAW'. - -.. ocv:function:: void getParvo(Mat parvoOutput) -.. ocv:function:: void getParvoRAW(Mat parvoOutput) -.. ocv:function:: Mat getParvoRAW() - Retrieve the Magnocellular channel (transient events, grayscale) output normalized between range [0;255] if not 'RAW'. - Retina::getInputSize ++++++++++++++++++++ diff --git a/modules/contrib/src/retina.cpp b/modules/contrib/src/retina.cpp index e9d4de6..663aa8b 100644 --- a/modules/contrib/src/retina.cpp +++ b/modules/contrib/src/retina.cpp @@ -573,11 +573,13 @@ const Mat RetinaImpl::getParvoRAW() const { if (_retinaFilter->getColorMode()) // check if color mode is enabled { // create a cv::Mat table (for RGB planes as a single vector) - return Mat(_retinaFilter->getColorOutput().size(), 1, CV_32F, (void*)&(_retinaFilter->getColorOutput()[0])); + const float *retinaFilterOutputPTR=&(_retinaFilter->getColorOutput()[0]); + return Mat(_retinaFilter->getColorOutput().size(), 1, CV_32F, (void*)retinaFilterOutputPTR); } // otherwise, output is gray level // create a cv::Mat header for the valarray - return Mat( _retinaFilter->getContours().size(), 1, CV_32F, (void*)&(_retinaFilter->getContours()[0])); + const float *retinaFilterOutputPTR=&(_retinaFilter->getContours()[0]); + return Mat( _retinaFilter->getContours().size(), 1, CV_32F, (void*)retinaFilterOutputPTR); } // private method called by constructirs -- 2.7.4