casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
MirField Class Reference

a container for field information More...

#include <FillMetadata.h>

Inheritance diagram for MirField:
MirInfo MirTypeAssert

Public Member Functions

 MirField (casacore::Float delra, casacore::Float deldec, casacore::Int fid=-1)
 create a new field description More...
 
virtual ~MirField ()
 delete this field More...
 
casacore::Bool operator== (const MirField &that)
 return true if this field's offsets match those of another More...
 
casacore::Bool operator!= (const MirField &that)
 return false if this field's offsets match those of another More...
 
MirFieldfindIn (casacore::List< MirField * > &fldlist)
 return a pointer to a field in a given list of fields that is equal to this field. More...
 
- Public Member Functions inherited from MirInfo
 MirInfo ()
 
virtual ~MirInfo ()
 

Static Public Member Functions

static void clearIDs (casacore::List< MirField * > &fldlist)
 clear the ID values for all the fields in a field list by setting them to -1. More...
 

Public Attributes

casacore::Float dra
 the position offsets More...
 
casacore::Float ddec
 
casacore::Int id
 the ID assigned to this field within the casacore::MeasurementSet being filled. More...
 

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 113 of file FillMetadata.h.

Constructor & Destructor Documentation

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

create a new field description

virtual MirField::~MirField ( )
virtual

delete this field

Member Function Documentation

static void MirField::clearIDs ( casacore::List< MirField * > &  fldlist)
inlinestatic

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

Definition at line 149 of file FillMetadata.h.

References casacore::ConstListIter< t >::atEnd().

Referenced by MirSource::clearIDs().

MirField* MirField::findIn ( casacore::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 141 of file FillMetadata.h.

References casacore::ConstListIter< t >::atEnd(), and casacore::ListIter< t >::getRight().

casacore::Bool MirField::operator!= ( const MirField that)
inline

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

Definition at line 135 of file FillMetadata.h.

casacore::Bool MirField::operator== ( const MirField that)
inline

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

Definition at line 130 of file FillMetadata.h.

References ddec, and dra.

Member Data Documentation

casacore::Float MirField::ddec

Definition at line 117 of file FillMetadata.h.

Referenced by MirSource::offSource(), and operator==().

casacore::Float MirField::dra

the position offsets

Definition at line 117 of file FillMetadata.h.

Referenced by MirSource::offSource(), and operator==().

casacore::Int MirField::id

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

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

Definition at line 121 of file FillMetadata.h.


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