if_filler__define.pro

NRAO GBTIDL
Produced by IDL 7.1.1
Developer Documentation

prev file | next file view single page | view frames | update routines

SUMMARY: fields | routine DETAILS: routine

./toolbox/io
if_filler__define.pro

Last modification date:: Wed Sep 28 13:27:14 2016

Special class whose sole purpose is just to calclulate the if numbers for a given scan and its info

Fields Summary

DEBUG
longword integer .

Routine Summary 13 routines

procedure if_filler__define
Special class whose sole purpose is just to calclulate the if numbers for a given scan and its info

function IF_FILLER::init()

procedure IF_FILLER::cleanup

procedure IF_FILLER::set_debug_on

procedure IF_FILLER::set_debug_off

function IF_FILLER::get_if_numbers(scan_rows, names, ints, index_start, index_end)

function IF_FILLER::remove_element(arr, count, value=value, index=index)

function IF_FILLER::get_uniques(arr, count)
private
Sorts and uniques an array

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

function IF_FILLER::get_col_variability(rows, tag_name, names, default_value)
private
Given rows from an sdfits file, how much does the value of a given column vary? Used when translating contents of an sdfits file into contents of the index file.

function IF_FILLER::find_matching_polarizations(pols, pol, count)

function IF_FILLER::get_matching_polarization(polarization)

function IF_FILLER::get_other_polarizations(polarization)

Routine Details

if_filler__define

procedure if_filler__define

Special class whose sole purpose is just to calclulate the if numbers for a given scan and its info

IF_FILLER::init

function IF_FILLER::init()

IF_FILLER::cleanup

procedure IF_FILLER::cleanup

IF_FILLER::set_debug_on

procedure IF_FILLER::set_debug_on

IF_FILLER::set_debug_off

procedure IF_FILLER::set_debug_off

IF_FILLER::get_if_numbers

function IF_FILLER::get_if_numbers(scan_rows, names, ints, index_start, index_end)

Parameters

scan_rows
.

names
.

ints
.

index_start
.

index_end
.

IF_FILLER::remove_element

function IF_FILLER::remove_element(arr, count, value=value, index=index)

Parameters

arr
.

count
.

Keywords

value
.

index
.

IF_FILLER::get_uniques private

function IF_FILLER::get_uniques(arr, count)

Sorts and uniques an array

Returns: uniqe values of array

Parameters

arr
in
array array to be sorted and uniqued

count
.

IF_FILLER::get_row_value private

function IF_FILLER::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 mathes 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

Parameters

row
in
struct structure that mirrors a row in an sdfits file

tag_name
in
string name of the value that we want to retrieve

virtuals
in
struct struct giving the keyword-values found in the file-extension

names
in
struct struct contiaining pointers to the names of columns in the row, missing columns, and tag names in the virtuals struct

default_value
in
value to be returned if the tag_name is of a missing column

IF_FILLER::get_col_variability private

function IF_FILLER::get_col_variability(rows, tag_name, names, default_value)

Given rows from an sdfits file, how much does the value of a given column vary? Used when translating contents of an sdfits file into contents of the index file.

Returns: the variablity of this column in the fits file

Parameters

rows
in
array array of structures mirroring sdfits rows

tag_name
in
string column in the sdfits rows we are querying

names
in
struct structure containing pointers to the list of row columns, missing cols, and header keywords

default_value
in
if the tag_name is not found in the rows or as a keyword, use this as the variability

IF_FILLER::find_matching_polarizations

function IF_FILLER::find_matching_polarizations(pols, pol, count)

Parameters

pols
.

pol
.

count
.

IF_FILLER::get_matching_polarization

function IF_FILLER::get_matching_polarization(polarization)

Parameters

polarization
.

IF_FILLER::get_other_polarizations

function IF_FILLER::get_other_polarizations(polarization)

Parameters

polarization
.

Produced by IDLdoc 1.6 on Wed Sep 28 13:27:26 2016

procedure if_filler__define
Special class whose sole purpose is just to calclulate the if numbers for a given scan and its info

function IF_FILLER::get_if_numbers(scan_rows, names, ints, index_start, index_end)

function IF_FILLER::remove_element(arr, count, value=value, index=index)

function IF_FILLER::get_uniques(arr, count)	private
Sorts and uniques an array

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

function IF_FILLER::get_col_variability(rows, tag_name, names, default_value)	private
Given rows from an sdfits file, how much does the value of a given column vary? Used when translating contents of an sdfits file into contents of the index file.

function IF_FILLER::find_matching_polarizations(pols, pol, count)

Parameters
row in struct	structure that mirrors a row in an sdfits file
tag_name in string	name of the value that we want to retrieve
virtuals in struct	struct giving the keyword-values found in the file-extension
names in struct	struct contiaining pointers to the names of columns in the row, missing columns, and tag names in the virtuals struct
default_value in	value to be returned if the tag_name is of a missing column

Parameters
rows in array	array of structures mirroring sdfits rows
tag_name in string	column in the sdfits rows we are querying
names in struct	structure containing pointers to the list of row columns, missing cols, and header keywords
default_value in	if the tag_name is not found in the rows or as a keyword, use this as the variability