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::ImageRotator< T > Class Template Reference

This class rotates an image through a specified angle. More...

#include <ImageRotator.h>

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

Public Member Functions

 ImageRotator ()=delete
 
 ImageRotator (const SPCIIT image, const casacore::Record *const &regionPtr, const casacore::String &mask, const casacore::String &outname, casacore::Bool overwrite)
 
 ImageRotator (const ImageRotator &other)=delete
 
 ~ImageRotator ()
 
ImageRotatoroperator= (const ImageRotator &other)=delete
 
casacore::String getClass () const
 
SPIIT rotate ()
 
void setAngle (const casacore::Quantity &angle)
 set angle through which to rotate the direction or linear coordinate More...
 
void setDecimate (casacore::Int d)
 
void setInterpolationMethod (const casacore::String &method)
 set the interpolation method More...
 
void setReplicate (casacore::Bool b)
 
void setShape (const casacore::IPosition &shape)
 set shape of output image More...
 
- 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::IPosition _shape
 
casacore::String _method
 
casacore::Quantity _angle
 
casacore::Int _decimate
 
casacore::Bool _replicate
 

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

This class rotates an image through a specified angle.

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Etymology

This class rotates an image through a specified angle.

Synopsis

This class rotates an image through a specified angle.

Example

Motivation

users like histograms.

Definition at line 69 of file ImageRotator.h.

Constructor & Destructor Documentation

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

Member Function Documentation

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

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

Implements casa::ImageTask< T >.

Definition at line 114 of file ImageRotator.h.

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

Implements casa::ImageTask< T >.

Definition at line 110 of file ImageRotator.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

template<class T >
casacore::Bool casa::ImageRotator< T >::_supportsMultipleRegions ( ) const
inlineprotectedvirtual

Reimplemented from casa::ImageTask< T >.

Definition at line 118 of file ImageRotator.h.

template<class T >
casacore::String casa::ImageRotator< T >::getClass ( ) const
inlinevirtual

Implements casa::ImageTask< T >.

Definition at line 88 of file ImageRotator.h.

References casa::ImageRotator< T >::CLASS_NAME.

template<class T >
ImageRotator& casa::ImageRotator< T >::operator= ( const ImageRotator< T > &  other)
delete
template<class T >
SPIIT casa::ImageRotator< T >::rotate ( )
template<class T >
void casa::ImageRotator< T >::setAngle ( const casacore::Quantity angle)
inline

set angle through which to rotate the direction or linear coordinate

Definition at line 93 of file ImageRotator.h.

References casa::ImageRotator< T >::_angle.

template<class T >
void casa::ImageRotator< T >::setDecimate ( casacore::Int  d)
inline

Definition at line 95 of file ImageRotator.h.

References casa::ImageRotator< T >::_decimate.

template<class T >
void casa::ImageRotator< T >::setInterpolationMethod ( const casacore::String method)
inline

set the interpolation method

Definition at line 98 of file ImageRotator.h.

References casa::ImageRotator< T >::_method, and casacore::String::upcase().

template<class T >
void casa::ImageRotator< T >::setReplicate ( casacore::Bool  b)
inline

Definition at line 103 of file ImageRotator.h.

References casa::ImageRotator< T >::_replicate.

template<class T >
void casa::ImageRotator< T >::setShape ( const casacore::IPosition shape)
inline

set shape of output image

Definition at line 106 of file ImageRotator.h.

References casa::ImageRotator< T >::_shape, and casacore::shape().

Member Data Documentation

template<class T >
casacore::Quantity casa::ImageRotator< T >::_angle
private

Definition at line 123 of file ImageRotator.h.

Referenced by casa::ImageRotator< T >::setAngle().

template<class T >
casacore::Int casa::ImageRotator< T >::_decimate
private

Definition at line 124 of file ImageRotator.h.

Referenced by casa::ImageRotator< T >::setDecimate().

template<class T >
casacore::String casa::ImageRotator< T >::_method
private

Definition at line 122 of file ImageRotator.h.

Referenced by casa::ImageRotator< T >::setInterpolationMethod().

template<class T >
casacore::Bool casa::ImageRotator< T >::_replicate
private

Definition at line 125 of file ImageRotator.h.

Referenced by casa::ImageRotator< T >::setReplicate().

template<class T >
casacore::IPosition casa::ImageRotator< T >::_shape
private

Definition at line 121 of file ImageRotator.h.

Referenced by casa::ImageRotator< T >::setShape().

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

Definition at line 72 of file ImageRotator.h.

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


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