aboutsummaryrefslogtreecommitdiff
path: root/pkg/proto/doc/imscale.hlp
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2015-07-08 20:46:52 -0400
committerJoseph Hunkeler <jhunkeler@gmail.com>2015-07-08 20:46:52 -0400
commitfa080de7afc95aa1c19a6e6fc0e0708ced2eadc4 (patch)
treebdda434976bc09c864f2e4fa6f16ba1952b1e555 /pkg/proto/doc/imscale.hlp
downloadiraf-linux-fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4.tar.gz
Initial commit
Diffstat (limited to 'pkg/proto/doc/imscale.hlp')
-rw-r--r--pkg/proto/doc/imscale.hlp43
1 files changed, 43 insertions, 0 deletions
diff --git a/pkg/proto/doc/imscale.hlp b/pkg/proto/doc/imscale.hlp
new file mode 100644
index 00000000..1f8a4a2a
--- /dev/null
+++ b/pkg/proto/doc/imscale.hlp
@@ -0,0 +1,43 @@
+.help imscale Aug84 proto
+.ih
+NAME
+imscale -- Scale an image to a specified windowed mean
+.ih
+USAGE
+imscale input output mean
+.ih
+PARAMETERS
+.ls input
+Input image to be scaled.
+.le
+.ls output
+Output scaled image.
+.le
+.ls mean
+Scale the output image to this mean value.
+.le
+.ls lower = INDEF
+Lower limit of window for calculating the input image mean. INDEF corresponds
+to the minimum possible pixel value.
+.le
+.ls upper = INDEF
+Upper limit of window for calculating the input image mean. INDEF corresponds
+to the maximum possible pixel value.
+.le
+.ls verbose = no
+Print the calculated input and output image means.
+.le
+.ih
+DESCRIPTION
+The mean of the \fIinput\fR image between the limits \fIlower\fR
+and \fIupper\fR is computed. The image is then scaled to the
+specified output \fImean\fR.
+.ih
+EXAMPLES
+To scale an image to a unit mean excluding deviant points below
+1000 and above 5000.
+
+.nf
+ cl> imscale calib flat 1 lower=1000 upper=5000
+.fi
+.endhelp