MirField Class Reference

a container for field information More...

#include <FillMetadata.h>

Inheritance diagram for MirField:

Public Member Functions
	MirField (Float delra, Float deldec, Int fid=-1)
	create a new field description
virtual	~MirField ()
	delete this field
Bool	operator== (const MirField &that)
	return true if this field's offsets match those of another
Bool	operator!= (const MirField &that)
	return false if this field's offsets match those of another
MirField *	findIn (List< MirField * > &fldlist)
	return a pointer to a field in a given list of fields that is equal to this field.
Static Public Member Functions
static void	clearIDs (List< MirField * > &fldlist)
	clear the ID values for all the fields in a field list by setting them to -1.
Public Attributes
Float	dra
	the position offsets
Float	ddec
Int	id
	the ID assigned to this field within the MeasurementSet being filled.

Detailed Description

a container for field information

Intended use:

Internal

Review Status

Date Reviewed:: yyyy/mm/dd

Etymology

a Miriad observing field is expressed as an offset from a reference position

Synopsis

MirField is a helper class used by MirFiller and FillMetadata to hold the data describing an observing field in a single container. Most of the interaction with this class is through public data members (for programming and runtime efficiency); thus, this class is not appropriate for use outside of this module. A few helper funtions are provided to aid in utilizing the information (mainly for comparison with other MirField objects).

Motivation

A Miriad dataset can contain a number of observing fields, described as offsets from a reference position. When scanning a multi-field dataset, one usually will encounter data each field as the observations cycles through the set of pointings. Thus, the filler must keep a list of unique fields that can be matched against the current field.

Definition at line 112 of file FillMetadata.h.

Constructor & Destructor Documentation

MirField::MirField	(	Float	delra,
		Float	deldec,
		Int	fid = `-1`
	)

create a new field description

virtual MirField::~MirField ( ) [virtual]

delete this field

Member Function Documentation

static void MirField::clearIDs ( List< MirField * > & fldlist ) [inline, static]

clear the ID values for all the fields in a field list by setting them to -1.

Definition at line 148 of file FillMetadata.h.

MirField* MirField::findIn ( List< MirField * > & fldlist ) [inline]

return a pointer to a field in a given list of fields that is equal to this field.

Definition at line 140 of file FillMetadata.h.

Bool MirField::operator!= ( const MirField & that ) [inline]

return false if this field's offsets match those of another

Definition at line 134 of file FillMetadata.h.

Bool MirField::operator== ( const MirField & that ) [inline]

return true if this field's offsets match those of another

Definition at line 129 of file FillMetadata.h.

References ddec, and dra.

Member Data Documentation

Float MirField::ddec

Definition at line 116 of file FillMetadata.h.

Referenced by operator==().

Float MirField::dra

the position offsets

Definition at line 116 of file FillMetadata.h.

Referenced by operator==().

Int MirField::id

the ID assigned to this field within the MeasurementSet being filled.

A value of -1 means that the ID has not yet been assigned.

Definition at line 120 of file FillMetadata.h.

The documentation for this class was generated from the following file:

code/miriad/Filling/FillMetadata.h