casacore
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::ObsInfo Class Reference

Store miscellaneous information related to an observation. More...

#include <ObsInfo.h>

Inheritance diagram for casacore::ObsInfo:
casacore::RecordTransformable

Public Member Functions

 ObsInfo ()
 Default constructor makes an object where all the parameters are set to their default values (see below) More...
 
 ~ObsInfo ()
 Destructor. More...
 
 ObsInfo (const ObsInfo &other)
 Copy all fields from "other" to this object. More...
 
ObsInfooperator= (const ObsInfo &other)
 
String telescope () const
 Telescope identifier. More...
 
ObsInfosetTelescope (const String &telescope)
 
Bool isTelescopePositionSet () const
 
const MPositiontelescopePosition () const
 
String telescopePositionString () const
 
ObsInfosetTelescopePosition (const MPosition &)
 
String observer () const
 The name (or initials) of the observer. More...
 
ObsInfosetObserver (const String &observer)
 
MEpoch obsDate () const
 When was the observation taken (start time)? This is somewhat problematical for observations which are taken at multiple epochs. More...
 
ObsInfosetObsDate (const MEpoch &obsDate)
 
MVDirection pointingCenter () const
 What was the pointing centre, as distinct from the phase centre ? This value is specified as an MVDirection. More...
 
ObsInfosetPointingCenter (const MVDirection &direction)
 
Bool isPointingCenterInitial () const
 Because the default pointing center is a valid value (0,0), this function is available to tell you whether the pointing center has been set (with setPointingCenter) to some value other than its initial (return False) More...
 
virtual Bool toRecord (String &error, RecordInterface &outRecord) const
 Functions to interconvert between an ObsInfo and a record. More...
 
virtual Bool fromRecord (String &error, const RecordInterface &inRecord)
 Initialise the class from a Record representation. More...
 
Bool toFITS (String &error, RecordInterface &outRecord) const
 Functions to interconvert between an ObsInfo and FITS keywords (converted to a Record). More...
 
Bool fromFITS (Vector< String > &error, const RecordInterface &inRecord)
 
- Public Member Functions inherited from casacore::RecordTransformable
virtual ~RecordTransformable ()
 The destructor must be virtual so that the destructor of derived classes is actually used. More...
 
virtual Bool fromString (String &error, const String &inString)
 Initialise the class from a String representation. More...
 
virtual const Stringident () const
 Specify the identification of the record (e.g. More...
 

Static Public Member Functions

static String defaultTelescope ()
 In some circumstances it might be useful to know what the defaults for the various values are so you can check if they have been set. More...
 
static String defaultObserver ()
 
static MEpoch defaultObsDate ()
 
static MVDirection defaultPointingCenter ()
 
static Vector< StringkeywordNamesFITS ()
 It might be useful to know what FITS keyword names are used in to/from FITS so we can remove them so they won't be used more than once. More...
 

Private Member Functions

void copy_other (const ObsInfo &other)
 False after setPointingCenter called. More...
 

Private Attributes

String telescope_p
 
String observer_p
 
MEpoch obsdate_p
 
MPosition telPosition_p
 
Bool isTelPositionSet_p
 
MVDirection pointingCenter_p
 
Bool isPointingCenterInitial_p
 

Detailed Description

Store miscellaneous information related to an observation.

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Synopsis

This class is used to record miscellaneous information about an observation. At present it contains the following:

  1. Telescope name
  2. Observer name
  3. Observation date
  4. Pointing centre (as distinct from the phase center or tangent point)

This list can easily be extended if necessary.

This class has functions to interconvert with a record in a "lossless" fashion, and to also interconvert between a record that contains a list of FITS keywords.

Example

The interface is a simple get/set interface. Note that the "set" methods can be chained together since each set method returns a reference to its object (rather like cout).

ObsInfo oi;
oi.setTelescope("VLA").setObserver("Glendenning");
..\.
cout << "The date observed is: " << oi.obsDate() << endl;

Motivation

Record information to allow more full measures conversion, e.g. topo->lsr requires observatory location and time. Also record in a typesafe way image summary information users are used to from classic AIPS.

To Do

Definition at line 97 of file ObsInfo.h.

Constructor & Destructor Documentation

casacore::ObsInfo::ObsInfo ( )

Default constructor makes an object where all the parameters are set to their default values (see below)

casacore::ObsInfo::~ObsInfo ( )

Destructor.

casacore::ObsInfo::ObsInfo ( const ObsInfo other)

Copy all fields from "other" to this object.

Uses copy semantics.

Member Function Documentation

void casacore::ObsInfo::copy_other ( const ObsInfo other)
private

False after setPointingCenter called.

Common copy ctor/assignment operator code.

static MEpoch casacore::ObsInfo::defaultObsDate ( )
static
static String casacore::ObsInfo::defaultObserver ( )
static
static MVDirection casacore::ObsInfo::defaultPointingCenter ( )
static
static String casacore::ObsInfo::defaultTelescope ( )
static

In some circumstances it might be useful to know what the defaults for the various values are so you can check if they have been set.

Bool casacore::ObsInfo::fromFITS ( Vector< String > &  error,
const RecordInterface inRecord 
)
virtual Bool casacore::ObsInfo::fromRecord ( String error,
const RecordInterface inRecord 
)
virtual

Initialise the class from a Record representation.

The input record should contain the fields that are required by the class. Other fields will be ignored. If the transformation succeeds then the error String is unchanged and the function returns True. Otherwise the function returns False and appends an error message to the supplied String giving the reason why the conversion failed.

Implements casacore::RecordTransformable.

Bool casacore::ObsInfo::isPointingCenterInitial ( ) const
inline

Because the default pointing center is a valid value (0,0), this function is available to tell you whether the pointing center has been set (with setPointingCenter) to some value other than its initial (return False)

Definition at line 162 of file ObsInfo.h.

References isPointingCenterInitial_p.

Bool casacore::ObsInfo::isTelescopePositionSet ( ) const
inline

Definition at line 124 of file ObsInfo.h.

References isTelPositionSet_p.

static Vector<String> casacore::ObsInfo::keywordNamesFITS ( )
static

It might be useful to know what FITS keyword names are used in to/from FITS so we can remove them so they won't be used more than once.

The names are in lower case.

MEpoch casacore::ObsInfo::obsDate ( ) const

When was the observation taken (start time)? This is somewhat problematical for observations which are taken at multiple epochs.

You should use the start time of the first sample. The default is the MEpoch default: MJD 0 UTC

String casacore::ObsInfo::observer ( ) const

The name (or initials) of the observer.

Defaults to "UNKNOWN".

ObsInfo& casacore::ObsInfo::operator= ( const ObsInfo other)
MVDirection casacore::ObsInfo::pointingCenter ( ) const

What was the pointing centre, as distinct from the phase centre ? This value is specified as an MVDirection.

This means it is you, the callers responsibility, to know what its reference type is in order to turn it into an MDirection. The default is (0,0) (or [1,0,0]). After you have called setPointingCenter, the function isPointingCenterInitial will return False.

ObsInfo& casacore::ObsInfo::setObsDate ( const MEpoch obsDate)
ObsInfo& casacore::ObsInfo::setObserver ( const String observer)
ObsInfo& casacore::ObsInfo::setPointingCenter ( const MVDirection direction)
ObsInfo& casacore::ObsInfo::setTelescope ( const String telescope)
ObsInfo& casacore::ObsInfo::setTelescopePosition ( const MPosition )
String casacore::ObsInfo::telescope ( ) const

Telescope identifier.

If this is a "standard" telescope, you should use the same name as is available in the Observatories method of class MeasTable. Defaults to "UNKNOWN".
The telescope position can be set and will be converted to ITRF. If the telescope position has not been set explicitly, it will be set for a standard telescope found in the MeasTable.

const MPosition& casacore::ObsInfo::telescopePosition ( ) const
inline

Definition at line 126 of file ObsInfo.h.

References telPosition_p.

String casacore::ObsInfo::telescopePositionString ( ) const
Bool casacore::ObsInfo::toFITS ( String error,
RecordInterface outRecord 
) const

Functions to interconvert between an ObsInfo and FITS keywords (converted to a Record).

For the pointing center, the FITS keywords OBSRA and OBSDEC are used. Failure of fromFITS should probably not be regarded as fatal as the default ObsInfo values are viable. For each item contained in the ObsInfo, an attempt to decode it from FITS is made. If any of them fail, False is returned, but it attempts to decode them all. For those that fail an error message is held in error in the order telescope (error(0)), observer (error(1)), date (error(2)), pointing center (error(3)). error will be returned of length 0 if the return value is True, else it will be length 4.

virtual Bool casacore::ObsInfo::toRecord ( String error,
RecordInterface outRecord 
) const
virtual

Functions to interconvert between an ObsInfo and a record.

These functions are inherited from class RecordTransformable. As new fields get added to ObsInfo these functions should be augmented. Missing fields should not generate an error to in fromRecord to allow for backwards compatibility - null values should be supplied instead. The field names are "observer", "telescope", "obsdate", and "pointingcenter"

Implements casacore::RecordTransformable.

Member Data Documentation

Bool casacore::ObsInfo::isPointingCenterInitial_p
private

Definition at line 216 of file ObsInfo.h.

Referenced by isPointingCenterInitial().

Bool casacore::ObsInfo::isTelPositionSet_p
private

Definition at line 214 of file ObsInfo.h.

Referenced by isTelescopePositionSet().

MEpoch casacore::ObsInfo::obsdate_p
private

Definition at line 212 of file ObsInfo.h.

String casacore::ObsInfo::observer_p
private

Definition at line 211 of file ObsInfo.h.

MVDirection casacore::ObsInfo::pointingCenter_p
private

Definition at line 215 of file ObsInfo.h.

String casacore::ObsInfo::telescope_p
private

Definition at line 210 of file ObsInfo.h.

MPosition casacore::ObsInfo::telPosition_p
private

Definition at line 213 of file ObsInfo.h.

Referenced by telescopePosition().


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