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

Fits and subtracts or models the continuum in spectra. More...

#include <MSContinuumSubtractor.h>

List of all members.

Public Member Functions

 MSContinuumSubtractor (MeasurementSet &ms)
 Constructor.
MSContinuumSubtractoroperator= (MSContinuumSubtractor &other)
 Assignment (only copies reference to MS, need to reset selection etc)
 ~MSContinuumSubtractor ()
 Destructor.
void setField (const String &field)
 Set the required field Ids.
void setFields (const Vector< Int > &fieldIds)
void setFitSpw (const String &fitspw)
 Set the channels to use in the fit.
void setSubSpw (const String &subspw)
void setDataDescriptionIds (const Vector< Int > &ddIds)
 Set the required spws (ddids)
void setSolutionInterval (Float solInt)
 Set the solution interval in seconds, the value zero implies scan averaging.
void setSolutionInterval (String solInt)
 Set the solution interval in seconds, the value zero implies scan averaging.
void setOrder (Int order)
 Set the order of the fit (1=linear)
void setMode (const String &mode)
 Set the processing mode: subtract, model or replace.
void subtract ()
 Do the subtraction (or save the model)

Private Attributes

MeasurementSetms_p
 Pointer to MS.
Vector< IntitsDDIds
 DataDescription Ids to process.
Vector< IntitsFieldIds
 Field Ids to process.
Matrix< IntitsFitChans
 Channels to use in fit.
Matrix< IntitsSubChans
 Channels to subtract from.
Float itsSolInt
 Solution interval for fit.
Int itsOrder
 Order of the fit.
String itsMode
 Processing mode.
Int nSpw_
 Number of spws.

Detailed Description

Fits and subtracts or models the continuum in spectra.

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

This class's main aim is to subtract the continuum from spectral line data.

Synopsis

Spectral line observations often contain continuum emission which is present in all channels (often with small slope across band). This class fits this continuum and subtracts it, replacing either the corrected data or the model data column.

Example

        MS inMS(fileName);
        MSContinuumSubtractor mssub(inMS);
        mssub.setDataDescriptionIds(ddIds);
        mssub.setFields(fieldIds);
        mssub.setSolutionInterval(10.0);
        mssub.setMode("subtract");
        mssub.subtract();

A MSContinuumSubtractor object is constructed and the continuum is subtracted with a 10.0s averaging time for the fit.

Motivation

This class replaces existing functionality at the glish level, in an attempt to speed up the continuum subtraction process.

Definition at line 83 of file MSContinuumSubtractor.h.


Constructor & Destructor Documentation

Constructor.

Destructor.


Member Function Documentation

MSContinuumSubtractor& casa::MSContinuumSubtractor::operator= ( MSContinuumSubtractor other)

Assignment (only copies reference to MS, need to reset selection etc)

Set the required spws (ddids)

Set the required field Ids.

void casa::MSContinuumSubtractor::setFields ( const Vector< Int > &  fieldIds)

Set the channels to use in the fit.

Set the processing mode: subtract, model or replace.

Set the order of the fit (1=linear)

Set the solution interval in seconds, the value zero implies scan averaging.

Set the solution interval in seconds, the value zero implies scan averaging.

Do the subtraction (or save the model)


Member Data Documentation

DataDescription Ids to process.

Definition at line 124 of file MSContinuumSubtractor.h.

Field Ids to process.

Definition at line 126 of file MSContinuumSubtractor.h.

Channels to use in fit.

Definition at line 128 of file MSContinuumSubtractor.h.

Processing mode.

Definition at line 136 of file MSContinuumSubtractor.h.

Order of the fit.

Definition at line 134 of file MSContinuumSubtractor.h.

Solution interval for fit.

Definition at line 132 of file MSContinuumSubtractor.h.

Channels to subtract from.

Definition at line 130 of file MSContinuumSubtractor.h.

Pointer to MS.

Definition at line 122 of file MSContinuumSubtractor.h.

Number of spws.

Definition at line 138 of file MSContinuumSubtractor.h.


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