Commit e46f2cb5 authored by Victor Poughon's avatar Victor Poughon

DOC: Clarify doc of Convert mask param

parent d98a5296
......@@ -129,8 +129,8 @@ private:
AddParameter(ParameterType_InputImage, "mask", "Input mask");
SetParameterDescription("mask",
"Optional binary mask to only process part of the input image. "
"Only pixels where the mask is less than 0.5 will be processed. "
"Optional mask to indicate which pixels are valid for computing the histogram quantiles. "
"Only pixels where the mask is less than 0.5 will contribute to the histogram. "
"The mask must have the same dimensions as the input image.");
MandatoryOff("mask");
DisableParameter("mask");
......
......@@ -92,9 +92,7 @@ private:
SetName("DynamicConvert");
SetDescription("Change the pixel type and rescale the image's dynamic");
// Documentation
SetDocName("Dynamic Conversion");
// TODO
SetDocLongDescription("This application performs an image pixel type "
"conversion (short, ushort, uchar, int, uint, float and double types are "
"handled). The output image is written in the specified format (ie. "
......@@ -137,8 +135,8 @@ private:
AddParameter(ParameterType_InputImage, "mask", "Input mask");
SetParameterDescription("mask",
"Optional binary mask to only process part of the input image. "
"Pixels where the mask is zero will not be processed. "
"Optional mask to indicate which pixels are valid for computing the histogram quantiles. "
"Pixels where the mask is zero will not contribute to the histogram. "
"The mask must have the same dimensions as the input image.");
MandatoryOff("mask");
DisableParameter("mask");
......
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