next up previous 405
Next: Does the dataset have variance/quality/axis/history information?
Up: Obtaining dataset attributes
Previous: Obtaining dataset shape


Available attributes

Below is a complete list of the results parameters from ndftrace. If the parameter is an array, it will have one element per dimension of the data array (given by parameter NDIM); except for EXTNAM and EXTTYPE where there is one element per extension (given by parameter NEXTN). Several of the axis parameters are only set if the ndftrace input keyword fullaxis is set (not the default). To obtain, say, the data type of the axis centres of the current dataset, the code would look like this.

     ndftrace fullaxis accept > dev/null
     set axtype = `parget atype ndftrace`

Name Array? Meaning
     
AEND Yes The axis upper extents of the NDF. For non-monotonic axes, zero is used. See parameter AMONO. This is not assigned if AXIS is FALSE.
AFORM Yes The storage forms of the axis centres of the NDF. This is only written when parameter FULLAXIS is TRUE and AXIS is TRUE.
ALABEL Yes The axis labels of the NDF. This is not assigned if AXIS is FALSE.
AMONO Yes These are TRUE when the axis centres are monotonic, and FALSE otherwise. This is not assigned if AXIS is FALSE.
ANORM Yes The axis normalisation flags of the NDF. This is only written when FULLAXIS is TRUE and AXIS is TRUE.
ASTART Yes The axis lower extents of the NDF. For non-monotonic axes, zero is used. See parameter AMONO. This is not assigned if AXIS is FALSE.
ATYPE Yes The data types of the axis centres of the NDF. This is only written when FULLAXIS is TRUE and AXIS is TRUE.
AUNITS Yes The axis units of the NDF. This is not assigned if AXIS is FALSE.
AVARIANCE Yes Whether or not there are axis variance arrays present in the NDF. This is only written when FULLAXIS is TRUE and AXIS is TRUE.
AXIS   Whether or not the NDF has an axis system.
BAD   If TRUE, the NDF's data array may contain bad values.
BADBITS   The BADBITS mask. This is only valid when QUALITY is TRUE.
CURRENT   The integer Frame index of the current co-ordinate Frame in the WCS component.
DIMS Yes The dimensions of the NDF.
EXTNAME Yes The names of the extensions in the NDF. It is only written when NEXTN is positive.
EXTTYPE Yes The types of the extensions in the NDF. Their order corresponds to the names in EXTNAME. It is only written when NEXTN is positive.
FDIM Yes The numbers of axes in each co-ordinate Frame stored in the WCS component of the NDF. The elements in this parameter correspond to those in FDOMAIN and FTITLE. The number of elements in each of these parameters is given by NFRAME.
FDOMAIN Yes The domain of each co-ordinate Frame stored in the WCS component of the NDF. The elements in this parameter correspond to those in FDIM and FTITLE. The number of elements in each of these parameters is given by NFRAME.
FLABEL Yes The axis labels from the current WCS Frame of the NDF.
FLBND Yes The lower bounds of the bounding box enclosing the NDF in the current WCS Frame. The number of elements in this parameter is equal to the number of axes in the current WCS Frame (see FDIM).
FORM   The storage form of the NDF's data array.
FTITLE Yes The title of each co-ordinate Frame stored in the WCS component of the NDF. The elements in this parameter correspond to those in FDOMAIN and FDIM. The number of elements in each of these parameters is given by NFRAME.
     

Name Array? Meaning
     
FUBND Yes The upper bounds of the bounding box enclosing the NDF in the current WCS Frame. The number of elements in this parameter is equal to the number of axes in the current WCS Frame (see FDIM).
FUNIT Yes The axis units from the current WCS Frame of the NDF.
HISTORY   Whether or not the NDF contains HISTORY records.
LABEL   The label of the NDF.
LBOUND Yes The lower bounds of the NDF.
NDIM   The number of dimensions of the NDF.
NEXTN   The number of extensions in the NDF.
NFRAME   The number of WCS domains described by FDIM, FDOMAIN and FTITLE. Set to zero if WCS is FALSE.
QUALITY   Whether or not the NDF contains a QUALITY array.
TITLE   The title of the NDF.
TYPE   The data type of the NDF's data array.
UBOUND Yes The upper bounds of the NDF.
UNITS   The units of the NDF.
VARIANCE   Whether or not the NDF contains a VARIANCE array.
WCS   Whether or not the NDF has any WCS co-ordinate Frames, over and above the default GRID, PIXEL and AXIS Frames.
WIDTH Yes Whether or not there are axis width arrays present in the NDF. This is only written when FULLAXIS is TRUE and AXIS is TRUE.
     



next up previous 405
Next: Does the dataset have variance/quality/axis/history information?
Up: Obtaining dataset attributes
Previous: Obtaining dataset shape

C-shell Cookbook
Starlink Cookbook 4
Malcolm J. Currie
2006 November 26
E-mail:ussc@star.rl.ac.uk

Copyright © 2009 Science and Technology Facilities Council