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

#include <ImageMaskHandler.h>

Public Member Functions

 ImageMaskHandler (SPIIT)
 Perform various image mask operations. More...
 
 ~ImageMaskHandler ()
 
void set (const casacore::String &name)
 set default mask. More...
 
casacore::String defaultMask () const
 return the default mask name More...
 
void deleteMasks (const std::set< casacore::String > &masks)
 delete specified masks More...
 
void rename (const casacore::String &oldName, const casacore::String &newName)
 rename a mask More...
 
casacore::Vector
< casacore::String
get () const
 get all mask names More...
 
void copy (const casacore::String &currentName, const casacore::String &newName)
 copy mask More...
 
void calcmask (const casacore::String &mask, casacore::Record &regions, const casacore::String &name, casacore::Bool asdefault=true)
 
template<class U >
void copy (const casacore::MaskedLattice< U > &mask)
 copy the mask from the specified lattice to the image's (default) mask. More...
 

Private Member Functions

void _calcmask (const casacore::LatticeExprNode &node, const casacore::String &name, const casacore::Bool makedefault)
 

Static Private Member Functions

static void _makeRegionBlock (casacore::PtrBlock< const casacore::ImageRegion * > &regions, const casacore::Record &Regions)
 Make a block of regions from a Record. More...
 

Private Attributes

const SPIIT _image
 

Detailed Description

template<class T>
class casa::ImageMaskHandler< T >

Definition at line 23 of file ImageMaskHandler.h.

Constructor & Destructor Documentation

template<class T >
casa::ImageMaskHandler< T >::ImageMaskHandler ( SPIIT  )

Perform various image mask operations.

Etymology

Synopsis

template<class T >
casa::ImageMaskHandler< T >::~ImageMaskHandler ( )

Member Function Documentation

template<class T >
void casa::ImageMaskHandler< T >::_calcmask ( const casacore::LatticeExprNode node,
const casacore::String name,
const casacore::Bool  makedefault 
)
private
template<class T >
static void casa::ImageMaskHandler< T >::_makeRegionBlock ( casacore::PtrBlock< const casacore::ImageRegion * > &  regions,
const casacore::Record Regions 
)
staticprivate

Make a block of regions from a Record.

template<class T >
void casa::ImageMaskHandler< T >::calcmask ( const casacore::String mask,
casacore::Record regions,
const casacore::String name,
casacore::Bool  asdefault = true 
)
template<class T >
void casa::ImageMaskHandler< T >::copy ( const casacore::String currentName,
const casacore::String newName 
)

copy mask

template<class T >
template<class U >
void casa::ImageMaskHandler< T >::copy ( const casacore::MaskedLattice< U > &  mask)

copy the mask from the specified lattice to the image's (default) mask.

The mask and the image must have the same shape.

template<class T >
casacore::String casa::ImageMaskHandler< T >::defaultMask ( ) const

return the default mask name

template<class T >
void casa::ImageMaskHandler< T >::deleteMasks ( const std::set< casacore::String > &  masks)

delete specified masks

template<class T >
casacore::Vector<casacore::String> casa::ImageMaskHandler< T >::get ( ) const

get all mask names

template<class T >
void casa::ImageMaskHandler< T >::rename ( const casacore::String oldName,
const casacore::String newName 
)

rename a mask

template<class T >
void casa::ImageMaskHandler< T >::set ( const casacore::String name)

set default mask.

Empty string means unset default mask.

Member Data Documentation

template<class T >
const SPIIT casa::ImageMaskHandler< T >::_image
private

Definition at line 74 of file ImageMaskHandler.h.


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