casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
casa::VisSet Class Reference

#include <VisSet.h>

Public Member Functions

 VisSet ()
 default constructor, only useful to assign to later. More...
 
 VisSet (casacore::MeasurementSet &ms, const casacore::Block< casacore::Int > &columns, const casacore::Matrix< casacore::Int > &chanSelection, casacore::Double timeInterval=0, casacore::Bool compress=false, casacore::Bool doModelData=true)
 Construct from a casacore::MeasurementSet, with iteration order specified in columns (giving the casacore::MS enum for the column) Specify channel selection as a casacore::Matrix(3,nSpw) where for each spectral window the three values are start,nChannel and spectral window number. More...
 
 VisSet (casacore::MeasurementSet &ms, const casacore::Block< casacore::Int > &columns, const casacore::Matrix< casacore::Int > &chanSelection, casacore::Bool addScratch, casacore::Double timeInterval=0, casacore::Bool compress=false, casacore::Bool doModelData=true)
 Same as above, but provide scratch column option. More...
 
 VisSet (casacore::Block< casacore::MeasurementSet > &mss, const casacore::Block< casacore::Int > &columns, const casacore::Block< casacore::Matrix< casacore::Int > > &chanSelections, casacore::Bool addStratch=false, casacore::Double timeInterval=0, casacore::Bool compress=false, casacore::Bool doModelData=true)
 This is a constructor for multiple MS...but everything is same as the one above. More...
 
 VisSet (casacore::MeasurementSet &ms, const casacore::Matrix< casacore::Int > &chanSelection, casacore::Double timeInterval=0)
 This is a no frills constructor, no re-sorting, the default order is used, no scratch columns is made even if they don't exist. More...
 
 VisSet (ROVisibilityIterator &vi)
 Constructor from visibility iterator....a temporary fix as EPJones as Imager stops using VisSet. More...
 
 VisSet (const VisSet &vs, const casacore::Block< casacore::Int > &columns, casacore::Double timeInterval=0)
 Construct from an existing VisSet, this references the underlying casacore::MeasurementSet(s) but allows a new iteration order and time interval to be specified. More...
 
 ~VisSet ()
 Destructor, flushes the data to disk. More...
 
VisSetoperator= (const VisSet &other)
 referencing assignment operator More...
 
void resetVisIter (const casacore::Block< casacore::Int > &columns, casacore::Double timeInterval=0, asyncio::PrefetchColumns *prefetchColumns=NULL)
 Re-initialize the VisibilityIterator (cf copy ctor) More...
 
void initCalSet (casacore::Int calSet=0)
 Initializes scratch columns. More...
 
void flush ()
 Flushes the data to disk. More...
 
VisIteriter ()
 Iterator access to the data. More...
 
void selectChannel (casacore::Int nGroup, casacore::Int start, casacore::Int width, casacore::Int increment, casacore::Int spectralWindow)
 Reset the channel selection. More...
 
void selectChannel (casacore::Int nGroup, casacore::Int start, casacore::Int width, casacore::Int increment, casacore::Int spectralWindow, casacore::Bool callOrigin)
 call to VisIter origin optional: More...
 
void selectChannel (const casacore::Matrix< casacore::Int > &chansel)
 Collective selection via casacore::MSSelection channel selection Matrix. More...
 
void selectAllChans ()
 Set nominal selection to ALL channels. More...
 
casacore::Int numberAnt ()
 number of antennas More...
 
casacore::Int numberFld ()
 number of fields More...
 
casacore::Int numberSpw ()
 number of spectral windows More...
 
casacore::Vector< casacore::IntnumberChan () const
 number of channels in each spectral window More...
 
casacore::Vector< casacore::IntstartChan () const
 start channel of VisSet selection in each spectral window More...
 
casacore::Int numberCoh () const
 number of coherences More...
 
void lock ()
 Lock and unlock the associated MS. More...
 
void unlock ()
 
casacore::String msName ()
 Return the associated casacore::MS name. More...
 
casacore::String sysCalTableName ()
 SYSCAL table name of the associated MS. More...
 
casacore::String spectralWindowTableName ()
 SPECTRAL_WINDOW table name of the associated MS. More...
 
casacore::String fieldTableName ()
 FIELD table name of the associated MS. More...
 
casacore::String syspowerTableName ()
 SYSPOWER table name of the associated MS. More...
 
casacore::String caldeviceTableName ()
 CALDEVICE table name of the associated MS. More...
 

Private Member Functions

void addScratchCols (casacore::MeasurementSet &ms, casacore::Bool compress=false, casacore::Bool doModelData=true)
 Add the scratch columns. More...
 
void addCalSet (casacore::MeasurementSet &ms, casacore::Bool compress=true, casacore::Bool doModelData=true)
 Add a calibration set (comprising a set of CORRECTED_DATA and MODEL_DATA) to the casacore::MeasurementSet (casacore::MS). More...
 
void addCalSet2 (casacore::MeasurementSet &ms, casacore::Bool compress=false, casacore::Bool doModelData=true)
 

Private Attributes

casacore::MeasurementSet ms_p
 
VisIteriter_p
 
casacore::Matrix< casacore::Intselection_p
 
casacore::Block
< casacore::MeasurementSet > * 
blockOfMS_p
 
casacore::Bool multims_p
 

Detailed Description

Definition at line 102 of file VisSet.h.

Constructor & Destructor Documentation

casa::VisSet::VisSet ( )
inline

default constructor, only useful to assign to later.

Definition at line 106 of file VisSet.h.

casa::VisSet::VisSet ( casacore::MeasurementSet ms,
const casacore::Block< casacore::Int > &  columns,
const casacore::Matrix< casacore::Int > &  chanSelection,
casacore::Double  timeInterval = 0,
casacore::Bool  compress = false,
casacore::Bool  doModelData = true 
)

Construct from a casacore::MeasurementSet, with iteration order specified in columns (giving the casacore::MS enum for the column) Specify channel selection as a casacore::Matrix(3,nSpw) where for each spectral window the three values are start,nChannel and spectral window number.

Spectral windows without an entry will have all channels selected. Specify a time interval for iterating in 'chunks' of time. The default time interval of 0 groups all times together. This constructor creates two new columns: MODEL_DATA and CORRECTED_DATA If they already exist and have the same channel selection applied, they are reused. Note that the contents of these columns are NOT initialized, you should fill them before trying to read the data. The casacore::MS calibration scratch columns can be optionally compressed.

casa::VisSet::VisSet ( casacore::MeasurementSet ms,
const casacore::Block< casacore::Int > &  columns,
const casacore::Matrix< casacore::Int > &  chanSelection,
casacore::Bool  addScratch,
casacore::Double  timeInterval = 0,
casacore::Bool  compress = false,
casacore::Bool  doModelData = true 
)

Same as above, but provide scratch column option.

casa::VisSet::VisSet ( casacore::Block< casacore::MeasurementSet > &  mss,
const casacore::Block< casacore::Int > &  columns,
const casacore::Block< casacore::Matrix< casacore::Int > > &  chanSelections,
casacore::Bool  addStratch = false,
casacore::Double  timeInterval = 0,
casacore::Bool  compress = false,
casacore::Bool  doModelData = true 
)

This is a constructor for multiple MS...but everything is same as the one above.

casa::VisSet::VisSet ( casacore::MeasurementSet ms,
const casacore::Matrix< casacore::Int > &  chanSelection,
casacore::Double  timeInterval = 0 
)

This is a no frills constructor, no re-sorting, the default order is used, no scratch columns is made even if they don't exist.

So if you use this constructor and plan to use the scratch columns make sure that they exist prior to constructing the VisSet this way.

casa::VisSet::VisSet ( ROVisibilityIterator vi)

Constructor from visibility iterator....a temporary fix as EPJones as Imager stops using VisSet.

casa::VisSet::VisSet ( const VisSet vs,
const casacore::Block< casacore::Int > &  columns,
casacore::Double  timeInterval = 0 
)

Construct from an existing VisSet, this references the underlying casacore::MeasurementSet(s) but allows a new iteration order and time interval to be specified.

casa::VisSet::~VisSet ( )

Destructor, flushes the data to disk.

Member Function Documentation

void casa::VisSet::addCalSet ( casacore::MeasurementSet ms,
casacore::Bool  compress = true,
casacore::Bool  doModelData = true 
)
private

Add a calibration set (comprising a set of CORRECTED_DATA and MODEL_DATA) to the casacore::MeasurementSet (casacore::MS).

Optionally compress these columns using the casacore::CompressComplex column engine.

void casa::VisSet::addCalSet2 ( casacore::MeasurementSet ms,
casacore::Bool  compress = false,
casacore::Bool  doModelData = true 
)
private
void casa::VisSet::addScratchCols ( casacore::MeasurementSet ms,
casacore::Bool  compress = false,
casacore::Bool  doModelData = true 
)
private

Add the scratch columns.

casacore::String casa::VisSet::caldeviceTableName ( )

CALDEVICE table name of the associated MS.

casacore::String casa::VisSet::fieldTableName ( )

FIELD table name of the associated MS.

void casa::VisSet::flush ( )

Flushes the data to disk.

void casa::VisSet::initCalSet ( casacore::Int  calSet = 0)

Initializes scratch columns.

VisIter& casa::VisSet::iter ( )

Iterator access to the data.

void casa::VisSet::lock ( )
inline

Lock and unlock the associated MS.

Definition at line 211 of file VisSet.h.

References casacore::Table::lock(), and ms_p.

casacore::String casa::VisSet::msName ( )

Return the associated casacore::MS name.

casacore::Int casa::VisSet::numberAnt ( )

number of antennas

casacore::Vector<casacore::Int> casa::VisSet::numberChan ( ) const

number of channels in each spectral window

casacore::Int casa::VisSet::numberCoh ( ) const

number of coherences

casacore::Int casa::VisSet::numberFld ( )

number of fields

casacore::Int casa::VisSet::numberSpw ( )

number of spectral windows

VisSet& casa::VisSet::operator= ( const VisSet other)

referencing assignment operator

void casa::VisSet::resetVisIter ( const casacore::Block< casacore::Int > &  columns,
casacore::Double  timeInterval = 0,
asyncio::PrefetchColumns prefetchColumns = NULL 
)

Re-initialize the VisibilityIterator (cf copy ctor)

void casa::VisSet::selectAllChans ( )

Set nominal selection to ALL channels.

void casa::VisSet::selectChannel ( casacore::Int  nGroup,
casacore::Int  start,
casacore::Int  width,
casacore::Int  increment,
casacore::Int  spectralWindow 
)

Reset the channel selection.

Only subsets of the original selection (set in constructor) can be specified. Note: this calls origin on the iterator.

void casa::VisSet::selectChannel ( casacore::Int  nGroup,
casacore::Int  start,
casacore::Int  width,
casacore::Int  increment,
casacore::Int  spectralWindow,
casacore::Bool  callOrigin 
)

call to VisIter origin optional:

void casa::VisSet::selectChannel ( const casacore::Matrix< casacore::Int > &  chansel)

Collective selection via casacore::MSSelection channel selection Matrix.

casacore::String casa::VisSet::spectralWindowTableName ( )

SPECTRAL_WINDOW table name of the associated MS.

casacore::Vector<casacore::Int> casa::VisSet::startChan ( ) const

start channel of VisSet selection in each spectral window

casacore::String casa::VisSet::sysCalTableName ( )

SYSCAL table name of the associated MS.

casacore::String casa::VisSet::syspowerTableName ( )

SYSPOWER table name of the associated MS.

void casa::VisSet::unlock ( )
inline

Definition at line 212 of file VisSet.h.

References ms_p, and casacore::Table::unlock().

Member Data Documentation

casacore::Block<casacore::MeasurementSet>* casa::VisSet::blockOfMS_p
private

Definition at line 247 of file VisSet.h.

VisIter* casa::VisSet::iter_p
private

Definition at line 245 of file VisSet.h.

casacore::MeasurementSet casa::VisSet::ms_p
private

Definition at line 244 of file VisSet.h.

Referenced by lock(), and unlock().

casacore::Bool casa::VisSet::multims_p
private

Definition at line 248 of file VisSet.h.

casacore::Matrix<casacore::Int> casa::VisSet::selection_p
private

Definition at line 246 of file VisSet.h.


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