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

#include <ImageConcatenator.h>

Public Member Functions

 ImageConcatenator ()=delete
 Top level interface for concatenating images. More...
 
 ImageConcatenator (std::vector< casacore::String > &images, const casacore::String &outname, casacore::Bool overwrite)
 image should be the first image in the list of images to be concatenated. More...
 
 ~ImageConcatenator ()
 destructor More...
 
SPIIT concatenate ()
 Perform the concatenation. More...
 
void setAxis (casacore::Int axis)
 Set the axis along which to do the concatenation. More...
 
void setTempClose (casacore::Bool b)
 
void setMode (const casacore::String &mymode)
 
void setRelax (casacore::Bool b)
 
void setReorder (casacore::Bool b)
 
casacore::String getClass () const
 

Protected Types

enum  MODE {
  COPYVIRTUAL,
  MOVEVIRTUAL,
  NOMOVEVIRTUAL,
  PAGED
}
 

Private Member Functions

casacore::Bool _minAxisValues (casacore::Double &min, const casacore::CoordinateSystem &csys, const casacore::IPosition &shape) const
 returns true if world coordinate values increase with pixel coordinate values More...
 
void _addImage (std::shared_ptr< casacore::ImageConcat< T >> pConcat, const casacore::String &name, casacore::Bool first) const
 

Private Attributes

std::vector< casacore::String_imageNames
 
casacore::String _outname
 
casacore::Bool _overwrite
 
casacore::Int _axis
 
casacore::Bool _tempClose
 
casacore::Bool _relax
 
casacore::Bool _reorder
 
MODE _mode
 

Static Private Attributes

static const casacore::String _class
 

Detailed Description

template<class T>
class casa::ImageConcatenator< T >

Definition at line 41 of file ImageConcatenator.h.

Member Enumeration Documentation

template<class T >
enum casa::ImageConcatenator::MODE
protected
Enumerator
COPYVIRTUAL 
MOVEVIRTUAL 
NOMOVEVIRTUAL 
PAGED 

Definition at line 102 of file ImageConcatenator.h.

Constructor & Destructor Documentation

template<class T >
casa::ImageConcatenator< T >::ImageConcatenator ( )
delete

Top level interface for concatenating images.

Etymology

Concatenate an image

Synopsis

High level interface for concatenating images.

template<class T >
casa::ImageConcatenator< T >::ImageConcatenator ( std::vector< casacore::String > &  images,
const casacore::String outname,
casacore::Bool  overwrite 
)

image should be the first image in the list of images to be concatenated.

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

destructor

Member Function Documentation

template<class T >
void casa::ImageConcatenator< T >::_addImage ( std::shared_ptr< casacore::ImageConcat< T >>  pConcat,
const casacore::String name,
casacore::Bool  first 
) const
private
template<class T >
casacore::Bool casa::ImageConcatenator< T >::_minAxisValues ( casacore::Double min,
const casacore::CoordinateSystem csys,
const casacore::IPosition shape 
) const
private

returns true if world coordinate values increase with pixel coordinate values

template<class T >
SPIIT casa::ImageConcatenator< T >::concatenate ( )

Perform the concatenation.

SPIIT concatenate(const std::vector<casacore::String>& imageNames);

template<class T >
casacore::String casa::ImageConcatenator< T >::getClass ( ) const
template<class T >
void casa::ImageConcatenator< T >::setAxis ( casacore::Int  axis)

Set the axis along which to do the concatenation.

A negative value of axis means use the spectral axis. An exception is thrown if axis is negative and the image has no spectral axis.

template<class T >
void casa::ImageConcatenator< T >::setMode ( const casacore::String mymode)
template<class T >
void casa::ImageConcatenator< T >::setRelax ( casacore::Bool  b)
inline

Definition at line 95 of file ImageConcatenator.h.

References casa::ImageConcatenator< T >::_relax.

template<class T >
void casa::ImageConcatenator< T >::setReorder ( casacore::Bool  b)
inline

Definition at line 97 of file ImageConcatenator.h.

References casa::ImageConcatenator< T >::_reorder.

template<class T >
void casa::ImageConcatenator< T >::setTempClose ( casacore::Bool  b)
inline

Definition at line 91 of file ImageConcatenator.h.

References casa::ImageConcatenator< T >::_tempClose.

Member Data Documentation

template<class T >
casacore::Int casa::ImageConcatenator< T >::_axis
private

Definition at line 113 of file ImageConcatenator.h.

template<class T >
const casacore::String casa::ImageConcatenator< T >::_class
staticprivate

Definition at line 118 of file ImageConcatenator.h.

template<class T >
std::vector<casacore::String> casa::ImageConcatenator< T >::_imageNames
private

Definition at line 110 of file ImageConcatenator.h.

template<class T >
MODE casa::ImageConcatenator< T >::_mode
private

Definition at line 117 of file ImageConcatenator.h.

template<class T >
casacore::String casa::ImageConcatenator< T >::_outname
private

Definition at line 111 of file ImageConcatenator.h.

template<class T >
casacore::Bool casa::ImageConcatenator< T >::_overwrite
private

Definition at line 112 of file ImageConcatenator.h.

template<class T >
casacore::Bool casa::ImageConcatenator< T >::_relax
private

Definition at line 115 of file ImageConcatenator.h.

Referenced by casa::ImageConcatenator< T >::setRelax().

template<class T >
casacore::Bool casa::ImageConcatenator< T >::_reorder
private

Definition at line 116 of file ImageConcatenator.h.

Referenced by casa::ImageConcatenator< T >::setReorder().

template<class T >
casacore::Bool casa::ImageConcatenator< T >::_tempClose
private

Definition at line 114 of file ImageConcatenator.h.

Referenced by casa::ImageConcatenator< T >::setTempClose().


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