casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Member Functions | Private Attributes
casa::ImageSourceFinder< T > Class Template Reference

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

#include <ImageSourceFinder.h>

List of all members.

Public Member Functions

 ImageSourceFinder (const ImageInterface< T > &)
 Constructor.
 ImageSourceFinder (const ImageSourceFinder< T > &other)
 Copy constructor.
 ~ImageSourceFinder ()
 Destructor.
ImageSourceFinder< T > & operator= (const ImageSourceFinder< T > &other)
 Assignment operator.
ComponentList findSources (LogIO &os, Int nMax, Double cutoff=0.1, Bool absFind=True, Bool doPoint=True, Int width=4)
 Find strong sources.
SkyComponent findSourceInSky (LogIO &os, Vector< Double > &absPixel, Double cutoff=0.1, Bool absFind=True, Bool doPoint=True, Int width=4)
 Find one source in sky plane.
Bool setNewImage (const ImageInterface< T > &image)
 Set a new image.

Private Member Functions

ComponentList findSources (LogIO &os, const ImageInterface< T > &image, Int nMax, Double cutoff, Bool absFind, Bool doPoint, Int width)
 Find strong (point) sources.

Private Attributes

const ImageInterface< T > * pImage_p

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


Constructor & Destructor Documentation

template<class T>
casa::ImageSourceFinder< T >::ImageSourceFinder ( const ImageInterface< T > &  )

Constructor.

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

Copy constructor.

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

Destructor.


Member Function Documentation

template<class T>
SkyComponent casa::ImageSourceFinder< T >::findSourceInSky ( LogIO os,
Vector< Double > &  absPixel,
Double  cutoff = 0.1,
Bool  absFind = True,
Bool  doPoint = True,
Int  width = 4 
)

Find one source in sky plane.

Exception if no sky

template<class T>
ComponentList casa::ImageSourceFinder< T >::findSources ( LogIO os,
Int  nMax,
Double  cutoff = 0.1,
Bool  absFind = True,
Bool  doPoint = True,
Int  width = 4 
)

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>
ComponentList casa::ImageSourceFinder< T >::findSources ( LogIO os,
const ImageInterface< T > &  image,
Int  nMax,
Double  cutoff,
Bool  absFind,
Bool  doPoint,
Int  width 
) [private]

Find strong (point) sources.

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

Assignment operator.

template<class T>
Bool casa::ImageSourceFinder< T >::setNewImage ( const ImageInterface< T > &  image)

Set a new image.


Member Data Documentation

template<class T>
const ImageInterface<T>* casa::ImageSourceFinder< T >::pImage_p [private]

Definition at line 130 of file ImageSourceFinder.h.


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