casacore
Public Member Functions | Private Attributes | List of all members
casacore::LELFunctionBool Class Reference

This LEL class handles logical functions. More...

#include <LELFunction.h>

Public Member Functions

 LELFunctionBool (const LELFunctionEnums::Function function, const Block< LatticeExprNode > &expr)
 Constructor takes operation and left and right expressions to be operated upon. More...
 
 ~LELFunctionBool ()
 Destructor
More...
 
virtual void eval (LELArray< Bool > &result, const Slicer &section) const
 Recursively evaluate the expression
More...
 
virtual LELScalar< BoolgetScalar () const
 Recursively evaluate the scalar expression
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< Bool >
virtual ~LELInterface ()
 Virtual destructor. More...
 
virtual void evalRef (LELArrayRef< Bool > &result, const Slicer &section) const
 
LELArray< BoolgetArray () 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

LELFunctionEnums::Function function_p
 
Block< LatticeExprNodearg_p
 

Additional Inherited Members

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

Detailed Description

This LEL class handles logical functions.

Intended use:

Internal

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

This derived LEL letter class handles logical functions (arbitrary number of arguments)

Synopsis

This LEL letter class is derived from LELInterface. It is used to construct LEL objects that apply logical functions of arbitrary number of arguments (but only 1 or 2 arguments currently implemented) to Lattice expressions. They operate on Bool Lattice expressions only and return a Bool. The available C++ functions are all,any with equivalents in the enum of ALL and ANY.

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. Examples of how the user would indirectly use this class (through the envelope) are:

IPosition shape(2,5,10);
ArrayLattice<Bool> x(shape); x.set(True);
ArrayLattice<Bool> y(shape);
y.copyData(any(x)); // y = any(x)
const IPosition & shape() const
Get the shape of the expression result.
Definition: LELInterface.h:182
LatticeExprNode any(const LatticeExprNode &expr)
Functions operating on a logical expression resulting in a scalar; Functions "any" (are any pixels "T...
const Bool True
Definition: aipstype.h:43

The result of the any function (were any of the values True) is a Bool scalar. So the output Lattice is filled with that one value.

Motivation

Logical functions are a basic mathematical expression.

Definition at line 826 of file LELFunction.h.

Constructor & Destructor Documentation

◆ LELFunctionBool()

casacore::LELFunctionBool::LELFunctionBool ( const LELFunctionEnums::Function  function,
const Block< LatticeExprNode > &  expr 
)

Constructor takes operation and left and right expressions to be operated upon.

◆ ~LELFunctionBool()

casacore::LELFunctionBool::~LELFunctionBool ( )

Destructor

Member Function Documentation

◆ className()

virtual String casacore::LELFunctionBool::className ( ) const
virtual

Get class name.

Implements casacore::LELInterface< Bool >.

◆ eval()

virtual void casacore::LELFunctionBool::eval ( LELArray< Bool > &  result,
const Slicer section 
) const
virtual

Recursively evaluate the expression

Implements casacore::LELInterface< Bool >.

◆ getScalar()

virtual LELScalar<Bool> casacore::LELFunctionBool::getScalar ( ) const
virtual

Recursively evaluate the scalar expression

Implements casacore::LELInterface< Bool >.

◆ hasLock()

virtual Bool casacore::LELFunctionBool::hasLock ( FileLocker::LockType  ) const
virtual

Reimplemented from casacore::LELInterface< Bool >.

◆ lock()

virtual Bool casacore::LELFunctionBool::lock ( FileLocker::LockType  ,
uInt  nattempts 
)
virtual

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

Reimplemented from casacore::LELInterface< Bool >.

◆ prepareScalarExpr()

virtual Bool casacore::LELFunctionBool::prepareScalarExpr ( )
virtual

Do further preparations (e.g.

optimization) on the expression.

Implements casacore::LELInterface< Bool >.

◆ resync()

virtual void casacore::LELFunctionBool::resync ( )
virtual

Reimplemented from casacore::LELInterface< Bool >.

◆ unlock()

virtual void casacore::LELFunctionBool::unlock ( )
virtual

Reimplemented from casacore::LELInterface< Bool >.

Member Data Documentation

◆ arg_p

Block<LatticeExprNode> casacore::LELFunctionBool::arg_p
private

Definition at line 861 of file LELFunction.h.

◆ function_p

LELFunctionEnums::Function casacore::LELFunctionBool::function_p
private

Definition at line 860 of file LELFunction.h.


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