Commit f9532541 authored by Antoine Regimbeau's avatar Antoine Regimbeau
Browse files

DOC: improve doc and add min max default value

No related merge requests found
Showing with 10 additions and 6 deletions
+10 -6
...@@ -165,7 +165,7 @@ private: ...@@ -165,7 +165,7 @@ private:
"histogram. That gives us gain for each bin that transform the original " "histogram. That gives us gain for each bin that transform the original "
"histogram into the flat one. This gain is then apply on the original " "histogram into the flat one. This gain is then apply on the original "
"image." "image."
"\nThe application proposes several option to allow a finer result : " "\nThe application proposes several options to allow a finer result : "
"\n- There is an option to limit contrast. We choose to limit the contrast " "\n- There is an option to limit contrast. We choose to limit the contrast "
"by modifying the original histogram. To do so we clip the histogram at a " "by modifying the original histogram. To do so we clip the histogram at a "
"given height and redistribute equally among the bins the clipped population. " "given height and redistribute equally among the bins the clipped population. "
...@@ -226,7 +226,8 @@ private: ...@@ -226,7 +226,8 @@ private:
AddParameter(ParameterType_Choice , "minmax" , "Minimum and maximum " AddParameter(ParameterType_Choice , "minmax" , "Minimum and maximum "
"settings"); "settings");
SetParameterDescription("minmax","Minimum and maximum value that will " SetParameterDescription("minmax","Minimum and maximum value that will "
"bound the histogram."); "bound the histogram and thus the dynamic of the resulting image. Values "
"over those boundaries will be clipped.");
AddChoice( "minmax.auto" , "Automatic" ); AddChoice( "minmax.auto" , "Automatic" );
SetParameterDescription("minmax.auto" , "Minimum and maximum value will " SetParameterDescription("minmax.auto" , "Minimum and maximum value will "
"be computed on the image (nodata value won't be taken " "be computed on the image (nodata value won't be taken "
...@@ -234,12 +235,15 @@ private: ...@@ -234,12 +235,15 @@ private:
AddParameter(ParameterType_Bool, "minmax.auto.global", "Global"); AddParameter(ParameterType_Bool, "minmax.auto.global", "Global");
SetParameterDescription("minmax.auto.global" , "Automatic" SetParameterDescription("minmax.auto.global" , "Automatic"
"Min/max computation will result in the same minimum and maximum for " "Min/max computation will result in the same minimum and maximum for "
"all the bands."); "all the bands. Otherwise the computation will be done for each "
"thumbnail if a local equalization is done");
AddChoice( "minmax.manual" , "Manual settings of min/max values" ); AddChoice( "minmax.manual" , "Manual settings of min/max values" );
SetParameterDescription("minmax.auto","Minimum and maximum value will be " SetParameterDescription("minmax.auto","Minimum and maximum value will be "
"set by the user"); "set by the user");
AddParameter(ParameterType_Float , "minmax.manual.min" , "Minimum value"); AddParameter(ParameterType_Float , "minmax.manual.min" , "Minimum value");
AddParameter(ParameterType_Float , "minmax.manual.max" , "Maximum value"); AddParameter(ParameterType_Float , "minmax.manual.max" , "Maximum value");
SetDefaultParameterFloat("minmax.manual.min", 0 );
SetDefaultParameterFloat("minmax.manual.max", 255 );
MandatoryOff("minmax.manual.min"); MandatoryOff("minmax.manual.min");
MandatoryOff("minmax.manual.max"); MandatoryOff("minmax.manual.max");
...@@ -249,9 +253,9 @@ private: ...@@ -249,9 +253,9 @@ private:
"Each channel is equalized independently" ); "Each channel is equalized independently" );
AddChoice( "mode.lum" , "Luminance" ); AddChoice( "mode.lum" , "Luminance" );
SetParameterDescription( "mode.lum" , SetParameterDescription( "mode.lum" ,
"The relative luminance is calculated thanks to the coefficients." "The relative luminance is computed thanks to the coefficients."
"Then the histogram is equalized and then a gain is applied on each channels." "Then the histogram is equalized and the gain is applied on each channels."
"This gain for each channels will depend on" "This gain for each channels will depend on "
"the weight (coef) of the channel in the luminance." "the weight (coef) of the channel in the luminance."
"\nNote that default values come from color space theories " "\nNote that default values come from color space theories "
"on how human eyes perceive colors)" "on how human eyes perceive colors)"
......
Supports Markdown
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