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

Class to convert a region to a boolean node. More...

#include <LELRegion.h>

Public Member Functions

 LELRegionAsBool (const LELRegion &region)
 Constructor. More...
 
 ~LELRegionAsBool ()
 Destructor. More...
 
virtual void eval (LELArray< Bool > &result, const Slicer &section) const
 Get region data. More...
 
virtual LELScalar< BoolgetScalar () const
 Getting region data as a scalar cannot be done (throws an exception). More...
 
virtual Bool prepareScalarExpr ()
 Do further preparations (e.g. More...
 
virtual String className () const
 Get class name. More...
 
- 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...
 
virtual Bool lock (FileLocker::LockType, uInt nattempts)
 Handle locking/syncing of the parts of a lattice expression. More...
 
virtual void unlock ()
 
virtual Bool hasLock (FileLocker::LockType) const
 
virtual void resync ()
 

Private Attributes

LatticeRegion region_p
 Member variables. More...
 

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

Class to convert a region to a boolean node.

Intended use:

Internal

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

This derived LEL letter class handles a region as a boolean lattice.

Synopsis

This class makes it possible to handle a region as a true boolean lattice without the need to apply the region to an image. It means that it is only possible if the region has absolute lattice coordinates.

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

Motivation

It is useful to be able to handle a mask as a boolean lattice.

Definition at line 182 of file LELRegion.h.

Constructor & Destructor Documentation

◆ LELRegionAsBool()

casacore::LELRegionAsBool::LELRegionAsBool ( const LELRegion region)

Constructor.

◆ ~LELRegionAsBool()

casacore::LELRegionAsBool::~LELRegionAsBool ( )

Destructor.

Member Function Documentation

◆ className()

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

Get class name.

Implements casacore::LELInterface< Bool >.

◆ eval()

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

Get region data.

Implements casacore::LELInterface< Bool >.

◆ getScalar()

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

Getting region data as a scalar cannot be done (throws an exception).

Implements casacore::LELInterface< Bool >.

◆ prepareScalarExpr()

virtual Bool casacore::LELRegionAsBool::prepareScalarExpr ( )
virtual

Do further preparations (e.g.

optimization) on the expression.

Implements casacore::LELInterface< Bool >.

Member Data Documentation

◆ region_p

LatticeRegion casacore::LELRegionAsBool::region_p
private

Member variables.

Definition at line 206 of file LELRegion.h.


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