/usr/include/casacore/measures/Measures/MFrequency.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 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 | //# MFrequency.h: A Measure: wave characteristics
//# Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003
//# 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 MEASURES_MFREQUENCY_H
#define MEASURES_MFREQUENCY_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/measures/Measures/MeasBase.h>
#include <casacore/measures/Measures/MeasRef.h>
#include <casacore/casa/Quanta/MVFrequency.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class MFrequency;
class MCFrequency;
class MDoppler;
class MVDoppler;
template <class M> class MeasConvert;
template <class M> class ArrayMeasColumn;
template <class M> class ScalarMeasColumn;
//# Typedefs
// <summary>
// A Measure: wave characteristics
// </summary>
// <use visibility=export>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="tMeasure" demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class=Measure>Measure</linkto> class
// <li> <linkto class = MRadialVelocity>MRadialVelocity</linkto> class
// for some other background.
// </prerequisite>
//
// <etymology>
// </etymology>
//
// <synopsis>
// MFrequency is a derived Measure class for wave characteristics.<br>
// An MFrequency can be generated from a simple value (or an
// <linkto class=MVFrequency>MFrequency</linkto> object), which is then
// interpreted as a frequency in Hz, and a reference, with an LSRK type
// as default.<br>
// It can also be generated from a Quantity, where the interpretation
// depends on the dimensionality of the Quantity:
// <ul>
// <li> time (e.g. s): period
// <li> frequency (e.g. Hz): frequency
// <li> angular frequency (e.g. arcmin/s): angular frequency
// <li> length (e.g. cm): wavelength
// <li> inverse length (e.g. mm<sup>-1</sup>): wave number
// <li> energy (e.g. J.s): energy (i.e. <em>h.nu</em>)
// <li> momentum (e.g. kg.m): <em>m.c/h</em>
// </ul>
// The different reference types of a frequency are:
// <ul>
// <li> MFrequency::REST -- Rest frequency
// <li> MFrequency::LSRD -- Local Standard of Rest (J2000) -- as the
// dynamical definition (IAU, [9,12,7] km/s in galactic
// coordinates)
// <li> MFrequency::LSRK -- LSR as a kinematical (radio) definition --
// 20.0 km/s in direction ra,dec = [270,+30] deg (B1900.0)
// <li> MFrequency::BARY -- Barycentric (J2000)
// <li> MFrequency::GEO --- Geocentric
// <li> MFrequency::TOPO -- Topocentric
// <li> MFrequency::GALACTO -- Galacto centric (with rotation of 220 km/s
// in direction l,b = [90,0] deg.
// <li> MFrequency::LGROUP -- Local group velocity -- 308km/s towards
// l,b = [105,-7] deg (F. Ghigo)
// <li> MFrequency::CMB -- CMB velocity -- 369.5km/s towards
// l,b = [264.4, 48.4] deg (F. Ghigo)
// <li> MFrequency::DEFAULT = LSRK
// </ul>
// <p>
// Conversion between the different types is done with the standard
// <linkto class=MeasConvert>MeasConvert</linkto> class
// (<src>MFrequency::Convert</src> in this case).
// Some of the conversions are only possible if frame information has been
// filled in. The following frame information is necessary if a conversion
// goes to or from the (different) specified types:
// <ul>
// <li><em>Radial Velocity</em>: REST
// <li><em>Epoch</em>: TOPO, GEO
// <li><em>Position</em>: TOPO
// <li><em>Direction</em> all
// </ul>
// <br>
// To accommodate unknown or invalid frames, the additional reference type
// <ul>
// <li> MFrequency::Undefined
// </ul>
// is available. Conversions to/from Undefined are not possible.
// If attempted, an exception will be thrown.
// The name was chosen to be Undefined and not UNDEFINED in order to
// not collide with the (ugly) WCSLIB macro of the upper case name
// and in concordance with Stokes::Undefined.
// <br>
// An MFrequency can be created from an
// <linkto class=MDoppler>MDoppler</linkto> (and a rest frequency, (the
// <linkto class=QC>QC</linkto> class contains at least <src>QC::HI</src>))
// by the <src>fromDoppler()</src> member. It can be converted to an MDoppler
// with the <src>toDoppler()</src>. Comparable methods will be available
// for <linkto class=MFrequency>MFrequency</linkto> as
// <src>toRadial()</src> and <src>fromRadial</src>.<br>
// If the Doppler shift is known (e.g. from another spectral line), the
// REST frequency can be determined with the <src>toREST()</src> member.
// <note role=caution> Conversion between the different frequencies can,
// due to relativistic effects, only be done approximately for very high
// (order c) radial velocities (shifted frequencies). A better approach
// would be to start from radial velocities and a rest frequency.
// </note>
// </synopsis>
//
// <example>
// Get the Doppler shift for an oberved HI frequency of 1380 MHz
// <srcblock>
// cout << "Redshift for 1380 MHz: " <<
// MDoppler::Convert( MFrequency( Quantity(1380., "MHz"),
// MFrequency::TOPO).toDoppler(QC::HI),
// MDoppler::Z)() << endl;
// </srcblock>
// </example>
//
// <motivation>
// </motivation>
//
// <todo asof="2003/03/03">
// </todo>
class MFrequency : public MeasBase<MVFrequency, MeasRef<MFrequency> > {
public:
//# Friends
// Conversion of data
friend class MeasConvert<MFrequency>;
//# Enumerations
// Types of known MFrequencies
// <note role=warning> The order defines the order in the translation
// matrix FromTo
// in the getConvert routine. Do not change the order without
// changing the array. Additions should be made before N_types, and
// an additional row and column should be coded in FromTo, and
// in showType().</note>
enum Types {
REST,
LSRK,
LSRD,
BARY,
GEO,
TOPO,
GALACTO,
LGROUP,
CMB,
N_Types,
Undefined = 64,
N_Other,
// all extra bits
EXTRA = 64,
// Defaults
DEFAULT=LSRK,
// Synonyms
LSR=LSRK };
//# Typedefs
// Measure value container for this class (i.e. MFrequency::MVType)
typedef MVFrequency MVType;
// Measure conversion routines for this class (i.e. MFrequency::MCType)
typedef MCFrequency MCType;
// Measure reference (i.e. MFrequency::Ref)
typedef MeasRef<MFrequency> Ref;
// Measure conversion use (i.e. MFrequency::Convert)
typedef MeasConvert<MFrequency> Convert;
// Measure table Columns (e.g., MFrequency::ScalarColumn)
typedef ScalarMeasColumn<MFrequency> ScalarColumn;
typedef ArrayMeasColumn<MFrequency> ArrayColumn;
// Reference enum Types (included originally for gcc 2.95)
typedef WHATEVER_SUN_TYPEDEF(MFrequency) Types Types;
//# Constructors
// <note role=tip> In the following constructors and other functions, all
// <em>MeasRef</em> can be replaced with simple <src>Measure::TYPE</src>
// where no offsets or frames are needed in the reference. </note>
// Default constructor; generates a zero rest frequency
MFrequency();
// Create from data and reference
// <group>
MFrequency(const MVFrequency &dt);
MFrequency(const MVFrequency &dt, const MFrequency::Ref &rf);
MFrequency(const MVFrequency &dt, MFrequency::Types rf);
MFrequency(const Quantity &dt);
MFrequency(const Quantity &dt, const MFrequency::Ref &rf);
MFrequency(const Quantity &dt, MFrequency::Types rf);
MFrequency(const Measure *dt);
MFrequency(const MeasValue *dt);
// </group>
//# Destructor
virtual ~MFrequency();
//# Operators
//# General Member Functions
// Tell me your type
// <group>
virtual const String &tellMe() const;
static const String &showMe();
virtual uInt type() const;
static void assure(const Measure &in);
// </group>
// Translate reference code. The uInt version has a check for valid codes
// (i.e. it is a safe cast).
// <thrown>
// <li> AipsError in the uInt interface if illegal code given
// </thrown>
// <group>
static MFrequency::Types castType(uInt tp);
static const String &showType(MFrequency::Types tp);
static const String &showType(uInt tp);
// </group>
// Translate string to reference code
// <group>
static Bool getType(MFrequency::Types &tp, const String &in);
// Throws an exception if the type string is not recognized
static MFrequency::Types typeFromString(const String& in);
Bool giveMe(MFrequency::Ref &mr, const String &in);
// </group>
// Set the offset in the reference (False if non-matching Measure)
virtual Bool setOffset(const Measure &in);
// Set the reference type to the specified String. False if illegal
// string, reference set to DEFAULT.
virtual Bool setRefString(const String &in);
// Get the default reference type
virtual const String &getDefaultType() const;
// Get a list of all known reference codes. nall returns the number in list,
// nextra the number of specials (like planets) that should be at
// end of list). typ returns the list of corresponding types.
// <group>
virtual const String* allTypes(Int &nall, Int &nextra,
const uInt *&typ) const;
static const String* allMyTypes(Int &nall, Int &nextra,
const uInt *&typ);
// </group>
// Check if all internal tables of types (both enum and String) are
// complete and correct. This function is called automatically if and when
// necessary.
// <thrown>
// <li> AipsError if a (programming) error in the types.
// </thrown>
// <group>
virtual void checkTypes() const;
static void checkMyTypes();
// </group>
// Get the reference type (for records, including codes like R_)
virtual String getRefString() const;
// Get my type (as Register)
static uInt myType();
// Get frequency in specified units
Quantity get(const Unit &un) const;
// Make a Doppler velocity from the frequency and the specified rest frequency
// <group>
MDoppler toDoppler(const MVFrequency &rest);
MDoppler toDoppler(const MVFrequency &rest) const;
// </group>
// Local use only
static MDoppler toDoppler(const Measure &in, const MVFrequency &rest);
// Make a frequency from the Doppler velocity and the specified rest frequency
// (default reference type LSRK)
// <group>
static MFrequency fromDoppler(const MDoppler &dop,
const MVFrequency &rest);
static MFrequency fromDoppler(const MDoppler &dop,
const MVFrequency &rest,
MFrequency::Types type);
// For internal use only
static MFrequency fromDoppler(const Measure &dop,
const MVFrequency &rest,
MFrequency::Types type);
// </group>
// Make a rest frequency using a Doppler velocity
MFrequency toRest(const MDoppler &dop);
// For local use only
static MFrequency toRest(const Measure &in, const Measure &dop);
// Make a copy
// <group>
virtual Measure *clone() const;
// </group>
private:
//# Enumerations
//# Data
//# Member functions
};
} //# NAMESPACE CASACORE - END
#endif
|