asdmbinaries::SDMDataObject::SpectralWindow Class Reference

SDMDataObject::SpectralWindow:: declarations. More...

#include <SDMDataObject.h>

List of all members.

Public Member Functions

 SpectralWindow ()
 An empty constructor.
virtual ~SpectralWindow ()
 The destructor.
 SpectralWindow (const vector< StokesParameter > &crossPolProducts, float scaleFactor, unsigned int numSpectralPoint, unsigned int numBin, NetSideband sideband)
 A constructor of SpectralWindow to use when there are only interferometric data (correlationMode == CROSS_ONLY).
 SpectralWindow (const vector< StokesParameter > &sdPolProducts, unsigned int numSpectralPoint, unsigned numBin, NetSideband sideband)
 A constructor of SpectralWindow to use when there are only single dish data (correlationMode == AUTO_ONLY).
 SpectralWindow (const vector< StokesParameter > &crossPolProducts, const vector< StokesParameter > &sdPolProduct, float scaleFactor, unsigned int numSpectralPoint, unsigned int numBin, NetSideband sideband)
 A constructor of SpectralWindow to use when there are both single dish and interferometric data (correlationMode == CROSS_AND_AUTO).
const vector< StokesParameter > & crossPolProducts () const
 Returns the vector of polarization products (for the interferometric data).
const vector< StokesParameter > & sdPolProducts () const
 void crossPolProducts(const vector<StokesParameter>& value);
float scaleFactor () const
 void sdPolProducts(const vector<StokesParameter>& value);
unsigned int numSpectralPoint () const
 void scaleFactor(float value);
unsigned int numBin () const
 void numSpectralPoint(unsigned int value);
NetSidebandMod::NetSideband sideband () const
 void numBin(unsigned int value);

Private Member Functions

void strSw (const string &s)
const string & strSw () const
void strImage (const string &s)
const string & strImage () const
void owner (const SDMDataObject *o)

Private Attributes

vector< StokesParameter > crossPolProducts_
vector< StokesParameter > sdPolProducts_
float scaleFactor_
unsigned int numSpectralPoint_
unsigned int numBin_
NetSideband sideband_
string strSw_
string strImage_
const SDMDataObjectowner_

Friends

class SDMDataObject
class DataStruct
class Baseband
class HeaderParser

Detailed Description

SDMDataObject::SpectralWindow:: declarations.

A class to describe a spectral window in use during an observation. An instance of this class collects the following informations :

Definition at line 370 of file SDMDataObject.h.


Constructor & Destructor Documentation

asdmbinaries::SDMDataObject::SpectralWindow::SpectralWindow (  ) 

An empty constructor.

Note:
This constructor should never be used.
virtual asdmbinaries::SDMDataObject::SpectralWindow::~SpectralWindow (  )  [virtual]

The destructor.

asdmbinaries::SDMDataObject::SpectralWindow::SpectralWindow ( const vector< StokesParameter > &  crossPolProducts,
float  scaleFactor,
unsigned int  numSpectralPoint,
unsigned int  numBin,
NetSideband  sideband 
)

A constructor of SpectralWindow to use when there are only interferometric data (correlationMode == CROSS_ONLY).

asdmbinaries::SDMDataObject::SpectralWindow::SpectralWindow ( const vector< StokesParameter > &  sdPolProducts,
unsigned int  numSpectralPoint,
unsigned  numBin,
NetSideband  sideband 
)

A constructor of SpectralWindow to use when there are only single dish data (correlationMode == AUTO_ONLY).

asdmbinaries::SDMDataObject::SpectralWindow::SpectralWindow ( const vector< StokesParameter > &  crossPolProducts,
const vector< StokesParameter > &  sdPolProduct,
float  scaleFactor,
unsigned int  numSpectralPoint,
unsigned int  numBin,
NetSideband  sideband 
)

A constructor of SpectralWindow to use when there are both single dish and interferometric data (correlationMode == CROSS_AND_AUTO).


Member Function Documentation

const vector<StokesParameter>& asdmbinaries::SDMDataObject::SpectralWindow::crossPolProducts (  )  const

Returns the vector of polarization products (for the interferometric data).

Returns:
a reference to a vector of StokesParameter.
Exceptions:
SDMDataObjectException when correlationMode() == AUTO_ONLY.
unsigned int asdmbinaries::SDMDataObject::SpectralWindow::numBin (  )  const

void numSpectralPoint(unsigned int value);

Returns the number of bins. For ALMA this is the number of steps in a switch-cycle and a value of 1 means no switching cycle.

Returns:
an unsigned int.
unsigned int asdmbinaries::SDMDataObject::SpectralWindow::numSpectralPoint (  )  const

void scaleFactor(float value);

Returns the number of spectral points.

Returns:
an unsigned int.
void asdmbinaries::SDMDataObject::SpectralWindow::owner ( const SDMDataObject o  )  [private]
float asdmbinaries::SDMDataObject::SpectralWindow::scaleFactor (  )  const

void sdPolProducts(const vector<StokesParameter>& value);

Returns the scale factor.

Returns:
a float.
Exceptions:
SDMDataObjectException when correlationMode() == AUTO_ONLY.
const vector<StokesParameter>& asdmbinaries::SDMDataObject::SpectralWindow::sdPolProducts (  )  const

void crossPolProducts(const vector<StokesParameter>& value);

Returns the vector of polarization products (for the single dish data).

Returns:
a reference to a vector of StokesParameter.
Exceptions:
SDMDataObjectException when correlationMode() == CROSS_ONLY.
NetSidebandMod::NetSideband asdmbinaries::SDMDataObject::SpectralWindow::sideband (  )  const

void numBin(unsigned int value);

Returns the netsideband.

Returns:
a NetSidebandMod::NetSideband
const string& asdmbinaries::SDMDataObject::SpectralWindow::strImage (  )  const [private]
void asdmbinaries::SDMDataObject::SpectralWindow::strImage ( const string &  s  )  [private]
const string& asdmbinaries::SDMDataObject::SpectralWindow::strSw (  )  const [private]
void asdmbinaries::SDMDataObject::SpectralWindow::strSw ( const string &  s  )  [private]

Friends And Related Function Documentation

friend class Baseband [friend]

Definition at line 373 of file SDMDataObject.h.

friend class DataStruct [friend]

Definition at line 372 of file SDMDataObject.h.

friend class HeaderParser [friend]

Definition at line 374 of file SDMDataObject.h.

friend class SDMDataObject [friend]

Definition at line 371 of file SDMDataObject.h.


Member Data Documentation

Definition at line 377 of file SDMDataObject.h.

Definition at line 381 of file SDMDataObject.h.

Definition at line 380 of file SDMDataObject.h.

Definition at line 390 of file SDMDataObject.h.

Definition at line 379 of file SDMDataObject.h.

Definition at line 378 of file SDMDataObject.h.

Definition at line 382 of file SDMDataObject.h.

Definition at line 384 of file SDMDataObject.h.

Definition at line 383 of file SDMDataObject.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