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);
	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)
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 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 356 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).

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.

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::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.

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]

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.

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.

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

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 string &

s

)

[private]

void asdmbinaries::SDMDataObject::SpectralWindow::strImage

(

const string &

s

)

[private]

const string& asdmbinaries::SDMDataObject::SpectralWindow::strImage

(

)

const [private]

const string& asdmbinaries::SDMDataObject::SpectralWindow::strImage

(

)

const [private]

void asdmbinaries::SDMDataObject::SpectralWindow::strSw

(

const string &

s

)

[private]

void asdmbinaries::SDMDataObject::SpectralWindow::strSw

(

const string &

s

)

[private]

const string& asdmbinaries::SDMDataObject::SpectralWindow::strSw

(

)

const [private]

const string& asdmbinaries::SDMDataObject::SpectralWindow::strSw

(

)

const [private]

---

Friends And Related Function Documentation

Baseband [friend]

Definition at line 359 of file SDMDataObject.h.

DataStruct [friend]

Definition at line 358 of file SDMDataObject.h.

HeaderParser [friend]

Definition at line 360 of file SDMDataObject.h.

SDMDataObject [friend]

Definition at line 357 of file SDMDataObject.h.

---

Member Data Documentation

vector< StokesParameter > asdmbinaries::SDMDataObject::SpectralWindow::crossPolProducts_ [private]

Definition at line 363 of file SDMDataObject.h.

unsigned int asdmbinaries::SDMDataObject::SpectralWindow::numBin_ [private]

Definition at line 367 of file SDMDataObject.h.

unsigned int asdmbinaries::SDMDataObject::SpectralWindow::numSpectralPoint_ [private]

Definition at line 366 of file SDMDataObject.h.

const SDMDataObject * asdmbinaries::SDMDataObject::SpectralWindow::owner_ [private]

Definition at line 376 of file SDMDataObject.h.

float asdmbinaries::SDMDataObject::SpectralWindow::scaleFactor_ [private]

Definition at line 365 of file SDMDataObject.h.

vector< StokesParameter > asdmbinaries::SDMDataObject::SpectralWindow::sdPolProducts_ [private]

Definition at line 364 of file SDMDataObject.h.

NetSideband asdmbinaries::SDMDataObject::SpectralWindow::sideband_ [private]

Definition at line 368 of file SDMDataObject.h.

string asdmbinaries::SDMDataObject::SpectralWindow::strImage_ [private]

Definition at line 370 of file SDMDataObject.h.

string asdmbinaries::SDMDataObject::SpectralWindow::strSw_ [private]

Definition at line 369 of file SDMDataObject.h.

---

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

• code/alma/ASDMBinaries/SDMDataObject.h
• code/alma_v3/ASDMBinaries/SDMDataObject.h