next up previous 107
Next: Groups
Up: Frames
Previous: Frames

Frame headers

There are a number of internal headers that ORAC primitives rely on to correctly reduce data. These headers are retrieved from the files and translated to be used by oracdr. These headers can be used in recipes through the ORAC::Frame::uhdr() method and prepending ORAC_ to each header. For example, to refer to the INSTRUMENT header in a primitive, you would use

my $Frm = new ORAC::Frame('filename.sdf');
my $instrument = $Frm->uhdr('ORAC_INSTRUMENT');

New internal headers can always be created, if necessary, to define some ancillary data needed by a recipe, in an instrument-independent fashion.

The following headers currently exist. Note that not all headers are defined for each instrument or recipe.

AIRMASS_START

Airmass at start of the observation (for a mosaic) or integration (for a raw frame).

AIRMASS_END

Airmass at end of the observation (for a mosaic) or integration (for a raw frame).

CHOP_ANGLE

Position angle of the chop (in degrees).

CHOP_THROW

Throw of the chop with respect to the middle position (in arcseconds).

CONFIGURATION_INDEX

Configuration index. Increments when an instrument's hardware configuration changes.

DEC_BASE

Declination (ORAC_EQUINOX equinox) at the reference position at zero offset (in degrees). The reference position is normally at the array centre, but may be displaced, for example, to avoid the intersections of abutted detector sub-arrays.

DEC_SCALE

Pixel increment along declination axis (in arcsec).

DEC_TELESCOPE_OFFSET

Telescope declination offset with respect to the base position given by DEC_BASE (in arcseconds).

DETECTOR_BIAS

Detector bias voltage (in volts)

DETECTOR_INDEX

Position number in detector scan.

DETECTOR_READ_TYPE

Observing mode, such as STARE, NDSTARE, CHOP.

EQUINOX

Equinox of object position (in years). It should be 2000.

EXPOSURE_TIME

Integration time per exposure (in seconds).

FILTER

Combined filter name.

GAIN

Detector gain (in electrons/ADU).

GRATING_DISPERSION

Grating dispersion (in microns/pixel).

GRATING_NAME

Grating name.

GRATING_ORDER

Grating order.

GRATING_WAVELENGTH

Grating wavelength (in microns).

INSTRUMENT

Instrument name.

NSCAN_POSITIONS

Number of scan positions in scan.

NUMBER_OF_EXPOSURES

Number of exposures in integration.

NUMBER_OF_OFFSETS

Number of jitter offset positions in an observation.

NUMBER_OF_READS

Number of reads per exposure.

OBJECT

Object name from telescope.

OBSERVATION_MODE

Camera mode, such as imaging or spectroscopy. Used for multi-mode instruments like Michelle.

OBSERVATION_NUMBER

Observation number. Observation numbers normally commence at 1 for each night.

OBSERVATION_TYPE

Observation type. Used to determine whether observation is of the OBJECT, DARK, or ARC, for example.

POLARIMETRY

Whether or not polarimetry observations are being done. True (1) if so, false (0) otherwise.

RA_BASE

Right Ascension (ORAC_EQUINOX equinox) at the reference position at zero offset (in degrees). See DEC_SCALE.

RA_SCALE

Pixel increment along right-ascension axis (in arcsec).

RA_TELESCOPE_OFFSET

Telescope right-ascension offset with respect to the base position given by RA_BASE (in arcseconds).

ROTATION

Angle of declination axis with respect to the second (y) axis, measured counterclockwise (in degrees).

SCAN_INCREMENT

Increment between scan positions (in pixels).

SLIT_ANGLE

Position angle of slit (in degrees)

SLIT_NAME

Name of slit.

SPEED_GAIN

Readout speed. The default is Normal.

STANDARD

Is the target a standard-star observation?

UTDATE

UTC date when the observation was made.

UTEND

End time of integration (for raw data) or the observation (for a mosaic).

UTSTART

Start time of integration (for raw data) or the observation (for a mosaic).

WAVEPLATE_ANGLE

Polarimeter waveplate position angle (in degrees).

X_DIM

Number of detectors in a readout column (in pixels).

Y_DIM

Number of detectors in a readout row (in pixels).

X_LOWER_BOUND

Start column of array readout.

X_UPPER_BOUND

End column of array readout.

Y_LOWER_BOUND

Start row of array readout.

Y_UPPER_BOUND

End row of array readout.



next up previous 107
Next: Groups
Up: Frames
Previous: Frames

ORAC-DR -- Programmer's Guide
Starlink User Note 233
Tim Jenness, Frossie Economou, Brad Cavanagh
Joint Astronomy Centre, Hilo, Hawaii
June 2004
E-mail:ussc@star.rl.ac.uk

Copyright © 2004 Particle Physics and Astronomy Research Council