calquiz

Synopsis

Find calibration files in the CALDB

calquiz  infile telescope instrument product calfile [outfile] [echo]
[echo_qual] [echo_fidel] [verbose]

Description

`calquiz' is use to query the CALDB for calibrations matching a set of conditions. It may run in two ways:

• an input file (FITS image, FITS table, or observation parameter file) is specified. This file is used to get the metadata needed to complete the CALDB lookup, such as DATE-OBS, DATE-END, INSTRUME, and TELESCOP
• no infile is specified; in this case, the telescope and instrument parameters must be set

For detailed information on the structure and operation of the CALDB, see "ahelp caldb" and the Chandra CALDB webpages.

Example 1

calquiz acisf00459N002_evt2.fits product=DET_GAIN calfile=CALDB
pget calquiz outfile
/data/CALDB/ciao/data/chandra/acis/det_gain/acisD1999-09-16gainN0006.fit
s[2]

Query the CALDB for the detector gain (DET_GAIN) for the data in acisf00459N002_evt2.fits. The pget tool is used to get the resulting filename from calquiz.par.

Example 2

calquiz sources.wmap8 product=fef_pha calfile=CALDB verbose=1

Use the information in sources.wmap8 to determine which FEF file would be used to create the RMF. calquiz is run with "verbose=1", so the information is printed to the screen:

   Telescope: CHANDRA
  Instrument: ACIS
        Data: FEF_PHA
    Detector: -
  Start-Date: 2002-02-27
  Start-Time: 14:51:49
   Stop-Date: 2002-03-01
   Stop-Time: 01:38:40
  Expression: GRATING=NONE
              CTI_APP=PPPPPNPNPP
              FP_TEMP=153.446
      Config: /soft/ciao-4.2/CALDB/software/tools/caldb.config
   CXC-caldb: v4.1.0

Found 1 files:
/data/CALDB/ciao/data/chandra/acis/fef_pha/acisD2000-01-29fef_pha_ctiN0004.fits[2]

Example 3

calquiz none chandra hrc 2d_psf
calfile='CALDB(detnam=hrc-s,fidelity=0:200, quality=:5)' echo_qual=y
echo_fidel=y verbose=1

Found 2 files:
/data/CALDB/ciao/data/chandra/hrc/2d_psf/hrcs1998-11-052dpsf1N0002.fits[
1] CAL_QUAL=0 FIDELITY=166.667
/data/CALDB/ciao/data/chandra/hrc/2d_psf/hrcs1998-11-052dpsf2N0002.fits[
1] CAL_QUAL=0 FIDELITY=83.333

Query the CALDB for Chandra HRC-S detector, product 2D_PSF, Fidelity upto 200 and all available Quality numbers. calquiz is run with "echo_qual=yes" and "echo_fidel=yes", so it returns the files with the values of the corresponding qualities and fideilities.

Parameters

Detailed Parameter Descriptions

Parameter=infile (file required filetype=input)

Input file name

The input file from which the metadata needed to complete the CALDB lookup is obtained. This includes things such as DATE-OBS, DATE-END, INSTRUME, TELESCOP, etc. The file can be either a datamodel file or a parameter file. It can also be left blank and users can use the `telescope' and `instrument' parameters.

Parameter=telescope (string required default=)

Telescope name

The input "telescope" is to replace the "infile" only when the file string is empty. The value of TELESCOP keyword is needed to do the CALDB lookup.

Parameter=instrument (string required default=)

Instrument name

The input "instrument", together with "telescope", is to replace the "infile" when the input file is an empty string. This parameter is optional.

Parameter=product (string required)

Calibration Database product code name

Each data type of data-product in the CALDB has a unique code-name. See the CALDB keywords page for a complete list of code names. Common examples are CTI, DET_GAIN, and P2_RESP.

Parameter=calfile (string required default=CALDB)

The CALDB directive

This parameter indicates that the CALDB should be used to lookup the calibration file and accepts optional arguments to refine the search. Arguments take the form:

  CALDB(PARAMETER=VALUE;PARAMETER=VALUE)

The PARAMETER's above are arbitrary, so if for example the CALDB query needs a value for 'GRATTYPE' but no such header keyword exists, you can specify

CALDB(GRATTYPE=HEG)

There are three special directives:

• QUALITY : this can take single inerger number from 0 to 5, or can take a colon separated range, eg '1:3', ':4', or '0:'. Or it can take -5, equivalent to 0:5, which means to return all files without concerns of the quality values.
• FIDELITY : this can take the values 'HIGHEST', 'LOWEST', or can take a colon separated range, eg '1:3.4', ':4', or '0:'
• MATCH : this can take the values 'ALL', 'FIRST', 'WARNFIRST', 'LAST', 'WARNLAST', 'SINGLE'

Parameter=outfile (string filetype=output)

The selected file with path and extension appended. It might be also appended with 'CAL_QUAL=value' if 'echo_qual=yes' is set and or appended with 'FIDELITY=value' if 'echo_fidel=yes' is set in the run.

This field is populated after the tool has finished running. The information is also printed to the screen if verbose>0.

Parameter=echo (boolean not required default=no)

Echo value to screen?

Determines if the retrieved value is printed to the screen in addition to being stored in the parameter file.

Parameter=echo_qual (boolean not required default=no)

return quality value?

Returns CA_QUAL value(s) along with the corresponding retrieved file(s) if TRUE.

Parameter=echo_fidel (boolean not required default=no)

return fidelity value?

Returns FIDELITY value(s) along with the corresponding retrieved file(s) if TRUE.

Parameter=verbose (integer default=0 min=0 max=5)

Amount of tool output.

Changes in CIAO 4.5

The echo_qual and echo_fidel parameters can now be used to return information about the quality and the fidelity values associated with each CALDB search result.

Changes in CIAO 4.5

• New Tool!

  The calquiz tool is the CALDB 4 version of the tool quizcaldb. It is used to query the CALDB for calibration files which match the given set of conditions.

Bugs

There are no known bugs for this tool.

See Also

calibration

ardlib, caldb

tools

calindex, calmerge, calvalid, check_ciao_caldb