/usr/include/casacore/coordinates/Coordinates/ObsInfo.h is in casacore-dev 2.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 | //# ObsInfo.h: Store miscellaneous information related to an observation
//# Copyright (C) 1998,2000,2001
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: aips2-request@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
//#
//# $Id$
#ifndef COORDINATES_OBSINFO_H
#define COORDINATES_OBSINFO_H
#include <casacore/casa/aips.h>
#include <casacore/casa/Utilities/RecordTransformable.h>
#include <casacore/casa/BasicSL/String.h>
#include <casacore/measures/Measures/MEpoch.h>
#include <casacore/measures/Measures/MPosition.h>
#include <casacore/casa/Quanta/MVDirection.h>
//# Forward declarations
#include <casacore/casa/iosfwd.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary>
// Store miscellaneous information related to an observation.
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class=RecordTransformable>RecordTransformable</linkto>
// <li> <linkto class=MEpoch>MEpoch</linkto>
// </prerequisite>
//
// <synopsis>
// This class is used to record miscellaneous information about an observation.
// At present it contains the following:
// <ol>
// <li> Telescope name
// <li> Observer name
// <li> Observation date
// <li> Pointing centre (as distinct from the phase center or tangent point)
// </ol>
// 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.
// </synopsis>
//
// <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).
// <srcblock>
// ObsInfo oi;
// oi.setTelescope("VLA").setObserver("Glendenning");
// ...
// cout << "The date observed is: " << oi.obsDate() << endl;
// </srcblock>
// </example>
//
// <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.
// </motivation>
//
// <todo asof="2000/04/20">
// <li> Nothing known
// </todo>
class ObsInfo : public RecordTransformable
{
public:
// Default constructor makes an object where all the
// parameters are set to their default values (see below)
ObsInfo();
// Destructor
~ObsInfo();
// Copy all fields from "other" to this object. Uses copy semantics.
// <group>
ObsInfo(const ObsInfo &other);
ObsInfo &operator=(const ObsInfo &other);
// </group>
// Telescope identifier. If this is a "standard" telescope, you should use
// the same name as is available in the Observatories method of class
// <linkto class=MeasTable>MeasTable</linkto>. Defaults to "UNKNOWN".
// <br>
// 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.
// <group>
String telescope() const;
ObsInfo& setTelescope(const String &telescope);
Bool isTelescopePositionSet() const
{ return isTelPositionSet_p; }
const MPosition& telescopePosition() const
{ return telPosition_p; }
String telescopePositionString() const;
ObsInfo& setTelescopePosition(const MPosition&);
// </group>
// The name (or initials) of the observer. Defaults to "UNKNOWN".
// <group>
String observer() const;
ObsInfo& setObserver(const String &observer);
// </group>
// 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
// <group>
MEpoch obsDate() const;
ObsInfo& setObsDate(const MEpoch &obsDate);
// </group>
// 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.
// <group>
MVDirection pointingCenter() const;
ObsInfo& setPointingCenter (const MVDirection& direction);
// </group>
// 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)
Bool isPointingCenterInitial () const {return isPointingCenterInitial_p;};
// Functions to interconvert between an ObsInfo and a record. These
// functions are inherited from class
// <linkto class=RecordTransformable>RecordTransformable</linkto>. 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"
// <group>
virtual Bool toRecord(String & error, RecordInterface & outRecord) const;
virtual Bool fromRecord(String & error, const RecordInterface & inRecord);
// </group>
// 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 <src>fromFITS</src>
// 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 <src>error</src>
// in the order telescope (error(0)), observer (error(1)), date
// (error(2)), pointing center (error(3)). <src>error</src> will
// be returned of length 0 if the return value is True, else
// it will be length 4.
// <group>
Bool toFITS(String & error, RecordInterface & outRecord) const;
Bool fromFITS(Vector<String>& error, const RecordInterface & inRecord);
// 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.
// <group>
static String defaultTelescope();
static String defaultObserver();
static MEpoch defaultObsDate();
static MVDirection defaultPointingCenter();
// </group>
// 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.
static Vector<String> keywordNamesFITS();
private:
String telescope_p;
String observer_p;
MEpoch obsdate_p;
MPosition telPosition_p;
Bool isTelPositionSet_p;
MVDirection pointingCenter_p;
Bool isPointingCenterInitial_p; // True when ObsInfo contructed.
// False after setPointingCenter called
// Common copy ctor/assignment operator code.
void copy_other(const ObsInfo &other);
};
// <summary> Global functions </summary>
// <group name=Output>
// Output declaration - useful for debugging.
ostream &operator<<(ostream &os, const ObsInfo &info);
// </group>
} //# NAMESPACE CASACORE - END
#endif
|