casacore
Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
casacore::Interpolate2D Class Reference

A two dimension interpolator for Matrices or Arrays. More...

#include <Interpolate2D.h>

Public Types

enum  Method {
  NEAREST,
  LINEAR,
  CUBIC,
  LANCZOS
}
 

Public Member Functions

 Interpolate2D (Interpolate2D::Method method=Interpolate2D::LINEAR)
 Constructor. More...
 
 Interpolate2D (const Interpolate2D &other)
 Copy constructor (copy semantics) More...
 
 ~Interpolate2D ()
 destructor More...
 
Interpolate2Doperator= (const Interpolate2D &other)
 Assignment operator (copy semantics) More...
 
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. More...
 
Bool interp (Float &result, const Vector< Double > &where, const Matrix< Float > &data, const Matrix< Bool > &mask) const
 
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. More...
 
Bool interp (Double &result, const Vector< Double > &where, const Matrix< Double > &data, const Matrix< Bool > &mask) const
 
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. More...
 
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
 
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. More...
 
Method interpolationMethod () const
 Recover interpolation method. More...
 

Static Public Member Functions

static Interpolate2D::Method stringToMethod (const String &method)
 Convert string ("nearest", "linear", "cubic") to interpolation method Minimum match will do. More...
 

Private Types

typedef Bool(Interpolate2D::* FuncPtrFloat) (Float &result, const Vector< Double > &where, const Matrix< Float > &data, const Matrix< Bool > *&maskPtr) const
 Typedefs for function pointers. More...
 
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
 

Private Member Functions

Bool anyBadMaskPixels (const Matrix< Bool > *&mask, Int i1, Int i2, Int j1, Int j2) const
 Are any of the mask pixels bad ? Returns False if no mask. More...
 
template<typename T >
Bool interpNearest (T &result, const Vector< Double > &where, const Matrix< T > &data, const Matrix< Bool > *&maskPtr) const
 nearest neighbour interpolation More...
 
Bool interpNearestBool (Bool &result, const Vector< Double > &where, const Matrix< Bool > &data) const
 
template<typename T >
Bool interpLinear (T &result, const Vector< Double > &where, const Matrix< T > &data, const Matrix< Bool > *&maskPtr) const
 bi-linear interpolation More...
 
Bool interpLinearBool (Bool &result, const Vector< Double > &where, const Matrix< Bool > &data) const
 
template<typename T >
Bool interpCubic (T &result, const Vector< Double > &where, const Matrix< T > &data, const Matrix< Bool > *&maskPtr) const
 bi-cubic interpolation More...
 
Bool interpCubicBool (Bool &result, const Vector< Double > &where, const Matrix< Bool > &data) const
 
template<typename T >
Bool interpLanczos (T &result, const Vector< Double > &where, const Matrix< T > &data, const Matrix< Bool > *&maskPtr) const
 Lanczos interpolation. More...
 
Bool interpLanczosBool (Bool &result, const Vector< Double > &where, const Matrix< Bool > &data) const
 
template<typename T >
sinc (const T x) const
 Lanczos interpolation: helper functions. More...
 
template<typename T >
L (const T x, const Int a) const
 
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 More...
 

Private Attributes

Interpolate2D::Method itsMethod
 
FuncPtrFloat itsFuncPtrFloat
 
FuncPtrDouble itsFuncPtrDouble
 
FuncPtrBool itsFuncPtrBool
 

Detailed Description

A two dimension interpolator for Matrices or Arrays.

Intended use:

Public interface

Review Status

Reviewed By:
wbrouw
Date Reviewed:
2004/05/26

Prerequisite

Etymology

This class is called Interpolate2D because it does 2 dimensional interpolations

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.

Example

Matrix<Float> matt(10,10);
Vector<Float> where(2);
where(0) = 3.452; where(1) = 6.1;
Float result;
Bool ok = myInterp(result, where, matt);

Motivation

2-D interpolation is required in geometry transformation routines such as in ImageRegrid.

To Do

Definition at line 99 of file Interpolate2D.h.

Member Typedef Documentation

§ FuncPtrBool

typedef Bool(Interpolate2D::* casacore::Interpolate2D::FuncPtrBool) (Bool &result, const Vector< Double > &where, const Matrix< Bool > &data) const
private

Definition at line 249 of file Interpolate2D.h.

§ FuncPtrDouble

typedef Bool(Interpolate2D::* casacore::Interpolate2D::FuncPtrDouble) (Double &result, const Vector< Double > &where, const Matrix< Double > &data, const Matrix< Bool > *&maskPtr) const
private

Definition at line 244 of file Interpolate2D.h.

§ FuncPtrFloat

typedef Bool(Interpolate2D::* casacore::Interpolate2D::FuncPtrFloat) (Float &result, const Vector< Double > &where, const Matrix< Float > &data, const Matrix< Bool > *&maskPtr) const
private

Typedefs for function pointers.

Definition at line 239 of file Interpolate2D.h.

Member Enumeration Documentation

§ Method

Enumerator
NEAREST 

Nearest neighbour.

LINEAR 

Bilinear.

CUBIC 

Bicubic.

LANCZOS 

Lanczos.

Definition at line 102 of file Interpolate2D.h.

Constructor & Destructor Documentation

§ Interpolate2D() [1/2]

casacore::Interpolate2D::Interpolate2D ( Interpolate2D::Method  method = Interpolate2D::LINEAR)

Constructor.

§ Interpolate2D() [2/2]

casacore::Interpolate2D::Interpolate2D ( const Interpolate2D other)

Copy constructor (copy semantics)

§ ~Interpolate2D()

casacore::Interpolate2D::~Interpolate2D ( )

destructor

Member Function Documentation

§ anyBadMaskPixels()

Bool casacore::Interpolate2D::anyBadMaskPixels ( const Matrix< Bool > *&  mask,
Int  i1,
Int  i2,
Int  j1,
Int  j2 
) const
private

Are any of the mask pixels bad ? Returns False if no mask.

Referenced by interpolationMethod().

§ bcucof()

void casacore::Interpolate2D::bcucof ( Double  c[4][4],
const Double  y[4],
const Double  y1[4],
const Double  y2[4],
const Double  y12[4] 
) const
private

helping routine from numerical recipes

Referenced by interpolationMethod().

§ interp() [1/6]

Bool casacore::Interpolate2D::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.

Returns False if coordinate out of range or data are masked. No shape integrity checking is done (see above).

§ interp() [2/6]

Bool casacore::Interpolate2D::interp ( Float result,
const Vector< Double > &  where,
const Matrix< Float > &  data,
const Matrix< Bool > &  mask 
) const

§ interp() [3/6]

Bool casacore::Interpolate2D::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.

Returns False if coordinate out of range or data are masked. No shape integrity checking is done (see above).

§ interp() [4/6]

Bool casacore::Interpolate2D::interp ( Double result,
const Vector< Double > &  where,
const Matrix< Double > &  data,
const Matrix< Bool > &  mask 
) const

§ interp() [5/6]

Bool casacore::Interpolate2D::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.

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.

§ interp() [6/6]

Bool casacore::Interpolate2D::interp ( Bool result,
const Vector< Double > &  where,
const Matrix< Bool > &  data 
) const

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.

§ interpCubic()

template<typename T >
Bool casacore::Interpolate2D::interpCubic ( T &  result,
const Vector< Double > &  where,
const Matrix< T > &  data,
const Matrix< Bool > *&  maskPtr 
) const
private

bi-cubic interpolation

Referenced by interpolationMethod().

§ interpCubicBool()

Bool casacore::Interpolate2D::interpCubicBool ( Bool result,
const Vector< Double > &  where,
const Matrix< Bool > &  data 
) const
private

Referenced by interpolationMethod().

§ interpLanczos()

template<typename T >
Bool casacore::Interpolate2D::interpLanczos ( T &  result,
const Vector< Double > &  where,
const Matrix< T > &  data,
const Matrix< Bool > *&  maskPtr 
) const
private

Lanczos interpolation.

Referenced by interpolationMethod().

§ interpLanczosBool()

Bool casacore::Interpolate2D::interpLanczosBool ( Bool result,
const Vector< Double > &  where,
const Matrix< Bool > &  data 
) const
private

Referenced by interpolationMethod().

§ interpLinear()

template<typename T >
Bool casacore::Interpolate2D::interpLinear ( T &  result,
const Vector< Double > &  where,
const Matrix< T > &  data,
const Matrix< Bool > *&  maskPtr 
) const
private

bi-linear interpolation

Referenced by interpolationMethod().

§ interpLinear2()

template<typename T >
Bool casacore::Interpolate2D::interpLinear2 ( T &  resultI,
T &  resultJ,
const Vector< Double > &  where,
const Matrix< T > &  dataI,
const Matrix< T > &  dataJ,
const Matrix< Bool > &  mask 
) const

§ interpLinearBool()

Bool casacore::Interpolate2D::interpLinearBool ( Bool result,
const Vector< Double > &  where,
const Matrix< Bool > &  data 
) const
private

Referenced by interpolationMethod().

§ interpNearest()

template<typename T >
Bool casacore::Interpolate2D::interpNearest ( T &  result,
const Vector< Double > &  where,
const Matrix< T > &  data,
const Matrix< Bool > *&  maskPtr 
) const
private

nearest neighbour interpolation

Referenced by interpolationMethod().

§ interpNearestBool()

Bool casacore::Interpolate2D::interpNearestBool ( Bool result,
const Vector< Double > &  where,
const Matrix< Bool > &  data 
) const
private

Referenced by interpolationMethod().

§ interpolationMethod()

Method casacore::Interpolate2D::interpolationMethod ( ) const
inline

§ L()

template<typename T >
T casacore::Interpolate2D::L ( const T  x,
const Int  a 
) const
private

Referenced by interpolationMethod().

§ operator=()

Interpolate2D& casacore::Interpolate2D::operator= ( const Interpolate2D other)

Assignment operator (copy semantics)

§ sinc()

template<typename T >
T casacore::Interpolate2D::sinc ( const T  x) const
private

Lanczos interpolation: helper functions.

Referenced by interpolationMethod().

§ stringToMethod()

static Interpolate2D::Method casacore::Interpolate2D::stringToMethod ( const String method)
static

Convert string ("nearest", "linear", "cubic") to interpolation method Minimum match will do.

Referenced by interpolationMethod().

Member Data Documentation

§ itsFuncPtrBool

FuncPtrBool casacore::Interpolate2D::itsFuncPtrBool
private

Definition at line 255 of file Interpolate2D.h.

§ itsFuncPtrDouble

FuncPtrDouble casacore::Interpolate2D::itsFuncPtrDouble
private

Definition at line 254 of file Interpolate2D.h.

§ itsFuncPtrFloat

FuncPtrFloat casacore::Interpolate2D::itsFuncPtrFloat
private

Definition at line 253 of file Interpolate2D.h.

§ itsMethod

Interpolate2D::Method casacore::Interpolate2D::itsMethod
private

Definition at line 235 of file Interpolate2D.h.

Referenced by interpolationMethod().


The documentation for this class was generated from the following file: