From 36394ee6519419bf7f0ab11d7520e2d5fdfc50ad Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ga=C3=ABlle=20USSEGLIO?= <gaelle.usseglio@cnes.fr>
Date: Fri, 6 Mar 2020 16:34:46 +0000
Subject: [PATCH] ENH : Update comments
---
app/otbSAROrthoInterferogram.cxx | 11 +++++----
include/otbSARCompensatedComplexImageFilter.h | 6 ++---
.../otbSARCompensatedComplexImageFilter.txx | 2 +-
include/otbSARDerampImageFilter.h | 5 ++--
.../otbSARDopplerCentroidFreqImageFilter.h | 10 ++++----
include/otbSARESDOffsetsImageFilter.h | 5 ++--
include/otbSARGroupedByOrthoImageFilter.h | 13 +++++-----
include/otbSARGroupedByOrthoImageFilter.txx | 5 ++--
include/otbSARInterferogramImageFilter.h | 24 ++++---------------
include/otbSARTopographicPhaseImageFilter.h | 21 ++++------------
include/otbSARTopographicPhaseImageFilter.txx | 2 +-
11 files changed, 34 insertions(+), 70 deletions(-)
diff --git a/app/otbSAROrthoInterferogram.cxx b/app/otbSAROrthoInterferogram.cxx
index cbf7beb..374235e 100644
--- a/app/otbSAROrthoInterferogram.cxx
+++ b/app/otbSAROrthoInterferogram.cxx
@@ -60,7 +60,7 @@ namespace otb
" SAR images.");
//Optional descriptors
- SetDocLimitations("Only Sentinel 1 (IW and StripMap mode) and Cosmo products are supported for now.");
+ SetDocLimitations("Only Sentinel 1 (StripMap mode) and Cosmo products are supported for now.");
SetDocAuthors("OTB-Team");
SetDocSeeAlso(" ");
AddDocTag(Tags::SAR);
@@ -81,7 +81,7 @@ namespace otb
SetParameterDescription("incartmeanmaster", "Input Cartesian Mean Master image.");
AddParameter(ParameterType_InputImage, "indem", "Input DEM");
- SetParameterDescription("indem", "GetGround geometry thanks to DEM (only metadata).");
+ SetParameterDescription("indem", "Get Ground geometry thanks to DEM (only metadata).");
AddParameter(ParameterType_Float, "gain", "Gain to apply for amplitude estimation");
SetParameterDescription("gain","Gain to apply for amplitude estimation");
@@ -101,17 +101,18 @@ namespace otb
SetMinimumParameterIntValue("streamingsizevalue", 0);
MandatoryOff("streamingsizevalue");
- AddParameter(ParameterType_OutputImage, "out", "Interferogram");
- SetParameterDescription("out","Output Vector Image : Interferogram.");
+ AddParameter(ParameterType_OutputImage, "out", "Interferogram in ground geometry");
+ SetParameterDescription("out","Output Vector Image : Interferogram in ground geometry.");
AddRAMParameter();
SetDocExampleParameterValue("insarslave","s1b-s4-slc-vv-20160929t014610-20160929t014634-002277-003d71-002.tiff");
SetDocExampleParameterValue("insarmaster","s1a-s4-slc-vv-20160818t014650-20160818t014715-012648-013db1-002_SLC.tiff");
SetDocExampleParameterValue("incartmeanmaster","CartesianMaster.tiff");
+ SetDocExampleParameterValue("topographicphase","TopographicPhase.tiff");
SetDocExampleParameterValue("indem","S21E055.hgt");
SetDocExampleParameterValue("gain","0.1");
- SetDocExampleParameterValue("out","s1b-s1a-s4-interferogram.tiff");
+ SetDocExampleParameterValue("out","s1b-s1a-s4-Orthointerferogram.tiff");
}
void DoUpdateParameters() override
diff --git a/include/otbSARCompensatedComplexImageFilter.h b/include/otbSARCompensatedComplexImageFilter.h
index 38a9490..85c93e1 100644
--- a/include/otbSARCompensatedComplexImageFilter.h
+++ b/include/otbSARCompensatedComplexImageFilter.h
@@ -155,10 +155,8 @@ protected:
*/
virtual void GenerateOutputInformation() ITK_OVERRIDE;
- /** SARCompensatedComplexImageFilter needs a input requested region that corresponds to the margin and shifts
- * into the requested region of our output requested region. The output requested region needs to be modified
- * to construct as wanted tiles with input size.
- * As such, TilesAnalysesImageFilter needs to provide an implementation for
+ /** SARCompensatedComplexImageFilter needs a input requested region for all inputs.
+ * As such, SARCompensatedComplexImageFilter needs to provide an implementation for
* GenerateInputRequestedRegion() in order to inform the pipeline execution model.
* \sa ProcessObject::GenerateInputRequestedRegion() */
virtual void GenerateInputRequestedRegion() ITK_OVERRIDE;
diff --git a/include/otbSARCompensatedComplexImageFilter.txx b/include/otbSARCompensatedComplexImageFilter.txx
index 8644b0b..eb20444 100644
--- a/include/otbSARCompensatedComplexImageFilter.txx
+++ b/include/otbSARCompensatedComplexImageFilter.txx
@@ -247,7 +247,7 @@ namespace otb
masterPtr->SetRequestedRegion(outputRequestedRegion);
slavePtr->SetRequestedRegion(outputRequestedRegion);
- ///////////// Find the region into topographic phase image (if needed) /////////////
+ // Region into topographic phase image (if needed) = Output region
if (this->GetTopographicPhaseInput() != nullptr)
{
ImagePhasePointer phasePtr = const_cast< ImagePhaseType * >( this->GetTopographicPhaseInput() );
diff --git a/include/otbSARDerampImageFilter.h b/include/otbSARDerampImageFilter.h
index b24cf8d..f5877ee 100644
--- a/include/otbSARDerampImageFilter.h
+++ b/include/otbSARDerampImageFilter.h
@@ -227,9 +227,8 @@ protected:
itk::ThreadIdType threadId) ITK_OVERRIDE;
- /** SARDerampImageFilter needs a input requested region that corresponds to the margin and shifts
- * into the requested region of our output requested region. The output requested region needs to be modified
- * to construct as wanted tiles with input size.
+ /** SARDerampImageFilter needs a input requested region for the different inputs with our output requested
+ * region.
* As such, DerampImageFilter needs to provide an implementation for
* GenerateInputRequestedRegion() in order to inform the pipeline execution model.
* \sa ProcessObject::GenerateInputRequestedRegion() */
diff --git a/include/otbSARDopplerCentroidFreqImageFilter.h b/include/otbSARDopplerCentroidFreqImageFilter.h
index 2791154..77b5ccb 100644
--- a/include/otbSARDopplerCentroidFreqImageFilter.h
+++ b/include/otbSARDopplerCentroidFreqImageFilter.h
@@ -172,17 +172,15 @@ protected:
itk::ThreadIdType threadId) ITK_OVERRIDE;
- /** SARDopplerCentroidFreqImageFilter needs a input requested region that corresponds to the margin and shifts
- * into the requested region of our output requested region. The output requested region needs to be modified
- * to construct as wanted tiles with input size.
- * As such, DopplerCentroidFreqImageFilter needs to provide an implementation for
+ /** SARDopplerCentroidFreqImageFilter needs a input requested region that corresponds to our output
+ * requested region.
* GenerateInputRequestedRegion() in order to inform the pipeline execution model.
* \sa ProcessObject::GenerateInputRequestedRegion() */
virtual void GenerateInputRequestedRegion() ITK_OVERRIDE;
/**
- * SARDopplerCentroidFreqImageFilter reuses calculations into ThreadedGeneratedData. The aim is to estimate once and for all
- * some calculations and store results into argument of this class.
+ * SARDopplerCentroidFreqImageFilter reuses calculations into ThreadedGeneratedData.
+ * The aim is to estimate once and for all, some calculations and store results into argument of this class.
*
* \sa ImageToImageFilter::BeforeThreadedGenerateData()*/
void BeforeThreadedGenerateData() ITK_OVERRIDE;
diff --git a/include/otbSARESDOffsetsImageFilter.h b/include/otbSARESDOffsetsImageFilter.h
index c9a0288..17b0950 100644
--- a/include/otbSARESDOffsetsImageFilter.h
+++ b/include/otbSARESDOffsetsImageFilter.h
@@ -191,9 +191,8 @@ protected:
itk::ThreadIdType threadId) ITK_OVERRIDE;
- /** SARESDOffsetsImageFilter needs a input requested region that corresponds to the margin and shifts
- * into the requested region of our output requested region. The output requested region needs to be modified
- * to construct as wanted tiles with input size.
+ /** SARESDOffsetsImageFilter needs a input requested region that corresponds to our output requested region
+ * for all input images.
* As such, ESDOffsetsImageFilter needs to provide an implementation for
* GenerateInputRequestedRegion() in order to inform the pipeline execution model.
* \sa ProcessObject::GenerateInputRequestedRegion() */
diff --git a/include/otbSARGroupedByOrthoImageFilter.h b/include/otbSARGroupedByOrthoImageFilter.h
index 7cd509f..0543da3 100644
--- a/include/otbSARGroupedByOrthoImageFilter.h
+++ b/include/otbSARGroupedByOrthoImageFilter.h
@@ -50,11 +50,11 @@
namespace otb
{
/** \class SARGroupedByOrthoImageFilter
- * \brief Creates an interferogram into ground geometry between two images.
+ * \brief Creates an interferogram into ground geometry between two SAR images.
*
* This filter built the Ortho interferogram between a master and a slave image.
*
- * The output is a vector image with amplitude, phase and coherency.
+ * The output is a vector image with amplitude, phase coherency adn occurrences.
*
* \ingroup DiapOTBModule
*/
@@ -189,10 +189,9 @@ protected:
*/
virtual void GenerateOutputInformation() ITK_OVERRIDE;
- /** SARGroupedByOrthoImageFilter needs a input requested region that corresponds to the margin and shifts
- * into the requested region of our output requested region. The output requested region needs to be modified
- * to construct as wanted tiles with input size.
- * As such, TilesAnalysesImageFilter needs to provide an implementation for
+ /** SARGroupedByOrthoImageFilter needs a input requested region that corresponds to our output requested
+ * region (SAR geometry for inputs and Ground for output).
+ * As such, SARGroupedByOrthoImageFilter needs to provide an implementation for
* GenerateInputRequestedRegion() in order to inform the pipeline execution model.
* \sa ProcessObject::GenerateInputRequestedRegion() */
virtual void GenerateInputRequestedRegion() ITK_OVERRIDE;
@@ -205,7 +204,7 @@ protected:
/**
- * SARGroupedByOrthoImageFilterr can be implemented as a multithreaded filter.
+ * SARGroupedByOrthoImageFilter can be implemented as a multithreaded filter.
* Therefore, this implementation provides a ThreadedGenerateData() routine
* which is called for each processing thread. The main output image data is
* allocated automatically by the superclass prior to calling
diff --git a/include/otbSARGroupedByOrthoImageFilter.txx b/include/otbSARGroupedByOrthoImageFilter.txx
index 141fb46..658724e 100644
--- a/include/otbSARGroupedByOrthoImageFilter.txx
+++ b/include/otbSARGroupedByOrthoImageFilter.txx
@@ -206,7 +206,7 @@ SARGroupedByOrthoImageFilter< TImageVector, TImageDEM, TImageOut >
// _ amplitude
// _ phase
// _ coherency
- // _ count
+ // _ occurrence
outputPtr->SetNumberOfComponentsPerPixel(4);
// The output is defined with the DEM Image
@@ -319,7 +319,6 @@ SARGroupedByOrthoImageFilter< TImageVector, TImageDEM, TImageOut >
h = m_geoidEmg96->offsetFromEllipsoid(gptPt);
}
demGeoPoint[2] = h;
- //demGeoPoint[2] = 0;
// Call the method of sarSensorModelAdapter
m_SarSensorModelAdapter->WorldToLineSampleYZ(demGeoPoint, col_row, y_z);
@@ -523,7 +522,7 @@ SARGroupedByOrthoImageFilter< TImageVector, TImageDEM, TImageOut >
// Coherency
pixelOutput[2] = mod_Acc / m_tmpArray_mod[index_intoArray] ;
- // IsData
+ // Occurrences
pixelOutput[3] = m_tmpArray_count[index_intoArray];
}
else
diff --git a/include/otbSARInterferogramImageFilter.h b/include/otbSARInterferogramImageFilter.h
index befd8cc..c90c1e2 100644
--- a/include/otbSARInterferogramImageFilter.h
+++ b/include/otbSARInterferogramImageFilter.h
@@ -39,7 +39,7 @@ namespace otb
* \brief Creates an interferogram between two images.
*
* This filter built the interferogram between a master and a slave image.
- * Two kinds of output geometries are available : ML (master) and DEM geometry.
+ * Two kinds of output geometries are available : ML (master) and SAR geometry.
* A topographic phase can be used to create the interferogram.
*
* The output (whtaever the geometry) is a vector image with amplitude, phase and coherence.
@@ -186,10 +186,9 @@ protected:
*/
virtual void GenerateOutputInformation() ITK_OVERRIDE;
- /** SARInterferogramImageFilter needs a input requested region that corresponds to the margin and shifts
- * into the requested region of our output requested region. The output requested region needs to be modified
- * to construct as wanted tiles with input size.
- * As such, TilesAnalysesImageFilter needs to provide an implementation for
+ /** SARInterferogramImageFilter needs a input requested region that corresponds to the margin and ML factors
+ * into the requested region of our output requested region.
+ * As such, SARInterferogramImageFilter needs to provide an implementation for
* GenerateInputRequestedRegion() in order to inform the pipeline execution model.
* \sa ProcessObject::GenerateInputRequestedRegion() */
virtual void GenerateInputRequestedRegion() ITK_OVERRIDE;
@@ -205,21 +204,6 @@ protected:
ImagePhaseRegionType OutputRegionToInputPhaseRegion(const ImageOutRegionType& outputRegion,
bool & sameGeoAsMainOutput, bool withMargin) const;
- /**
- * SARInterferogramImageFilter can produce an optionnal image if UseDEMGeoAsOutput = true. The requested
- * region for this optionnal output is set to the largest possible region.
- */
- //void EnlargeOutputRequestedRegion( itk::DataObject *output ) ITK_OVERRIDE;
-
- /**
- * SARInterferogramImageFilter can produce an optionnal image according to the functor. An allocation of
- * this optionnal output is made into BeforeThreadedGenerateData and free memory into
- * AfterThreadedGenerateData.
- */
- //void BeforeThreadedGenerateData() ITK_OVERRIDE;
-
- //void AfterThreadedGenerateData() ITK_OVERRIDE;
-
/**
* SARInterferogramImageFilterr can be implemented as a multithreaded filter.
* Therefore, this implementation provides a ThreadedGenerateData() routine
diff --git a/include/otbSARTopographicPhaseImageFilter.h b/include/otbSARTopographicPhaseImageFilter.h
index 7f0731a..d2b5e96 100644
--- a/include/otbSARTopographicPhaseImageFilter.h
+++ b/include/otbSARTopographicPhaseImageFilter.h
@@ -40,11 +40,8 @@ namespace otb
* This topographic phase can be used to create the interferogram.
* This filter uses the Cartesian mean (per pixel and per lines) for all DEM points projection into SAR Images.
*
- * Five inputs are required :
+ * Two inputs are required :
* _ Cartesian mean per pixel into Master SAR or ML geometry
- * _ Cartesian mean per line into Master SAR or ML geometry
- * _ Cartesian mean per pixel into Slave SAR or ML geometry
- * _ Cartesian mean per line into Slave SAR or ML geometry
* _ A shift grid to adapt slave SAR or ML geometry to master SAR or ML geometry
*
*
@@ -168,15 +165,6 @@ public:
/** Connect one of the operands for topographic phase estimation : Master Cartesian Mean */
void SetMasterCartesianMeanInput( const ImageInType* image);
- /** Connect one of the operands for topographic phase estimation: Master Cartesian Mean Per line */
- //void SetMasterCartesianMeanPerLineInput( const ImageInType* image);
-
- /** Connect one of the operands for topographic phase estimation : Slave Cartesian Mean */
- // void SetSlaveCartesianMeanInput( const ImageInType* image);
-
- /** Connect one of the operands for topographic phase estimation : Slave Cartesian Mean Per line */
- //void SetSlaveCartesianMeanPerLineInput( const ImageInType* image);
-
void SetGridInput( const GridType* image);
/** Get the inputs */
@@ -200,10 +188,9 @@ protected:
*/
virtual void GenerateOutputInformation() ITK_OVERRIDE;
- /** SARTopographicPhaseImageFilter needs a input requested region that corresponds to the margin and shifts
- * into the requested region of our output requested region. The output requested region needs to be modified
- * to construct as wanted tiles with input size.
- * As such, TilesAnalysesImageFilter needs to provide an implementation for
+ /** SARTopographicPhaseImageFilter needs a input requested region that corresponds to our output requested
+ * region for the two input images.
+ * As such, SARTopographicPhaseImageFilter needs to provide an implementation for
* GenerateInputRequestedRegion() in order to inform the pipeline execution model.
* \sa ProcessObject::GenerateInputRequestedRegion() */
virtual void GenerateInputRequestedRegion() ITK_OVERRIDE;
diff --git a/include/otbSARTopographicPhaseImageFilter.txx b/include/otbSARTopographicPhaseImageFilter.txx
index 6645422..e6f2838 100644
--- a/include/otbSARTopographicPhaseImageFilter.txx
+++ b/include/otbSARTopographicPhaseImageFilter.txx
@@ -161,7 +161,7 @@ namespace otb
//////////////////////////// TopographicPhase into Master Cartesian Mean Geo ///////////////////////////
// Vector Image :
- // At Least 5 Components :
+ // At Most 5 Components :
// _ Topographic Phase
// _ IsData Mask
// _ Copy of XCart mean Master (if copy)
--
GitLab