dp3::common::VdsPartDesc Class Reference

Description of a visibility data set or part thereof. More...

#include <VdsPartDesc.h>

Public Member Functions
	VdsPartDesc ()
	Construct an empty object. More...
	VdsPartDesc (const ParameterSet &)
	Construct from the given parameterset. More...
void	addParm (const std::string &key, const std::string &value)
void	changeBaseName (const std::string &newBaseName)
	Change the base part of the name. More...
void	clearParms ()
	Clear the extra parameters. More...
const ParameterSet &	getParms () const
	Get access to the extra parameters. More...
void	setClusterDescName (const std::string &cdName)
	Set the name of the ClusterDesc file used. More...
void	setFileName (const std::string &name)
	Set the original file name. More...
void	setName (const std::string &name, const std::string &fileSys)
	Set VDS name and file system. More...
void	setTimes (double startTime, double endTime, double stepTime, const std::vector< double > &starts=std::vector< double >(), const std::vector< double > &ends=std::vector< double >())
void	write (std::ostream &os, const std::string &prefix) const
	Write the VdsPartDesc object in parset format. More...
void	addBand (int nchan, double startFreq, double endFreq)
void	addBand (int nchan, const std::vector< double > &startFreq, const std::vector< double > &endFreq)
const std::string &	getName () const
const std::string &	getFileName () const
const std::string &	getFileSys () const
const std::string &	getClusterDescName () const
double	getStartTime () const
double	getEndTime () const
double	getStepTime () const
const std::vector< double > &	getStartTimes () const
const std::vector< double > &	getEndTimes () const
int	getNBand () const
const std::vector< int > &	getNChan () const
const std::vector< double > &	getStartFreqs () const
const std::vector< double > &	getEndFreqs () const
blob::BlobOStream &	toBlob (blob::BlobOStream &) const
blob::BlobIStream &	fromBlob (blob::BlobIStream &)

Detailed Description

Description of a visibility data set or part thereof.

This class holds the description of a visibility data set (VDS) part. It defines the name of the part and on which file system it is located. Using the ClusterDesc object it can be derived on which node this VDS part can be processed best. This is done by the WorkersDesc class. The description of the VDS also contains info about the time, frequency, and baseline domain of the visibility data. The information is made persistent in a LOFAR .parset file.

Constructor & Destructor Documentation

VdsPartDesc() [1/2]

dp3::common::VdsPartDesc::VdsPartDesc ( )

inline

Construct an empty object.

VdsPartDesc() [2/2]

dp3::common::VdsPartDesc::VdsPartDesc ( const ParameterSet &  )

explicit

Construct from the given parameterset.

Member Function Documentation

addBand() [1/2]

void dp3::common::VdsPartDesc::addBand	(	int	nchan,
		const std::vector< double > &	startFreq,
		const std::vector< double > &	endFreq
	)

addBand() [2/2]

void dp3::common::VdsPartDesc::addBand	(	int	nchan,
		double	startFreq,
		double	endFreq
	)

Add a band.

addParm()

void dp3::common::VdsPartDesc::addParm ( const std::string &  key, const std::string &  value  )

inline

Add an extra parameter. It is added to the subset 'Extra.'. If the parameter already exists, it is replaced.

changeBaseName()

void dp3::common::VdsPartDesc::changeBaseName

(

const std::string &

newBaseName

)

Change the base part of the name.

clearParms()

void dp3::common::VdsPartDesc::clearParms ( )

inline

Clear the extra parameters.

fromBlob()

blob::BlobIStream& dp3::common::VdsPartDesc::fromBlob

(

blob::BlobIStream &

)

getClusterDescName()

const std::string& dp3::common::VdsPartDesc::getClusterDescName ( ) const

inline

getEndFreqs()

const std::vector<double>& dp3::common::VdsPartDesc::getEndFreqs ( ) const

inline

getEndTime()

double dp3::common::VdsPartDesc::getEndTime ( ) const

inline

getEndTimes()

const std::vector<double>& dp3::common::VdsPartDesc::getEndTimes ( ) const

inline

getFileName()

const std::string& dp3::common::VdsPartDesc::getFileName ( ) const

inline

getFileSys()

const std::string& dp3::common::VdsPartDesc::getFileSys ( ) const

inline

getName()

const std::string& dp3::common::VdsPartDesc::getName ( ) const

inline

Get the values.

getNBand()

int dp3::common::VdsPartDesc::getNBand ( ) const

inline

getNChan()

const std::vector<int>& dp3::common::VdsPartDesc::getNChan ( ) const

inline

getParms()

const ParameterSet& dp3::common::VdsPartDesc::getParms ( ) const

inline

Get access to the extra parameters.

getStartFreqs()

const std::vector<double>& dp3::common::VdsPartDesc::getStartFreqs ( ) const

inline

getStartTime()

double dp3::common::VdsPartDesc::getStartTime ( ) const

inline

getStartTimes()

const std::vector<double>& dp3::common::VdsPartDesc::getStartTimes ( ) const

inline

getStepTime()

double dp3::common::VdsPartDesc::getStepTime ( ) const

inline

setClusterDescName()

void dp3::common::VdsPartDesc::setClusterDescName ( const std::string &  cdName )

inline

Set the name of the ClusterDesc file used.

setFileName()

void dp3::common::VdsPartDesc::setFileName ( const std::string &  name )

inline

Set the original file name.

setName()

void dp3::common::VdsPartDesc::setName	(	const std::string &	name,
		const std::string &	fileSys
	)

Set VDS name and file system.

setTimes()

void dp3::common::VdsPartDesc::setTimes	(	double	startTime,
		double	endTime,
		double	stepTime,
		const std::vector< double > &	starts = std::vector< double >(),
		const std::vector< double > &	ends = std::vector< double >()
	)

Set the observation start and end time. Optionally the start and end per time interval can be set.

toBlob()

blob::BlobOStream& dp3::common::VdsPartDesc::toBlob

(

blob::BlobOStream &

)

const

Put/get the object to/from a blob.

write()

void dp3::common::VdsPartDesc::write	(	std::ostream &	os,
		const std::string &	prefix
	)		const

Write the VdsPartDesc object in parset format.

---

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

• VdsPartDesc.h