./toolbox/io
File io_sdfits_writer__define.pro

IO
|
+-IO_SDFITS
  |
  +-IO_SDFITS_LINE
    |
    +-io_sdfits_writer

All known superclasses:

IO_SDFITS_LINE, IO_SDFITS, IO

Last modification date:

Wed Dec 8 11:57:38 2004

IO_SDFITS_WRITER is intended for use by users who wish to write spectral line data to sdfits. See UML for all IO Classes, or IO_SDFITS UML for just the line and continuum sdfits classes.

Routine Summary  4 routines

procedure io_sdfits_writer__define
IO_SDFITS_WRITER is intended for use by users who wish to write spectral line data to sdfits.

procedure IO_SDFITS_WRITER::set_output_file, file_name
Sets the name of the output file, and if the file exists, creates an sdfits object for it

procedure IO_SDFITS_WRITER::set_file, file_name, file_path=string, index_name=string
Sets the file which this object will exclusively be writing to and reading from.

procedure IO_SDFITS_WRITER::write_spectra, spectra, file_name=string
Writes given spectra to an sdfits file.

Routine Details

io_sdfits_writer__define

procedure io_sdfits_writer__define

IO_SDFITS_WRITER is intended for use by users who wish to write spectral line data to sdfits. See UML for all IO Classes, or IO_SDFITS UML for just the line and continuum sdfits classes.

Inherits

io_sdfits_line

Sets the name of the output file, and if the file exists, creates an sdfits object for it

Uses

IO::file_exists IO_SDFITS::add_fits_obj

Parameters
file_name in string	full path name to the file to write to

Sets the file which this object will exclusively be writing to and reading from. Acts much like IO_SDFITS::set_file in the way it forces creation of a new index file

Uses

IO_SDFITS::set_file_path IO_SDFITS_LINE::set_file IO_SDFITS::set_index_file_name IO_SDFITS::free_fits_objs

Parameters
file_name in string	file name (full path or not) of file to use exclusively

Keywords
file_path in string	file path where file_name is found
index_name in string	name to use for the index file

Writes given spectra to an sdfits file. The spectra are translated to their proper form for sdfits, and the rows are written to the output file in extensions based off the data size of each spectrum.

Uses

IO_SDFITS_WRITER::set_output_file IO_SDFITS_WRITER::check_spectrum_size_uniformity IO_SDFITS_WRITER::spectra_to_rows IO_SDFITS_WRITER::write_rows_to_extension IO_SDFITS_WRITER::update_index_with_spectra

Parameters
spectra in array	array of spectrum data containers to write to disk

Keywords
file_name in string	if passed in, this is the name of the output file