[otb] 10/11: Add manpages for new executables.
Bas Couwenberg
sebastic at debian.org
Thu Jan 25 12:28:53 UTC 2018
This is an automated email from the git hooks/post-receive script.
sebastic pushed a commit to branch master
in repository otb.
commit 4d4652ac04190aaccb204a4ae9609482de38a545
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date: Thu Jan 25 10:50:49 2018 +0100
Add manpages for new executables.
---
debian/changelog | 1 +
debian/manpages/otbcli_ContrastEnhancement.1 | 92 ++++++++++++++++++++++++++++
debian/manpages/otbcli_DynamicConvert.1 | 71 +++++++++++++++++++++
debian/manpages/otbgui_ContrastEnhancement.1 | 92 ++++++++++++++++++++++++++++
debian/manpages/otbgui_DynamicConvert.1 | 71 +++++++++++++++++++++
debian/otb-bin-qt.manpages | 2 +
debian/otb-bin.manpages | 2 +
7 files changed, 331 insertions(+)
diff --git a/debian/changelog b/debian/changelog
index d9ff975..e924df3 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -9,6 +9,7 @@ otb (6.4.0~rc1+dfsg-1) UNRELEASED; urgency=medium
* Bump Standards-Version to 4.1.3, no changes.
* Update lintian override for spelling-error-in-binary false positive.
* Add patch to fix spelling errors.
+ * Add manpages for new executables.
-- Bas Couwenberg <sebastic at debian.org> Thu, 25 Jan 2018 07:50:01 +0100
diff --git a/debian/manpages/otbcli_ContrastEnhancement.1 b/debian/manpages/otbcli_ContrastEnhancement.1
new file mode 100644
index 0000000..faa9d79
--- /dev/null
+++ b/debian/manpages/otbcli_ContrastEnhancement.1
@@ -0,0 +1,92 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5.
+.TH OTBCLI_CONTRASTENHANCEMENT "1" "January 2018" "otbcli_ContrastEnhancement 6.4.0" "User Commands"
+.SH NAME
+otbcli_ContrastEnhancement \- OTB ContrastEnhancement application
+.SH DESCRIPTION
+This is the Contrast Enhancement (ContrastEnhancement) application, version 6.4.0
+.PP
+This application is the implementation of the histogram equalization algorithm. It can be used to enhance contrast in an image or to reduce the dynamic of the image without losing too much contrast. It offers several options as a no data value, a contrast limitation factor, a local version of the algorithm and also a mode to equalized the luminance of the image.
+.PP
+Parameters:
+.PP
+\fB\-in\fR <string> Input Image (mandatory)
+.TP
+\fB\-out\fR <string> [pixel] Output Image [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is float) (mandatory)
+.TP
+\fB\-bins\fR
+<int32> Number of bin (mandatory, default value is 256)
+.TP
+\fB\-hfact\fR
+<float> Contrast Limitation (optional, off by default)
+.TP
+\fB\-nodata\fR
+<float> Nodata Value (optional, off by default)
+.TP
+\fB\-spatial\fR
+<string> Spatial parameters for the histogram computation [local/global] (mandatory, default value is local)
+.TP
+\fB\-spatial\fR.local.h
+<int32> Thumbnail height in pixel (mandatory, default value is 256)
+.TP
+\fB\-spatial\fR.local.w
+<int32> Thumbnail width in pixel (mandatory, default value is 256)
+.TP
+\fB\-minmax\fR
+<string> Minimum and maximum definition [auto/manuel] (mandatory, default value is auto)
+.TP
+\fB\-minmax\fR.auto.global
+<boolean> Global (optional, off by default)
+.TP
+\fB\-minmax\fR.manuel.min
+<float> Minimum (optional, off by default)
+.TP
+\fB\-minmax\fR.manuel.max
+<float> Maximum (optional, off by default)
+.TP
+\fB\-mode\fR
+<string> What to equalized [each/lum] (mandatory, default value is each)
+.TP
+\fB\-mode\fR.lum.red
+<group> Red Channel
+.TP
+\fB\-mode\fR.lum.red.ch
+<int32> Red Channel (mandatory, default value is 0)
+.TP
+\fB\-mode\fR.lum.red.coef
+<float> Value for luminance computation (mandatory, default value is 0.21)
+.TP
+\fB\-mode\fR.lum.green
+<group> Green Channel
+.TP
+\fB\-mode\fR.lum.green.ch
+<int32> Greenen Channel (mandatory, default value is 1)
+.TP
+\fB\-mode\fR.lum.green.coef <float>
+Value for luminance computation (mandatory, default value is 0.71)
+.TP
+\fB\-mode\fR.lum.blue
+<group> Blue Channel
+.TP
+\fB\-mode\fR.lum.blue.ch
+<int32> Blue Channel (mandatory, default value is 2)
+.TP
+\fB\-mode\fR.lum.blue.coef
+<float> Value for luminance computation (mandatory, default value is 0.08)
+.TP
+\fB\-ram\fR
+<int32> Available RAM (Mb) (optional, off by default, default value is 128)
+.TP
+\fB\-inxml\fR
+<string> Load otb application from xml file (optional, off by default)
+.TP
+\fB\-progress\fR
+<boolean> Report progress
+.TP
+\fB\-help\fR
+<string list> Display long help (empty list), or help for given parameters keys
+.PP
+Use \fB\-help\fR param1 [... paramN] to see detailed documentation of those parameters.
+.SH EXAMPLES
+Local contrast enhancement by luminance
+.PP
+otbcli_ContrastEnhancement \-in couleurs.tif \-out equalizedcouleurs.tif float \-bins 256 \-spatial.local.w 500 \-spatial.local.h 500 \-mode lum
diff --git a/debian/manpages/otbcli_DynamicConvert.1 b/debian/manpages/otbcli_DynamicConvert.1
new file mode 100644
index 0000000..4610284
--- /dev/null
+++ b/debian/manpages/otbcli_DynamicConvert.1
@@ -0,0 +1,71 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5.
+.TH OTBCLI_DYNAMICCONVERT "1" "January 2018" "otbcli_DynamicConvert 6.4.0" "User Commands"
+.SH NAME
+otbcli_DynamicConvert \- OTB DynamicConvert application
+.SH DESCRIPTION
+This is the Dynamic Conversion (DynamicConvert) application, version 6.4.0
+.PP
+Change the pixel type and rescale the image's dynamic
+.PP
+Complete documentation: http://www.orfeo\-toolbox.org/Applications/DynamicConvert.html or \fB\-help\fR
+.PP
+Parameters:
+.PP
+\fB\-in\fR <string> Input image (mandatory)
+.TP
+\fB\-out\fR <string> [pixel] Output Image [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is uint8) (mandatory)
+.TP
+\fB\-type\fR
+<string> Rescale type [linear/log2] (mandatory, default value is linear)
+.TP
+\fB\-type\fR.linear.gamma
+<float> Gamma correction factor (optional, on by default, default value is 1)
+.TP
+\fB\-mask\fR
+<string> Input mask (optional, off by default)
+.TP
+\fB\-quantile\fR
+<group> Histogram quantile cutting
+.TP
+\fB\-quantile\fR.high
+<float> High cut quantile (optional, off by default, default value is 2)
+.TP
+\fB\-quantile\fR.low
+<float> Low cut quantile (optional, off by default, default value is 2)
+.TP
+\fB\-channels\fR
+<string> Channels selection [all/grayscale/rgb] (mandatory, default value is all)
+.TP
+\fB\-channels\fR.grayscale.channel <int32>
+Grayscale channel (mandatory, default value is 1)
+.TP
+\fB\-channels\fR.rgb.red
+<int32> Red Channel (mandatory)
+.TP
+\fB\-channels\fR.rgb.green
+<int32> Green Channel (mandatory)
+.TP
+\fB\-channels\fR.rgb.blue
+<int32> Blue Channel (mandatory)
+.TP
+\fB\-outmin\fR
+<float> Output min value (optional, on by default, default value is 0)
+.TP
+\fB\-outmax\fR
+<float> Output max value (optional, on by default, default value is 255)
+.TP
+\fB\-ram\fR
+<int32> Available RAM (Mb) (optional, off by default, default value is 128)
+.TP
+\fB\-inxml\fR
+<string> Load otb application from xml file (optional, off by default)
+.TP
+\fB\-progress\fR
+<boolean> Report progress
+.TP
+\fB\-help\fR
+<string list> Display long help (empty list), or help for given parameters keys
+.PP
+Use \fB\-help\fR param1 [... paramN] to see detailed documentation of those parameters.
+.SH EXAMPLES
+otbcli_DynamicConvert \-in QB_Toulouse_Ortho_XS.tif \-out otbConvertWithScalingOutput.png \-type linear \-channels rgb \-outmin 0 \-outmax 255
diff --git a/debian/manpages/otbgui_ContrastEnhancement.1 b/debian/manpages/otbgui_ContrastEnhancement.1
new file mode 100644
index 0000000..5b8fdb3
--- /dev/null
+++ b/debian/manpages/otbgui_ContrastEnhancement.1
@@ -0,0 +1,92 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5.
+.TH OTBGUI_CONTRASTENHANCEMENT "1" "January 2018" "otbgui_ContrastEnhancement 6.4.0" "User Commands"
+.SH NAME
+otbgui_ContrastEnhancement \- OTB ContrastEnhancement application
+.SH DESCRIPTION
+This is the Contrast Enhancement (ContrastEnhancement) application, version 6.4.0
+.PP
+This application is the implementation of the histogram equalization algorithm. It can be used to enhance contrast in an image or to reduce the dynamic of the image without losing too much contrast. It offers several options as a no data value, a contrast limitation factor, a local version of the algorithm and also a mode to equalized the luminance of the image.
+.PP
+Parameters:
+.PP
+\fB\-in\fR <string> Input Image (mandatory)
+.TP
+\fB\-out\fR <string> [pixel] Output Image [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is float) (mandatory)
+.TP
+\fB\-bins\fR
+<int32> Number of bin (mandatory, default value is 256)
+.TP
+\fB\-hfact\fR
+<float> Contrast Limitation (optional, off by default)
+.TP
+\fB\-nodata\fR
+<float> Nodata Value (optional, off by default)
+.TP
+\fB\-spatial\fR
+<string> Spatial parameters for the histogram computation [local/global] (mandatory, default value is local)
+.TP
+\fB\-spatial\fR.local.h
+<int32> Thumbnail height in pixel (mandatory, default value is 256)
+.TP
+\fB\-spatial\fR.local.w
+<int32> Thumbnail width in pixel (mandatory, default value is 256)
+.TP
+\fB\-minmax\fR
+<string> Minimum and maximum definition [auto/manuel] (mandatory, default value is auto)
+.TP
+\fB\-minmax\fR.auto.global
+<boolean> Global (optional, off by default)
+.TP
+\fB\-minmax\fR.manuel.min
+<float> Minimum (optional, off by default)
+.TP
+\fB\-minmax\fR.manuel.max
+<float> Maximum (optional, off by default)
+.TP
+\fB\-mode\fR
+<string> What to equalized [each/lum] (mandatory, default value is each)
+.TP
+\fB\-mode\fR.lum.red
+<group> Red Channel
+.TP
+\fB\-mode\fR.lum.red.ch
+<int32> Red Channel (mandatory, default value is 0)
+.TP
+\fB\-mode\fR.lum.red.coef
+<float> Value for luminance computation (mandatory, default value is 0.21)
+.TP
+\fB\-mode\fR.lum.green
+<group> Green Channel
+.TP
+\fB\-mode\fR.lum.green.ch
+<int32> Greenen Channel (mandatory, default value is 1)
+.TP
+\fB\-mode\fR.lum.green.coef <float>
+Value for luminance computation (mandatory, default value is 0.71)
+.TP
+\fB\-mode\fR.lum.blue
+<group> Blue Channel
+.TP
+\fB\-mode\fR.lum.blue.ch
+<int32> Blue Channel (mandatory, default value is 2)
+.TP
+\fB\-mode\fR.lum.blue.coef
+<float> Value for luminance computation (mandatory, default value is 0.08)
+.TP
+\fB\-ram\fR
+<int32> Available RAM (Mb) (optional, off by default, default value is 128)
+.TP
+\fB\-inxml\fR
+<string> Load otb application from xml file (optional, off by default)
+.TP
+\fB\-progress\fR
+<boolean> Report progress
+.TP
+\fB\-help\fR
+<string list> Display long help (empty list), or help for given parameters keys
+.PP
+Use \fB\-help\fR param1 [... paramN] to see detailed documentation of those parameters.
+.SH EXAMPLES
+Local contrast enhancement by luminance
+.PP
+otbgui_ContrastEnhancement \-in couleurs.tif \-out equalizedcouleurs.tif float \-bins 256 \-spatial.local.w 500 \-spatial.local.h 500 \-mode lum
diff --git a/debian/manpages/otbgui_DynamicConvert.1 b/debian/manpages/otbgui_DynamicConvert.1
new file mode 100644
index 0000000..e5b1514
--- /dev/null
+++ b/debian/manpages/otbgui_DynamicConvert.1
@@ -0,0 +1,71 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5.
+.TH OTBGUI_DYNAMICCONVERT "1" "January 2018" "otbgui_DynamicConvert 6.4.0" "User Commands"
+.SH NAME
+otbgui_DynamicConvert \- OTB DynamicConvert application
+.SH DESCRIPTION
+This is the Dynamic Conversion (DynamicConvert) application, version 6.4.0
+.PP
+Change the pixel type and rescale the image's dynamic
+.PP
+Complete documentation: http://www.orfeo\-toolbox.org/Applications/DynamicConvert.html or \fB\-help\fR
+.PP
+Parameters:
+.PP
+\fB\-in\fR <string> Input image (mandatory)
+.TP
+\fB\-out\fR <string> [pixel] Output Image [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is uint8) (mandatory)
+.TP
+\fB\-type\fR
+<string> Rescale type [linear/log2] (mandatory, default value is linear)
+.TP
+\fB\-type\fR.linear.gamma
+<float> Gamma correction factor (optional, on by default, default value is 1)
+.TP
+\fB\-mask\fR
+<string> Input mask (optional, off by default)
+.TP
+\fB\-quantile\fR
+<group> Histogram quantile cutting
+.TP
+\fB\-quantile\fR.high
+<float> High cut quantile (optional, off by default, default value is 2)
+.TP
+\fB\-quantile\fR.low
+<float> Low cut quantile (optional, off by default, default value is 2)
+.TP
+\fB\-channels\fR
+<string> Channels selection [all/grayscale/rgb] (mandatory, default value is all)
+.TP
+\fB\-channels\fR.grayscale.channel <int32>
+Grayscale channel (mandatory, default value is 1)
+.TP
+\fB\-channels\fR.rgb.red
+<int32> Red Channel (mandatory)
+.TP
+\fB\-channels\fR.rgb.green
+<int32> Green Channel (mandatory)
+.TP
+\fB\-channels\fR.rgb.blue
+<int32> Blue Channel (mandatory)
+.TP
+\fB\-outmin\fR
+<float> Output min value (optional, on by default, default value is 0)
+.TP
+\fB\-outmax\fR
+<float> Output max value (optional, on by default, default value is 255)
+.TP
+\fB\-ram\fR
+<int32> Available RAM (Mb) (optional, off by default, default value is 128)
+.TP
+\fB\-inxml\fR
+<string> Load otb application from xml file (optional, off by default)
+.TP
+\fB\-progress\fR
+<boolean> Report progress
+.TP
+\fB\-help\fR
+<string list> Display long help (empty list), or help for given parameters keys
+.PP
+Use \fB\-help\fR param1 [... paramN] to see detailed documentation of those parameters.
+.SH EXAMPLES
+otbgui_DynamicConvert \-in QB_Toulouse_Ortho_XS.tif \-out otbConvertWithScalingOutput.png \-type linear \-channels rgb \-outmin 0 \-outmax 255
diff --git a/debian/otb-bin-qt.manpages b/debian/otb-bin-qt.manpages
index d775f03..26562e9 100644
--- a/debian/otb-bin-qt.manpages
+++ b/debian/otb-bin-qt.manpages
@@ -14,6 +14,7 @@ debian/manpages/otbgui_ComputePolylineFeatureFromImage.1
debian/manpages/otbgui_ConcatenateImages.1
debian/manpages/otbgui_ConcatenateVectorData.1
debian/manpages/otbgui_ConnectedComponentSegmentation.1
+debian/manpages/otbgui_ContrastEnhancement.1
debian/manpages/otbgui_Convert.1
debian/manpages/otbgui_ConvertCartoToGeoPoint.1
debian/manpages/otbgui_ConvertSensorToGeoPoint.1
@@ -24,6 +25,7 @@ debian/manpages/otbgui_DisparityMapToElevationMap.1
debian/manpages/otbgui_DomainTransform.1
debian/manpages/otbgui_DownloadSRTMTiles.1
debian/manpages/otbgui_DSFuzzyModelEstimation.1
+debian/manpages/otbgui_DynamicConvert.1
debian/manpages/otbgui_EdgeExtraction.1
debian/manpages/otbgui_ExtractROI.1
debian/manpages/otbgui_FineRegistration.1
diff --git a/debian/otb-bin.manpages b/debian/otb-bin.manpages
index a584df9..f89a414 100644
--- a/debian/otb-bin.manpages
+++ b/debian/otb-bin.manpages
@@ -14,6 +14,7 @@ debian/manpages/otbcli_ComputePolylineFeatureFromImage.1
debian/manpages/otbcli_ConcatenateImages.1
debian/manpages/otbcli_ConcatenateVectorData.1
debian/manpages/otbcli_ConnectedComponentSegmentation.1
+debian/manpages/otbcli_ContrastEnhancement.1
debian/manpages/otbcli_Convert.1
debian/manpages/otbcli_ConvertCartoToGeoPoint.1
debian/manpages/otbcli_ConvertSensorToGeoPoint.1
@@ -24,6 +25,7 @@ debian/manpages/otbcli_DisparityMapToElevationMap.1
debian/manpages/otbcli_DomainTransform.1
debian/manpages/otbcli_DownloadSRTMTiles.1
debian/manpages/otbcli_DSFuzzyModelEstimation.1
+debian/manpages/otbcli_DynamicConvert.1
debian/manpages/otbcli_EdgeExtraction.1
debian/manpages/otbcli_ExtractROI.1
debian/manpages/otbcli_FineRegistration.1
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/otb.git
More information about the Pkg-grass-devel
mailing list