casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Static Private Attributes
casa::ImagePrimaryBeamCorrector Class Reference

#include <ImagePrimaryBeamCorrector.h>

Inheritance diagram for casa::ImagePrimaryBeamCorrector:
casa::ImageTask

List of all members.

Public Types

enum  Mode {
  MULTIPLY,
  DIVIDE
}
 Top level interface for primary beam correction. More...

Public Member Functions

 ImagePrimaryBeamCorrector (const ImageInterface< Float > *const &image, const ImageInterface< Float > *const &pbImage, const Record *const &regionPtr, const String &region, const String &box, const String &chanInp, const String &stokes, const String &maskInp, const String &outname, const Bool overwrite, const Float cutoff, const Bool useCutoff, const Mode mode)
 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 Only one of regionPtr or region<src> should be specified.
 ImagePrimaryBeamCorrector (const ImageInterface< Float > *const &image, const Array< Float > &pbArray, const Record *const &regionPtr, const String &region, const String &box, const String &chanInp, const String &stokes, const String &maskInp, const String &outname, const Bool overwrite, const Float cutoff, const Bool useCutoff, const Mode mode)
 ~ImagePrimaryBeamCorrector ()
 destructor
ImageInterface< Float > * correct (const Bool wantReturn) const
 perform the correction.
String getClass () const

Protected Member Functions

vector< Coordinate::Type_getNecessaryCoordinates () const
 Represents the minimum set of coordinates necessary for the task to function.
CasacRegionManager::StokesControl _getStokesControl () const

Private Member Functions

 ImagePrimaryBeamCorrector ()
void _checkPBSanity ()

Private Attributes

std::auto_ptr< ImageInterface
< Float > > 
_pbImage
Float _cutoff
Mode _mode
Bool _useCutoff

Static Private Attributes

static const String _class

Detailed Description

Definition at line 40 of file ImagePrimaryBeamCorrector.h.


Member Enumeration Documentation

Top level interface for primary beam correction.

Etymology

Collapses image.

Synopsis

High level interface for primary beam correction.

Example

            ImagePrimaryBeamCorrector corrector(...);
            corrector.correct();
Enumerator:
MULTIPLY 
DIVIDE 

Definition at line 68 of file ImagePrimaryBeamCorrector.h.


Constructor & Destructor Documentation

casa::ImagePrimaryBeamCorrector::ImagePrimaryBeamCorrector ( const ImageInterface< Float > *const &  image,
const ImageInterface< Float > *const &  pbImage,
const Record *const &  regionPtr,
const String region,
const String box,
const String chanInp,
const String stokes,
const String maskInp,
const String outname,
const Bool  overwrite,
const Float  cutoff,
const Bool  useCutoff,
const Mode  mode 
)

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 Only one of regionPtr or region<src> should be specified.

casa::ImagePrimaryBeamCorrector::ImagePrimaryBeamCorrector ( const ImageInterface< Float > *const &  image,
const Array< Float > &  pbArray,
const Record *const &  regionPtr,
const String region,
const String box,
const String chanInp,
const String stokes,
const String maskInp,
const String outname,
const Bool  overwrite,
const Float  cutoff,
const Bool  useCutoff,
const Mode  mode 
)

destructor


Member Function Documentation

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

Implements casa::ImageTask.

Implements casa::ImageTask.

perform the correction.

If <src>wantReturn is True, return a pointer to the collapsed image. The returned pointer is created via new(); it is the caller's responsibility to delete the returned pointer. If wantReturn is False, a NULL pointer is returned and pointer deletion is performed internally.

Implements casa::ImageTask.


Member Data Documentation

Definition at line 127 of file ImagePrimaryBeamCorrector.h.

Definition at line 124 of file ImagePrimaryBeamCorrector.h.

Definition at line 125 of file ImagePrimaryBeamCorrector.h.

Definition at line 122 of file ImagePrimaryBeamCorrector.h.

Definition at line 126 of file ImagePrimaryBeamCorrector.h.


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