From 62cffc4188f5709044c198dc827aad5df2584c19 Mon Sep 17 00:00:00 2001
From: Emmanuel Christophe <emmanuel.christophe@orfeo-toolbox.org>
Date: Sat, 26 Jun 2010 12:06:45 +0900
Subject: [PATCH] DOC: correct typo for Software guide
---
Examples/BasicFilters/DEMToRainbowExample.cxx | 14 +++++++++++---
Examples/BasicFilters/IndexedToRGBExample.cxx | 8 ++++----
.../BasicFilters/PrintableImageFilterExample.cxx | 2 +-
Examples/BasicFilters/ScalingFilterExample.cxx | 10 ++++++----
.../ChangeDetectionFrameworkExample.cxx | 6 ++----
5 files changed, 24 insertions(+), 16 deletions(-)
diff --git a/Examples/BasicFilters/DEMToRainbowExample.cxx b/Examples/BasicFilters/DEMToRainbowExample.cxx
index 34d96cbaea..f2c1fd1038 100644
--- a/Examples/BasicFilters/DEMToRainbowExample.cxx
+++ b/Examples/BasicFilters/DEMToRainbowExample.cxx
@@ -42,9 +42,10 @@
//
// In some situation, it is desirable to represent a gray level image in color for easier
// interpretation. This is particularly the case if pixel values in the image are used
-// to represent some data such as elevation, deformation map, interferogram.
-//
-// In this case, it is important to ensure that similar values will get similar colors.
+// to represent some data such as elevation, deformation map,
+// interferogram. In this case, it is important to ensure that similar
+// values will get similar colors. You can notice how this requirement
+// differ from the previous case.
//
// The following example illustrates the use of the \doxygen{otb}{DEMToImageGenerator} class
// combined with the \doxygen{otb}{ScalarToRainbowRGBPixelFunctor}. You can refer to the
@@ -163,6 +164,13 @@ int main(int argc, char * argv[])
colormapper->SetColormap(colormap);
}
}
+ // Software Guide : BeginLatex
+ //
+ // And we connect the color mapper filter with the filter producing
+ // the image of the DEM:
+ //
+ // Software Guide : EndLatex
+
// Software Guide : BeginCodeSnippet
colormapper->SetInput(demToImage->GetOutput());
diff --git a/Examples/BasicFilters/IndexedToRGBExample.cxx b/Examples/BasicFilters/IndexedToRGBExample.cxx
index 3dfc14d4cf..46bbb589fc 100644
--- a/Examples/BasicFilters/IndexedToRGBExample.cxx
+++ b/Examples/BasicFilters/IndexedToRGBExample.cxx
@@ -30,13 +30,13 @@
// Software Guide : BeginLatex
//
-// Some algorithms produce as an output an indexed image. In such images,
+// Some algorithms produce an indexed image as output. In such images,
// each pixel is given a value according to the region number it belongs to.
// This value starting at 0 or 1 is usually an integer value.
-// Often, such images are produced by segmentation or classification algorithm.
+// Often, such images are produced by segmentation or classification algorithms.
//
-// If such regions are easy to manipulate, as it is easier to compare two integers
-// than a RGB value, it is different when it comes to displaying the results.
+// If such regions are easy to manipulate -- it is easier and faster to compare two integers
+// than a RGB value -- it is different when it comes to displaying the results.
//
// Here we present a convient way to convert such indexed image to a color image. In
// such conversion, it is important to ensure that neighborhood region, which are
diff --git a/Examples/BasicFilters/PrintableImageFilterExample.cxx b/Examples/BasicFilters/PrintableImageFilterExample.cxx
index 9ed9963f22..6b34a95cb6 100644
--- a/Examples/BasicFilters/PrintableImageFilterExample.cxx
+++ b/Examples/BasicFilters/PrintableImageFilterExample.cxx
@@ -50,7 +50,7 @@
// captured by the satellite with those captured by your eye: thus matching the red band
// with the red color, etc.
//
-// Some satellite (SPOT 5 is an example) do not acquire all the {\em human} spectral bands:
+// Some satellites (SPOT 5 is an example) do not acquire all the {\em human} spectral bands:
// the blue can be missing and replaced by some other wavelength of interest for a specific application.
// In these situations, another mapping has to be created. That's why, the vegetation often appears in
// red in satellite images (see on left of figure~\ref{fig:PRINTABLE_FILTER}).
diff --git a/Examples/BasicFilters/ScalingFilterExample.cxx b/Examples/BasicFilters/ScalingFilterExample.cxx
index 3517214dc9..371193b647 100644
--- a/Examples/BasicFilters/ScalingFilterExample.cxx
+++ b/Examples/BasicFilters/ScalingFilterExample.cxx
@@ -30,8 +30,9 @@
// Software Guide : BeginLatex
//
-// Satellite images are commonly coded on more that 8 bits. On the opposite, image formats
-// use for printing and display are usually limited to 8 bits. We need to convert the value
+// On one hand, satellite images are commonly coded on more that 8 bits to provide
+// the dynamic range required from shadows to clouds. On the other hand, image formats
+// in use for printing and display are usually limited to 8 bits. We need to convert the value
// to enable a proper display. This is usually done using linear scaling. Of course, you have
// to be aware that some information is lost in the process.
//
@@ -91,8 +92,9 @@ int main(int argc, char * argv[])
writer->Update();
// Software Guide : BeginLatex
- // Figure~\ref{fig:SCALING_FILTER} shows the difference between a proper scaling and
- // a simple truncation of the value
+ // Figure~\ref{fig:SCALING_FILTER} illustrates the difference between a proper scaling and
+ // a simple truncation of the value and demonstrates why it is
+ // important to keep this in mind.
// \begin{figure}
// \center
// \includegraphics[width=0.44\textwidth]{QB_Toulouse_Ortho_PAN_casted.eps}
diff --git a/Examples/ChangeDetection/ChangeDetectionFrameworkExample.cxx b/Examples/ChangeDetection/ChangeDetectionFrameworkExample.cxx
index cd19395db8..d40e811dc4 100644
--- a/Examples/ChangeDetection/ChangeDetectionFrameworkExample.cxx
+++ b/Examples/ChangeDetection/ChangeDetectionFrameworkExample.cxx
@@ -217,10 +217,8 @@ int main(int argc, char* argv[])
// SoftwareGuide : EndLatex
// Software Guide : BeginCodeSnippet
- typedef MyChangeDetectorImageFilter<
- InputImageType1,
- InputImageType2,
- ChangeImageType> FilterType;
+ typedef MyChangeDetectorImageFilter<InputImageType1,InputImageType2,
+ ChangeImageType> FilterType;
// Software Guide : EndCodeSnippet
ReaderType1::Pointer reader1 = ReaderType1::New();
--
GitLab