...

Available since release ana-0.10.15, CalibManager V00-00-35.

In addition to the GUI-based calibration, command Command line interface for dark-run calibration of detectors is implemented by POCs P.O.C.s request. It can be started by the command calibrun with parameters.  The list of options/ parameters can be dumped on terminal by the command:

calibrun -h

...

Usage:   calibrun [options] args
Example: calibrun -e xppi0613 -d CSPAD,OPAL1000 -c ./calib -P -D -r 173

calibrun - command line calibration utility

Options:
  -h, --help            show this help message and exit
  -e EXP, --exp=EXP     experiment name, ex.: cxi12345
  -r RUNNUM, --run=RUNNUM
                        run number
  -n NUM_EVENTS, --num_events=NUM_EVENTS
                        number of events to process
  -s SKIP_EVENTS, --skip_events=SKIP_EVENTS
                        number of events to skip before processing
  -t THR_RMS, --thr_rms=THR_RMS
                        threshold on rms for hot pixel mask evaluation
  -v RUNRANGE, --runrange=RUNRANGE
                        validity run range, ex.: 123-567 or 123-end
  -q QUEUE, --queue=QUEUE
                        queue name, ex: psnehq, psfehq, psanacsq. If specified
                        - run in batch
  -w WORKDIR, --workdir=WORKDIR
                        work directory, ex: ./work
  -c CALIBDIR, --calibdir=CALIBDIR
                        non-standard calibration directory, ex: ./calib
  -d DETECTOR, --detector=DETECTOR
                        detector names separated by comma,
                        ex:CSPAD,CSPAD2x2,PNCCD
  -p PRINT_BITS, --print_bits=PRINT_BITS
                        =0-minimalprint print+warningsnothing, =+1-detailed printout
  -P, --processdebug, +2-info, +4-warning,
         process xtc files and produce calib files under the
        +8-error, +16-critical; default=036, minimal
                        recommended=020
  -P, --process         process xtc files and produce calib files under the
                        "work" directory
  -D, --deploy          deploy calibrated files under the "calib" directory

The calibrun application re-uses reuses code and approach developed for calibman. At start calibrun loads parameters from configuration file confpars-calibman.txt, which by default .  By default this file is the same configuration file as for calibman. If necessary parameters are were already set in  confpars-calibman.txt, then calibrun can be started with a single parameter - run number run number (-r <run-number>) and options for processing (-P) and deployment (-D), for example:

calibrun -r <run-number> -P -D

otherwise, desired parameters need to be defined in the command line.  Starting from the bare command calibrun will print hint-messages If parameters are not defined either in the command line or in the configuration file, then application will dump to terminal hint-warnings about missing option(s) which needs to be added to the command line in order to complete job. An example of the command with minimal set of self-sufficient parameters ,should looks like

calibrun -e xppi0613 -d CSPAD,OPAL1000 -P -D -r 173

This command will process (-P) xtc files for experiment (-e) xppi0613, run (-r) 173, detectors (-d) CSPAD and (,) OPAL1000, and deploy (-D) them for default run range 173-end in under the default calib directory /reg/d/psdm/xpp/xppi0613/calib/

By default the image-averaging psana job is processed interactively. If queue (-q <queue-name>) option is provided, it is submitted in batch.

By default this the calibrun command produces quite extensive output on terminal window, which in most cases is enough sufficient to figure out what is going on.  If the print-control option (-p  0) is provided, the major output will be suppressed and only begin, end of job comments, and warning messages will be printed. Most complete output can be found in the session  log file auto-saved in the work directory with relevant time stamp in the name, for example: ./work/2014-04-16-16:43:52-log.txt

Calibration GUI-based calibration manager calibman, using has the same file name conventions , and can always be used to inspect all output files and problems generated by  by the command line application  calibrun.

References

• Calibration management tool developement notes
• Description of Calibration database
• Mask Editor button