Commit b870832a authored by Victor Poughon's avatar Victor Poughon

DOC: doc review SAR apps

parent 43c63b95
......@@ -71,7 +71,7 @@ private:
AddParameter(ParameterType_Bool, "noise", "Disable Noise");
SetParameterDescription("noise", "Flag to disable noise. For 5.2.0 release, the noise values are only read by TerraSARX product.");
AddParameter(ParameterType_Choice, "lut", "Lookup table sigma /gamma/ beta/ DN.");
AddParameter(ParameterType_Choice, "lut", "Lookup table");
SetParameterDescription("lut", "Lookup table values are not available with all SAR products. Products that provide lookup table with metadata are: Sentinel1, Radarsat2.");
AddChoice("lut.sigma", "Use sigma nought lookup");
SetParameterDescription("lut.sigma","Use Sigma nought lookup value from product metadata");
......
......@@ -93,9 +93,9 @@ private:
SetDocName("SARDecompositions");
SetDocLongDescription("From one-band complex images (HH, HV, VH, VV), returns the selected decomposition.\n \n"
"All the decompositions implemented are intended for the mono-static case (transmitter and receiver are co-located).\n"
"There are two kinds of decomposition : coherent ones and incoherent ones.\n"
"There are two kinds of decomposition: coherent ones and incoherent ones.\n"
"In the coherent case, only the Pauli decomposition is available.\n"
"In the incoherent case, there the decompositions available : Huynen, Barnes, and H-alpha-A.\n"
"In the incoherent case, there the decompositions available: Huynen, Barnes, and H-alpha-A.\n"
"User must provide three one-band complex images HH, HV or VH, and VV (mono-static case <=> HV = VH).\n"
"Incoherent decompositions consist in averaging 3x3 complex coherency/covariance matrices; the user must provide the size of the averaging window, thanks to the parameter inco.kernelsize."
);
......@@ -139,7 +139,7 @@ private:
AddParameter(ParameterType_Group,"inco","Incoherent decompositions");
SetParameterDescription("inco","This group allows setting parameters related to the incoherent decompositions.");
AddParameter(ParameterType_Int, "inco.kernelsize", "Kernel size for spatial incoherent averaging.");
AddParameter(ParameterType_Int, "inco.kernelsize", "Kernel size for spatial incoherent averaging");
SetParameterDescription("inco.kernelsize", "Minute (0-59)");
SetMinimumParameterIntValue("inco.kernelsize", 1);
SetDefaultParameterInt("inco.kernelsize", 3);
......@@ -162,7 +162,7 @@ private:
void DoUpdateParameters() override
{
// Nothing to do here : all parameters are independent
// Nothing to do here: all parameters are independent
}
void DoExecute() override
......
......@@ -232,28 +232,28 @@ private:
AddDocTag(Tags::SAR);
AddParameter(ParameterType_InputImage, "inc", "Input: multi-band complex image");
AddParameter(ParameterType_InputImage, "inc", "Input multi-band complex image");
SetParameterDescription("inc", "Input: multi-band complex image");
MandatoryOff("inc");
AddParameter(ParameterType_InputImage, "inf", "Input: multi-band real image");
AddParameter(ParameterType_InputImage, "inf", "Input multi-band real image");
SetParameterDescription("inf", "Input: multi-band real image");
MandatoryOff("inf");
AddParameter(ParameterType_InputImage, "inhh", "Input: one-band complex image (HH)");
AddParameter(ParameterType_InputImage, "inhh", "Input one-band complex image (HH)");
SetParameterDescription("inhh", "Input: one-band complex image (HH)");
MandatoryOff("inhh");
AddParameter(ParameterType_InputImage, "inhv", "Input: one-band complex image (HV)");
AddParameter(ParameterType_InputImage, "inhv", "Input one-band complex image (HV)");
SetParameterDescription("inhv", "Input: one-band complex image (HV)");
MandatoryOff("inhv");
AddParameter(ParameterType_InputImage, "invh", "Input: one-band complex image (VH)");
AddParameter(ParameterType_InputImage, "invh", "Input one-band complex image (VH)");
SetParameterDescription("invh", "Input: one-band complex image (VH)");
MandatoryOff("invh");
AddParameter(ParameterType_InputImage, "invv", "Input: one-band complex image (VV)");
AddParameter(ParameterType_InputImage, "invv", "Input one-band complex image (VV)");
SetParameterDescription("invv", "Input: one-band complex image (VV)");
MandatoryOff("invv");
......
......@@ -56,11 +56,11 @@ private:
"These parameters are namely psii, khii, psir and khir. The suffixes (i) and (r) refer to the transmitting antenna and the receiving antenna respectively.\n"
"Orientations and ellipticities are given in degrees, and are between -90/90 degrees and -45/45 degrees respectively.\n "
"\n"
"Four polarization architectures can be processed : \n\n"
"1. HH_HV_VH_VV : full polarization, general bistatic case.\n"
"2. HH_HV_VV or HH_VH_VV : full polarization, monostatic case (transmitter and receiver are co-located).\n"
"3. HH_HV : dual polarization.\n"
"4. VH_VV : dual polarization.\n\n"
"Four polarization architectures can be processed: \n\n"
"1. HH_HV_VH_VV: full polarization, general bistatic case.\n"
"2. HH_HV_VV or HH_VH_VV: full polarization, monostatic case (transmitter and receiver are co-located).\n"
"3. HH_HV: dual polarization.\n"
"4. VH_VV: dual polarization.\n\n"
"The application takes a complex vector image as input, where each band correspond to a particular emission/reception polarization scheme.\n"
"User must comply with the band order given above, since the bands are used to build the Sinclair matrix.\n"
"\n"
......@@ -68,8 +68,8 @@ private:
"1. Architecture HH_HV_VH_VV is the only one with four bands, there is no possible confusion.\n"
"2. Concerning HH_HV_VV and HH_VH_VV architectures, both correspond to a three channels image. But they are processed in the same way, as the Sinclair matrix is symmetric in the monostatic case.\n"
"3. Finally, the two last architectures (dual polarizations), can't be distinguished only by the number of bands of the input image."
" User must then use the parameters emissionh and emissionv to indicate the architecture of the system : emissionh=1 and emissionv=0 --> HH_HV, emissionh=0 and emissionv=1 --> VH_VV.\n"
"\nNote : if the architecture is HH_HV, khii and psii are automatically both set to 0 degree; if the architecture is VH_VV, khii and psii are automatically set to 0 degree and 90 degrees respectively.\n"
" User must then use the parameters emissionh and emissionv to indicate the architecture of the system: emissionh=1 and emissionv=0 --> HH_HV, emissionh=0 and emissionv=1 --> VH_VV.\n"
"\nNote: if the architecture is HH_HV, khii and psii are automatically both set to 0 degree; if the architecture is VH_VV, khii and psii are automatically set to 0 degree and 90 degrees respectively.\n"
"\n"
"It is also possible to force the calculation to co-polar or cross-polar modes.\n"
"In the co-polar case, values for psir and khir will be ignored and forced to psii and khii; same as the cross-polar mode, where khir and psir will be forced to (psii + 90 degrees) and -khii.\n"
......@@ -156,7 +156,7 @@ private:
void DoUpdateParameters() override
{
// Nothing to do here : all parameters are independent
// Nothing to do here: all parameters are independent
}
void DoExecute() override
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment