./toolbox/io
io_sdfits__define.pro

IO
|
+-io_sdfits

All known superclasses:

IO

Last modification date:

Wed Sep 28 13:27:14 2016

IO_SDFITS is the base class for spectral line and continuum sdfits classes. All the general functionality for reading, writing, navigating sdfits files, and for; translating their info to data containers is placed in this class. See UML for all IO Classes, or IO_SDFITS UML for just the line and continuum sdfits classes.

Fields Summary
FILE_PATH string	The path in which index and sdfits files are to be found
FITS_FILES pointer	An array of pointers to objects, one for each sdfits file
INDEX object reference	Object which manages the index file
FLAGS object reference	.
INDEX_SYNCED longword integer	Flag which signals wether index and fits files are in sync
UPDATE_EXPANDED_FILES longword integer	Flag determining wether index files are updated to keep in sink with an expanded fits file
ONE_FILE longword integer	Flag for determining if this object is locked into working with just one file
OBSERVER string	should not be here?
TCAL_TABLE string	should not be here?
BACKEND string	should not be here?
LAST_RECORD longword integer	.
ONLINE longword integer	.
UPDATE_IN_PROGRESS longword integer	.
ONLINE_STATUS object reference	.
DEBUG longword integer	Flag that determines the verbosity of object

Fields inherited from IO:

string   VERSION

Routine Summary  103 routines

procedure io_sdfits__define
IO_SDFITS is the base class for spectral line and continuum sdfits classes.

function IO_SDFITS::init()	private
Class Constructor.

procedure IO_SDFITS::cleanup	private
Class cleanup on deletion: cleans up index object and sdfits objects

procedure IO_SDFITS::set_debug_on
The class can be made to verbosly describe what its doing

procedure IO_SDFITS::set_debug_off
The class can be made to be quite

procedure IO_SDFITS::set_project, dir, _EXTRA=_EXTRA
This method looks into the given directory and attempts to load any existing index file.

procedure IO_SDFITS::set_file, file_name[, status], file_path=string, index_name=string, online=online, _EXTRA=_EXTRA
This method can be used to lock the io object into working with only one sdfits file.

procedure IO_SDFITS::add_file, file_name[, status], /new_index, index_name=index_name, max_nrows=max_nrows
This method is the main interface to the sdfits io classes.

procedure IO_SDFITS::load_index_flag_info
For every sdfits file managed by the current index file, the flags object is updated with info from these files.

procedure IO_SDFITS::init_index	private
Creates a new index file using current info (file_path, observer, etc.

procedure IO_SDFITS::load_index, file_name, file_path=string
This method will read an index file, check that the index agrees with the sdfits files on disk, and create fits objects for the files listed in its index.

procedure IO_SDFITS::read_index, file_name	private
Calls index file's read_file method

procedure IO_SDFITS::add_fits_obj, file_name, result, _EXTRA=_EXTRA	private
Creates a fits object for the file name passed to it, and adds it to the list of fits objects

procedure IO_SDFITS::add_fits_objs, file_names	private
From an array of full path names to sdfits files, create an array of sdfits objects

procedure IO_SDFITS::create_index_file, index_file_name	private
Creates a new index file, populating it with information from all the fits object

procedure IO_SDFITS::set_project_create_index_file, file_paths	private
Creates a new index files for an entire project, this includes the master index file for the directory and all the auxillary index files, one per fits file.

procedure IO_SDFITS::create_index_for_fits_obj, index_file_name, fits_obj, status
Every sdfits file that is read in must have an index file.

procedure IO_SDFITS::update_flags_with_fits_file, fits_obj
For every sdfits file managed by the current index file, the flags object must be able to convert the record numbers in the current index file to record numbers stored in each flag file.

function IO_SDFITS::conform_to_index()	private
Checks to make sure index file that is loaded agrees with this object, and will create new sdfits objects if necessary to conform.

procedure IO_SDFITS::conform_fits_objs_to_index	private
Called after loading an index, gets all files in index and calls conform_fits_objs

procedure IO_SDFITS::conform_fits_objs, file_names	private
Checks that the list of file names passed to it are all represented by fits objects.

function IO_SDFITS::get_full_file_name(file_name)	private
Takes in a file name string and returns the full path, with prepended path if needed.

procedure IO_SDFITS::set_file_path, file_path
Sets the path where index file and all sdfits files are to be found

function IO_SDFITS::get_file_path()
Gets the path where index file and all sdfits files are to be found

function IO_SDFITS::is_data_loaded()
Checks to see if this object has any sdfits files connected to it.

procedure IO_SDFITS::set_index_file_name, file_name
Sets the file name of the index file.

function IO_SDFITS::get_index_file_name([/full])
Retrieves the file name of the index file.

function IO_SDFITS::find_fits(file_name)	private
Given the full path name of an sdfits file, returns the object that represents that file

function IO_SDFITS::get_fits_file_names()	private

function IO_SDFITS::get_fits(file_name)	private

function IO_SDFITS::get_number_extensions(file_name)	private
Retrieves the number of extensions for the given sdfits file

function IO_SDFITS::get_extension_type(ext_num, file_name)	private
Retrieves the extension type for the given sdfits file and extension

function IO_SDFITS::get_extension_name(ext_num, file_name)	private
Retrieves the extension name for the given sdfits file and extension

function IO_SDFITS::get_ext_num_rows(ext_num, file_name)	private
Retrieves the number of rows for the given sdfits file and extension

procedure IO_SDFITS::list[, start][, finish], [sortcol=string], /verbose, [/user], [columns=string array], [file=string], _EXTRA=_EXTRA
Prints out rows from the index file used by object.

function IO_SDFITS::get_index(_EXTRA=_EXTRA)
Returns indicies of rows in index file that match search.

function IO_SDFITS::get_scan_info(scan_number[, file], count=variable, [/quiet])
Returns an array of structures that contains info about the scan number given, such as scan number, procedure name, number of integrations, ifs, etc.

procedure IO_SDFITS::list_index_header
Prints out the header section of the index file used by this object

function IO_SDFITS::get_index_values(column_name, _EXTRA=_EXTRA)
Returns the values contained in the index file column used by this object

function IO_SDFITS::get_index_files(_EXTRA=_EXTRA, full=full)
Returns the unique file names (no path) contained in the index file used by this object

function IO_SDFITS::get_index_projects(_EXTRA=_EXTRA)
Returns the unique project names (no path) contained in the index file used by this object

function IO_SDFITS::get_index_sources(_EXTRA=_EXTRA)
Returns the unique source names (no path) contained in the index file used by this object

function IO_SDFITS::get_index_procedures(_EXTRA=_EXTRA)
Returns the unique procedure names (no path) contained in the index file used by this object

function IO_SDFITS::get_index_scans(_EXTRA=_EXTRA)
Returns the unique scan names (no path) contained in the index file used by this object

function IO_SDFITS::group_row_info(row_info)	private
Groups rows from the index table and sorts them by file-extension, since if we read these rows we want to do that efficiently (one file-extension at a time).

function IO_SDFITS::get_sdfits_rows(row_group)	private
Deprecated function: given a listing of rows from the same file-extension, this uses an sdfits objects to simply return those rows from the file.

function IO_SDFITS::get_and_eval_rows(row_group, missing, virtuals, apply_offsets)	private
Given a listing of rows from the same file-extension, this uses an sdfits object to simply return those rows from the file and evaluate what columns are missing and what are the keywords for the extension

function IO_SDFITS::get_row_value(row, tag_name, virtuals, names, default_value)	private
Method for attempting to extract a value from an sdfits row.

function IO_SDFITS::format_sdfits_polarization(pol)	private
Translates the polarization from the sdfits integer value into a char based value

function IO_SDFITS::format_sdfits_freq_type(freq_type)	private
Translates the sdfits string for frequency type to the gbtidl representation CTYPE1 has two parts: First 4 characters are the type of quantity on that axis.

function IO_SDFITS::format_sdfits_procedure(obsmode)	private
Deprecated

procedure IO_SDFITS::parse_sdfits_obsmode, obsmode, proc, swstate, swtchsig	private
Translates the sdfits value for obsmode into seperate procedure, switch state and switch signal values

function IO_SDFITS::coord_mode_from_types(long_type, lat_type)	private
Incomplete: Translates the sdfits values for longitutde and latitude type into a coordinate mode.

function IO_SDFITS::translate_cal(cal)	private
Translates sdfits cal string value into 1 or 0

function IO_SDFITS::translate_sig(sig)	private
Translates sdfits sig string value into 1 or 0

procedure IO_SDFITS::free_fits_objs	private
Releases the memory for all the current sdfits objects for this object

procedure IO_SDFITS::set_debug_for_fits_objs, debug	private
Sets debug flag for all fits objs

function IO_SDFITS::are_index_file_indicies_unique()
Diagnostic function to determine if index file indicies are unique (as they should be)

procedure IO_SDFITS::set_more_format_on
Sets the object to print rows using the interactive 'more' format

procedure IO_SDFITS::set_more_format_off
Sets the object NOT to print rows using the interactive 'more' format

procedure IO_SDFITS::list_available_columns
Prints the available columns from the rows section for list; these are also the valid search keywords

procedure IO_SDFITS::set_user_columns, columns
Sets what columns should be used for user listing

procedure IO_SDFITS::list_user_columns
Prints the columns currently selected for the user specified listing

function IO_SDFITS::get_num_index_rows()
Retrieves number of records the object is connected to - or how many rows currently in the index file

function IO_SDFITS::sort_search_results(results, column)
Given an integer array representing some rows in the index, sorts this array by a given column name in the index file

function IO_SDFITS::get_expected_full_index_name(fits_obj)
Given a fits file name of form '/path/filename.

function IO_SDFITS::update_index_with_other_index(index_name)
Instead of adding rows to an index file by reading in an sdfits file, this method attempts to take advantage of a pre-existing index files info.

function IO_SDFITS::get_index_name_from_fits_name(fits_name)
Takes a file named *.

procedure IO_SDFITS::set_flag, scan, _EXTRA=_EXTRA
Sets a flagging rule for a given scan(s) along with other options according to the current flagging version.

procedure IO_SDFITS::set_flag_rec, recnum, _EXTRA=_EXTRA
Sets a flagging rule for a given record number(s) along with other options according to the current flagging version.

function IO_SDFITS::get_scans_in_index(scans[, count], [quiet=bool])
Given a set of scan numbers, returns which scans can currently be found in the index file.

function IO_SDFITS::get_recnums_in_index(recnums[, count], [quiet=bool])
Given a set of record numbers, returns which records can currently be found in the index file.

function IO_SDFITS::get_flag_file_names([count], [recnum=long], [scan=long])
When certain spectra are being flagged, which flag files need to be used? This can be determined by finding in which fits file the record and scan numbers being flagged reside.

procedure IO_SDFITS::list_flags, _EXTRA=_EXTRA
For printing flag files' contents

procedure IO_SDFITS::list_flag_ids
Prints all unique IDSTRINGS in flag files

function IO_SDFITS::get_flag_lines([count], _EXTRA=_EXTRA)
Returns contents of all flag files idstring keyword allows retrieving only specific IDSTRINGs

procedure IO_SDFITS::unflag, id, [/all], /quiet
Removes the flag(s) associated with the id passed in.

function IO_SDFITS::find_exact_matches(search_arr, values[, total_count])
Finds where multiple values occur in an array.

procedure IO_SDFITS::find_values_plus_and, array, values, and_result	private
Used for making a search in an array and ANDing the results with previous searches

function IO_SDFITS::find_flagged_data(dcs, flag[, count])
For a given flag structure, determines which of the given data containers' this flag applies to.

function IO_SDFITS::find_flagged_data_field(data_field, flag_strct, flag_field_name, result)
Looks for matches between a given array of values, and a field in a given flagging structure.

procedure IO_SDFITS::flag_data, dcs, flag
Once it has been determined which flags apply to which data containers, this method actually blanks the data containers data, using the bchan and echan fields.

function IO_SDFITS::IS_SCAN_FLAGGED(scan, [idstring=idstring])
Find if the specific scan has been flagged at all.

function IO_SDFITS::get_columns(columns, [_EXTRA=structure])
Get the named columns as a set of vectors in a structure from the associated data file(s) using any supplied selection criteria.

function IO_SDFITS::find_flagged_index_data(indicies, recnum_string[, count])
For finding what data containers have been flagged via record number.

procedure IO_SDFITS::set_flag_file_version, version_num, version_class
For testing purposes only.

function IO_SDFITS::validate_param_value_type(value, type, name, [quiet=bool])
Checks a given value against a given type

function IO_SDFITS::validate_param_value_types(value, types, name, [quiet=bool])
Checks to make sure that the given value is one of the given types.

function IO_SDFITS::validate_param_list_types(values_strct, param_types, _EXTRA=_EXTRA)
Generic method used for checking keywords used in both flagging commands and index searches.

function IO_SDFITS::get_param_index(param_names, param_name[, count])
Looks for a keyword passed in for such methods as index searches or or flag commands in the list of valid names.

function IO_SDFITS::check_param_syntax(param_name, value, _EXTRA=_EXTRA)

function IO_SDFITS::get_single_param_types(param_name)

function IO_SDFITS::get_index_param_types()
All the index file columns can be searched against, using keyword arguments.

function IO_SDFITS::get_flag_param_types()
Most of the keywords used in a flagging command match against the columns found in a flag file.

function IO_SDFITS::check_flag_param_syntax(_EXTRA=_EXTRA, [quiet=bool])
Checks the parameters used in a flagging command Checks for validity of both type and range syntax.

function IO_SDFITS::check_search_param_syntax(_EXTRA=_EXTRA, [quiet=bool])
Checks the parameters used for a search, be it for a list command, or get_* method.

function IO_SDFITS::validate_string_value(value, types, quiet=quiet)
Used to check the validaty of values passed into keywords used with index and flagging commands.

function IO_SDFITS::validate_integer_range(value)
Sometimes keywords that take integers can be passed in a string representing a a range of integers.

function IO_SDFITS::validate_float_range(value)
Sometimes keywords that take floats can be passed in a string representing a float to a certain perscion, or a range of floats.

function IO_SDFITS::validate_string_range(values)
For some keywords, strings can be used with wildcards either at the begining or end of the string.

function IO_SDFITS::get_last_record()
Retrieves the last record, or index number to be retrieved from a get_* method

function IO_SDFITS::get_flags_obj()
Get access to the associated flags object

procedure IO_SDFITS::flags_show_state
Debugging function to explore the FLAG state

Routine Details

io_sdfits__define

procedure io_sdfits__define

IO_SDFITS is the base class for spectral line and continuum sdfits classes. All the GENERAL functionality for reading, writing, navigating sdfits files, and for; translating their info to data containers is placed in this class. See UML for all IO Classes, or IO_SDFITS UML for just the line and continuum sdfits classes.

Inherits

io

Version

$Id$

IO_SDFITS::init

private

function IO_SDFITS::init()

Class Constructor. Initialize the object

Uses

IO::init

IO_SDFITS::cleanup

private

procedure IO_SDFITS::cleanup

Class cleanup on deletion: cleans up index object and sdfits objects

IO_SDFITS::set_debug_on

procedure IO_SDFITS::set_debug_on

The class can be made to verbosly describe what its doing

IO_SDFITS::set_debug_off

procedure IO_SDFITS::set_debug_off

The class can be made to be quite

IO_SDFITS::set_project

procedure IO_SDFITS::set_project, dir, _EXTRA=_EXTRA

This method looks into the given directory and attempts to load any existing index file. If the file does not exist, all sdfits files in this directory are loaded using the add_file method, and a new index is created. For a complete description, see the flowchart.

Examples

    path = '/users/me/my_project'
    io = obj_new('io_sdfits_line')
    io->set_project, path 
   

Uses

add_file

Parameters
dir in string	The path in which all sdfits files and possibly the index file are to be found

Keywords
_EXTRA	.

IO_SDFITS::set_file

procedure IO_SDFITS::set_file, file_name[, status], file_path=string, index_name=string, online=online, _EXTRA=_EXTRA

This method can be used to lock the io object into working with only one sdfits file. An index file is automatically created (overwrites pre-existing one).

Examples

   io = obj_new('io_sdfits_cntm')
   io->set_file, 'TREG_04_01.dcr.raw.fits'
   

Uses

add_file

Parameters
file_name in string	The file name of the sdfits file (no path)
status out, optional variable	1 - success, 0 - failure

Keywords
file_path in string	Where to find the sdfits file
index_name in string (def. 'file_name.index')	What to call the new index file
online	.
_EXTRA	.

IO_SDFITS::add_file

procedure IO_SDFITS::add_file, file_name[, status], /new_index, index_name=index_name, max_nrows=max_nrows

This method is the main interface to the sdfits io classes. It is used in turn by set_project and set_file. Most of the logic for keeping the index file in sync with the fits files is coded in this method. For a complete description, see the flowchart.

Examples

    path = '/users/me/my_project'
    io = obj_new('io_sdfits_line')
    io->set_file_path, path 
    io->add_file, 'TREG_O1_04.acs.raw.fits'
 

Parameters
file_name in string	Name of sdfits file to add (no path)
status out, optional variable	1 - success, 0 - failure

Keywords
new_index in boolean (def. 0)	Forces the creation of a new index file (overwrites pre-existing index)
index_name	.
max_nrows	.

IO_SDFITS::load_index_flag_info

procedure IO_SDFITS::load_index_flag_info

For every sdfits file managed by the current index file, the flags object is updated with info from these files.

IO_SDFITS::init_index

private

procedure IO_SDFITS::init_index

Creates a new index file using current info (file_path, observer, etc.) for index header.

IO_SDFITS::load_index

procedure IO_SDFITS::load_index, file_name, file_path=string

This method will read an index file, check that the index agrees with the sdfits files on disk, and create fits objects for the files listed in its index.

Examples

    path = '/users/me/my_project'
    io = obj_new('io_sdfits_line')
    io->load_index, 'my_index', file_path='/users/me/my_project'
 

IO_SDFITS::read_index

private

procedure IO_SDFITS::read_index, file_name

Calls index file's read_file method

Uses

INDEX_FILE::read_file

IO_SDFITS::add_fits_obj

private

procedure IO_SDFITS::add_fits_obj, file_name, result, _EXTRA=_EXTRA

Creates a fits object for the file name passed to it, and adds it to the list of fits objects

Uses

IO_SDFITS::get_full_file_name IO_SDFITS::get_new_fits_obj

IO_SDFITS::add_fits_objs

private

procedure IO_SDFITS::add_fits_objs, file_names

From an array of full path names to sdfits files, create an array of sdfits objects

Parameters
file_names	.

IO_SDFITS::create_index_file

private

procedure IO_SDFITS::create_index_file, index_file_name

Creates a new index file, populating it with information from all the fits object

Uses

SDFITS::get_rows FITS::get_extension_header_value IO_SDFITS::init_index IO_SDFITS::update_index_with_fits_file

IO_SDFITS::set_project_create_index_file

private

procedure IO_SDFITS::set_project_create_index_file, file_paths

Creates a new index files for an entire project, this includes the master index file for the directory and all the auxillary index files, one per fits file. This is a variation of create_index_file.

Parameters
file_paths in, required array	array of full path names to fits files

IO_SDFITS::create_index_for_fits_obj

procedure IO_SDFITS::create_index_for_fits_obj, index_file_name, fits_obj, status

Every sdfits file that is read in must have an index file. Even if multiple sdfits files are managed by a single index file, this master index file gets its info from the individual index files. This method creates an index file for the given fits object.

Parameters
index_file_name	.
fits_obj	.
status	.

IO_SDFITS::update_flags_with_fits_file

procedure IO_SDFITS::update_flags_with_fits_file, fits_obj

For every sdfits file managed by the current index file, the flags object must be able to convert the record numbers in the current index file to record numbers stored in each flag file.

Parameters
fits_obj in, required object	object representing an sdfits file referred to in the current index.

IO_SDFITS::conform_to_index

private

function IO_SDFITS::conform_to_index()

Checks to make sure index file that is loaded agrees with this object, and will create new sdfits objects if necessary to conform.

Uses

INDEX_FILE::get_column_values INDEX_FILE::get_header_value IO_SDFITS::file_exists INDEX_FILE::search_for_row_info IO_SDFITS::group_row_info FITS_OPEN FITS_CLOSE IO_SDFITS::free_group_row_info IO_SDFITS::conform_fits_objs IO_SDFITS::set_file_path

IO_SDFITS::conform_fits_objs_to_index

private

procedure IO_SDFITS::conform_fits_objs_to_index

Called after loading an index, gets all files in index and calls conform_fits_objs

Uses

IO_SDFITS::get_index_files IO_SDFITS::conform_fits_objs

IO_SDFITS::conform_fits_objs

private

procedure IO_SDFITS::conform_fits_objs, file_names

Checks that the list of file names passed to it are all represented by fits objects. If not, the fits objects are created from scratch.

Uses

IO_SDFITS::get_fits IO_SDFITS::add_fits_objs

IO_SDFITS::get_full_file_name

private

function IO_SDFITS::get_full_file_name(file_name)

Takes in a file name string and returns the full path, with prepended path if needed. If the object has no file path, then the file name is returned unaltered. If the object DOES have a file path, then the passed in file name is checked for backslashes. If there is no backslash, the objects file path is prepended to the file name and passed back.

Returns

Either the original passed in file name, or the full path file name.

IO_SDFITS::set_file_path

procedure IO_SDFITS::set_file_path, file_path

Sets the path where index file and all sdfits files are to be found

Examples

    path = '/users/me/my_project'
    io = obj_new('io_sdfits_line')
    io->set_file_path, path 
 

IO_SDFITS::get_file_path

function IO_SDFITS::get_file_path()

Gets the path where index file and all sdfits files are to be found

Returns

{type=string} Path where index file and all sdfits files are to be found.

Examples

    path = '/users/me/my_project'
    io = obj_new('io_sdfits_line')
    io->set_project, path
    print, io->get_file_path()
    '/users/me/my_project'
 

IO_SDFITS::is_data_loaded

function IO_SDFITS::is_data_loaded()

Checks to see if this object has any sdfits files connected to it.

Returns

0 - data is not loaded; 1 - data is loaded.

IO_SDFITS::set_index_file_name

procedure IO_SDFITS::set_index_file_name, file_name

Sets the file name of the index file.

Parameters
file_name	.

IO_SDFITS::get_index_file_name

function IO_SDFITS::get_index_file_name([/full])

Retrieves the file name of the index file.

Returns

The file name of the index file

IO_SDFITS::find_fits

private

function IO_SDFITS::find_fits(file_name)

Given the full path name of an sdfits file, returns the object that represents that file

Returns

The index for the sdfits object to represent that represents this file, or -1 if object not found

Uses

IO_SDFITS::get_full_file_name

IO_SDFITS::get_fits_file_names

private

function IO_SDFITS::get_fits_file_names()

Returns

an array of the file names of all of the FITS files associated with this io_sdfits object. Returns -1 if none or not initialized.

IO_SDFITS::get_fits

private

function IO_SDFITS::get_fits(file_name)

Returns

The the sdfits object to represent that represents this file, or -1 if object not found

Uses

IO_SDFITS::find_fits

IO_SDFITS::get_number_extensions

private

function IO_SDFITS::get_number_extensions(file_name)

Retrieves the number of extensions for the given sdfits file

Returns

number of extensions for file_name

IO_SDFITS::get_extension_type

private

function IO_SDFITS::get_extension_type(ext_num, file_name)

Retrieves the extension type for the given sdfits file and extension

Returns

extension type for file_name and extension

IO_SDFITS::get_extension_name

private

function IO_SDFITS::get_extension_name(ext_num, file_name)

Retrieves the extension name for the given sdfits file and extension

Returns

extension name for file_name and extension number

IO_SDFITS::get_ext_num_rows

private

function IO_SDFITS::get_ext_num_rows(ext_num, file_name)

Retrieves the number of rows for the given sdfits file and extension

Returns

number of rows for file_name and extension

IO_SDFITS::list

procedure IO_SDFITS::list[, start][, finish], [sortcol=string], /verbose, [/user], [columns=string array], [file=string], _EXTRA=_EXTRA

Prints out rows from the index file used by object. For exact search parameters to enter, see LINE_INDEX::search_index or CNTM_INDEX::search_index

Parameters
start in, optional long	where to start the range to list
finish in, optional long	where to stop the range to list

Keywords
sortcol in, optional string	what index column name to order listwith
verbose in boolean (def. 0)	Print out ALL information?
user in, optional boolean	print out columns specified using set_user_columns? Takes precedence over verbose keyword
columns in, optional string array	array of column names to print out upon list command. Takes precedence over user and verbose keywords.
file in, optional string (def. /dev/tty)	The file to write to. Defaults to the current screen, using "more" to page the output.
_EXTRA	.

IO_SDFITS::get_index

function IO_SDFITS::get_index(_EXTRA=_EXTRA)

Returns indicies of rows in index file that match search. For exact search parameters to enter, see LINE_INDEX::search_index or CNTM_INDEX::search_index

Returns

Long array of indicies of rows in index file that match search

Uses

INDEX_FILE::search_index

Keywords
_EXTRA	.

IO_SDFITS::get_scan_info

function IO_SDFITS::get_scan_info(scan_number[, file], count=variable, [/quiet])

Returns an array of structures that contains info about the scan number given, such as scan number, procedure name, number of integrations, ifs, etc.. A separate element is returned for each unique TIMESTAMP and file for all rows having that scan number.

Returns

Array of structure containing info on scan

Uses

INDEX_FILE::get_scan_info

IO_SDFITS::list_index_header

procedure IO_SDFITS::list_index_header

Prints out the header section of the index file used by this object

Uses

INDEX_FILE::list_header

IO_SDFITS::get_index_values

function IO_SDFITS::get_index_values(column_name, _EXTRA=_EXTRA)

Returns the values contained in the index file column used by this object

Returns

the values found in the index column name specified.

Uses

INDEX_FILE::get_column_values

IO_SDFITS::get_index_files

function IO_SDFITS::get_index_files(_EXTRA=_EXTRA, full=full)

Returns the unique file names (no path) contained in the index file used by this object

Returns

The unique file names (no path) contained in the index file used by this object

Uses

INDEX_FILE::get_column_values

IO_SDFITS::get_index_projects

function IO_SDFITS::get_index_projects(_EXTRA=_EXTRA)

Returns the unique project names (no path) contained in the index file used by this object

Returns

The unique project names (no path) contained in the index file used by this object

Uses

INDEX_FILE::get_column_values

IO_SDFITS::get_index_sources

function IO_SDFITS::get_index_sources(_EXTRA=_EXTRA)

Returns the unique source names (no path) contained in the index file used by this object

Returns

The unique source names (no path) contained in the index file used by this object

Uses

INDEX_FILE::get_column_values

IO_SDFITS::get_index_procedures

function IO_SDFITS::get_index_procedures(_EXTRA=_EXTRA)

Returns the unique procedure names (no path) contained in the index file used by this object

Returns

The unique procedure names (no path) contained in the index file used by this object

Uses

INDEX_FILE::get_column_values

IO_SDFITS::get_index_scans

function IO_SDFITS::get_index_scans(_EXTRA=_EXTRA)

Returns the unique scan names (no path) contained in the index file used by this object

Returns

The unique scan names (no path) contained in the index file used by this object

Uses

INDEX_FILE::get_column_values

IO_SDFITS::group_row_info

private

function IO_SDFITS::group_row_info(row_info)

Groups rows from the index table and sorts them by file-extension, since if we read these rows we want to do that efficiently (one file-extension at a time).

Returns

an array of structures, each struct representing index file rows grouped by file-extension.

IO_SDFITS::get_sdfits_rows

private

function IO_SDFITS::get_sdfits_rows(row_group)

Deprecated function: given a listing of rows from the same file-extension, this uses an sdfits objects to simply return those rows from the file.

Returns

array of structs mirroring the rows in the sdfits file specified to read in.

Uses

IO_SDFITS::get_fits SDFITS::get_sdfits_rows

IO_SDFITS::get_and_eval_rows

private

function IO_SDFITS::get_and_eval_rows(row_group, missing, virtuals, apply_offsets)

Given a listing of rows from the same file-extension, this uses an sdfits object to simply return those rows from the file and evaluate what columns are missing and what are the keywords for the extension

Returns

array of structs mirroring the rows in the sdfits file specified to read in.

Uses

IO_SDFITS::get_fits SDFITS::get_and_eval_rows

IO_SDFITS::get_row_value

private

function IO_SDFITS::get_row_value(row, tag_name, virtuals, names, default_value)

Method for attempting to extract a value from an sdfits row. If the row contains the tag name requested, that value is passed back. If that tag name actually specifies a keyword in the extension-header, and NOT a column, then that value is returned. Finally, if the tag name matches one of the expected column names that were not found in this extension, the default value is returned.

Returns

either the value of row.tag_name, virtauls.tag_name, or default_value

IO_SDFITS::format_sdfits_polarization

private

function IO_SDFITS::format_sdfits_polarization(pol)

Translates the polarization from the sdfits integer value into a char based value

Returns

Char representation of polarization

IO_SDFITS::format_sdfits_freq_type

private

function IO_SDFITS::format_sdfits_freq_type(freq_type)

Translates the sdfits string for frequency type to the gbtidl representation CTYPE1 has two parts: First 4 characters are the type of quantity on that axis. Possible values are: FREQ == frequency. The axis is linear in frequency. VELO == velocity. The axis is linear in velocity. FELO == The axis is linear in frequency, but the quantities describing it are given in velocity units in the optical convention. These all date from a AIPS memo by Eric Griesen from November of 1983. The WCS paper III finally gets it right and eventually we'll have to update SDFITS to do that as Arecibo apparently has done. SDFITS, though, is still stuck in 1983. The second 4 characters describe the reference frame. These come from M&C, which uses these codes: OBS - observed (sky frequencies) GEO - geocentric BAR - barycentric HEL - heliocentric GAL - galactic LSR - Local Standard of Rest (equivalent to Kinematic LSR or LSRK) LSD - Dynamic Local Standard of Rest LGR - Local group CMB - Cosmic Microwave Background There's a "-" as the first character in this second set of 4. For reasons I can't remember, we decided that OBS should be translated to TOPO but everything else was okay as is. The sdfits tool at the moment always sets CTYPE1=FREQ-OBS, but of course other SDFITS files might have other combinations. For the moment, ensure that the first 4 characters are FREQ, and set frequency_type to the characters after the "-", translating "OBS" to "TOPO". Eventually, we'll want to translate VELO and FELO to true FREQ axes in the data container, but I think you should just reject those for now and come back to it later.

Parameters
freq_type	.

IO_SDFITS::format_sdfits_procedure

private

function IO_SDFITS::format_sdfits_procedure(obsmode)

Deprecated

Parameters
obsmode	.

IO_SDFITS::parse_sdfits_obsmode

private

procedure IO_SDFITS::parse_sdfits_obsmode, obsmode, proc, swstate, swtchsig

Translates the sdfits value for obsmode into seperate procedure, switch state and switch signal values

Parameters
obsmode in string	the obsmode column from sdfits; takes form 'proc:swstate:swtchsig'
proc out variable	procedure
swstate out variable	switch state
swtchsig out variable	switch signal

IO_SDFITS::coord_mode_from_types

private

function IO_SDFITS::coord_mode_from_types(long_type, lat_type)

Incomplete: Translates the sdfits values for longitutde and latitude type into a coordinate mode.

Returns

coordinate mode

IO_SDFITS::translate_cal

private

function IO_SDFITS::translate_cal(cal)

Translates sdfits cal string value into 1 or 0

Returns

1,0

IO_SDFITS::translate_sig

private

function IO_SDFITS::translate_sig(sig)

Translates sdfits sig string value into 1 or 0

Returns

1,0

IO_SDFITS::free_fits_objs

private

procedure IO_SDFITS::free_fits_objs

Releases the memory for all the current sdfits objects for this object

IO_SDFITS::set_debug_for_fits_objs

private

procedure IO_SDFITS::set_debug_for_fits_objs, debug

Sets debug flag for all fits objs

Parameters
debug	.

IO_SDFITS::are_index_file_indicies_unique

function IO_SDFITS::are_index_file_indicies_unique()

Diagnostic function to determine if index file indicies are unique (as they should be)

Returns

0 - bad, 1 - good

IO_SDFITS::set_more_format_on

procedure IO_SDFITS::set_more_format_on

Sets the object to print rows using the interactive 'more' format

IO_SDFITS::set_more_format_off

procedure IO_SDFITS::set_more_format_off

Sets the object NOT to print rows using the interactive 'more' format

IO_SDFITS::list_available_columns

procedure IO_SDFITS::list_available_columns

Prints the available columns from the rows section for list; these are also the valid search keywords

IO_SDFITS::set_user_columns

procedure IO_SDFITS::set_user_columns, columns

Sets what columns should be used for user listing

Parameters
columns in, required string array	array of columns to print on list command

IO_SDFITS::list_user_columns

procedure IO_SDFITS::list_user_columns

Prints the columns currently selected for the user specified listing

IO_SDFITS::get_num_index_rows

function IO_SDFITS::get_num_index_rows()

Retrieves number of records the object is connected to - or how many rows currently in the index file

Returns

number of records this object is connected to

IO_SDFITS::sort_search_results

function IO_SDFITS::sort_search_results(results, column)

Given an integer array representing some rows in the index, sorts this array by a given column name in the index file

Parameters
results in, required array	integer array representing some rows in the index file
column in, required string	must be uniquely identify a column in the index file

IO_SDFITS::get_expected_full_index_name

function IO_SDFITS::get_expected_full_index_name(fits_obj)

Given a fits file name of form '/path/filename.fits', returns the expected name of its index: '/path/filename.index'

Returns

expected name of index for given fits object

IO_SDFITS::update_index_with_other_index

function IO_SDFITS::update_index_with_other_index(index_name)

Instead of adding rows to an index file by reading in an sdfits file, this method attempts to take advantage of a pre-existing index files info.

Returns

0 - failure, 1 - success

IO_SDFITS::get_index_name_from_fits_name

function IO_SDFITS::get_index_name_from_fits_name(fits_name)

Takes a file named *.fits and returns a string equal to *.index

Returns

name of the file passed in, with extension changed to index

IO_SDFITS::set_flag

procedure IO_SDFITS::set_flag, scan, _EXTRA=_EXTRA

Sets a flagging rule for a given scan(s) along with other options according to the current flagging version. With the current version, the flagging options include: intnum, fdnum, plnum, ifnum, bchan, echan, and idstring.

Parameters
scan in, required long	scan or scans to be flagged.

Keywords
_EXTRA	.

IO_SDFITS::set_flag_rec

procedure IO_SDFITS::set_flag_rec, recnum, _EXTRA=_EXTRA

Sets a flagging rule for a given record number(s) along with other options according to the current flagging version. With the current version, the flagging options include: bchan, echan, and idstring.

Parameters
recnum in, required long	recnum or recnums to be flagged.

Keywords
_EXTRA	.

IO_SDFITS::get_scans_in_index

function IO_SDFITS::get_scans_in_index(scans[, count], [quiet=bool])

Given a set of scan numbers, returns which scans can currently be found in the index file.

Returns

an array of the scans that were found in the index file.

IO_SDFITS::get_recnums_in_index

function IO_SDFITS::get_recnums_in_index(recnums[, count], [quiet=bool])

Given a set of record numbers, returns which records can currently be found in the index file.

Returns

an array of the recs that were found in the index file.

IO_SDFITS::get_flag_file_names

function IO_SDFITS::get_flag_file_names([count], [recnum=long], [scan=long])

When certain spectra are being flagged, which flag files need to be used? This can be determined by finding in which fits file the record and scan numbers being flagged reside.

Returns

arrary of flag file names.

IO_SDFITS::list_flags

procedure IO_SDFITS::list_flags, _EXTRA=_EXTRA

For printing flag files' contents

Keywords
_EXTRA	.

IO_SDFITS::list_flag_ids

procedure IO_SDFITS::list_flag_ids

Prints all unique IDSTRINGS in flag files

IO_SDFITS::get_flag_lines

function IO_SDFITS::get_flag_lines([count], _EXTRA=_EXTRA)

Returns contents of all flag files idstring keyword allows retrieving only specific IDSTRINGs

Returns

string array representing contents of all flag files

IO_SDFITS::unflag

procedure IO_SDFITS::unflag, id, [/all], /quiet

Removes the flag(s) associated with the id passed in. If the id passe in is a string, then this is an IDSTRING, and whatever flags using this IDSTRING are removed. If id passed in is an integer, then this is a unique ID, and only one flag is removed.

Parameters
id in, required string,long	ID or IDSTRING of flag to remove.

Keywords
all in, optional boolean	When set, unflag all IDs.
quiet in boolean	When set, suppress the warning message when the requested ID was not found. Any value of ID is ignored.

IO_SDFITS::find_exact_matches

function IO_SDFITS::find_exact_matches(search_arr, values[, total_count])

Finds where multiple values occur in an array.

Returns

the indicies showing where the values were found in the search array.

IO_SDFITS::find_values_plus_and

private

procedure IO_SDFITS::find_values_plus_and, array, values, and_result

Used for making a search in an array and ANDing the results with previous searches

Examples

 >a = [1,2,3,4]
 >b = ['dog','cat','mouse','moose']
 >;init the search results
 >and_result = [0,1,2,3]
 >io->find_values_plus_and,a,'1:',and_result
 >print,and_result
 >[1,2,3]
 >io->find_values_plus_and,b,'dog,mo*',and_result
 >print,and_result
 >[2,3]
 

IO_SDFITS::find_flagged_data

function IO_SDFITS::find_flagged_data(dcs, flag[, count])

For a given flag structure, determines which of the given data containers' this flag applies to. This is done by checking the flags contents against the data containers' scan_number, integration, polarization_num, feed_num, and if_number fields.

Returns

indicies of the data containers that the flag applies to, -1 if none.

IO_SDFITS::find_flagged_data_field

function IO_SDFITS::find_flagged_data_field(data_field, flag_strct, flag_field_name, result)

Looks for matches between a given array of values, and a field in a given flagging structure. The flag structure holds strings, which magy need to be converted to integer arrays before the search can be done.

Returns

the indicies where the flag structure's field appears in the search array

IO_SDFITS::flag_data

procedure IO_SDFITS::flag_data, dcs, flag

Once it has been determined which flags apply to which data containers, this method actually blanks the data containers data, using the bchan and echan fields.

Parameters
dcs in, required data container array	array of data contianers to be flagged by single flag
flag in, required flag structure	structure representing a line in a flag file

IO_SDFITS::IS_SCAN_FLAGGED

function IO_SDFITS::IS_SCAN_FLAGGED(scan, [idstring=idstring])

Find if the specific scan has been flagged at all.

Returns

1 if it has been flagged in some way, otherwise 0.

IO_SDFITS::get_columns

function IO_SDFITS::get_columns(columns, [_EXTRA=structure])

Get the named columns as a set of vectors in a structure from the associated data file(s) using any supplied selection criteria.

Returns

structure - one field for each requested column. Returns -1 on any errors.

IO_SDFITS::find_flagged_index_data

function IO_SDFITS::find_flagged_index_data(indicies, recnum_string[, count])

For finding what data containers have been flagged via record number. Finds matches between a given array of index record numbers, and a string containing a compressed list of index numbers.

Returns

the indicies where a record number in the compressed string is found in the search array

IO_SDFITS::set_flag_file_version

procedure IO_SDFITS::set_flag_file_version, version_num, version_class

For testing purposes only. Allows overriding of flag format to use

Parameters
version_num	.
version_class	.

IO_SDFITS::validate_param_value_type

function IO_SDFITS::validate_param_value_type(value, type, name, [quiet=bool])

Checks a given value against a given type

Returns

0 - not valid, 1 - valid

IO_SDFITS::validate_param_value_types

function IO_SDFITS::validate_param_value_types(value, types, name, [quiet=bool])

Checks to make sure that the given value is one of the given types. If its a string, it also makes sure that is is in the correct form. This is used to make sure that keywords for index searches and flagging commands are correctly used.

Returns

0 - not valid, 1 - valid

IO_SDFITS::validate_param_list_types

function IO_SDFITS::validate_param_list_types(values_strct, param_types, _EXTRA=_EXTRA)

Generic method used for checking keywords used in both flagging commands and index searches. The names and types for each keyword are stored in the 2-D string arrays in the flag and index objects. These arrays are passed in to this method, along with the keywords used (passed in as a structure). In this method, for each keyword used, first the keyword is checked if it's name is valid, and then its type and range syntax is checked.

Parameters
values_strct in, required structure	keywords passed in via inheritance
param_types in, required string array	contains param names and their types

Keywords
_EXTRA	.

IO_SDFITS::get_param_index

function IO_SDFITS::get_param_index(param_names, param_name[, count])

Looks for a keyword passed in for such methods as index searches or or flag commands in the list of valid names. A keyword shortened to it's most unambigious abbreviation is valid.

Returns

the index of the keyword in the list of valid names

IO_SDFITS::check_param_syntax

function IO_SDFITS::check_param_syntax(param_name, value, _EXTRA=_EXTRA)

Parameters
param_name	.
value	.

Keywords
_EXTRA	.

IO_SDFITS::get_single_param_types

function IO_SDFITS::get_single_param_types(param_name)

Parameters
param_name	.

IO_SDFITS::get_index_param_types

function IO_SDFITS::get_index_param_types()

All the index file columns can be searched against, using keyword arguments. The types of each column are stored in memory in the index object, which this method retrieves. This way, the keywords used in a search can be checked

IO_SDFITS::get_flag_param_types

function IO_SDFITS::get_flag_param_types()

Most of the keywords used in a flagging command match against the columns found in a flag file. These columns, along with the CHANS and CHANWIDTH columns have their names and types stored in a 2-D string array in the flag object. This method retrieves this info so that the keywords used with a flagging command can be checked for valid type and range syntax before the command progresses.

IO_SDFITS::check_flag_param_syntax

function IO_SDFITS::check_flag_param_syntax(_EXTRA=_EXTRA, [quiet=bool])

Checks the parameters used in a flagging command Checks for validity of both type and range syntax. First the param types for a flagging commmand are found, which are stored as a 2-D array in the flag object, and then these values are used to check against the search parameters actually used. _EXTRA=ex refers to all keywords valid in a flagging command.

Keywords
_EXTRA	.
quiet in, optional bool	wether or not to be quiet on errors

IO_SDFITS::check_search_param_syntax

function IO_SDFITS::check_search_param_syntax(_EXTRA=_EXTRA, [quiet=bool])

Checks the parameters used for a search, be it for a list command, or get_* method. Checks for validity of both type and range syntax. First the param types for an index file search are found, which are stored as a 2-D array in the index object, and then these values are used to check against the search parameters actually used. _EXTRA=ex refers to all keywords valid for a search.

Keywords
_EXTRA	.
quiet in, optional bool	wether or not to be quiet on errors

IO_SDFITS::validate_string_value

function IO_SDFITS::validate_string_value(value, types, quiet=quiet)

Used to check the validaty of values passed into keywords used with index and flagging commands. Integer and float ranges can sometimes be passed in with string values, and strings themselves sometimes can use wildcards.

Returns

0 - not valid, 1 - valid

IO_SDFITS::validate_integer_range

function IO_SDFITS::validate_integer_range(value)

Sometimes keywords that take integers can be passed in a string representing a a range of integers. This checks that the value passed in conforms to the correct syntax.

Returns

0 - does not conform to syntax, 1 - does conform

IO_SDFITS::validate_float_range

function IO_SDFITS::validate_float_range(value)

Sometimes keywords that take floats can be passed in a string representing a float to a certain perscion, or a range of floats. This checks that the value passed in conforms to the correct syntax.

Returns

0 - does not conform to syntax, 1 - does conform

IO_SDFITS::validate_string_range

function IO_SDFITS::validate_string_range(values)

For some keywords, strings can be used with wildcards either at the begining or end of the string. This makes sure that the passed in string conforms to this syntax

Returns

0 - does not conform to syntax, 1 - does conform

IO_SDFITS::get_last_record

function IO_SDFITS::get_last_record()

Retrieves the last record, or index number to be retrieved from a get_* method

Returns

last record member variable

IO_SDFITS::get_flags_obj

function IO_SDFITS::get_flags_obj()

Get access to the associated flags object

IO_SDFITS::flags_show_state

procedure IO_SDFITS::flags_show_state

Debugging function to explore the FLAG state