casa::MSContinuumSubtractor Class Reference

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

#include <MSContinuumSubtractor.h>

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

Private Attributes
casacore::MeasurementSet *	ms_p
	Pointer to MS. More...
casacore::Vector< casacore::Int >	itsDDIds
	DataDescription Ids to process. More...
casacore::Vector< casacore::Int >	itsFieldIds
	Field Ids to process. More...
casacore::Matrix< casacore::Int >	itsFitChans
	Channels to use in fit. More...
casacore::Matrix< casacore::Int >	itsSubChans
	Channels to subtract from. More...
casacore::Float	itsSolInt
	Solution interval for fit. More...
casacore::Int	itsOrder
	Order of the fit. More...
casacore::String	itsMode
	Processing mode. More...
casacore::Int	nSpw_
	Number of spws. More...

Detailed Description

Fits and subtracts or models the continuum in spectra.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Prerequisite

• MeasurementSet

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

casacore::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 87 of file MSContinuumSubtractor.h.

Constructor & Destructor Documentation

casa::MSContinuumSubtractor::MSContinuumSubtractor

(

casacore::MeasurementSet &

ms

)

Constructor.

casa::MSContinuumSubtractor::~MSContinuumSubtractor

(

)

Destructor.

Member Function Documentation

MSContinuumSubtractor& casa::MSContinuumSubtractor::operator=

(

MSContinuumSubtractor &

other

)

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

void casa::MSContinuumSubtractor::setDataDescriptionIds

(

const casacore::Vector< casacore::Int > &

ddIds

)

Set the required spws (ddids)

void casa::MSContinuumSubtractor::setField

(

const casacore::String &

field

)

Set the required field Ids.

void casa::MSContinuumSubtractor::setFields

(

const casacore::Vector< casacore::Int > &

fieldIds

)

void casa::MSContinuumSubtractor::setFitSpw

(

const casacore::String &

fitspw

)

Set the channels to use in the fit.

void casa::MSContinuumSubtractor::setMode

(

const casacore::String &

mode

)

Set the processing mode: subtract, model or replace.

void casa::MSContinuumSubtractor::setOrder

(

casacore::Int

order

)

Set the order of the fit (1=linear)

void casa::MSContinuumSubtractor::setSolutionInterval

(

casacore::Float

solInt

)

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

void casa::MSContinuumSubtractor::setSolutionInterval

(

casacore::String

solInt

)

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

void casa::MSContinuumSubtractor::setSubSpw

(

const casacore::String &

subspw

)

void casa::MSContinuumSubtractor::subtract

(

)

Do the subtraction (or save the model)

void casa::MSContinuumSubtractor::subtract2

(

)

Member Data Documentation

casacore::Vector<casacore::Int> casa::MSContinuumSubtractor::itsDDIds

private

DataDescription Ids to process.

Definition at line 129 of file MSContinuumSubtractor.h.

casacore::Vector<casacore::Int> casa::MSContinuumSubtractor::itsFieldIds

private

Field Ids to process.

Definition at line 131 of file MSContinuumSubtractor.h.

casacore::Matrix<casacore::Int> casa::MSContinuumSubtractor::itsFitChans

private

Channels to use in fit.

Definition at line 133 of file MSContinuumSubtractor.h.

casacore::String casa::MSContinuumSubtractor::itsMode

private

Processing mode.

Definition at line 141 of file MSContinuumSubtractor.h.

casacore::Int casa::MSContinuumSubtractor::itsOrder

private

Order of the fit.

Definition at line 139 of file MSContinuumSubtractor.h.

casacore::Float casa::MSContinuumSubtractor::itsSolInt

private

Solution interval for fit.

Definition at line 137 of file MSContinuumSubtractor.h.

casacore::Matrix<casacore::Int> casa::MSContinuumSubtractor::itsSubChans

private

Channels to subtract from.

Definition at line 135 of file MSContinuumSubtractor.h.

casacore::MeasurementSet* casa::MSContinuumSubtractor::ms_p

private

Pointer to MS.

Definition at line 127 of file MSContinuumSubtractor.h.

casacore::Int casa::MSContinuumSubtractor::nSpw_

private

Number of spws.

Definition at line 143 of file MSContinuumSubtractor.h.

---

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

• casa/code/msvis/MSVis/MSContinuumSubtractor.h