casa::MSTransform Class Reference

MSTransform: Apply transformations to data on the fly. More...

#include <MSTransform.h>

Public Member Functions
	MSTransform ()
	default constructor
	~MSTransform ()
	destructor
void	done ()
	reset everything
bool	configure (Record config)
	set the defaults of the parameters Record & defaultOptions();
bool	open ()
	Open the MS and select the data.
Record	run ()
	Run the tool and write the flags to the MS.
Protected Attributes
LogIO	log_p
String	msname_p
	variables used to initialize the MSTransformManager
String	outputms_p
String	spw_p
	members to parse to selectData
String	scan_p
String	field_p
String	antenna_p
String	timerange_p
String	correlation_p
String	intent_p
String	feed_p
String	array_p
String	uvrange_p
String	observation_p
Record	config_p
String	datacolumn_p
Bool	isconfigured_p
	Tells if tool is already configured at least once.
MSTransformManager *	mdh_p
	variables for initAgents
Private Member Functions
	MSTransform (const MSTransform &)
MSTransform &	operator= (const MSTransform &)
Private Attributes
LogSink	logSink_p
	String validateDataColumn(String datacol);.

Detailed Description

MSTransform: Apply transformations to data on the fly.

Intended use:

Prerequisite

MSTransformManager

Synopsis

MSTransform ......\.

Example

The following is a typical way of using this class and its methods ..\.

 MSTransform *mst = new MSTransform();

Create a Record with the desired parameters. The parameters are: data selection parameters and any parameters for the transformations.

 Record params = Recod();
 params.define("spw", "0,1,2");
 params.define("combinespws",true);
 mst->configure(params);

Open the MS, select the data and setup the output MS.

 mst->open();

Run the tool and afterwards, destroy any instance of it by calling the destructor.

 mst->run();
 
 mst->done();

Motivation

To avoid multiple read/writes of the data...\.

Definition at line 96 of file MSTransform.h.

Constructor & Destructor Documentation

casa::MSTransform::MSTransform ( )

default constructor

casa::MSTransform::~MSTransform ( )

destructor

casa::MSTransform::MSTransform ( const MSTransform & ) [inline, private]

Definition at line 155 of file MSTransform.h.

Member Function Documentation

bool casa::MSTransform::configure ( Record config )

set the defaults of the parameters Record & defaultOptions();

configure the tool and parse the parameters

void casa::MSTransform::done ( )

reset everything

bool casa::MSTransform::open ( )

Open the MS and select the data.

MSTransform& casa::MSTransform::operator= ( const MSTransform & ) [inline, private]

Definition at line 157 of file MSTransform.h.

Record casa::MSTransform::run ( )

Run the tool and write the flags to the MS.

Member Data Documentation

String casa::MSTransform::antenna_p [protected]

Definition at line 111 of file MSTransform.h.

String casa::MSTransform::array_p [protected]

Definition at line 116 of file MSTransform.h.

Record casa::MSTransform::config_p [protected]

Definition at line 119 of file MSTransform.h.

String casa::MSTransform::correlation_p [protected]

Definition at line 113 of file MSTransform.h.

String casa::MSTransform::datacolumn_p [protected]

Definition at line 120 of file MSTransform.h.

String casa::MSTransform::feed_p [protected]

Definition at line 115 of file MSTransform.h.

String casa::MSTransform::field_p [protected]

Definition at line 110 of file MSTransform.h.

String casa::MSTransform::intent_p [protected]

Definition at line 114 of file MSTransform.h.

Bool casa::MSTransform::isconfigured_p [protected]

Tells if tool is already configured at least once.

Definition at line 123 of file MSTransform.h.

LogIO casa::MSTransform::log_p [protected]

Definition at line 100 of file MSTransform.h.

LogSink casa::MSTransform::logSink_p [private]

String validateDataColumn(String datacol);.

Sink used to store history

Definition at line 157 of file MSTransform.h.

MSTransformManager* casa::MSTransform::mdh_p [protected]

variables for initAgents

Definition at line 127 of file MSTransform.h.

String casa::MSTransform::msname_p [protected]

variables used to initialize the MSTransformManager

Definition at line 103 of file MSTransform.h.

String casa::MSTransform::observation_p [protected]

Definition at line 118 of file MSTransform.h.

String casa::MSTransform::outputms_p [protected]

Definition at line 104 of file MSTransform.h.

String casa::MSTransform::scan_p [protected]

Definition at line 109 of file MSTransform.h.

String casa::MSTransform::spw_p [protected]

members to parse to selectData

Definition at line 108 of file MSTransform.h.

String casa::MSTransform::timerange_p [protected]

Definition at line 112 of file MSTransform.h.

String casa::MSTransform::uvrange_p [protected]

Definition at line 117 of file MSTransform.h.

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

code/mstransform/MSTransform/MSTransform.h