./toolbox/io
line_sdfits__define.pro

FITS
|
+-SDFITS
  |
  +-line_sdfits

All known superclasses:

SDFITS, FITS

Last modification date:

Wed Sep 28 13:27:14 2016

Class provides an interface for reading/writing sdfits files that contain spectral line data.

Fields inherited from SDFITS:

string   FITSVER string   SDFITVER string   SDFITVER_NUMBER longword integer   FROM_GBTIDL longword integer   AUTO_OFFSETS

Fields inherited from FITS:

string   FILE_NAME longword integer   NUM_EXTENSIONS pointer   EXTENSION_NAMES pointer   EXTENSION_TYPES pointer   AXIS object reference   PRIMARY_HEADER object reference   EXT_HEADER longword integer   PROPERTIES_KNOWN longword integer   DEBUG string   VERSION

Routine Summary  4 routines

procedure line_sdfits__define
Class provides an interface for reading/writing sdfits files that contain spectral line data.

function LINE_SDFITS::init([file_name], /new, _EXTRA=_EXTRA)
Class constructor - object is constructed and file may be checked for validity

function LINE_SDFITS::check_file_validity(_EXTRA=_EXTRA)
Checks sdfits file for basic validity, and also that it contains spectral line data

function LINE_SDFITS::flagVegasSpurs(flagFile, [/flagcenteradc])
Set the flags in the supplied flag_file object as appropriate for VEGAS_SPURS using the current contents of this FITS file Nothing is flagged if SDFITVER is not present (any value) and INSTRUME is "VEGAS" in the primary HDU.

Routine Details

line_sdfits__define

procedure line_sdfits__define

Class provides an interface for reading/writing sdfits files that contain spectral line data.

Inherits

sdfits

LINE_SDFITS::init

function LINE_SDFITS::init([file_name], /new, _EXTRA=_EXTRA)

Class constructor - object is constructed and file may be checked for validity

Parameters
file_name in, optional string	full path name to sdfits file

Keywords
new in boolean	is this a new file? _
_EXTRA	.

LINE_SDFITS::check_file_validity

function LINE_SDFITS::check_file_validity(_EXTRA=_EXTRA)

Checks sdfits file for basic validity, and also that it contains spectral line data

Returns

0,1

Uses

SDFITS::check_sdfits_properties

LINE_SDFITS::flagVegasSpurs

function LINE_SDFITS::flagVegasSpurs(flagFile, [/flagcenteradc])

Set the flags in the supplied flag_file object as appropriate for VEGAS_SPURS using the current contents of this FITS file Nothing is flagged if SDFITVER is not present (any value) and INSTRUME is "VEGAS" in the primary HDU. The VEGAS spur columns are also necessary: VSPRPIX, VSPRVAL, VSPDELT.

Returns

number of flags set (integer). 0 if none set.