casa::SolveDataBuffer Class Reference

SolveDataBuffer is a container for VisBuffer2 data and related residual and differentiation results related to generic calibration solving. More...

#include <SolveDataBuffer.h>

List of all members.

Public Member Functions

 SolveDataBuffer ()
 Generic ctor.
 SolveDataBuffer (const vi::VisBuffer2 &vb)
 Create from a VisBuffer2.
 SolveDataBuffer (const SolveDataBuffer &sdb)
 Copy construct current iteration (or reattach).
 ~SolveDataBuffer ()
 Destructor.
SolveDataBufferoperator= (const SolveDataBuffer &sdb)
 Assignment.
Bool Ok ()
 Does SDB contain finite weight?
void enforceAPonData (const String &apmode)
 Apply amp-only or phase-only to data.
void enforceSolveWeights (const Bool pHandOnly)
 Zero flagged weights, and optionally the cross-hand weights.
void setFocusChan (const Int focusChan=-1)
 Set the focus channel (forms references to focus-channel flag/data/model).
void sizeResiduals (const Int &nPar, const Int &nDiff)
 Size/init/finalize the residuals workspaces.
void initResidWithModel ()
void finalizeResiduals ()
void cleanUp ()
 Delete the workspaces.
Int nRows () const
 VB2-like data access methods (mostly const).
const Vector< Int > & observationId () const
const Vector< Int > & arrayId () const
const Vector< Int > & antenna1 () const
const Vector< Int > & antenna2 () const
const Vector< Int > & dataDescriptionIds () const
const Vector< Int > & spectralWindow () const
const Vector< Int > & scan () const
const Vector< Double > & time () const
const Vector< Int > & fieldId () const
const Vector< Double > & freqs () const
Int nChannels () const
Int nCorrelations () const
const Cube< Complex > & visCubeModel () const
const Cube< Complex > & visCubeCorrected () const
Vector< Bool > & flagRow ()
 These are not const, because we will generally amend them:.
Cube< Bool > & flagCube ()
Cube< Float > & weightSpectrum ()
Cube< Bool > & infocusFlagCube ()
 Access functions.
const Cube< Bool > & infocusFlagCube () const
Cube< Complex > & infocusVisCube ()
const Cube< Complex > & infocusVisCube () const
Cube< Float > & infocusWtSpec ()
const Cube< Float > & infocusWtSpec () const
Cube< Complex > & infocusModelVisCube ()
const Cube< Complex > & infocusModelVisCube () const
Cube< Complex > & residuals ()
 Workspace for the residual visibilities.
const Cube< Complex > & residuals () const
Cube< Bool > & residFlagCube ()
 Workspace for flags of the residuals.
const Cube< Bool > & residFlagCube () const
Array< Complex > & diffResiduals ()
 Workspace for the differentiated residuals.
const Array< Complex > & diffResiduals () const

Protected Member Functions

void initFromVB (const vi::VisBuffer2 &vb)
 Handle copy from the input VB2.

Private Attributes

vi::VisBuffer2vb_
 The underlying VisBuffer2.
Vector< Double > freqs_
 The frequencies Currently, assumed uniform over rows.
Vector< Bool > fR_
 Array reference objects for things in the vb we need to mess with.
Cube< Bool > fC_
Cube< Float > wS_
Int focusChan_p
 The current in-focus channel.
Cube< Bool > infocusFlagCube_p
 actual storage for the data
Cube< Float > infocusWtSpec_p
Cube< Complex > infocusVisCube_p
Cube< Complex > infocusModelVisCube_p
Cube< Complex > residuals_p
Cube< Bool > residFlagCube_p
Array< Complex > diffResiduals_p

Detailed Description

SolveDataBuffer is a container for VisBuffer2 data and related residual and differentiation results related to generic calibration solving.

Intended use:

Public interface

Prerequisite

Etymology

SolveDataBuffer is a Buffer for Solving Data

Synopsis

To Do

Definition at line 65 of file SolveDataBuffer.h.


Constructor & Destructor Documentation

casa::SolveDataBuffer::SolveDataBuffer (  ) 

Generic ctor.

casa::SolveDataBuffer::SolveDataBuffer ( const vi::VisBuffer2 vb  ) 

Create from a VisBuffer2.

casa::SolveDataBuffer::SolveDataBuffer ( const SolveDataBuffer sdb  ) 

Copy construct current iteration (or reattach).

casa::SolveDataBuffer::~SolveDataBuffer (  ) 

Destructor.


Member Function Documentation

const Vector<Int>& casa::SolveDataBuffer::antenna1 ( void   )  const [inline]

Definition at line 110 of file SolveDataBuffer.h.

References vb_.

const Vector<Int>& casa::SolveDataBuffer::antenna2 ( void   )  const [inline]

Definition at line 111 of file SolveDataBuffer.h.

References casa::vi::VisBuffer2::antenna2(), and vb_.

const Vector<Int>& casa::SolveDataBuffer::arrayId (  )  const [inline]

Definition at line 109 of file SolveDataBuffer.h.

References casa::vi::VisBuffer2::arrayId(), and vb_.

void casa::SolveDataBuffer::cleanUp (  ) 

Delete the workspaces.

const Vector<Int>& casa::SolveDataBuffer::dataDescriptionIds (  )  const [inline]

Definition at line 112 of file SolveDataBuffer.h.

References casa::vi::VisBuffer2::dataDescriptionIds(), and vb_.

const Array<Complex>& casa::SolveDataBuffer::diffResiduals (  )  const [inline]

Definition at line 154 of file SolveDataBuffer.h.

References diffResiduals().

Referenced by diffResiduals().

Array<Complex>& casa::SolveDataBuffer::diffResiduals (  )  [inline]

Workspace for the differentiated residuals.

Definition at line 153 of file SolveDataBuffer.h.

References diffResiduals_p.

void casa::SolveDataBuffer::enforceAPonData ( const String &  apmode  ) 

Apply amp-only or phase-only to data.

void casa::SolveDataBuffer::enforceSolveWeights ( const Bool  pHandOnly  ) 

Zero flagged weights, and optionally the cross-hand weights.

const Vector<Int>& casa::SolveDataBuffer::fieldId (  )  const [inline]

Definition at line 116 of file SolveDataBuffer.h.

References casa::vi::VisBuffer2::fieldId(), and vb_.

void casa::SolveDataBuffer::finalizeResiduals (  ) 
Cube<Bool>& casa::SolveDataBuffer::flagCube (  )  [inline]

Definition at line 124 of file SolveDataBuffer.h.

References fC_, casa::vi::VisBuffer2::flagCube(), and vb_.

Vector<Bool>& casa::SolveDataBuffer::flagRow (  )  [inline]

These are not const, because we will generally amend them:.

Definition at line 123 of file SolveDataBuffer.h.

References casa::vi::VisBuffer2::flagRow(), fR_, and vb_.

const Vector<Double>& casa::SolveDataBuffer::freqs (  )  const [inline]

Definition at line 117 of file SolveDataBuffer.h.

References freqs_.

const Cube<Bool>& casa::SolveDataBuffer::infocusFlagCube (  )  const [inline]

Definition at line 133 of file SolveDataBuffer.h.

References infocusFlagCube().

Referenced by infocusFlagCube().

Cube<Bool>& casa::SolveDataBuffer::infocusFlagCube (  )  [inline]

Access functions.

Access to focus-channel slices of the flags, data, and model

Definition at line 132 of file SolveDataBuffer.h.

References infocusFlagCube_p.

const Cube<Complex>& casa::SolveDataBuffer::infocusModelVisCube (  )  const [inline]

Definition at line 142 of file SolveDataBuffer.h.

References infocusModelVisCube().

Referenced by infocusModelVisCube().

Cube<Complex>& casa::SolveDataBuffer::infocusModelVisCube (  )  [inline]

Definition at line 141 of file SolveDataBuffer.h.

References infocusModelVisCube_p.

const Cube<Complex>& casa::SolveDataBuffer::infocusVisCube (  )  const [inline]

Definition at line 136 of file SolveDataBuffer.h.

References infocusVisCube().

Referenced by infocusVisCube().

Cube<Complex>& casa::SolveDataBuffer::infocusVisCube (  )  [inline]

Definition at line 135 of file SolveDataBuffer.h.

References infocusVisCube_p.

const Cube<Float>& casa::SolveDataBuffer::infocusWtSpec (  )  const [inline]

Definition at line 139 of file SolveDataBuffer.h.

References infocusWtSpec().

Referenced by infocusWtSpec().

Cube<Float>& casa::SolveDataBuffer::infocusWtSpec (  )  [inline]

Definition at line 138 of file SolveDataBuffer.h.

References infocusWtSpec_p.

void casa::SolveDataBuffer::initFromVB ( const vi::VisBuffer2 vb  )  [protected]

Handle copy from the input VB2.

void casa::SolveDataBuffer::initResidWithModel (  ) 
Int casa::SolveDataBuffer::nChannels (  )  const [inline]

Definition at line 118 of file SolveDataBuffer.h.

References casa::vi::VisBuffer2::nChannels(), and vb_.

Int casa::SolveDataBuffer::nCorrelations (  )  const [inline]

Definition at line 119 of file SolveDataBuffer.h.

References casa::vi::VisBuffer2::nCorrelations(), and vb_.

Int casa::SolveDataBuffer::nRows (  )  const [inline]

VB2-like data access methods (mostly const).

Definition at line 107 of file SolveDataBuffer.h.

References casa::vi::VisBuffer2::nRows(), and vb_.

const Vector<Int>& casa::SolveDataBuffer::observationId (  )  const [inline]

Definition at line 108 of file SolveDataBuffer.h.

References casa::vi::VisBuffer2::observationId(), and vb_.

Bool casa::SolveDataBuffer::Ok (  ) 

Does SDB contain finite weight?

SolveDataBuffer& casa::SolveDataBuffer::operator= ( const SolveDataBuffer sdb  ) 

Assignment.

const Cube<Bool>& casa::SolveDataBuffer::residFlagCube (  )  const [inline]

Definition at line 150 of file SolveDataBuffer.h.

References residFlagCube().

Referenced by residFlagCube().

Cube<Bool>& casa::SolveDataBuffer::residFlagCube (  )  [inline]

Workspace for flags of the residuals.

Definition at line 149 of file SolveDataBuffer.h.

References residFlagCube_p.

const Cube<Complex>& casa::SolveDataBuffer::residuals (  )  const [inline]

Definition at line 146 of file SolveDataBuffer.h.

References residuals().

Referenced by residuals().

Cube<Complex>& casa::SolveDataBuffer::residuals (  )  [inline]

Workspace for the residual visibilities.

Definition at line 145 of file SolveDataBuffer.h.

References residuals_p.

const Vector<Int>& casa::SolveDataBuffer::scan (  )  const [inline]

Definition at line 114 of file SolveDataBuffer.h.

References casa::vi::VisBuffer2::scan(), and vb_.

void casa::SolveDataBuffer::setFocusChan ( const Int  focusChan = -1  ) 

Set the focus channel (forms references to focus-channel flag/data/model).

void casa::SolveDataBuffer::sizeResiduals ( const Int &  nPar,
const Int &  nDiff 
)

Size/init/finalize the residuals workspaces.

const Vector<Int>& casa::SolveDataBuffer::spectralWindow (  )  const [inline]

Definition at line 113 of file SolveDataBuffer.h.

References casa::vi::VisBuffer2::spectralWindows(), and vb_.

const Vector<Double>& casa::SolveDataBuffer::time ( void   )  const [inline]

Definition at line 115 of file SolveDataBuffer.h.

References casa::vi::VisBuffer2::time(), and vb_.

const Cube<Complex>& casa::SolveDataBuffer::visCubeCorrected (  )  const [inline]

Definition at line 121 of file SolveDataBuffer.h.

References vb_, and casa::vi::VisBuffer2::visCubeCorrected().

const Cube<Complex>& casa::SolveDataBuffer::visCubeModel (  )  const [inline]

Definition at line 120 of file SolveDataBuffer.h.

References vb_, and casa::vi::VisBuffer2::visCubeModel().

Cube<Float>& casa::SolveDataBuffer::weightSpectrum (  )  [inline]

Definition at line 125 of file SolveDataBuffer.h.

References vb_, casa::vi::VisBuffer2::weightSpectrum(), and wS_.


Member Data Documentation

Array<Complex> casa::SolveDataBuffer::diffResiduals_p [private]

Definition at line 189 of file SolveDataBuffer.h.

Referenced by diffResiduals().

Cube<Bool> casa::SolveDataBuffer::fC_ [private]

Definition at line 175 of file SolveDataBuffer.h.

Referenced by flagCube().

The current in-focus channel.

Definition at line 179 of file SolveDataBuffer.h.

Vector<Bool> casa::SolveDataBuffer::fR_ [private]

Array reference objects for things in the vb we need to mess with.

Definition at line 174 of file SolveDataBuffer.h.

Referenced by flagRow().

Vector<Double> casa::SolveDataBuffer::freqs_ [private]

The frequencies Currently, assumed uniform over rows.

Definition at line 171 of file SolveDataBuffer.h.

Referenced by freqs().

actual storage for the data

Definition at line 182 of file SolveDataBuffer.h.

Referenced by infocusFlagCube().

Definition at line 185 of file SolveDataBuffer.h.

Referenced by infocusModelVisCube().

Cube<Complex> casa::SolveDataBuffer::infocusVisCube_p [private]

Definition at line 184 of file SolveDataBuffer.h.

Referenced by infocusVisCube().

Definition at line 183 of file SolveDataBuffer.h.

Referenced by infocusWtSpec().

Definition at line 188 of file SolveDataBuffer.h.

Referenced by residFlagCube().

Cube<Complex> casa::SolveDataBuffer::residuals_p [private]

Definition at line 187 of file SolveDataBuffer.h.

Referenced by residuals().

Cube<Float> casa::SolveDataBuffer::wS_ [private]

Definition at line 176 of file SolveDataBuffer.h.

Referenced by weightSpectrum().


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