casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Attributes
casa::LELLattice< T > Class Template Reference

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

#include <LELLattice.h>

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

List of all members.

Public Member Functions

 LELLattice (const Lattice< T > &lattice)
 Constructor takes lattice to fetch from it.
 LELLattice (const MaskedLattice< T > &lattice)
 ~LELLattice ()
 Destructor does nothing.
virtual void eval (LELArray< T > &result, const Slicer &section) const
 Evaluate the expression; this means get the chunk of the lattice.
virtual void evalRef (LELArrayRef< T > &result, const Slicer &section) const
virtual LELScalar< T > getScalar () const
 Getting a scalar value is not possible (throws exception).
virtual Bool prepareScalarExpr ()
 Do further preparations (e.g.
virtual String className () const
 Get class name.
virtual Bool lock (FileLocker::LockType, uInt nattempts)
 Handle locking/syncing of a lattice in a lattice expression.
virtual void unlock ()
virtual Bool hasLock (FileLocker::LockType) const
virtual void resync ()

Private Attributes

MaskedLattice< T > * pLattice_p
 
   


Detailed Description

template<class T>
class casa::LELLattice< T >

This LEL class handles access to Lattices.

Intended use:

Internal

 <h3>Review Status</h3><dl><dt>Date Reviewed:<dd>yyyy/mm/dd</dl> 

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 94 of file LELLattice.h.


Constructor & Destructor Documentation

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

Constructor takes lattice to fetch from it.

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

Destructor does nothing.


Member Function Documentation

template<class T >
virtual String casa::LELLattice< T >::className ( ) const [virtual]

Get class name.

Implements casa::LELInterface< T >.

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

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

Implements casa::LELInterface< T >.

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

Reimplemented from casa::LELInterface< T >.

template<class T >
virtual LELScalar<T> casa::LELLattice< T >::getScalar ( ) const [virtual]

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

Implements casa::LELInterface< T >.

template<class T >
virtual Bool casa::LELLattice< T >::hasLock ( FileLocker::LockType  ) const [virtual]

Reimplemented from casa::LELInterface< T >.

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

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

Reimplemented from casa::LELInterface< T >.

template<class T >
virtual Bool casa::LELLattice< T >::prepareScalarExpr ( ) [virtual]

Do further preparations (e.g.

optimization) on the expression.

Implements casa::LELInterface< T >.

template<class T >
virtual void casa::LELLattice< T >::resync ( ) [virtual]

Reimplemented from casa::LELInterface< T >.

template<class T >
virtual void casa::LELLattice< T >::unlock ( ) [virtual]

Reimplemented from casa::LELInterface< T >.


Member Data Documentation

template<class T >
MaskedLattice<T>* casa::LELLattice< T >::pLattice_p [private]

   

Definition at line 136 of file LELLattice.h.


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