casacore
Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | List of all members
casacore::LatticeTwoPtCorr< T > Class Template Reference

More...

#include <LatticeTwoPtCorr.h>

Public Types

enum  Method {
  UNDEFINED ,
  STRUCTUREFUNCTION ,
  NMETHODS
}
 

Public Member Functions

 LatticeTwoPtCorr ()
 Default constructor. More...
 
 ~LatticeTwoPtCorr ()
 Destructor. More...
 
void autoCorrelation (MaskedLattice< T > &out, const MaskedLattice< T > &in, const IPosition &axes, Method method, Bool showProgress=True) const
 Compute specified autocorrelation function for the planes of the given TWO axes. More...
 

Static Public Member Functions

static IPosition setUpShape (const IPosition &inShape, const IPosition &axes)
 Helper function to provide output lattice shape give the input shape and the axes to find the structure function over. More...
 
static Method fromString (const String &method)
 Helper functions to convert method types to and from strings. More...
 
static String toString (Method method)
 

Private Types

typedef T(LatticeTwoPtCorr< T >::* FuncPtr) (T d1, T d2) const
 Function Pointer typedef. More...
 

Private Member Functions

void autoCorrelation (MaskedLattice< T > &out, const MaskedLattice< T > &in, const IPosition &axes, FuncPtr, Bool showProgress) const
 Do the iteration work
More...
 
void check (LogIO &os, const MaskedLattice< T > &latOut, const MaskedLattice< T > &latIn, const IPosition &axes) const
 Check Output lattice shape. More...
 
structureFunction (T d1, T d2) const
 Compute structure function. More...
 

Detailed Description

template<class T>
class casacore::LatticeTwoPtCorr< T >

Compute two point auto-correlation functions from a lattice

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Synopsis

This class allows you to compute two point correlation functions from lattices over planes of the specified two axes. At present, only autocorrelation is implemented and only the structure function is available.

The structure function is S(x,y) = < [lat(i,j) - lat(i+x,j+y)]**2 > where x and y are absolute integer shifts (or lags).

Example

To Do

Definition at line 81 of file LatticeTwoPtCorr.h.

Member Typedef Documentation

◆ FuncPtr

template<class T >
typedef T(LatticeTwoPtCorr<T>::* casacore::LatticeTwoPtCorr< T >::FuncPtr) (T d1, T d2) const
private

Function Pointer typedef.

Definition at line 128 of file LatticeTwoPtCorr.h.

Member Enumeration Documentation

◆ Method

template<class T >
enum casacore::LatticeTwoPtCorr::Method
Enumerator
UNDEFINED 

Undefined.

STRUCTUREFUNCTION 

Structure Function.

NMETHODS 

nMethods

Definition at line 85 of file LatticeTwoPtCorr.h.

Constructor & Destructor Documentation

◆ LatticeTwoPtCorr()

template<class T >
casacore::LatticeTwoPtCorr< T >::LatticeTwoPtCorr ( )
inline

Default constructor.

Definition at line 99 of file LatticeTwoPtCorr.h.

◆ ~LatticeTwoPtCorr()

template<class T >
casacore::LatticeTwoPtCorr< T >::~LatticeTwoPtCorr ( )
inline

Destructor.

Definition at line 103 of file LatticeTwoPtCorr.h.

Member Function Documentation

◆ autoCorrelation() [1/2]

template<class T >
void casacore::LatticeTwoPtCorr< T >::autoCorrelation ( MaskedLattice< T > &  out,
const MaskedLattice< T > &  in,
const IPosition axes,
FuncPtr  ,
Bool  showProgress 
) const
private

Do the iteration work

◆ autoCorrelation() [2/2]

template<class T >
void casacore::LatticeTwoPtCorr< T >::autoCorrelation ( MaskedLattice< T > &  out,
const MaskedLattice< T > &  in,
const IPosition axes,
Method  method,
Bool  showProgress = True 
) const

Compute specified autocorrelation function for the planes of the given TWO axes.

If the output lattice has a mask, it will first be set to False (bad) and then any output pixel with some contributing values will be set to True (good).

◆ check()

template<class T >
void casacore::LatticeTwoPtCorr< T >::check ( LogIO os,
const MaskedLattice< T > &  latOut,
const MaskedLattice< T > &  latIn,
const IPosition axes 
) const
private

Check Output lattice shape.

◆ fromString()

template<class T >
static Method casacore::LatticeTwoPtCorr< T >::fromString ( const String method)
static

Helper functions to convert method types to and from strings.

◆ setUpShape()

template<class T >
static IPosition casacore::LatticeTwoPtCorr< T >::setUpShape ( const IPosition inShape,
const IPosition axes 
)
static

Helper function to provide output lattice shape give the input shape and the axes to find the structure function over.

◆ structureFunction()

template<class T >
T casacore::LatticeTwoPtCorr< T >::structureFunction ( d1,
d2 
) const
inlineprivate

Compute structure function.

Definition at line 142 of file LatticeTwoPtCorr.h.

◆ toString()

template<class T >
static String casacore::LatticeTwoPtCorr< T >::toString ( Method  method)
static

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