Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix -- in docs #598

Merged
merged 2 commits into from
Nov 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions doc/source/man/densify_Bragg.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ for subsequent analysis.
Usage
-----

densify_Bragg [-h] [-V] [-v] [--debug] [-l] [-o OUTPUT] [-O FORMAT]
[-D DUMMY] [--dry-run] [-N NOISY] [IMAGE ...]
densify_Bragg [-h] [-V] [-v] [-\-debug] [-l] [-o OUTPUT] [-O FORMAT]
[-D DUMMY] [-\-dry-run] [-N NOISY] [IMAGE ...]

Positional arguments:
---------------------
Expand All @@ -29,40 +29,40 @@ IMAGE
Pptions:
--------

**-h**, **--help**
**-h**, **-\-help**
show this help message and exit

**-V**, **--version**
**-V**, **-\-version**
output version and exit

**-v**, **--verbose**
**-v**, **-\-verbose**
show information for each conversions

**--debug**
**-\-debug**
show debug information

Main arguments:
---------------

**-l**, **--list**
**-l**, **-\-list**
show the list of available output formats and exit

**-o** OUTPUT, **--output** OUTPUT
**-o** OUTPUT, **-\-output** OUTPUT
output filename, by default {baseame}_densify.h5

**-O** FORMAT, **--output-format** FORMAT
**-O** FORMAT, **-\-output-format** FORMAT
output format among ``lima``, ``eiger`` ...

**-D** DUMMY, **--dummy** DUMMY
**-D** DUMMY, **-\-dummy** DUMMY
Set masked values to this dummy value

optional behaviour arguments:
-----------------------------

**--dry-run**
**-\-dry-run**
do everything except modifying the file system

**-N** NOISY, **--noise** NOISY
**-N** NOISY, **-\-noise** NOISY
Noise scaling factor, from 0 to 1, set to 0 to disable the noise
reconstruction

Expand Down
72 changes: 36 additions & 36 deletions doc/source/man/eiger2cbf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ Purpose
-------

Convert a multiframe HDF5 Eiger data file into several CBF files.
Portable image converter based on FabIO library to export Eiger frames (``lima`` or ``eiger``)

Portable image converter based on FabIO library to export Eiger frames (``lima`` or ``eiger``)
to CBF which mimic the header of a Dectris Pilatus detector.

Usage:
------

eiger2cbf [-h] [-V] [-v] [--debug] [-o OUTPUT] [-m MASK] [-O OFFSET] [-D DUMMY] [--pilatus] [--dry-run] [-e ENERGY]
[-w WAVELENGTH] [-d DISTANCE] [-b BEAM BEAM] [--alpha ALPHA] [--kappa KAPPA] [--chi CHI] [--phi PHI]
[--omega OMEGA] [--rotation ROTATION] [--transpose] [--flip-ud] [--flip-lr]
eiger2cbf [-h] [-V] [-v] [-\-debug] [-o OUTPUT] [-m MASK] [-O OFFSET] [-D DUMMY] [-\-pilatus] [-\-dry-run] [-e ENERGY]
[-w WAVELENGTH] [-d DISTANCE] [-b BEAM BEAM] [-\-alpha ALPHA] [-\-kappa KAPPA] [-\-chi CHI] [-\-phi PHI]
[-\-omega OMEGA] [-\-rotation ROTATION] [-\-transpose] [-\-flip-ud] [-\-flip-lr]
[IMAGE ...]

Positional arguments:
Expand All @@ -26,79 +26,79 @@ IMAGE
Options:
++++++++

**-h**, **--help**
**-h**, **-\-help**
show this help message and exit

**-V**, **--version**
**-V**, **-\-version**
output version and exit

**-v**, **--verbose**
**-v**, **-\-verbose**
show information for each conversions

**--debug**
**-\-debug**
show debug information

Main arguments:
+++++++++++++++

**-o** OUTPUT, **--output** OUTPUT
**-o** OUTPUT, **-\-output** OUTPUT
output directory and filename template:
``eiger2cbf/frame_{index:04d}.cbf``

**-m** MASK, **--mask** MASK
**-m** MASK, **-\-mask** MASK
Read masked pixel from this file

**-O** OFFSET, **--offset** OFFSET
index offset, CrysalisPro likes indexes to start at 1,
**-O** OFFSET, **-\-offset** OFFSET
index offset, CrysalisPro likes indexes to start at 1,
Python starts at 0 (default)

**-D** DUMMY, **--dummy** DUMMY
**-D** DUMMY, **-\-dummy** DUMMY
Set masked values to this dummy value

**--pilatus**
**-\-pilatus**
Select an image shape similar to Pilatus detectors for compatibiliy
with Crysalis

Optional behaviour arguments:
+++++++++++++++++++++++++++++

**--dry-run**
**-\-dry-run**
do everything except modifying the file system

Experimental setup options:
+++++++++++++++++++++++++++

**-e** ENERGY, **--energy** ENERGY
**-e** ENERGY, **-\-energy** ENERGY
Energy of the incident beam in keV

**-w** WAVELENGTH, **--wavelength** WAVELENGTH
**-w** WAVELENGTH, **-\-wavelength** WAVELENGTH
Wavelength of the incident beam in Angstrom

**-d** DISTANCE, **--distance** DISTANCE
**-d** DISTANCE, **-\-distance** DISTANCE
Detector distance in meters

**-b** BEAM BEAM, **--beam** BEAM BEAM
**-b** BEAM BEAM, **-\-beam** BEAM BEAM
Direct beam in pixels x, y

Goniometer setup:
-----------------

**--alpha** ALPHA
Goniometer angle alpha value in deg.
**-\-alpha** ALPHA
Goniometer angle alpha value in deg.
Constant, angle between kappa and omega.

**--kappa** KAPPA
**-\-kappa** KAPPA
Goniometer angle kappa value in degrees or formula f(index)
``-80 + 2*index``

**--chi** CHI
**-\-chi** CHI
Goniometer angle chi value in degres or formula f(index)

**--phi** PHI
**-\-phi** PHI
Goniometer angle phi value (inner-most rotation) in degrees or formula f(index)
``-180+0.7*index``

**--omega** OMEGA
**-\-omega** OMEGA
Goniometer angle omega value (outer-most rotation) in degrees or formula f(index)
``-180+0.5*index``

Expand All @@ -107,32 +107,32 @@ Image preprocessing:

Images are patched onto the center of a square frame, and transformation are applied in this order:

**--rotation** ROTATION
**-\-rotation** ROTATION
Rotate the initial image by this value in degrees. Must be a multiple
of 90 degrees.

**--transpose**
**-\-transpose**
Flip the x/y axis

**--flip-ud**
**-\-flip-ud**
Flip the image upside-down

**--flip-lr**
**-\-flip-lr**
Flip the image left-right

Return code:
Return code:
++++++++++++

- 0 means a success.
- 1 means the conversion contains a failure,
- 0 means a success.
- 1 means the conversion contains a failure,
- 2 means there was an error in the arguments

Nota:
-----

Images are made square, so the beam center found in the CBF-files differs from the one entered.
Images are made square, so the beam center found in the CBF-files differs from the one entered.


.. command-output:: eiger2cbf --help
.. command-output:: eiger2cbf -\-help
:nostderr:

Loading
Loading