casa::vi::FinalTvi2 Class Reference

FinalTvi2 - Class that serves as the final Tvi2 in a pipeline; it adds simple write functionality that allows writing back the data contained in the associated VB2. More...

#include <FinalTvi2.h>

Inheritance diagram for casa::vi::FinalTvi2:
casa::vi::TransformingVi2 casa::vi::ViImplementation2

List of all members.

Public Member Functions

 FinalTvi2 (ViImplementation2 *inputVi, MeasurementSet &finalMs, Bool isWritable)
virtual ~FinalTvi2 ()
 Destructor.
virtual void origin ()
 +==================================+ | | | Iteration Control and Monitoring | | | +==================================+
virtual void next ()
virtual void writeBackChanges (VisBuffer2 *vb)
 +=========================+ | | | Subchunk Data Accessors | | | +=========================+
virtual void writeFlag (const Matrix< Bool > &flag)
 These methods will throw a not-implemented exception if called.
virtual void writeFlag (const Cube< Bool > &flag)
 Write/modify the flags in the data.
virtual void writeFlagRow (const Vector< Bool > &rowflags)
 Write/modify the flag row column; dimension Vector (nrow).
virtual void writeFlagCategory (const Array< Bool > &fc)
virtual void writeVisCorrected (const Cube< Complex > &vis)
 Write/modify the visibilities.
virtual void writeVisModel (const Cube< Complex > &vis)
virtual void writeVisObserved (const Cube< Complex > &vis)
virtual void writeWeight (const Matrix< Float > &wt)
 Write/modify the weights.
virtual void writeWeightSpectrum (const Cube< Float > &wtsp)
 Write/modify the weightMat virtual void writeWeightMat (const Matrix<Float> & wtmat);.
virtual void writeSigma (const Matrix< Float > &sig)
 Write/modify the Sigma.
virtual void writeModel (const RecordInterface &rec, Bool iscomponentlist=True, Bool incremental=False)
 Write/modify the ncorr x nrow SigmaMat.

Protected Member Functions

void writeDataValues (MeasurementSet &ms, const RefRows &rows)
 void configureNewSubchunk ();
void writeKeyValues (MeasurementSet &ms, const RefRows &rows)
void writeMiscellaneousValues (MeasurementSet &ms, const RefRows &rows)

Private Attributes

ViColumns2 columns_p
Bool columnsAttached_p
MeasurementSet ms_p

Detailed Description

FinalTvi2 - Class that serves as the final Tvi2 in a pipeline; it adds simple write functionality that allows writing back the data contained in the associated VB2.

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Etymology

The FinalTvi2 in a transforming VI2 pipeline.

Synopsis

Example

Motivation

At the end of a Transforming VI pipeline it can be handy to write out the result. Putting a FinalTvi2 as the last transforming VI allows the output to disk of the transformed data into a brand new MS.

Thrown Exceptions

Definition at line 96 of file FinalTvi2.h.


Constructor & Destructor Documentation

casa::vi::FinalTvi2::FinalTvi2 ( ViImplementation2 inputVi,
MeasurementSet &  finalMs,
Bool  isWritable 
)
virtual casa::vi::FinalTvi2::~FinalTvi2 (  )  [virtual]

Destructor.


Member Function Documentation

virtual void casa::vi::FinalTvi2::next (  )  [virtual]

Reimplemented from casa::vi::TransformingVi2.

virtual void casa::vi::FinalTvi2::origin (  )  [virtual]

+==================================+ | | | Iteration Control and Monitoring | | | +==================================+

Reimplemented from casa::vi::TransformingVi2.

virtual void casa::vi::FinalTvi2::writeBackChanges ( VisBuffer2 vb  )  [virtual]

+=========================+ | | | Subchunk Data Accessors | | | +=========================+

+------------------------+ | | | Angular Data Providers | | | +------------------------+

+=========================+ | | | Chunk and MS Level Data | | | +=========================+

+-------------------+ | | | Writeback Methods | | | +-------------------+

This method writes back any changed (dirty) components of the provided VisBuffer and is the preferred method for writing data out.

Reimplemented from casa::vi::TransformingVi2.

void casa::vi::FinalTvi2::writeDataValues ( MeasurementSet &  ms,
const RefRows &  rows 
) [protected]

void configureNewSubchunk ();

These are the methods that actually write the data in the VB2 out to the new MS when called by writeBackChanges. The VB's data are handled as four categories: data - the various visibility data and the associated weight, weight spectrum, sigma, etc. keys - the values of the columns that ID the row (e.g., antennas, DdId, etc.) misc - the column values that don't fall in the data or key categories.

virtual void casa::vi::FinalTvi2::writeFlag ( const Cube< Bool > &  flag  )  [virtual]

Write/modify the flags in the data.

This writes the flags as found in the MS, Cube (npol,nchan,nrow), where nrow is the number of rows in the current iteration (given by nRow ()).

Reimplemented from casa::vi::TransformingVi2.

virtual void casa::vi::FinalTvi2::writeFlag ( const Matrix< Bool > &  flag  )  [virtual]

These methods will throw a not-implemented exception if called.

They are here because the interface requires them but the intended use of FinalTvi2 expects that the data will be output using only the writeBackChanges method.

Reimplemented from casa::vi::TransformingVi2.

virtual void casa::vi::FinalTvi2::writeFlagCategory ( const Array< Bool > &  fc  )  [virtual]

Reimplemented from casa::vi::TransformingVi2.

virtual void casa::vi::FinalTvi2::writeFlagRow ( const Vector< Bool > &  rowflags  )  [virtual]

Write/modify the flag row column; dimension Vector (nrow).

Reimplemented from casa::vi::TransformingVi2.

void casa::vi::FinalTvi2::writeKeyValues ( MeasurementSet &  ms,
const RefRows &  rows 
) [protected]
void casa::vi::FinalTvi2::writeMiscellaneousValues ( MeasurementSet &  ms,
const RefRows &  rows 
) [protected]
virtual void casa::vi::FinalTvi2::writeModel ( const RecordInterface &  rec,
Bool  iscomponentlist = True,
Bool  incremental = False 
) [virtual]

Write/modify the ncorr x nrow SigmaMat.

virtual void writeSigmaMat (const Matrix<Float> & sigmat);

Write the information needed to generate on-the-fly model visibilities.

Reimplemented from casa::vi::TransformingVi2.

virtual void casa::vi::FinalTvi2::writeSigma ( const Matrix< Float > &  sig  )  [virtual]

Write/modify the Sigma.

Reimplemented from casa::vi::TransformingVi2.

virtual void casa::vi::FinalTvi2::writeVisCorrected ( const Cube< Complex > &  vis  )  [virtual]

Write/modify the visibilities.

This is possibly only for a 'reference' MS which has a new DATA column. The first axis of the matrix should equal the selected number of channels in the original MS. If the MS does not contain all polarizations, only the parallel hand polarizations are used. virtual void writeVisCorrected (const Matrix<CStokesVector> & visibilityStokes); virtual void writeVisModel (const Matrix<CStokesVector> & visibilityStokes); virtual void writeVisObserved (const Matrix<CStokesVector> & visibilityStokes);

Write/modify the visibilities This writes the data as found in the MS, Cube (npol,nchan,nrow).

Reimplemented from casa::vi::TransformingVi2.

virtual void casa::vi::FinalTvi2::writeVisModel ( const Cube< Complex > &  vis  )  [virtual]

Reimplemented from casa::vi::TransformingVi2.

virtual void casa::vi::FinalTvi2::writeVisObserved ( const Cube< Complex > &  vis  )  [virtual]

Reimplemented from casa::vi::TransformingVi2.

virtual void casa::vi::FinalTvi2::writeWeight ( const Matrix< Float > &  wt  )  [virtual]

Write/modify the weights.

Reimplemented from casa::vi::TransformingVi2.

virtual void casa::vi::FinalTvi2::writeWeightSpectrum ( const Cube< Float > &  wtsp  )  [virtual]

Write/modify the weightMat virtual void writeWeightMat (const Matrix<Float> & wtmat);.

Write/modify the weightSpectrum

Reimplemented from casa::vi::TransformingVi2.


Member Data Documentation

Definition at line 184 of file FinalTvi2.h.

Definition at line 185 of file FinalTvi2.h.

MeasurementSet casa::vi::FinalTvi2::ms_p [private]

Definition at line 186 of file FinalTvi2.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1