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

#include <ImageFFTer.h>

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

Public Member Functions

 ImageFFTer (const SPCIIT image, const casacore::Record *const region, const casacore::String &maskInp, const casacore::Vector< casacore::uInt > &axes)
 Top level interface which allows FFTing of images. More...
 
 ~ImageFFTer ()
 destructor More...
 
void fft () const
 
void setReal (const casacore::String &name)
 
void setImag (const casacore::String &name)
 
void setAmp (const casacore::String &name)
 
void setPhase (const casacore::String &name)
 
void setComplex (const casacore::String &name)
 
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)
 

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...
 
- 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 _supportsMultipleRegions () 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 Member Functions

 ImageFFTer ()
 disallow default constructor More...
 
void _createOutputImages (const casacore::SubImage< T > &subImage, const ImageFFT< T > &fft) const
 
template<class U >
void _createImage (SPIIU &out, const casacore::String &name, const casacore::SubImage< T > &subimage) const
 

Static Private Member Functions

static void _checkExists (const casacore::String &name)
 

Private Attributes

casacore::Vector< casacore::uInt_axes
 
casacore::String _real
 
casacore::String _imag
 
casacore::String _amp
 
casacore::String _phase
 
casacore::String _complex
 

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::ImageFFTer< T >

Definition at line 12 of file ImageFFTer.h.

Constructor & Destructor Documentation

template<class T >
casa::ImageFFTer< T >::ImageFFTer ( const SPCIIT  image,
const casacore::Record *const  region,
const casacore::String maskInp,
const casacore::Vector< casacore::uInt > &  axes 
)

Top level interface which allows FFTing of images.

Etymology

FFTs image.

Synopsis

High level interface for FFTing an image.

template<class T >
casa::ImageFFTer< T >::~ImageFFTer ( )
inline

destructor

Definition at line 40 of file ImageFFTer.h.

template<class T >
casa::ImageFFTer< T >::ImageFFTer ( )
private

disallow default constructor

Member Function Documentation

template<class T >
static void casa::ImageFFTer< T >::_checkExists ( const casacore::String name)
staticprivate
template<class T >
template<class U >
void casa::ImageFFTer< T >::_createImage ( SPIIU out,
const casacore::String name,
const casacore::SubImage< T > &  subimage 
) const
private
template<class T >
void casa::ImageFFTer< T >::_createOutputImages ( const casacore::SubImage< T > &  subImage,
const ImageFFT< T > &  fft 
) const
private
template<class T >
std::vector<casacore::Coordinate::Type> casa::ImageFFTer< T >::_getNecessaryCoordinates ( ) const
inlineprotectedvirtual

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

Implements casa::ImageTask< T >.

Definition at line 60 of file ImageFFTer.h.

template<class T >
CasacRegionManager::StokesControl casa::ImageFFTer< T >::_getStokesControl ( ) const
inlineprotectedvirtual

Implements casa::ImageTask< T >.

Definition at line 56 of file ImageFFTer.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

template<class T >
void casa::ImageFFTer< T >::fft ( ) const
template<class T >
casacore::String casa::ImageFFTer< T >::getClass ( ) const
inlinevirtual

Implements casa::ImageTask< T >.

Definition at line 50 of file ImageFFTer.h.

template<class T >
void casa::ImageFFTer< T >::setAmp ( const casacore::String name)
inline

Definition at line 46 of file ImageFFTer.h.

References casa::ImageFFTer< T >::_amp, and casa::name().

template<class T >
void casa::ImageFFTer< T >::setComplex ( const casacore::String name)
inline

Definition at line 48 of file ImageFFTer.h.

References casa::ImageFFTer< T >::_complex, and casa::name().

template<class T >
void casa::ImageFFTer< T >::setImag ( const casacore::String name)
inline

Definition at line 45 of file ImageFFTer.h.

References casa::ImageFFTer< T >::_imag, and casa::name().

template<class T >
void casa::ImageFFTer< T >::setPhase ( const casacore::String name)
inline

Definition at line 47 of file ImageFFTer.h.

References casa::ImageFFTer< T >::_phase, and casa::name().

template<class T >
void casa::ImageFFTer< T >::setReal ( const casacore::String name)
inline

Definition at line 44 of file ImageFFTer.h.

References casa::ImageFFTer< T >::_real, and casa::name().

Member Data Documentation

template<class T >
casacore::String casa::ImageFFTer< T >::_amp
private

Definition at line 66 of file ImageFFTer.h.

Referenced by casa::ImageFFTer< T >::setAmp().

template<class T >
casacore::Vector<casacore::uInt> casa::ImageFFTer< T >::_axes
private

Definition at line 65 of file ImageFFTer.h.

template<class T >
casacore::String casa::ImageFFTer< T >::_complex
private

Definition at line 66 of file ImageFFTer.h.

Referenced by casa::ImageFFTer< T >::setComplex().

template<class T >
casacore::String casa::ImageFFTer< T >::_imag
private

Definition at line 66 of file ImageFFTer.h.

Referenced by casa::ImageFFTer< T >::setImag().

template<class T >
casacore::String casa::ImageFFTer< T >::_phase
private

Definition at line 66 of file ImageFFTer.h.

Referenced by casa::ImageFFTer< T >::setPhase().

template<class T >
casacore::String casa::ImageFFTer< T >::_real
private

Definition at line 66 of file ImageFFTer.h.

Referenced by casa::ImageFFTer< T >::setReal().


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