casacore
Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::CurvedLattice2D< T > Class Template Reference

A lattice crosscut based on a curve in a plane. More...

#include <CurvedImage2D.h>

Public Member Functions

 CurvedLattice2D ()
 Default constructor. More...
 
 CurvedLattice2D (const MaskedLattice< T > &, const CLInterpolator2D< T > &, const PixelCurve1D &, uInt axis1, uInt axis2, Int curveAxis=-1)
 Take a curved slice from the given MaskedLattice. More...
 
 CurvedLattice2D (const CurvedLattice2D< T > &other)
 Copy constructor (reference semantics) More...
 
virtual ~CurvedLattice2D ()
 Destructor, does nothing. More...
 
CurvedLattice2D< T > & operator= (const CurvedLattice2D< T > &other)
 Assignment (reference semantics) More...
 
virtual MaskedLattice< T > * cloneML () const
 Make a copy of the object (reference semantics). More...
 
virtual Bool isMasked () const
 Is the lattice masked? It is if its parent lattice is masked. More...
 
virtual Bool isPaged () const
 Is the lattice paged to disk? More...
 
virtual Bool isWritable () const
 The lattice is not writable. More...
 
virtual Bool lock (FileLocker::LockType, uInt nattempts)
 Handle ocking of the lattice which is delegated to its parent. More...
 
virtual void unlock ()
 
virtual Bool hasLock (FileLocker::LockType) const
 
virtual void resync ()
 Resynchronize the Lattice object with the lattice file. More...
 
virtual void flush ()
 Flush the data. More...
 
virtual void tempClose ()
 Close the Lattice temporarily (if it is paged to disk). More...
 
virtual void reopen ()
 If needed, reopen a temporarily closed Lattice. More...
 
virtual const LatticeRegiongetRegionPtr () const
 Get a pointer the region/mask object. More...
 
virtual IPosition shape () const
 Returns the shape of the lattice. More...
 
virtual String name (Bool stripPath=False) const
 Return the name of the parent lattice. More...
 
virtual uInt advisedMaxPixels () const
 This function returns the recommended maximum number of pixels to include in the cursor of an iterator. More...
 
virtual Bool ok () const
 Check class internals - used for debugging. More...
 
virtual Bool doGetSlice (Array< T > &buffer, const Slicer &section)
 Do the actual getting of an array of values. More...
 
virtual void doPutSlice (const Array< T > &sourceBuffer, const IPosition &where, const IPosition &stride)
 Do the actual getting of an array of values. More...
 
virtual Bool doGetMaskSlice (Array< Bool > &buffer, const Slicer &section)
 Get a section of the mask. More...
 
virtual IPosition doNiceCursorShape (uInt maxPixels) const
 Get the best cursor shape. More...
 

Private Member Functions

void makeMapping (uInt axis1, uInt axis2, Int curveAxis)
 Make the AxesMapping object to map input to output axes. More...
 

Private Attributes

MaskedLattice< T > * itsLatticePtr
 
CLInterpolator2D< T > * itsInterpolator
 
PixelCurve1D itsCurve
 
uInt itsAxis1
 
uInt itsAxis2
 
uInt itsCurveAxis
 
AxesMapping itsAxesMap
 

Detailed Description

template<class T>
class casacore::CurvedLattice2D< T >

A lattice crosscut based on a curve in a plane.

Intended use:

Internal

Review Status

Test programs:
tCurvedLattice2D

Prerequisite

Synopsis

Class CurvedImage2D can be used to make a crosscut through an image with a dimensionality >= 2. The crosscut is based on a curve defined by a PixelCurve1D object. The curve can be any 1-dim function (e.g. straight line, spline) supported by the Functionals module. The curve must be in one of the main planes of the image as defined by the axes arguments in the constructor.
See class CurvedImage2D for a more detailed description.

Example

See example in CurvedImage2D.

Motivation

Users like to view arbitrary image crosscuts.

Definition at line 39 of file CurvedImage2D.h.

Constructor & Destructor Documentation

◆ CurvedLattice2D() [1/3]

template<class T >
casacore::CurvedLattice2D< T >::CurvedLattice2D ( )

Default constructor.

◆ CurvedLattice2D() [2/3]

template<class T >
casacore::CurvedLattice2D< T >::CurvedLattice2D ( const MaskedLattice< T > &  ,
const CLInterpolator2D< T > &  ,
const PixelCurve1D ,
uInt  axis1,
uInt  axis2,
Int  curveAxis = -1 
)

Take a curved slice from the given MaskedLattice.

For example, define a spline in the RA-DEC plane and extend it in the FREQ direction. The result is a 2D lattice with axes FREQ and 'spline'.
The PixelCurve1D object defines the curve in one of the planes of the lattice. The arguments axis1 and axis2 define the plane the curve is in. The CLInterpolator2D object defines the interpolation scheme for pixels that are not on grid points. An example is CLIPNearest2D which takes the nearest neighbour. The dimensionality of the CurvedLattice2D is one less than the dimensionality of the given lattice. Two axes (axis1 and axis2) are replaced by the new axis representing the curve. The argument curveAxis defines the axis number of the new axis. It defaults to the last axis. An exception is thrown if the dimensionality of the input lattice is < 2 or if the given axes numbers are too high.

◆ CurvedLattice2D() [3/3]

template<class T >
casacore::CurvedLattice2D< T >::CurvedLattice2D ( const CurvedLattice2D< T > &  other)

Copy constructor (reference semantics)

◆ ~CurvedLattice2D()

template<class T >
virtual casacore::CurvedLattice2D< T >::~CurvedLattice2D ( )
virtual

Destructor, does nothing.

Member Function Documentation

◆ advisedMaxPixels()

template<class T >
virtual uInt casacore::CurvedLattice2D< T >::advisedMaxPixels ( ) const
virtual

This function returns the recommended maximum number of pixels to include in the cursor of an iterator.

◆ cloneML()

template<class T >
virtual MaskedLattice<T>* casacore::CurvedLattice2D< T >::cloneML ( ) const
virtual

Make a copy of the object (reference semantics).

◆ doGetMaskSlice()

template<class T >
virtual Bool casacore::CurvedLattice2D< T >::doGetMaskSlice ( Array< Bool > &  buffer,
const Slicer section 
)
virtual

Get a section of the mask.

◆ doGetSlice()

template<class T >
virtual Bool casacore::CurvedLattice2D< T >::doGetSlice ( Array< T > &  buffer,
const Slicer section 
)
virtual

Do the actual getting of an array of values.

◆ doNiceCursorShape()

template<class T >
virtual IPosition casacore::CurvedLattice2D< T >::doNiceCursorShape ( uInt  maxPixels) const
virtual

Get the best cursor shape.

◆ doPutSlice()

template<class T >
virtual void casacore::CurvedLattice2D< T >::doPutSlice ( const Array< T > &  sourceBuffer,
const IPosition where,
const IPosition stride 
)
virtual

Do the actual getting of an array of values.

◆ flush()

template<class T >
virtual void casacore::CurvedLattice2D< T >::flush ( )
virtual

Flush the data.

◆ getRegionPtr()

template<class T >
virtual const LatticeRegion* casacore::CurvedLattice2D< T >::getRegionPtr ( ) const
virtual

Get a pointer the region/mask object.

It returns 0.

◆ hasLock()

template<class T >
virtual Bool casacore::CurvedLattice2D< T >::hasLock ( FileLocker::LockType  ) const
virtual

◆ isMasked()

template<class T >
virtual Bool casacore::CurvedLattice2D< T >::isMasked ( ) const
virtual

Is the lattice masked? It is if its parent lattice is masked.

◆ isPaged()

template<class T >
virtual Bool casacore::CurvedLattice2D< T >::isPaged ( ) const
virtual

Is the lattice paged to disk?

◆ isWritable()

template<class T >
virtual Bool casacore::CurvedLattice2D< T >::isWritable ( ) const
virtual

The lattice is not writable.

◆ lock()

template<class T >
virtual Bool casacore::CurvedLattice2D< T >::lock ( FileLocker::LockType  ,
uInt  nattempts 
)
virtual

Handle ocking of the lattice which is delegated to its parent.


It is strongly recommended to use class LatticeLocker to handle lattice locking. It also contains a more detailed explanation of the locking process.

◆ makeMapping()

template<class T >
void casacore::CurvedLattice2D< T >::makeMapping ( uInt  axis1,
uInt  axis2,
Int  curveAxis 
)
private

Make the AxesMapping object to map input to output axes.

◆ name()

template<class T >
virtual String casacore::CurvedLattice2D< T >::name ( Bool  stripPath = False) const
virtual

Return the name of the parent lattice.

◆ ok()

template<class T >
virtual Bool casacore::CurvedLattice2D< T >::ok ( ) const
virtual

Check class internals - used for debugging.

Should always return True

◆ operator=()

template<class T >
CurvedLattice2D<T>& casacore::CurvedLattice2D< T >::operator= ( const CurvedLattice2D< T > &  other)

Assignment (reference semantics)

◆ reopen()

template<class T >
virtual void casacore::CurvedLattice2D< T >::reopen ( )
virtual

If needed, reopen a temporarily closed Lattice.

◆ resync()

template<class T >
virtual void casacore::CurvedLattice2D< T >::resync ( )
virtual

Resynchronize the Lattice object with the lattice file.

This function is only useful if no read-locking is used, ie. if the table lock option is UserNoReadLocking or AutoNoReadLocking. In that cases the table system does not acquire a read-lock, thus does not synchronize itself automatically.

◆ shape()

template<class T >
virtual IPosition casacore::CurvedLattice2D< T >::shape ( ) const
virtual

Returns the shape of the lattice.

◆ tempClose()

template<class T >
virtual void casacore::CurvedLattice2D< T >::tempClose ( )
virtual

Close the Lattice temporarily (if it is paged to disk).

It'll be reopened automatically when needed or when reopen is called explicitly.

◆ unlock()

template<class T >
virtual void casacore::CurvedLattice2D< T >::unlock ( )
virtual

Member Data Documentation

◆ itsAxesMap

template<class T >
AxesMapping casacore::CurvedLattice2D< T >::itsAxesMap
private

Definition at line 204 of file CurvedLattice2D.h.

◆ itsAxis1

template<class T >
uInt casacore::CurvedLattice2D< T >::itsAxis1
private

Definition at line 201 of file CurvedLattice2D.h.

◆ itsAxis2

template<class T >
uInt casacore::CurvedLattice2D< T >::itsAxis2
private

Definition at line 202 of file CurvedLattice2D.h.

◆ itsCurve

template<class T >
PixelCurve1D casacore::CurvedLattice2D< T >::itsCurve
private

Definition at line 200 of file CurvedLattice2D.h.

◆ itsCurveAxis

template<class T >
uInt casacore::CurvedLattice2D< T >::itsCurveAxis
private

Definition at line 203 of file CurvedLattice2D.h.

◆ itsInterpolator

template<class T >
CLInterpolator2D<T>* casacore::CurvedLattice2D< T >::itsInterpolator
private

Definition at line 199 of file CurvedLattice2D.h.

◆ itsLatticePtr

template<class T >
MaskedLattice<T>* casacore::CurvedLattice2D< T >::itsLatticePtr
private

Definition at line 198 of file CurvedLattice2D.h.


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