/usr/include/casacore/scimath/Mathematics/Interpolate2D.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 | //# Interpolate2D.h: this defines the Interpolate2D class
//# Copyright (C) 1996,1997,1998,1999,2000,2001,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 SCIMATH_INTERPOLATE2D_H
#define SCIMATH_INTERPOLATE2D_H
//# Includes
#include <casacore/casa/aips.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward declarations
template <typename T> class Vector;
template <typename T> class Matrix;
class String;
// <summary>
// A two dimension interpolator for Matrices or Arrays
// </summary>
// <use visibility=export>
// <reviewed reviewer="wbrouw" date="2004/05/26" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class=Array>Arrays</linkto>
// </prerequisite>
//
// <etymology>
// This class is called Interpolate2D because it does 2 dimensional interpolations
// </etymology>
//
// <synopsis>
// Given a regular Array or Matrix and a vector of pixel
// coordinates, interpolate the values of that array/matrix onto those
// pixel coordinates.
//
// Absolutely no checking of the consistency of the input data
// is done in order to preserve maximum speed. The coordinate vector
// *must* have at least 2 elements (others will be ignored). If
// you supply data and mask, those arrays *must* be the same shape.
// Failure to follow these rules will result in your program
// crashing.
// </synopsis>
//
// <example>
// <srcblock>
//
// Matrix<Float> matt(10,10);
// Vector<Float> where(2);
// where(0) = 3.452; where(1) = 6.1;
// Interpolate2D myInterp(Interpolate2D::LINEAR);
// Float result;
// Bool ok = myInterp(result, where, matt);
//
// </srcblock>
// </example>
//
// <motivation>
// 2-D interpolation is required in geometry transformation routines
// such as in ImageRegrid.
// </motivation>
//
//
// <todo asof="1998/08/02">
// <li> Now that there are float/double/bool versions, the class should
// be templated and specialized versions made as needed. The
// code duplucation in the Float/Double versions is pretty awful presently.
// <li> Alternative approach: instantiate with an Array, take a block of
// vector locations, return a block of interpolation results
// </todo>
class Interpolate2D {
public:
enum Method {
// Nearest neighbour
NEAREST,
// Bilinear
LINEAR,
// Bicubic
CUBIC,
// Lanczos
LANCZOS};
// Constructor
Interpolate2D(Interpolate2D::Method method=Interpolate2D::LINEAR);
// Copy constructor (copy semantics)
Interpolate2D(const Interpolate2D &other);
// destructor
~Interpolate2D();
// Assignment operator (copy semantics)
Interpolate2D &operator=(const Interpolate2D &other);
// Do one Float interpolation, supply Matrix and mask (True is good),
// and pixel coordinate. Returns False if coordinate out of range or data
// are masked. No shape integrity checking is done (see above).
// <group>
Bool interp (Float &result,
const Vector<Double> &where,
const Matrix<Float> &data) const;
Bool interp (Float &result,
const Vector<Double> &where,
const Matrix<Float> &data,
const Matrix<Bool> &mask) const;
// </group>
// Do one Double interpolation, supply Matrix/Array and mask (True is good),
// and pixel coordinate. Returns False if coordinate out of range or data
// are masked. No shape integrity checking is done (see above).
// <group>
Bool interp (Double &result,
const Vector<Double> &where,
const Matrix<Double> &data) const;
Bool interp (Double &result,
const Vector<Double> &where,
const Matrix<Double> &data,
const Matrix<Bool> &mask) const;
// </group>
// Do two linear interpolations simultaneously. The second call is direct.
// The first call transfers to the second call. It is assumed that the
// structure (shape, steps) of the mask and data files are the same.
// <group>
Bool interp(Double &resultI, Double &resultJ,
const Vector<Double> &where,
const Matrix<Double> &dataI,
const Matrix<Double> &dataJ,
const Matrix<Bool> &mask) const;
template <typename T>
Bool interpLinear2(T &resultI, T &resultJ,
const Vector<Double> &where,
const Matrix<T> &dataI,
const Matrix<T> &dataJ,
const Matrix<Bool> &mask) const;
// </group>
// Do one interpolation, supply boolean Matrix (True is good),
// and pixel coordinate. Returns False if coordinate
// out of range. The result is False if any data value in the interpolation
// grid are False (bad), else True. No shape integrity checking is done.
// <group>
Bool interp (Bool &result,
const Vector<Double> &where,
const Matrix<Bool> &data) const;
// </group>
// Recover interpolation method
Method interpolationMethod() const {return itsMethod;}
// Convert string ("nearest", "linear", "cubic") to interpolation method
// Minimum match will do.
static Interpolate2D::Method stringToMethod(const String &method);
private:
// Are any of the mask pixels bad ? Returns False if no mask.
Bool anyBadMaskPixels (const Matrix<Bool>* &mask, Int i1, Int i2,
Int j1, Int j2) const;
// nearest neighbour interpolation
template <typename T>
Bool interpNearest(T &result, const Vector<Double> &where,
const Matrix<T> &data,
const Matrix<Bool>* &maskPtr) const;
Bool interpNearestBool(Bool &result, const Vector<Double> &where,
const Matrix<Bool> &data) const;
// bi-linear interpolation
template <typename T>
Bool interpLinear(T &result, const Vector<Double> &where,
const Matrix<T> &data,
const Matrix<Bool>* &maskPtr) const;
Bool interpLinearBool(Bool &result, const Vector<Double> &where,
const Matrix<Bool> &data) const;
// bi-cubic interpolation
template <typename T>
Bool interpCubic(T &result, const Vector<Double> &where,
const Matrix<T> &data,
const Matrix<Bool>* &maskPtr) const;
Bool interpCubicBool(Bool &result, const Vector<Double> &where,
const Matrix<Bool> &data) const;
// Lanczos interpolation
template <typename T>
Bool interpLanczos(T &result, const Vector<Double> &where,
const Matrix<T> &data,
const Matrix<Bool>* &maskPtr) const;
Bool interpLanczosBool(Bool &result, const Vector<Double> &where,
const Matrix<Bool> &data) const;
// Lanczos interpolation: helper functions
template <typename T>
T sinc(const T x) const;
template <typename T>
T L(const T x, const Int a) const;
// helping routine from numerical recipes
void bcucof (Double c[4][4], const Double y[4],
const Double y1[4],
const Double y2[4], const Double y12[4]) const;
//
Interpolate2D::Method itsMethod;
// Typedefs for function pointers
typedef Bool(Interpolate2D::*FuncPtrFloat)
(Float &result,
const Vector<Double> &where,
const Matrix<Float> &data,
const Matrix<Bool>* &maskPtr) const;
typedef Bool(Interpolate2D::*FuncPtrDouble)
(Double &result,
const Vector<Double> &where,
const Matrix<Double> &data,
const Matrix<Bool>* &maskPtr) const;
typedef Bool(Interpolate2D::*FuncPtrBool)
(Bool &result,
const Vector<Double> &where,
const Matrix<Bool> &data) const;
//
FuncPtrFloat itsFuncPtrFloat;
FuncPtrDouble itsFuncPtrDouble;
FuncPtrBool itsFuncPtrBool;
};
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/scimath/Mathematics/Interpolate2D2.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|