#include <PeakIntensityFluxDensityConverter.h>

Inheritance diagram for casa::PeakIntensityFluxDensityConverter< T >:

Public Types
using	Angular2DGaussian = casacore::GaussianBeam
	Class for converting between peak intensity and flux density of a source of specified shape. More...

Public Types inherited from casa::ImageTask< T >
enum	Verbosity { QUIET, WHISPER, LOW, NORMAL, HIGH, NOISY, DEAFENING }
	Virtual base class for image analysis tasks. More...

Public Member Functions
	PeakIntensityFluxDensityConverter (const SPCIIT image)
	Specify image to get beam and coordinate info from. More...

	~PeakIntensityFluxDensityConverter ()
	destructor More...

void	setSize (const Angular2DGaussian &size)
	set the source size using a GaussianShape object. More...

void	setShape (const casacore::String &shape)
	set the component shape More...

void	setShape (ComponentType::Shape shape)

void	setBeam (casacore::Int channel, casacore::Int polarization)
	Given the channel and polarization, determine which beam in the image to use for the resolution area. More...

casacore::Quantity	fluxDensityToPeakIntensity (casacore::Bool &hadToMakeFakeBeam, const casacore::Quantity &fluxDensity) const

casacore::Quantity	peakIntensityToFluxDensity (casacore::Bool &hadToMakeFakeBeam, const casacore::Quantity &fluxDensity) const

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 Attributes
Angular2DGaussian	_size

ComponentType::Shape	_shape

casacore::GaussianBeam	_beam

Additional Inherited Members
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::PeakIntensityFluxDensityConverter< T >

Definition at line 38 of file PeakIntensityFluxDensityConverter.h.

Member Typedef Documentation

template<class T >

using casa::PeakIntensityFluxDensityConverter< T >::Angular2DGaussian = casacore::GaussianBeam

Class for converting between peak intensity and flux density of a source of specified shape.

Etymology

Collapses image.

Synopsis

Example

Definition at line 64 of file PeakIntensityFluxDensityConverter.h.

Constructor & Destructor Documentation

template<class T >

casa::PeakIntensityFluxDensityConverter< T >::PeakIntensityFluxDensityConverter ( const SPCIIT image )

Specify image to get beam and coordinate info from.

template<class T >

casa::PeakIntensityFluxDensityConverter< T >::~PeakIntensityFluxDensityConverter ( )

destructor

Member Function Documentation

template<class T >

std::vector<casacore::Coordinate::Type> casa::PeakIntensityFluxDensityConverter< 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 PeakIntensityFluxDensityConverter.h.

References casacore::Coordinate::DIRECTION.

template<class T >

CasacRegionManager::StokesControl casa::PeakIntensityFluxDensityConverter< T >::_getStokesControl ( ) const

inlineprotectedvirtual

Implements casa::ImageTask< T >.

Definition at line 102 of file PeakIntensityFluxDensityConverter.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

template<class T >

casacore::Quantity casa::PeakIntensityFluxDensityConverter< T >::fluxDensityToPeakIntensity	(	casacore::Bool &	hadToMakeFakeBeam,
		const casacore::Quantity &	fluxDensity
	)		const

template<class T >

casacore::String casa::PeakIntensityFluxDensityConverter< T >::getClass ( ) const

inlinevirtual

Implements casa::ImageTask< T >.

Definition at line 96 of file PeakIntensityFluxDensityConverter.h.

template<class T >

casacore::Quantity casa::PeakIntensityFluxDensityConverter< T >::peakIntensityToFluxDensity	(	casacore::Bool &	hadToMakeFakeBeam,
		const casacore::Quantity &	fluxDensity
	)		const

template<class T >

void casa::PeakIntensityFluxDensityConverter< T >::setBeam	(	casacore::Int	channel,
		casacore::Int	polarization
	)

Given the channel and polarization, determine which beam in the image to use for the resolution area.

template<class T >

void casa::PeakIntensityFluxDensityConverter< T >::setShape ( const casacore::String & shape )

inline

set the component shape

Definition at line 80 of file PeakIntensityFluxDensityConverter.h.

References casa::PeakIntensityFluxDensityConverter< T >::_shape, and casa::ComponentType::shape().

template<class T >

void casa::PeakIntensityFluxDensityConverter< T >::setShape ( ComponentType::Shape shape )

inline

Definition at line 82 of file PeakIntensityFluxDensityConverter.h.

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

template<class T >

void casa::PeakIntensityFluxDensityConverter< T >::setSize ( const Angular2DGaussian & size )

inline

set the source size using a GaussianShape object.

Note that this in itself, does not constrain the shape to be Gaussian, it is just used to set the size (and puts the burden on the caller to do sanity checking by first constructing a GaussianSource object). The position angle is not used.

Definition at line 76 of file PeakIntensityFluxDensityConverter.h.

References casa::PeakIntensityFluxDensityConverter< T >::_size, and casa::vi::size().