./toolbox/io
File fits__define.pro

Last modification date:

Wed Dec 8 11:57:37 2004

Provides basic interface for reading and writing fits files

Routine Summary  20 routines

procedure fits__define
Provides basic interface for reading and writing fits files

function FITS::init([file_name])
Class Constructor - if file name is passed and it exists, the properties of this file are determined and stored

procedure FITS::update_properties
Determins properties of file and last extension, and sotres them

procedure FITS::update_file_properties
Determines and stores the fits files number of extenions, names & types of each extension, and more info on each extension

procedure FITS::update_last_extension_properties
Determines and stores info on the last extension of the file

procedure FITS::set_file_name, file_name
Sets the full path name of the fits file

function FITS::get_full_file_name()
Retrieves the full path name of the fits file

function FITS::get_file_name()
Retrieves just the file name of the fits file (no path)

function FITS::file_exists([file_name=string])
Checks if fits file represented by object (or keyword) exist on disk

function FITS::get_number_extensions()
Returns the number of extensions of this fits file

function FITS::get_extension_type(ext_num)
Returns the type of the given extension

function FITS::get_extension_name(ext_num)
Returns the name of the given extension

function FITS::get_ext_num_rows(ext_num)
REturns the number of rows for this extension

function FITS::get_rows([ext=long], [row_nums=array])
Returns the contents of the gvein extension and row numbers for this fits file.

procedure FITS::list_extension_header
Prints the contents of the header of the last read extension

function FITS::get_extension_header_value(keyword)
Retrieves the value of a keyword in the last read extension

procedure FITS::create_sdfits_file, file_name
Creates a new blank fits file, with primary header info tagged for Green Bank

procedure FITS::write_rows_new_extension, rows, virtuals
Appends a new extension to fits file and adds rows to it.

procedure FITS::append_rows_to_extension, rows
Appends rows to last extension in fits file

function FITS::make_header_array(virtuals)
Converts a structure containing keyword-values and returns a string array suitable for using to add to extension header

Routine Details

fits__define

procedure fits__define

Provides basic interface for reading and writing fits files

Class Constructor - if file name is passed and it exists, the properties of this file are determined and stored

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

Determins properties of file and last extension, and sotres them

Uses

FITS::update_file_properties FITS::update_last_extension_properties

Determines and stores the fits files number of extenions, names & types of each extension, and more info on each extension

Uses

FITS_OPEN FITS_CLOSE

Determines and stores info on the last extension of the file

Uses

FXBOPEN FXBCLOSE FITS_HEADER_PARSER::create_extension_header_struct

Sets the full path name of the fits file

Parameters
file_name in string	full path name of fits file

Retrieves the full path name of the fits file

Returns

full path name of fits file

Retrieves just the file name of the fits file (no path)

Returns

file name of fits file

Checks if fits file represented by object (or keyword) exist on disk

Returns

0,1

Uses

file_info

Keywords
file_name in, optional string	full path name of file to check

Returns the number of extensions of this fits file

Returns

number of extensions

Returns the type of the given extension

Returns

extension type

Parameters
ext_num in long	extension number in question

Returns the name of the given extension

Returns

extension name

Parameters
ext_num in long	extension number in question

REturns the number of rows for this extension

Returns

number of rows

Parameters
ext_num in long	extension number

Returns the contents of the gvein extension and row numbers for this fits file. Also updates properties of this extension that was read.

Returns

array of structures representing each row read

Uses

mrdfits FITS::create_extension_header_struct

Keywords
ext in, optional long	extension to read, default = 1
row_nums in, optional array	array of row numbers to read, default=all

Prints the contents of the header of the last read extension

Uses

FITS_HEADER_PARSER::list

Retrieves the value of a keyword in the last read extension

Returns

value of keyword

Uses

FITS_HEADER_PARSER::get_key_value

Parameters
keyword in string	extension header keyword

Creates a new blank fits file, with primary header info tagged for Green Bank

Uses

fxhmake fxwrite fxhmodify

Parameters
file_name in string	full path name of fits file to create

Appends a new extension to fits file and adds rows to it. Additional keywords are added to the extesnion header, and fits files properties are updated.

Uses

FITS::make_header_array mwrfits

Parameters
rows in array	array of structures that mirror rows to be writtein
virtuals in struct	keywords to be written to new extension (other then column specs)

Appends rows to last extension in fits file

Uses

FXBOPEN FXBGROW FXBFIND FXBWRITE FXBFINISH FITS::get_logical_columsn

Parameters
rows in array	array of structs mirroring rows to be appended

Converts a structure containing keyword-values and returns a string array suitable for using to add to extension header

Returns

string array suitable for using to add to extension header.

Parameters
virtuals in struct	structure cointing keyword-values for header