Loading...
Searching...
No Matches
Interpolate2D.h
Go to the documentation of this file.
//# 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: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef SCIMATH_INTERPOLATE2D_H
#define SCIMATH_INTERPOLATE2D_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/Arrays/ArrayFwd.h>
#include <casacore/casa/BasicSL/Complex.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward declarations
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<Double> where(2);
// where(0) = 3.452; where(1) = 6.1;
// Interpolate2D myInterp(Interpolate2D::LINEAR);
// Float result;
// Bool ok = myInterp.interp(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> 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 one Complex 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). The real
// and imaginary parts are treated independently (see CAS-11375).
// <group>
Bool interp (Complex &result,
const Vector<Double> &where,
const Matrix<Complex> &data) const;
Bool interp (Complex &result,
const Vector<Double> &where,
const Matrix<Complex> &data,
const Matrix<Bool> &mask) const;
// </group>
// Do one DComplex 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). The real
// and imaginary parts are treated independently (see CAS-11375).
// <group>
Bool interp (DComplex &result,
const Vector<Double> &where,
const Matrix<DComplex> &data) const;
Bool interp (DComplex &result,
const Vector<Double> &where,
const Matrix<DComplex> &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>
// Convert string ("nearest", "linear", "cubic", "lanczos") to interpolation
// method. The match is case insensitive.
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;
// 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
casacore::Interpolate2D::anyBadMaskPixels
Bool anyBadMaskPixels(const Matrix< Bool > *&mask, Int i1, Int i2, Int j1, Int j2) const
Are any of the mask pixels bad ?
casacore::Interpolate2D::Interpolate2D
Interpolate2D(Interpolate2D::Method method=Interpolate2D::LINEAR)
Constructor.
casacore::Interpolate2D::interpLinearBool
Bool interpLinearBool(Bool &result, const Vector< Double > &where, const Matrix< Bool > &data) const
casacore::Interpolate2D::itsFuncPtrDouble
FuncPtrDouble itsFuncPtrDouble
Definition Interpolate2D.h:273
casacore::Interpolate2D::bcucof
void bcucof(Double c[4][4], const Double y[4], const Double y1[4], const Double y2[4], const Double y12[4]) const
helping routine from numerical recipes
casacore::Interpolate2D::interpLinear2
Bool interpLinear2(T &resultI, T &resultJ, const Vector< Double > &where, const Matrix< T > &dataI, const Matrix< T > &dataJ, const Matrix< Bool > &mask) const
casacore::Interpolate2D::interp
Bool interp(Double &result, const Vector< Double > &where, const Matrix< Double > &data) const
Do one Double interpolation, supply Matrix/Array and mask (True is good), and pixel coordinate.
casacore::Interpolate2D::interp
Bool interp(Bool &result, const Vector< Double > &where, const Matrix< Bool > &data) const
Do one interpolation, supply boolean Matrix (True is good), and pixel coordinate.
casacore::Interpolate2D::operator=
Interpolate2D & operator=(const Interpolate2D &other)
Assignment operator (copy semantics).
casacore::Interpolate2D::FuncPtrDouble
Bool(Interpolate2D::* FuncPtrDouble)(Double &result, const Vector< Double > &where, const Matrix< Double > &data, const Matrix< Bool > *&maskPtr) const
Definition Interpolate2D.h:263
casacore::Interpolate2D::interp
Bool interp(Double &resultI, Double &resultJ, const Vector< Double > &where, const Matrix< Double > &dataI, const Matrix< Double > &dataJ, const Matrix< Bool > &mask) const
Do two linear interpolations simultaneously.
casacore::Interpolate2D::~Interpolate2D
~Interpolate2D()
destructor
casacore::Interpolate2D::interp
Bool interp(Double &result, const Vector< Double > &where, const Matrix< Double > &data, const Matrix< Bool > &mask) const
casacore::Interpolate2D::interp
Bool interp(DComplex &result, const Vector< Double > &where, const Matrix< DComplex > &data, const Matrix< Bool > &mask) const
casacore::Interpolate2D::interpCubicBool
Bool interpCubicBool(Bool &result, const Vector< Double > &where, const Matrix< Bool > &data) const
casacore::Interpolate2D::interp
Bool interp(Complex &result, const Vector< Double > &where, const Matrix< Complex > &data) const
Do one Complex interpolation, supply Matrix/Array and mask (True is good), and pixel coordinate.
casacore::Interpolate2D::interpLinear
Bool interpLinear(T &result, const Vector< Double > &where, const Matrix< T > &data, const Matrix< Bool > *&maskPtr) const
bi-linear interpolation
casacore::Interpolate2D::interpLanczosBool
Bool interpLanczosBool(Bool &result, const Vector< Double > &where, const Matrix< Bool > &data) const
casacore::Interpolate2D::FuncPtrBool
Bool(Interpolate2D::* FuncPtrBool)(Bool &result, const Vector< Double > &where, const Matrix< Bool > &data) const
Definition Interpolate2D.h:268
casacore::Interpolate2D::FuncPtrFloat
Bool(Interpolate2D::* FuncPtrFloat)(Float &result, const Vector< Double > &where, const Matrix< Float > &data, const Matrix< Bool > *&maskPtr) const
Typedefs for function pointers.
Definition Interpolate2D.h:258
casacore::Interpolate2D::Interpolate2D
Interpolate2D(const Interpolate2D &other)
Copy constructor (copy semantics).
casacore::Interpolate2D::sinc
T sinc(const T x) const
Lanczos interpolation: helper functions.
casacore::Interpolate2D::interpLanczos
Bool interpLanczos(T &result, const Vector< Double > &where, const Matrix< T > &data, const Matrix< Bool > *&maskPtr) const
Lanczos interpolation.
casacore::Interpolate2D::L
T L(const T x, const Int a) const
casacore::Interpolate2D::interp
Bool interp(Float &result, const Vector< Double > &where, const Matrix< Float > &data) const
Do one Float interpolation, supply Matrix and mask (True is good), and pixel coordinate.
casacore::Interpolate2D::interp
Bool interp(DComplex &result, const Vector< Double > &where, const Matrix< DComplex > &data) const
Do one DComplex interpolation, supply Matrix/Array and mask (True is good), and pixel coordinate.
casacore::Interpolate2D::interp
Bool interp(Complex &result, const Vector< Double > &where, const Matrix< Complex > &data, const Matrix< Bool > &mask) const
casacore::Interpolate2D::itsFuncPtrFloat
FuncPtrFloat itsFuncPtrFloat
Definition Interpolate2D.h:272
casacore::Interpolate2D::itsFuncPtrBool
FuncPtrBool itsFuncPtrBool
Definition Interpolate2D.h:274
casacore::Interpolate2D::interpNearest
Bool interpNearest(T &result, const Vector< Double > &where, const Matrix< T > &data, const Matrix< Bool > *&maskPtr) const
nearest neighbour interpolation
casacore::Interpolate2D::Method
Method
Definition Interpolate2D.h:97
casacore::Interpolate2D::LANCZOS
@ LANCZOS
Lanczos.
Definition Interpolate2D.h:109
casacore::Interpolate2D::LINEAR
@ LINEAR
Bilinear.
Definition Interpolate2D.h:103
casacore::Interpolate2D::CUBIC
@ CUBIC
Bicubic.
Definition Interpolate2D.h:106
casacore::Interpolate2D::NEAREST
@ NEAREST
Nearest neighbour.
Definition Interpolate2D.h:100
casacore::Interpolate2D::interp
Bool interp(Float &result, const Vector< Double > &where, const Matrix< Float > &data, const Matrix< Bool > &mask) const
casacore::Interpolate2D::interpNearestBool
Bool interpNearestBool(Bool &result, const Vector< Double > &where, const Matrix< Bool > &data) const
casacore::Interpolate2D::interpCubic
Bool interpCubic(T &result, const Vector< Double > &where, const Matrix< T > &data, const Matrix< Bool > *&maskPtr) const
bi-cubic interpolation
casacore::Interpolate2D::stringToMethod
static Interpolate2D::Method stringToMethod(const String &method)
Convert string ("nearest", "linear", "cubic", "lanczos") to interpolation method.
casacore::Matrix
Definition Matrix.h:87
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore::Vector
Definition Vector.h:82
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::mask
LatticeExprNode mask(const LatticeExprNode &expr)
This function returns the mask of the given expression.
casacore::Float
float Float
Definition aipstype.h:52
casacore::Int
int Int
Definition aipstype.h:48
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40
casacore::Double
double Double
Definition aipstype.h:53