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

More...

#include <LELArray.h>

Public Member Functions

 LELArray (const Array< T > &value)
 Constructor takes value. More...
 
 LELArray (const Array< T > &value, const Array< Bool > &mask)
 Constructor takes value and mask. More...
 
 LELArray (const IPosition &shape)
 Constructor takes shape. More...
 
 LELArray (const LELArray< T > &other)
 Copy constructor (reference semantics). More...
 
 ~LELArray ()
 
LELArray< T > & operator= (const LELArray< T > &other)
 Assignment (reference semantics). More...
 
const IPositionshape () const
 Get shape (of the value). More...
 
const Array< T > & value () const
 Get value. More...
 
Array< T > & value ()
 
- Public Member Functions inherited from casacore::LELArrayBase
 LELArrayBase ()
 Default constructor sets to mask all true. More...
 
 LELArrayBase (const Array< Bool > &mask)
 Constructor takes mask. More...
 
 LELArrayBase (const LELArrayBase &other)
 Copy constructor (reference semantics). More...
 
 ~LELArrayBase ()
 
LELArrayBaseoperator= (const LELArrayBase &other)
 Assignment (reference semantics). More...
 
Bool isMasked () const
 Does the value have a mask? More...
 
const Array< Bool > & mask () const
 Get mask. More...
 
Array< Bool > & mask ()
 
void removeMask ()
 Remove the mask. More...
 
void setMask (const Array< Bool > &other)
 Set the mask from given array (takes reference). More...
 
void setMask (const LELArrayBase &other)
 Set the mask from the mask of the other value. More...
 
void setMask (Array< Bool > &other)
 Set the mask from given array (takes reference). More...
 
void setMask (const LELArrayBase &left, const LELArrayBase &right)
 Set the mask by combining the masks of both values. More...
 
void combineMask (const LELArrayBase &other)
 Combine the mask of this and the other value (by anding them). More...
 
void combineMask (const Array< Bool > &mask)
 
void combineOrAnd (Bool desiredValue, const Array< Bool > &value)
 Combine the mask with the given value in case of an OR or AND. More...
 
void combineOrAnd (Bool desiredValue, Array< Bool > &value, const Array< Bool > &temp)
 Combine for two arrays taking the true/false array values into account. More...
 
void combineOrAnd (Bool desiredValue, Array< Bool > &value, const Array< Bool > &temp, const Array< Bool > &tempMask)
 Combine for two arrays taking the true/false array values and mask into account. More...
 

Private Attributes

Array< T > itsValue
 

Detailed Description

template<class T>
class casacore::LELArray< T >

This LEL class holds an array with a mask.

Intended use:

Internal

Review Status

Date Reviewed:
yyyy/mm/dd

Synopsis

This LEL class holds an array with a mask. The mask can be a single Bool valid for all elements of the array. Otherwise it is a full mask with the same shape as the array.

Motivation

It makes it possible to handle an array with its mask as a single object.

Definition at line 62 of file LELArray.h.

Constructor & Destructor Documentation

◆ LELArray() [1/4]

template<class T >
casacore::LELArray< T >::LELArray ( const Array< T > &  value)
inline

Constructor takes value.

Its mask is set to all True.

Definition at line 67 of file LELArray.h.

◆ LELArray() [2/4]

template<class T >
casacore::LELArray< T >::LELArray ( const Array< T > &  value,
const Array< Bool > &  mask 
)
inline

Constructor takes value and mask.

Definition at line 71 of file LELArray.h.

◆ LELArray() [3/4]

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

Constructor takes shape.

Its mask is set to all True.

◆ LELArray() [4/4]

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

Copy constructor (reference semantics).

◆ ~LELArray()

template<class T >
casacore::LELArray< T >::~LELArray ( )

Member Function Documentation

◆ operator=()

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

Assignment (reference semantics).

◆ shape()

template<class T >
const IPosition& casacore::LELArray< T >::shape ( ) const
inline

Get shape (of the value).

Definition at line 87 of file LELArray.h.

References casacore::LELArray< T >::itsValue, and casacore::ArrayBase::shape().

◆ value() [1/2]

template<class T >
Array<T>& casacore::LELArray< T >::value ( )
inline

Definition at line 94 of file LELArray.h.

References casacore::LELArray< T >::itsValue.

◆ value() [2/2]

template<class T >
const Array<T>& casacore::LELArray< T >::value ( ) const
inline

Get value.

Definition at line 92 of file LELArray.h.

References casacore::LELArray< T >::itsValue.

Referenced by casacore::LELArrayRef< T >::value().

Member Data Documentation

◆ itsValue

template<class T >
Array<T> casacore::LELArray< T >::itsValue
private

Definition at line 99 of file LELArray.h.

Referenced by casacore::LELArray< T >::shape(), and casacore::LELArray< T >::value().


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