/usr/include/casacore/measures/Measures/MEarthMagnetic.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 | //# MEarthMagnetic.h: A Measure: Magnetic field on Earth
//# Copyright (C) 1995-1999,2000,2002,2004
//# 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_MEARTHMAGNETIC_H
#define MEASURES_MEARTHMAGNETIC_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/measures/Measures/MeasBase.h>
#include <casacore/measures/Measures/MeasRef.h>
#include <casacore/casa/Quanta/MVEarthMagnetic.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class MEarthMagnetic;
class MCEarthMagnetic;
template <class M> class MeasConvert;
template <class M> class ArrayMeasColumn;
template <class M> class ScalarMeasColumn;
//# Typedefs
// <summary> A Measure: Magnetic field on Earth </summary>
// <use visibility=export>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class=Measure>Measure</linkto> class
// </prerequisite>
//
// <etymology>
// Earth and Magnetic field
// </etymology>
//
// <synopsis>
// MEarthMagnetic forms derived Measure class for Earth' magnetic flux density.
// The field can be specified as a model, or as a 3D vector (see
// <linkto class=MVEarthMagnetic>MVEarthMagnetic</linkto>) with a specified
// reference frame code. If a model is specified, a possibly specified
// explicit field will be ignored, since the field will be calculated from
// the model if a conversion is asked for.<br>
// The class contains the following magnetic field models:
// <ul>
// <li> IGRF international reference field
// </ul>
// The reference frame type can be any of the types specified in the
// <linkto class=MDirection>MDirection</linkto> direction types (e.g. AZEL).
// <note role=warning>
// The IGRF needs a Table of coefficients (at 5-year interval) </note>
//
// Conversion between field models is not supported (but not relevant
// anyway with only one model supported). Conversion to an explicit direction
// is done by the standard <linkto class=MeasConvert>MeasConvert</linkto>
// class and rules (see example) using <em>MEarthMagnetic::Convert</em>,
// and the reference types (e.g. MEarthMagnetic::AZEL).
//
// An <linkto class=EarthMagneticMachine> EarthMagneticMachine</linkto> has
// been provided to get e.g. the field in a certain direction at a
// certain height.
//
// </synopsis>
//
// <example>
// <srcblock>
// // Where on Earth
// MPosition pos(MVPosition(Quantity(20,'m'), Quantity(5,'deg'),
// Quantity(52,'deg')), MPosition::WGS84);
// // Time we want it
// MEpoch epo(MVEpoch(50000));
// // Put in frame
// MeasFrame frame(pos, epo);
// // Magnetic field model
// MEarthMagnetic mf;
// // Show field strength in Gauss in AzEl system
// cout <<
// MEarthMagnetic::Convert(mf, MEarthMagnetic::AZEL)().
// getValue().getLength("G") << endl;
// </srcblock>
// </example>
//
// <motivation>
// To have the Earth' magnetic field in the standard Measure environment.
// </motivation>
//
// <todo asof="2000/06/15">
// <li> maybe add other field models if necessary (e.g. dipole)
// </todo>
class MEarthMagnetic : public MeasBase<MVEarthMagnetic, MeasRef<MEarthMagnetic> > {
public:
//# Friends
// Conversion of data
friend class MeasConvert<MEarthMagnetic>;
//# Enumerations
// Types of known MEarthMagnetics
// <note role=tip> The order defines the order in the translation matrix
// FromTo
// in the getConvert routine in MCEarthMagnetic. 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 {
J2000,
JMEAN,
JTRUE,
APP,
B1950,
BMEAN,
BTRUE,
GALACTIC,
HADEC,
AZEL,
AZELSW,
AZELGEO,
AZELSWGEO,
JNAT,
ECLIPTIC,
MECLIPTIC,
TECLIPTIC,
SUPERGAL,
ITRF,
TOPO,
ICRS,
N_Types,
// Models. First one should be IGRF
IGRF = 32,
N_Models,
// All extra bits (for internal use only)
EXTRA = 32,
// Defaults
DEFAULT=IGRF,
// Synonyms
AZELNE=AZEL,
AZELNEGEO=AZELGEO
};
//# Typedefs
// Measure value container for this class (i.e. MEarthMagnetic::MVType)
typedef MVEarthMagnetic MVType;
// Measure conversion routines for this class (i.e. MEarthMagnetic::MCType)
typedef MCEarthMagnetic MCType;
// Measure reference (i.e. MEarthMagnetic::Ref)
typedef MeasRef<MEarthMagnetic> Ref;
// Measure Convert (i.e. MEarthMagnetic::Convert)
typedef MeasConvert<MEarthMagnetic> Convert;
// Measure table Columns (e.g., MEarthMagnetic::ScalarColumn)
typedef ScalarMeasColumn<MEarthMagnetic> ScalarColumn;
typedef ArrayMeasColumn<MEarthMagnetic> ArrayColumn;
// Reference enum Types (included originally for gcc 2.95)
typedef WHATEVER_SUN_TYPEDEF(MEarthMagnetic) Types Types;
//# Constructors
// <note> 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 the default IGRF type
MEarthMagnetic();
// Create from data and reference
// <group>
MEarthMagnetic(const MVEarthMagnetic &dt);
MEarthMagnetic(const MVEarthMagnetic &dt, const MEarthMagnetic::Ref &rf);
MEarthMagnetic(const MVEarthMagnetic &dt, MEarthMagnetic::Types rf);
MEarthMagnetic(const Measure *dt);
MEarthMagnetic(const MeasValue *dt);
MEarthMagnetic(const MEarthMagnetic::Ref &rf);
// </group>
// <group>
MEarthMagnetic(const MEarthMagnetic &);
MEarthMagnetic &operator=(const MEarthMagnetic &);
// </group>
//# Destructor
virtual ~MEarthMagnetic();
//# 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 MEarthMagnetic::Types castType(uInt tp);
static const String &showType(MEarthMagnetic::Types tp);
static const String &showType(uInt tp);
// </group>
// Translate string to reference code
// <group>
static Bool getType(MEarthMagnetic::Types &tp, const String &in);
Bool giveMe(MEarthMagnetic::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();
// Tell me if you are a pure model (e.g. a planet)
virtual Bool isModel() const;
// Get Measure data
// <group>
Quantum<Vector<Double> > get(const Unit &inunit) const;
Quantum<Vector<Double> > getAngle() const;
Quantum<Vector<Double> > getAngle(const Unit &inunit) const;
// </group>
// Make copy
virtual Measure *clone() const;
private:
//# Enumerations
//# Data
//# Member functions
};
} //# NAMESPACE CASACORE - END
#endif
|