/usr/include/casacore/coordinates/Coordinates/TabularCoordinate.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 | //# TabularCoordinate.h: Table lookup 1-D coordinate, with interpolation
//# Copyright (C) 1997,1998,1999,2000,2001,2003,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 COORDINATES_TABULARCOORDINATE_H
#define COORDINATES_TABULARCOORDINATE_H
#include <casacore/casa/aips.h>
#include <casacore/casa/Arrays/ArrayMath.h>
#include <casacore/casa/Arrays/Vector.h>
#include <casacore/coordinates/Coordinates/Coordinate.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
template<class Domain, class Range> class Interpolate1D;
template<class T> class Quantum;
class LogIO;
// <summary>
// Table lookup 1-D coordinate, with interpolation.
// </summary>
// <use visibility=export>
// <reviewed reviewer="Peter Barnes" date="1999/12/24" tests="tTabularCoordinate">
// </reviewed>
// <prerequisite>
// <li> <linkto class=Coordinate>Coordinate</linkto>
// </prerequisite>
//
// <synopsis>
// This class is used where the world and pixel values are determined by a
// lookup table. For fractional pixel values, a linear interpolation is used.
// The values returned for, e.g., the increment, are based on
// the average of the whole table. At present,
// the values must either increase or decrease monotonically.
// </synopsis>
//
// <note role=caution>
// All pixels coordinates are zero relative.
// </note>
//
// <example>
// Let's make a non-linear TabularCoordinate and convert a pixel
// value to world (which will use linear interpolation)
// <srcblock>
// Vector<Double> pixelValues(3);
// Vector<Double> worldValues(3);
// pixelValues(0) = 122.0;
// pixelValues(1) = 300.0;
// pixelValues(2) = 6524.0;
// worldValues(0) = 1.1e6;
// worldValues(1) = 2.1e6;
// worldValues(2) = 2.2e6;
//
// String unit("km");
// String axisName("length");
//
// TabularCoordinate tc(pixelValues, worldValues, unit, axisName);
//
// Double world, pixel;
// pixel = 200.12;
// if (!tc.toWorld(world, pixel)) {
// cerr << "Error : " << tc.errorMessage() << endl;
// } else {
// cerr << "pixel, world = " << pixel << ", " << world << endl;
// }
// </srcblock>
// </example>
//
// <motivation>
// This class was motivated by the need for an irregular axis, such as a collection
// of frequencies. For example, the SpectralCoordinate class contains a TabularCoordinate.
// </motivation>
//
//
// <thrown>
// <li> AipsError
// </thrown>
//
// <todo asof="1997/07/12">
// <li> Allow interpolations other than linear.
// </todo>
class TabularCoordinate : public Coordinate
{
public:
// Default constructor. It is equivalent to
// TabularCoordinate(0,1,0, "", "Tabular");
TabularCoordinate();
// Create a linear TabularCoordinate where
// <src>world = refval + inc*(pixel-refpix)</src>
TabularCoordinate(Double refval, Double inc, Double refpix,
const String &unit, const String &axisName);
// Create a linear TabularCoordinate with a Quantum-based interface where
// <src>world = refval + inc*(pixel-refpix)</src>. The units of the
// increment (<src>inc</src>) will be converted to
// those of the reference value (<src>refVal</src>) which will
// then serve as the units of the Coordinate.
TabularCoordinate(const Quantum<Double>& refval,
const Quantum<Double>& inc,
Double refpix, const String& axisName);
// Construct a TabularCoordinate with the specified world values. The
// increments and related functions return the average values
// calculated from the first and last world values. The number of pixel
// and world values must be the same. Normally the pixel values will be
// 0,1,2,..., but this is not required.
//
// A linear interpolation/extrapolation is used for channels which are not
// supplied. The reference channel (pixel) is chosen to be 0. The
// frequencies must increase or decrease monotonically (otherwise the
// toPixel lookup would not be possible).
TabularCoordinate(const Vector<Double> &pixelValues,
const Vector<Double> &worldValues,
const String &unit, const String &axisName);
// Construct a TabularCoordinate with the specified world values
// via the Quantum-based interface. All comments for the
// previous constructor apply
TabularCoordinate(const Vector<Double>& pixelValues,
const Quantum<Vector<Double> >& worldValues,
const String &axisName);
// Copy constructor (copy semantics).
TabularCoordinate(const TabularCoordinate &other);
// Assignment (copy semantics).
TabularCoordinate &operator=(const TabularCoordinate &other);
// Destructor.
virtual ~TabularCoordinate();
// Returns Coordinate::TABULAR.
virtual Coordinate::Type type() const;
// Always returns the String "Tabular".
virtual String showType() const;
// Always returns 1.
// <group>
virtual uInt nPixelAxes() const;
virtual uInt nWorldAxes() const;
// </group>
// Convert a pixel position to a world position or vice versa. Returns True
// if the conversion succeeds, otherwise it returns False and method
// errorMessage contains an error message. The output
// vectors are appropriately resized.
// The Bool parameter in toWorld() has no effect as this coordinate does
// not support a conversion layer frame.
// <group>
virtual Bool toWorld(Vector<Double> &world,
const Vector<Double> &pixel, Bool=True) const;
virtual Bool toPixel(Vector<Double> &pixel,
const Vector<Double> &world) const;
Bool toWorld(Double &world, Double pixel) const;
Bool toPixel(Double &pixel, Double world) const;
// </group>
// Batch up a lot of transformations. The first (most rapidly varying) axis
// of the matrices contain the coordinates. Returns False if any conversion
// failed and <src>errorMessage()</src> will hold a message.
// The <src>failures</src> array (True for fail, False for success)
// is the length of the number of conversions and
// holds an error status for each conversion.
// <group>
virtual Bool toWorldMany(Matrix<Double> &world,
const Matrix<Double> &pixel,
Vector<Bool>& failures) const;
virtual Bool toPixelMany(Matrix<Double>& pixel,
const Matrix<Double>& world,
Vector<Bool>& failures) const;
// </group>
// Make absolute coordinates relative and vice-versa (with
// respect to the referencfe value).
// Vectors must be length <src>nPixelAxes()</src> or
// <src>nWorldAxes()</src> or memory access errors will occur
// <group>
virtual void makePixelRelative (Vector<Double>& pixel) const {pixel -= crpix_p;};
virtual void makePixelAbsolute (Vector<Double>& pixel) const {pixel += crpix_p;};
virtual void makeWorldRelative (Vector<Double>& world) const {world -= crval_p;};
virtual void makeWorldAbsolute (Vector<Double>& world) const {world += crval_p;};
// </group>
// Return the requested attribute.
// <group>
virtual Vector<String> worldAxisNames() const;
virtual Vector<Double> referencePixel() const;
virtual Matrix<Double> linearTransform() const;
virtual Vector<Double> increment() const;
virtual Vector<Double> referenceValue() const;
// </group>
// Set the value of the requested attribute. Note that these just
// change the internal values, they do not cause any recomputation.
// <group>
virtual Bool setWorldAxisNames(const Vector<String> &names);
virtual Bool setReferencePixel(const Vector<Double> &refPix);
virtual Bool setLinearTransform(const Matrix<Double> &xform);
virtual Bool setIncrement(const Vector<Double> &inc) ;
virtual Bool setReferenceValue(const Vector<Double> &refval);
// </group>
// Set/get the axis unit. Adjust the increment and
// reference value by the ratio of the old and new units.
// The unit must be compatible with the current units.
// <group>
virtual Bool setWorldAxisUnits(const Vector<String> &units);
virtual Vector<String> worldAxisUnits() const;
// </group>
// Overwrite the world axis units with no compatibility
// checks or adjustment.
Bool overwriteWorldAxisUnits(const Vector<String> &units);
// Get the table, i.e. the pixel and world values. The length of these
// Vectors will be zero if this axis is pure linear.
// <group>
Vector<Double> pixelValues() const;
Vector<Double> worldValues() const;
// </group>
// Comparison function. Any private Double data members are compared
// with the specified fractional tolerance. Don't compare on the specified
// axes in the Coordinate. If the comparison returns False, method
// errorMessage() contains a message about why.
// <group>
virtual Bool near(const Coordinate& other,
Double tol=1e-6) const;
virtual Bool near(const Coordinate& other,
const Vector<Int>& excludeAxes,
Double tol=1e-6) const;
// </group>
// Find the Coordinate for when we Fourier Transform ourselves. This pointer
// must be deleted by the caller. Axes specifies which axes of the Coordinate
// you wish to transform. Shape specifies the shape of the image
// associated with all the axes of the Coordinate. Currently the
// output reference pixel is always shape/2. If the pointer returned is 0,
// it failed with a message in <src>errorMessage</src>
virtual Coordinate* makeFourierCoordinate (const Vector<Bool>& axes,
const Vector<Int>& shape) const;
// Save the TabularCoordinate into the supplied record using the supplied field name.
// The field must not exist, otherwise <src>False</src> is returned.
virtual Bool save(RecordInterface &container, const String &fieldName) const;
// Recover the TabularCoordinate from a record.
// A null pointer means that the restoration did not succeed - probably
// because fieldName doesn't exist or doesn't contain a CoordinateSystem.
static TabularCoordinate *restore(const RecordInterface &container,
const String &fieldName);
// Make a copy of the TabularCoordinate using new. The caller is responsible for calling
// delete.
virtual Coordinate *clone() const;
private:
Double crval_p, cdelt_p, crpix_p;
Double matrix_p;
String unit_p;
String name_p;
// Channel_True = channel_corrections_p(Channel_average).
// <group>
Interpolate1D<Double,Double> *channel_corrector_p;
Interpolate1D<Double,Double> *channel_corrector_rev_p;
// </group>
// Common for assignment operator and destructor.
void clear_self();
// Common code for copy ctor and assignment operator.
void copy(const TabularCoordinate &other);
void makeNonLinearTabularCoordinate(const Vector<Double> &pixelValues,
const Vector<Double> &worldValues);
};
} //# NAMESPACE CASACORE - END
#endif
|