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

This class is the high level interface to image convolving. More...

#include <SepImageConvolverTask.h>

Inheritance diagram for casa::SepImageConvolverTask< T >:
casa::ImageTask< T >

Public Member Functions

 SepImageConvolverTask ()=delete
 
 SepImageConvolverTask (const SPCIIT image, const casacore::Record *const &regionPtr, const casacore::String &mask, const casacore::String &outname, const casacore::Bool overwrite)
 
 SepImageConvolverTask (const SepImageConvolverTask< T > &other)=delete
 
 ~SepImageConvolverTask ()
 
SepImageConvolverTaskoperator= (const SepImageConvolverTask< T > &other)=delete
 
SPIIT convolve ()
 
void setKernels (const casacore::Vector< casacore::String > &kernels)
 
void setKernelWidths (const casacore::Vector< casacore::Quantity > &kernelwidths)
 
void setScale (casacore::Double d)
 
void setSmoothAxes (const casacore::Vector< casacore::Int > &axes)
 
casacore::String getClass () const
 
- Public Member Functions inherited from casa::ImageTask< T >
virtual ~ImageTask ()
 
void setStretch (const casacore::Bool stretch)
 
void setLogfile (const casacore::String &lf)
 tacitly does nothing if lf is the empty string. More...
 
void setLogfileAppend (const casacore::Bool a)
 
void setRegion (const casacore::Record &region)
 
void setMask (const casacore::String &mask)
 
void setVerbosity (Verbosity verbosity)
 
void addHistory (const std::vector< std::pair< casacore::String, casacore::String > > &msgs) const
 These messages will appear in the product image history upon the call to _prepareOutputImage(). More...
 
void addHistory (const casacore::LogOrigin &origin, const casacore::String &msg) const
 
void addHistory (const casacore::LogOrigin &origin, const std::vector< casacore::String > &msgs) const
 
void addHistory (const casacore::LogOrigin &origin, const casacore::String &taskname, const std::vector< casacore::String > &paramNames, const std::vector< casac::variant > &paramValues) const
 This adds standard history messages regarding the task that was run and input parameters used. More...
 
void suppressHistoryWriting (casacore::Bool b)
 suppress writing the history on _prepareOutputImage() call. More...
 
std::vector< std::pair
< casacore::String,
casacore::String > > 
getHistory ()
 get the history associated with the task. More...
 
void setDropDegen (casacore::Bool d)
 

Static Public Attributes

static const casacore::String CLASS_NAME
 

Protected Member Functions

CasacRegionManager::StokesControl _getStokesControl () const
 
std::vector
< casacore::Coordinate::Type
_getNecessaryCoordinates () const
 Represents the minimum set of coordinates necessary for the task to function. More...
 
casacore::Bool _supportsMultipleRegions () const
 
- Protected Member Functions inherited from casa::ImageTask< T >
 ImageTask (const SPCIIT image, const casacore::String &region, const casacore::Record *const &regionPtr, const casacore::String &box, const casacore::String &chanInp, const casacore::String &stokes, const casacore::String &maskInp, const casacore::String &outname, casacore::Bool overwrite)
 if outname is empty, no image will be written if overwrite is True, if image already exists it will be removed if overwrite is False, if image already exists exception will be thrown More...
 
 ImageTask (const SPCIIT image, const casacore::Record *const &regionPtr, const casacore::String &mask, const casacore::String &outname, casacore::Bool overwrite)
 
virtual std::vector
< OutputDestinationChecker::OutputStruct
_getOutputStruct ()
 
virtual void _construct (casacore::Bool verbose=true)
 does the lion's share of constructing the object, ie checks validity of inputs, etc. More...
 
const SPCIIT _getImage () const
 
const casacore::String_getMask () const
 
const casacore::Record_getRegion () const
 
void _setStokes (const casacore::String &stokes)
 
const casacore::String_getStokes () const
 
const casacore::String_getChans () const
 
const casacore::String_getOutname () const
 
casacore::Bool _isPVImage () const
 Is the attached image a position-velocity (PV) image? More...
 
void _removeExistingOutfileIfNecessary () const
 
void _removeExistingFileIfNecessary (const casacore::String &filename, const casacore::Bool overwrite, casacore::Bool warnOnly=false) const
 if warnOnly is true, log a warning message if file exists and overwrite is true, else throw an exception. More...
 
casacore::String _summaryHeader () const
 
const std::shared_ptr
< casacore::LogIO
_getLog () const
 
virtual casacore::Bool _hasLogfileSupport () const
 by default, derived classes are configured to have no log file support. More...
 
casacore::Bool _getStretch () const
 
Bool _getSuppressHistory () const
 
const std::shared_ptr< LogFile_getLogFile () const
 
casacore::Bool _writeLogfile (const casacore::String &output, const casacore::Bool open=true, const casacore::Bool close=true)
 
casacore::Bool _openLogfile ()
 
void _closeLogfile () const
 
virtual casacore::Bool _supportsMultipleBeams () const
 does this task support images with multiple beams? false means it never does. More...
 
SPIIT _prepareOutputImage (const casacore::ImageInterface< T > &image, const casacore::Array< T > *const values, const casacore::ArrayLattice< casacore::Bool > *const mask=nullptr, const casacore::IPosition *const outShape=nullptr, const casacore::CoordinateSystem *const coordsys=nullptr, const casacore::String *const outname=nullptr, casacore::Bool overwrite=false, casacore::Bool dropDegen=false) const
 If outname != NULL, use the value supplied. More...
 
SPIIT _prepareOutputImage (const casacore::ImageInterface< T > &image, casacore::Bool dropDegen=false) const
 
SPIIT _prepareOutputImage (const casacore::ImageInterface< T > &image, const casacore::String &outname, casacore::Bool overwrite, casacore::Bool warnOnly) const
 if warnOnly is true, only log a warning message if the file exists and overwrite is true, else throw an excepction More...
 
SPIIT _prepareOutputImage (const casacore::ImageInterface< T > &image, const casacore::Lattice< T > &data) const
 data are copied to the output image from the data lattice. More...
 
Verbosity _getVerbosity () const
 
casacore::Bool _getOverwrite () const
 
virtual casacore::Bool _mustHaveSquareDirectionPixels () const
 
casacore::Bool _getDropDegen () const
 
template<class U >
void _doHistory (std::shared_ptr< casacore::ImageInterface< U >> &image) const
 
void _reportOldNewImageShapes (const ImageInterface< T > &out) const
 
void _reportOldNewImageShapes (const IPosition &outShape) const
 

Private Attributes

casacore::Vector
< casacore::String
_kernels
 
casacore::Vector
< casacore::Quantity
_kernelWidths
 
casacore::Double _scale
 
casacore::Vector< casacore::Int_axes
 

Additional Inherited Members

- Public Types inherited from casa::ImageTask< T >
enum  Verbosity {
  QUIET,
  WHISPER,
  LOW,
  NORMAL,
  HIGH,
  NOISY,
  DEAFENING
}
 Virtual base class for image analysis tasks. More...
 
- Static Protected Member Functions inherited from casa::ImageTask< T >
static void _copyMask (casacore::Lattice< casacore::Bool > &mask, const casacore::ImageInterface< T > &image)
 
static void _copyData (casacore::Lattice< T > &data, const casacore::Lattice< T > &image)
 

Detailed Description

template<class T>
class casa::SepImageConvolverTask< T >

This class is the high level interface to image convolving.

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

This class is the high level interface to image convolving

Synopsis

This class is the high level interface to image convolving

Example

Motivation

Convolution is a standard image processing requirement.

To Do

Definition at line 70 of file SepImageConvolverTask.h.

Constructor & Destructor Documentation

template<class T>
casa::SepImageConvolverTask< T >::SepImageConvolverTask ( )
delete
template<class T>
casa::SepImageConvolverTask< T >::SepImageConvolverTask ( const SPCIIT  image,
const casacore::Record *const &  regionPtr,
const casacore::String mask,
const casacore::String outname,
const casacore::Bool  overwrite 
)
template<class T>
casa::SepImageConvolverTask< T >::SepImageConvolverTask ( const SepImageConvolverTask< T > &  other)
delete
template<class T>
casa::SepImageConvolverTask< T >::~SepImageConvolverTask ( )
inline

Definition at line 84 of file SepImageConvolverTask.h.

Member Function Documentation

template<class T>
std::vector<casacore::Coordinate::Type> casa::SepImageConvolverTask< T >::_getNecessaryCoordinates ( ) const
inlineprotectedvirtual

Represents the minimum set of coordinates necessary for the task to function.

Implements casa::ImageTask< T >.

Definition at line 106 of file SepImageConvolverTask.h.

template<class T>
CasacRegionManager::StokesControl casa::SepImageConvolverTask< T >::_getStokesControl ( ) const
inlineprotectedvirtual
template<class T>
casacore::Bool casa::SepImageConvolverTask< T >::_supportsMultipleRegions ( ) const
inlineprotectedvirtual

Reimplemented from casa::ImageTask< T >.

Definition at line 110 of file SepImageConvolverTask.h.

template<class T>
SPIIT casa::SepImageConvolverTask< T >::convolve ( )
template<class T>
casacore::String casa::SepImageConvolverTask< T >::getClass ( ) const
inlinevirtual
template<class T>
SepImageConvolverTask& casa::SepImageConvolverTask< T >::operator= ( const SepImageConvolverTask< T > &  other)
delete
template<class T>
void casa::SepImageConvolverTask< T >::setKernels ( const casacore::Vector< casacore::String > &  kernels)
inline
template<class T>
void casa::SepImageConvolverTask< T >::setKernelWidths ( const casacore::Vector< casacore::Quantity > &  kernelwidths)
inline
template<class T>
void casa::SepImageConvolverTask< T >::setScale ( casacore::Double  d)
inline

Definition at line 94 of file SepImageConvolverTask.h.

References casa::SepImageConvolverTask< T >::_scale.

template<class T>
void casa::SepImageConvolverTask< T >::setSmoothAxes ( const casacore::Vector< casacore::Int > &  axes)
inline

Member Data Documentation

template<class T>
casacore::Vector<casacore::Int> casa::SepImageConvolverTask< T >::_axes
private
template<class T>
casacore::Vector<casacore::String> casa::SepImageConvolverTask< T >::_kernels
private
template<class T>
casacore::Vector<casacore::Quantity> casa::SepImageConvolverTask< T >::_kernelWidths
private
template<class T>
casacore::Double casa::SepImageConvolverTask< T >::_scale
private

Definition at line 115 of file SepImageConvolverTask.h.

Referenced by casa::SepImageConvolverTask< T >::setScale().

template<class T>
const casacore::String casa::SepImageConvolverTask< T >::CLASS_NAME
static

Definition at line 73 of file SepImageConvolverTask.h.

Referenced by casa::SepImageConvolverTask< T >::getClass().


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