aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorValerio Mariani <valerio.mariani@desy.de>2015-02-23 10:24:46 +0100
committerThomas White <taw@physics.org>2015-02-23 11:08:18 +0100
commit750ffce173aa9d345d72411ba398d4c34203a649 (patch)
tree5efc9ff4875183d65d5d287653258ce4caaf2bb9 /doc
parentfbb051e4b455bd8bb33544d2d3b342b53a09008a (diff)
-e option for hdfsee overrides data layout description from geometry file
Diffstat (limited to 'doc')
-rw-r--r--doc/man/hdfsee.16
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/man/hdfsee.1 b/doc/man/hdfsee.1
index c22f1894..77f7dd2b 100644
--- a/doc/man/hdfsee.1
+++ b/doc/man/hdfsee.1
@@ -43,7 +43,11 @@ Show the image after binning down by a factor of \fIb\fR.
.IP "\fB-e\fR \fIpath\fR"
.IP \fB--image=\fR\fIpath\fR
.PD
-Get the image data to display from \fIpath\fR inside the HDF5 file. For example: \fI/data/rawdata\fR. If this is not specified, the default behaviour is to display the first two-dimensional dataset with both dimensions greater than 64.
+Get the image data to display from \fIpath\fR inside the HDF5 file. Example: \fI/data/rawdata\fR.
+.IP
+If no geometry file is provided (see \fB-g\fR) and this option is not used, hdfsee will display the first two-dimensional dataset it finds in the file with both dimensions greater than 64. If a geometry file is provided, the data layout description from the file determines which image is displayed (see \fB man crystfel_geometry\fR).
+.IP
+If \fB-e\fR is used in combination with \fB-g\fR, hdfsee will attempt to show the specified dataset with the geometry applied. The data layout description from the geometry file will be ignored, the data block to be used as data source for all panels will be set to \fIpath\fR and it will be assumed to be 2-dimensional.
.PD 0
.IP "\fB-g\fR \fIfilename\fR"