Provides functionality to find sources in an image. More...

#include <ImageSourceFinder.h>

Inheritance diagram for casa::ImageSourceFinder< T >:

Public Member Functions
	ImageSourceFinder ()=delete

	ImageSourceFinder (SPCIIT image, const casacore::Record *const region, const casacore::String &mask)

	ImageSourceFinder (const ImageSourceFinder< T > &other)=delete

	~ImageSourceFinder ()

ImageSourceFinder< T > &	operator= (const ImageSourceFinder< T > &other)=delete

ComponentList	findSources (casacore::Int nMax)
	Find strong sources. More...

SkyComponent	findSourceInSky (casacore::Vector< casacore::Double > &absPixel)
	Find one source in sky plane. More...

void	setCutoff (casacore::Double cutoff)

void	setAbsFind (casacore::Bool af)

void	setDoPoint (casacore::Bool dp)

void	setWidth (casacore::Int w)

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...

casacore::Bool	_supportsMultipleRegions () const

casacore::Bool	_supportsMultipleBeams () const
	does this task support images with multiple beams? false means it never does. 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

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
ComponentList	_findSources (casacore::Int nMax)
	Find strong (point) sources. More...

Private Attributes
casacore::Double	_cutoff

casacore::Bool	_absFind

casacore::Bool	_doPoint

casacore::Int	_width

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

Provides functionality to find sources in an image.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

ImageInterface
Coordinates

Etymology

It finds sources.

Synopsis

This class provides methods to find sources in an image.

The finding procedes in two stages. First, strong point sources are found via an efficient algorithm producing POINT components. If you wish, you can further request a Gaussian fit to these found point sources and then return the parameters of the fit (as a GAUSIAN component).

Example

Motivation

This complements source fitting by providing an initial estimate

Definition at line 93 of file ImageSourceFinder.h.

Constructor & Destructor Documentation

template<class T>

casa::ImageSourceFinder< T >::ImageSourceFinder ( )

delete

template<class T>

casa::ImageSourceFinder< T >::ImageSourceFinder	(	SPCIIT	image,
		const casacore::Record *const	region,
		const casacore::String &	mask
	)

template<class T>

casa::ImageSourceFinder< T >::ImageSourceFinder ( const ImageSourceFinder< T > & other )

delete

template<class T>

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

Member Function Documentation

template<class T>

ComponentList casa::ImageSourceFinder< T >::_findSources ( casacore::Int nMax )

private

Find strong (point) sources.

template<class T>

std::vector<casacore::Coordinate::Type> casa::ImageSourceFinder< T >::_getNecessaryCoordinates ( ) const

inlineprotectedvirtual

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

Implements casa::ImageTask< T >.

Definition at line 144 of file ImageSourceFinder.h.

References casacore::Coordinate::DIRECTION.

template<class T>

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

inlineprotectedvirtual

Implements casa::ImageTask< T >.

Definition at line 138 of file ImageSourceFinder.h.

References casa::CasacRegionManager::USE_FIRST_STOKES.

template<class T>

casacore::Bool casa::ImageSourceFinder< T >::_supportsMultipleBeams ( ) const

inlineprotectedvirtual

does this task support images with multiple beams? false means it never does.

true means it does, but not necessarily in all cases (in which case, the derived class is responsible for checking for and throwing exceptions in those cases).

Reimplemented from casa::ImageTask< T >.

Definition at line 150 of file ImageSourceFinder.h.

template<class T>

casacore::Bool casa::ImageSourceFinder< T >::_supportsMultipleRegions ( ) const

inlineprotectedvirtual

Reimplemented from casa::ImageTask< T >.

Definition at line 148 of file ImageSourceFinder.h.

template<class T>

SkyComponent casa::ImageSourceFinder< T >::findSourceInSky ( casacore::Vector< casacore::Double > & absPixel )

Find one source in sky plane.

Exception if no sky

template<class T>

ComponentList casa::ImageSourceFinder< T >::findSources ( casacore::Int nMax )

Find strong sources.

nMax specifies the maximum number of sources to find. cutoff is the fractional cutoff (of peak) and soiurces below this limit will not be found. If absFind is true, only positive sources are found, else positive and negative are found. If doPoint=true, the returned components are of type POINT. If doPoint=false, the position and shape information is returned via a Gaussian fit (and components will be of type GAUSSIAN) to the point sources initially found. The parameter width specifies the half-width of a square grid of pixels centered on the initial point source location to be used in the fit. If you set doPoint=false and width=0, a default width of 3 and position angle 0 is returned in the GAUSSIAN component. Because the flux of the component is integrated, this rough shape influences the flux values as well.

template<class T>

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

inlinevirtual

Implements casa::ImageTask< T >.

Definition at line 131 of file ImageSourceFinder.h.

template<class T>

ImageSourceFinder<T>& casa::ImageSourceFinder< T >::operator= ( const ImageSourceFinder< T > & other )