aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThomas White <taw@bitwiz.org.uk>2013-03-15 19:54:02 +0100
committerThomas White <taw@bitwiz.org.uk>2013-03-15 19:54:40 +0100
commitdb32175e989e5feb060599d8cf53da828abb95d2 (patch)
tree7dcc8f53a832f8cc7e36d9da54a9963cebecba13 /doc
parentbb56d8540763997ae88668c9ab444853626b6ac2 (diff)
Update docs
Diffstat (limited to 'doc')
-rw-r--r--doc/man/hdfsee.16
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/man/hdfsee.1 b/doc/man/hdfsee.1
index e362a0a0..11a70630 100644
--- a/doc/man/hdfsee.1
+++ b/doc/man/hdfsee.1
@@ -73,14 +73,14 @@ Show rings on the image with the radii specified. \fIradii\fR can be a comma-de
Use \fIscale\fR as the colour scale. Possible scales are: \fBmono\fR, \fBinvmono\fR and \fBcolour\fR.
.PD 0
-.IP \fB--filter-cm\fR
+.IP \fB--median-filter=\fR\fIn\fR
.PD
-Attempt to subtract common-mode noise from the image.
+Apply a median filter with box "radius" \fIn\fR to the image. Each pixel will be set to the median of the values from a \fI(n+1)\fRx\fI(n+1)\fR square centered on the pixel. This might help with peak detection if the background is high and/or noisy. The \fIunfiltered\fR image will be used for the final integration of the peaks. If you also use \fB--noise-filter\fR, the median filter will be applied first.
.PD 0
.IP \fB--filter-noise\fR
.PD
-Apply a noise filter to the image with checks 3x3 squares of pixels and sets all of them to zero if any of the nine pixels have a negative value.
+Apply a noise filter to the image with checks 3x3 squares of pixels and sets all of them to zero if any of the nine pixels have a negative value. This filter may help with peak detection under certain circumstances. The \fIunfiltered\fR image will be used for the final integration of the peaks, because the filter is destroys a lot of information from the pattern. If you also use \fB--median-filter\fR, the median filter will be applied first.
.SH AUTHOR
This page was written by Thomas White.