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

#include <SDMDataObject.h>

Public Member Functions
	SpectralWindow ()
	An empty constructor. More...

virtual	~SpectralWindow ()
	The destructor. More...

	SpectralWindow (const std::vector< StokesParameterMod::StokesParameter > &crossPolProducts, float scaleFactor, unsigned int numSpectralPoint, unsigned int numBin, NetSidebandMod::NetSideband sideband)
	A constructor of SpectralWindow to use when there are only interferometric data (correlationMode == CROSS_ONLY). More...

	SpectralWindow (const std::vector< StokesParameterMod::StokesParameter > &sdPolProducts, unsigned int numSpectralPoint, unsigned numBin, NetSidebandMod::NetSideband sideband)
	A constructor of SpectralWindow to use when there are only single dish data (correlationMode == AUTO_ONLY). More...

	SpectralWindow (const std::vector< StokesParameterMod::StokesParameter > &crossPolProducts, const std::vector< StokesParameterMod::StokesParameter > &sdPolProduct, float scaleFactor, unsigned int numSpectralPoint, unsigned int numBin, NetSidebandMod::NetSideband sideband)
	A constructor of SpectralWindow to use when there are both single dish and interferometric data (correlationMode == CROSS_AND_AUTO). More...

const std::vector < StokesParameterMod::StokesParameter > &	crossPolProducts () const
	Returns the vector of polarization products (for the interferometric data). More...

const std::vector < StokesParameterMod::StokesParameter > &	sdPolProducts () const
	void crossPolProducts(const vector<StokesParameter>& value); More...

float	scaleFactor () const
	void sdPolProducts(const vector<StokesParameter>& value); More...

unsigned int	numSpectralPoint () const
	void scaleFactor(float value); More...

unsigned int	numBin () const
	void numSpectralPoint(unsigned int value); More...

NetSidebandMod::NetSideband	sideband () const
	void numBin(unsigned int value); More...

Private Member Functions
void	strSw (const std::string &s)

const std::string &	strSw () const

void	strImage (const std::string &s)

const std::string &	strImage () const

void	owner (const SDMDataObject *o)

Private Attributes
std::vector < StokesParameterMod::StokesParameter >	crossPolProducts_

std::vector < StokesParameterMod::StokesParameter >	sdPolProducts_

float	scaleFactor_

unsigned int	numSpectralPoint_

unsigned int	numBin_

NetSidebandMod::NetSideband	sideband_

std::string	strSw_

std::string	strImage_

const SDMDataObject *	owner_

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 :

The description of polarization products for the interferometric data , if any (crossPolProducts()).
The description of polarization products for the single dish data , if any (sdPolProducts()).
The scale factor used in the representation of spectral visibilities, if any (scaleFactor()).
The number of spectral points (numSpectralPoint()).
The number of bins (numBin()).

Definition at line 347 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 std::vector< StokesParameterMod::StokesParameter > &	crossPolProducts,
		float	scaleFactor,
		unsigned int	numSpectralPoint,
		unsigned int	numBin,
		NetSidebandMod::NetSideband	sideband
	)

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

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

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

asdmbinaries::SDMDataObject::SpectralWindow::SpectralWindow	(	const std::vector< StokesParameterMod::StokesParameter > &	crossPolProducts,
		const std::vector< StokesParameterMod::StokesParameter > &	sdPolProduct,
		float	scaleFactor,
		unsigned int	numSpectralPoint,
		unsigned int	numBin,
		NetSidebandMod::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 std::vector<StokesParameterMod::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 std::vector<StokesParameterMod::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

void asdmbinaries::SDMDataObject::SpectralWindow::strImage ( const std::string & s )

private

const std::string& asdmbinaries::SDMDataObject::SpectralWindow::strImage ( ) const

private

void asdmbinaries::SDMDataObject::SpectralWindow::strSw ( const std::string & s )

private

const std::string& asdmbinaries::SDMDataObject::SpectralWindow::strSw ( ) const

private

Friends And Related Function Documentation

friend class Baseband

friend

Definition at line 350 of file SDMDataObject.h.

friend class DataStruct

friend

Definition at line 349 of file SDMDataObject.h.

friend class HeaderParser

friend

Definition at line 351 of file SDMDataObject.h.

friend class SDMDataObject

friend

Definition at line 348 of file SDMDataObject.h.

Member Data Documentation

std::vector<StokesParameterMod::StokesParameter> asdmbinaries::SDMDataObject::SpectralWindow::crossPolProducts_

private

Definition at line 354 of file SDMDataObject.h.

unsigned int asdmbinaries::SDMDataObject::SpectralWindow::numBin_

private

Definition at line 358 of file SDMDataObject.h.

unsigned int asdmbinaries::SDMDataObject::SpectralWindow::numSpectralPoint_

private

Definition at line 357 of file SDMDataObject.h.

const SDMDataObject* asdmbinaries::SDMDataObject::SpectralWindow::owner_

private

Definition at line 367 of file SDMDataObject.h.

float asdmbinaries::SDMDataObject::SpectralWindow::scaleFactor_

private

Definition at line 356 of file SDMDataObject.h.

std::vector<StokesParameterMod::StokesParameter> asdmbinaries::SDMDataObject::SpectralWindow::sdPolProducts_

private

Definition at line 355 of file SDMDataObject.h.

NetSidebandMod::NetSideband asdmbinaries::SDMDataObject::SpectralWindow::sideband_

private

Definition at line 359 of file SDMDataObject.h.

std::string asdmbinaries::SDMDataObject::SpectralWindow::strImage_

private

Definition at line 361 of file SDMDataObject.h.

std::string asdmbinaries::SDMDataObject::SpectralWindow::strSw_

private

Definition at line 360 of file SDMDataObject.h.

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

casa/code/alma/ASDMBinaries/SDMDataObject.h

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation