casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
casacore::LELLattice< T > Class Template Reference

This LEL class handles access to Lattices. More...

#include <LELLattice.h>

Inheritance diagram for casacore::LELLattice< T >:
casacore::LELInterface< T >

Public Member Functions

 LELLattice (const Lattice< T > &lattice)
 Constructor takes lattice to fetch from it. More...
 
 LELLattice (const MaskedLattice< T > &lattice)
 
 ~LELLattice ()
 Destructor does nothing. More...
 
virtual void eval (LELArray< T > &result, const Slicer &section) const
 Evaluate the expression; this means get the chunk of the lattice. More...
 
virtual void evalRef (LELArrayRef< T > &result, const Slicer &section) const
 
virtual LELScalar< T > getScalar () const
 Getting a scalar value is not possible (throws exception). More...
 
virtual Bool prepareScalarExpr ()
 Do further preparations (e.g. More...
 
virtual String className () const
 Get class name. More...
 
virtual Bool lock (FileLocker::LockType, uInt nattempts)
 Handle locking/syncing of a lattice in a lattice expression. More...
 
virtual void unlock ()
 
virtual Bool hasLock (FileLocker::LockType) const
 
virtual void resync ()
 
- Public Member Functions inherited from casacore::LELInterface< T >
virtual ~LELInterface ()
 Virtual destructor. More...
 
LELArray< T > getArray () const
 Get the result of an array subexpression. More...
 
Bool isScalar () const
 Is the result of evaluating this expression a scalar ? More...
 
const IPositionshape () const
 Get the shape of the expression result. More...
 
const LELAttributegetAttribute () const
 Get expression attribute. More...
 

Private Attributes

MaskedLattice< T > * pLattice_p
 

Additional Inherited Members

- Static Public Member Functions inherited from casacore::LELInterface< T >
static Bool replaceScalarExpr (CountedPtr< LELInterface< T > > &expr)
 If the given expression is a valid scalar, replace it by its result. More...
 
- Protected Member Functions inherited from casacore::LELInterface< T >
void setAttr (const LELAttribute &attrib)
 Set the expression attributes of this object. More...
 

Detailed Description

template<class T>
class casacore::LELLattice< T >

This LEL class handles access to Lattices.

Intended use:

Internal

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

This derived LEL letter class handles access to the pixels in a Lattice

Synopsis

This LEL letter class is derived from LELInterface. It is used to construct LEL objects that access the pixels in a Lattice. It works with Lattices of type Float,Double,Complex,DComplex and Bool.

A description of the implementation details of the LEL classes can be found in Note 216

Example

Examples are not very useful as the user would never use these classes directly. Look in LatticeExprNode.cc to see how it invokes these classes. An example of how the user would indirectly use this class (through the envelope) is:

IPosition shape(2,5,10);
ArrayLattice<Float> x(shape); x.set(1.0);
ArrayLattice<Float> y(shape);
y.copyData(x); // y = x

Motivation

Accessing Lattices is fundamental to manipulating their pixel values

Definition at line 95 of file LELLattice.h.

Constructor & Destructor Documentation

template<class T >
casacore::LELLattice< T >::LELLattice ( const Lattice< T > &  lattice)

Constructor takes lattice to fetch from it.

template<class T >
casacore::LELLattice< T >::LELLattice ( const MaskedLattice< T > &  lattice)
template<class T >
casacore::LELLattice< T >::~LELLattice ( )

Destructor does nothing.

Member Function Documentation

template<class T >
virtual String casacore::LELLattice< T >::className ( ) const
virtual

Get class name.

Implements casacore::LELInterface< T >.

template<class T >
virtual void casacore::LELLattice< T >::eval ( LELArray< T > &  result,
const Slicer section 
) const
virtual

Evaluate the expression; this means get the chunk of the lattice.

Implements casacore::LELInterface< T >.

template<class T >
virtual void casacore::LELLattice< T >::evalRef ( LELArrayRef< T > &  result,
const Slicer section 
) const
virtual

Reimplemented from casacore::LELInterface< T >.

template<class T >
virtual LELScalar<T> casacore::LELLattice< T >::getScalar ( ) const
virtual

Getting a scalar value is not possible (throws exception).

Implements casacore::LELInterface< T >.

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

Reimplemented from casacore::LELInterface< T >.

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

Handle locking/syncing of a lattice in a lattice expression.

Reimplemented from casacore::LELInterface< T >.

template<class T >
virtual Bool casacore::LELLattice< T >::prepareScalarExpr ( )
virtual

Do further preparations (e.g.

optimization) on the expression.

Implements casacore::LELInterface< T >.

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

Reimplemented from casacore::LELInterface< T >.

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

Reimplemented from casacore::LELInterface< T >.

Member Data Documentation

template<class T >
MaskedLattice<T>* casacore::LELLattice< T >::pLattice_p
private

Definition at line 137 of file LELLattice.h.


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