casa::ImageSourceFinder< T > Class Template Reference

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

#include <ImageSourceFinder.h>

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

List of all members.

Public Member Functions

 ImageSourceFinder ()
 ImageSourceFinder (SPCIIT image, const Record *const region, const String &mask)
 ImageSourceFinder (const ImageSourceFinder< T > &other)
 ~ImageSourceFinder ()
ImageSourceFinder< T > & operator= (const ImageSourceFinder< T > &other)
ComponentList findSources (Int nMax)
 Find strong sources.
SkyComponent findSourceInSky (Vector< Double > &absPixel)
 Find one source in sky plane.
void setCutoff (Double cutoff)
void setAbsFind (Bool af)
void setDoPoint (Bool dp)
void setWidth (Int w)
String getClass () const

Protected Member Functions

CasacRegionManager::StokesControl _getStokesControl () const
std::vector< Coordinate::Type > _getNecessaryCoordinates () const
 Represents the minimum set of coordinates necessary for the task to function.
Bool _supportsMultipleRegions () const
Bool _supportsMultipleBeams () const
 does this task support images with multiple beams? False means it never does.

Private Member Functions

ComponentList _findSources (Int nMax)
 Find strong (point) sources.

Private Attributes

Double _cutoff
Bool _absFind
Bool _doPoint
Int _width

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

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 89 of file ImageSourceFinder.h.


Constructor & Destructor Documentation

template<class T>
casa::ImageSourceFinder< T >::ImageSourceFinder (  ) 
template<class T>
casa::ImageSourceFinder< T >::ImageSourceFinder ( SPCIIT  image,
const Record *const   region,
const String &  mask 
)
template<class T>
casa::ImageSourceFinder< T >::ImageSourceFinder ( const ImageSourceFinder< T > &  other  ) 
template<class T>
casa::ImageSourceFinder< T >::~ImageSourceFinder (  ) 

Member Function Documentation

template<class T>
ComponentList casa::ImageSourceFinder< T >::_findSources ( Int  nMax  )  [private]

Find strong (point) sources.

template<class T>
std::vector<Coordinate::Type> casa::ImageSourceFinder< T >::_getNecessaryCoordinates (  )  const [inline, protected, virtual]

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

Implements casa::ImageTask< T >.

Definition at line 140 of file ImageSourceFinder.h.

template<class T>
CasacRegionManager::StokesControl casa::ImageSourceFinder< T >::_getStokesControl (  )  const [inline, protected, virtual]

Implements casa::ImageTask< T >.

Definition at line 134 of file ImageSourceFinder.h.

References casa::CasacRegionManager::USE_FIRST_STOKES.

template<class T>
Bool casa::ImageSourceFinder< T >::_supportsMultipleBeams (  )  const [inline, protected, virtual]

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 146 of file ImageSourceFinder.h.

References casacore::False.

template<class T>
Bool casa::ImageSourceFinder< T >::_supportsMultipleRegions (  )  const [inline, protected, virtual]

Reimplemented from casa::ImageTask< T >.

Definition at line 144 of file ImageSourceFinder.h.

References casacore::True.

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

Find one source in sky plane.

Exception if no sky

template<class T>
ComponentList casa::ImageSourceFinder< T >::findSources ( 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>
String casa::ImageSourceFinder< T >::getClass (  )  const [inline, virtual]

Implements casa::ImageTask< T >.

Definition at line 127 of file ImageSourceFinder.h.

References String.

template<class T>
ImageSourceFinder<T>& casa::ImageSourceFinder< T >::operator= ( const ImageSourceFinder< T > &  other  ) 
template<class T>
void casa::ImageSourceFinder< T >::setAbsFind ( Bool  af  )  [inline]

Definition at line 121 of file ImageSourceFinder.h.

References casa::ImageSourceFinder< T >::_absFind.

template<class T>
void casa::ImageSourceFinder< T >::setCutoff ( Double  cutoff  )  [inline]

Definition at line 119 of file ImageSourceFinder.h.

References casa::ImageSourceFinder< T >::_cutoff.

template<class T>
void casa::ImageSourceFinder< T >::setDoPoint ( Bool  dp  )  [inline]

Definition at line 123 of file ImageSourceFinder.h.

References casa::ImageSourceFinder< T >::_doPoint.

template<class T>
void casa::ImageSourceFinder< T >::setWidth ( Int  w  )  [inline]

Definition at line 125 of file ImageSourceFinder.h.

References casa::ImageSourceFinder< T >::_width.


Member Data Documentation

template<class T>
Bool casa::ImageSourceFinder< T >::_absFind [private]

Definition at line 151 of file ImageSourceFinder.h.

Referenced by casa::ImageSourceFinder< T >::setAbsFind().

template<class T>
Double casa::ImageSourceFinder< T >::_cutoff [private]

Definition at line 150 of file ImageSourceFinder.h.

Referenced by casa::ImageSourceFinder< T >::setCutoff().

template<class T>
Bool casa::ImageSourceFinder< T >::_doPoint [private]

Definition at line 152 of file ImageSourceFinder.h.

Referenced by casa::ImageSourceFinder< T >::setDoPoint().

template<class T>
Int casa::ImageSourceFinder< T >::_width [private]

Definition at line 153 of file ImageSourceFinder.h.

Referenced by casa::ImageSourceFinder< T >::setWidth().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1