DOC: Software guide comments for NCC

Examples/DisparityMap/NCCRegistrationFilterExample.cxx

@@ -31,13 +31,24 @@
 //  Software Guide : EndCommandLineArgs
 
 
+// Software Guide : BeginLatex
+//
+// This example demonstrates the use of the \doxygen{otb}{NCCRegistrationFilter}. This filter performs deformation estimation
+// by optimising a PDE based on correlation. This use the finite difference solver hierarchy.
+//
+// The first step toward the use of these filters is to include the proper header files.
+//
+// Software Guide : EndLatex
 
 #include "otbImage.h"
 #include "otbImageFileWriter.h"
 #include "otbImageFileReader.h"
-#include "otbNCCRegistrationFilter.h"
 #include "otbCommandLineArgumentParser.h"
+
+// Software Guide : BeginCodeSnippet
+#include "otbNCCRegistrationFilter.h"
 #include "itkRecursiveGaussianImageFilter.h"
+// Software Guide : EndCodeSnippet
 
 #include <iostream>
 
@@ -52,11 +63,21 @@ int main(int argc, char** argv )
 
   typedef double                   CoordinateRepresentationType;
 
+  
+    // Software Guide : BeginLatex
+  //
+   // Several type of \doxygen{otb}{Image} are required to represent the reference image (fixed)
+  // the image we want to register (moving) and the deformation field.
+  //
+   // Software Guide : EndLatex
+  
   //Allocate Images
+  // Software Guide : BeginCodeSnippet
   typedef otb::Image<PixelType,ImageDimension>         MovingImageType;
   typedef otb::Image<PixelType,ImageDimension>         FixedImageType;
   typedef otb::Image<DeformationPixelType,
                                ImageDimension>         DeformationFieldType;
+  // Software Guide : EndCodeSnippet
 
   typedef otb::ImageFileReader< FixedImageType > FixedReaderType;
   FixedReaderType::Pointer fReader = FixedReaderType::New();
@@ -67,8 +88,16 @@ int main(int argc, char** argv )
   mReader->SetFileName(argv[2]);  
 
 
-  //Blur input images
 
+  // Software Guide : BeginLatex
+  //
+  // To make the correlation possible and to avoid some local minima the first required step is
+  // to blur the input images. This is done using the \doxygen{itk}{RecursiveGaussianImageFilter}:
+  //
+  // Software Guide : EndLatex
+  
+  //Blur input images
+  // Software Guide : BeginCodeSnippet
   typedef itk::RecursiveGaussianImageFilter< FixedImageType,
     FixedImageType > FixedBlurType;
 
@@ -83,9 +112,16 @@ int main(int argc, char** argv )
   MovingBlurType::Pointer mBlur = MovingBlurType::New();
   mBlur->SetInput( mReader->GetOutput() );
   mBlur->SetSigma(atof(argv[5]) );
+// Software Guide : EndCodeSnippet
 
-
+  // Software Guide : BeginLatex
+  //
+  // Now, we need to instanciate the NCCRegistrationFilter which is going to perform the registration:
+  //
+  // Software Guide : EndLatex
+  
   //Create the filter
+  // Software Guide : BeginCodeSnippet
   typedef otb::NCCRegistrationFilter< FixedImageType, 
                                        MovingImageType,
                                        DeformationFieldType >
@@ -95,8 +131,17 @@ int main(int argc, char** argv )
 
   registrator->SetMovingImage( mBlur->GetOutput() );
   registrator->SetFixedImage( fBlur->GetOutput() );
-
-
+// Software Guide : EndCodeSnippet
+
+  // Software Guide : BeginLatex
+  //
+  // Few parameters need to be specified to the NCCRegistrationFilter:
+  // \begin{itemize}
+  // \item The area where the search is performed. This area is defined by its radius:
+  //
+  // Software Guide : EndLatex
+  
+  // Software Guide : BeginCodeSnippet
   typedef RegistrationFilterType::RadiusType RadiusType;
 
   RadiusType radius;
@@ -105,16 +150,31 @@ int main(int argc, char** argv )
   radius[1] = atoi(argv[4]);
 
   registrator->SetNCCRadius( radius );
-
+// Software Guide : EndCodeSnippet
+  
   std::cout << "NCC radius " << registrator->GetNCCRadius() << std::endl;
   
+  // Software Guide : BeginLatex
+  //
+  // \item The number of iteration for the PDE resolution:
+  //
+  // Software Guide : EndLatex
   
+   // Software Guide : BeginCodeSnippet
   registrator->SetNumberOfIterations( atoi(argv[6]) );
-
+// Software Guide : EndCodeSnippet
   // registrator->GetDeformationField();
 
+  // Software Guide : BeginLatex
+  //
+  // \end{itemize}
+  // Then we can trigger the \code{Update()} method on the NCCRegistrationFilter:
+  //
+  // Software Guide : EndLatex
+  
+  // Software Guide : BeginCodeSnippet
   registrator->Update();
-
+  // Software Guide : EndCodeSnippet
 
 
   typedef otb::ImageFileWriter< DeformationFieldType > DFWriterType;
@@ -124,6 +184,23 @@ int main(int argc, char** argv )
   dfWriter->SetInput( registrator->GetOutput() );
   dfWriter->Update();
 
+  // Software Guide : BeginLatex
+  //
+  // Figure~\ref{fig:NCCRegistrationFilterOUTPUT} shows the result of applying.
+  //
+  // \begin{figure} 
+  // \center
+  // \includegraphics[width=0.40\textwidth]{}
+  // \includegraphics[width=0.40\textwidth]{}
+  // \includegraphics[width=0.40\textwidth]{}
+  // \includegraphics[width=0.40\textwidth]{}
+  // \itkcaption[Deformation field and resampling from NCC registration]{From left
+  // to right and top to bottom: fixed input image, moving image with a low stereo angle, 
+  // estimated deformation field in the horizontal direction, resampled moving image.}
+  // \label{fig:NCCRegistrationFilterOUTPUT}
+  // \end{figure}
+  //
+  // Software Guide : EndLatex
   
   return EXIT_SUCCESS;