dp3::parmdb::ParmValueSet Class Reference

A class holding information of multiple domains of a parameter. ParmValueSet holds the information of multiple domains of a parameter. It has a grid defining the domains held. More...

#include <ParmValue.h>

Public Member Functions
	ParmValueSet (const Grid &domainGrid, const std::vector< ParmValue::ShPtr > &values, const ParmValue &defaultValue=ParmValue(), ParmValue::FunkletType type=ParmValue::Scalar, double perturbation=1e-6, bool pertRel=true)
	ParmValueSet (const ParmValue &defaultValue=ParmValue(), ParmValue::FunkletType=ParmValue::Scalar, double perturbation=1e-6, bool pertRel=true, const Box &scaleDomain=Box())
	ParmValueSet (const ParmValueSet &)
	Copy constructor. More...
const ParmValue &	getFirstParmValue () const
ParmValue::FunkletType	getType () const
	Get the funklet type. More...
ParmValueSet &	operator= (const ParmValueSet &)
	Assignment. More...
void	setSolveGrid (const Grid &solveGrid)
const casacore::Array< bool > &	getSolvableMask () const
void	setSolvableMask (const casacore::Array< bool > &mask)
double	getPerturbation () const
	Get the perturbation value. More...
bool	getPertRel () const
	Is the perturbation relative or absolute? More...
const Grid &	getGrid () const
	Get access to the grid info, so a domain can be looked up. More...
unsigned int	size () const
	Get the nr of ParmValues. More...
bool	empty () const
	No ParmValues? More...
const ParmValue &	getDefParmValue () const
	Get the default ParmValue. More...
const Box &	getScaleDomain () const
void	setScaleDomain (const Box &domain)
const ParmValue &	getParmValue (int i) const
ParmValue &	getParmValue (int i)
bool	isDirty () const
void	setDirty (bool dirty=true)

Detailed Description

A class holding information of multiple domains of a parameter. ParmValueSet holds the information of multiple domains of a parameter. It has a grid defining the domains held.

Constructor & Destructor Documentation

ParmValueSet() [1/3]

dp3::parmdb::ParmValueSet::ParmValueSet ( const ParmValue &  defaultValue = ParmValue(), ParmValue::FunkletType  = ParmValue::Scalar, double  perturbation = 1e-6, bool  pertRel = true, const Box &  scaleDomain = Box()  )

explicit

Create a parameterset with the given default parm value (which is by default a scalar). If the funklet type is a scalar, the value in the default must contain one value only. It is possible to specify the domain on which a funklet is scaled.

ParmValueSet() [2/3]

dp3::parmdb::ParmValueSet::ParmValueSet	(	const Grid &	domainGrid,
		const std::vector< ParmValue::ShPtr > &	values,
		const ParmValue &	defaultValue = ParmValue(),
		ParmValue::FunkletType	type = ParmValue::Scalar,
		double	perturbation = 1e-6,
		bool	pertRel = true
	)

Create the parameterset for the given domain grid and ParmValue objects. If the funklet type is a scalar, the values in the ParmValues must contain one value only.

ParmValueSet() [3/3]

dp3::parmdb::ParmValueSet::ParmValueSet

(

const ParmValueSet &

)

Copy constructor.

Member Function Documentation

empty()

bool dp3::parmdb::ParmValueSet::empty ( ) const

inline

No ParmValues?

getDefParmValue()

const ParmValue& dp3::parmdb::ParmValueSet::getDefParmValue ( ) const

inline

Get the default ParmValue.

getFirstParmValue()

const ParmValue& dp3::parmdb::ParmValueSet::getFirstParmValue

(

)

const

Get the first ParmValue. If there are no ParmValues, the default ParmValue is returned.

getGrid()

const Grid& dp3::parmdb::ParmValueSet::getGrid ( ) const

inline

Get access to the grid info, so a domain can be looked up.

getParmValue() [1/2]

ParmValue& dp3::parmdb::ParmValueSet::getParmValue ( int  i )

inline

getParmValue() [2/2]

const ParmValue& dp3::parmdb::ParmValueSet::getParmValue ( int  i ) const

inline

Get the i-th ParmValue.

getPertRel()

bool dp3::parmdb::ParmValueSet::getPertRel ( ) const

inline

Is the perturbation relative or absolute?

getPerturbation()

double dp3::parmdb::ParmValueSet::getPerturbation ( ) const

inline

Get the perturbation value.

getScaleDomain()

const Box& dp3::parmdb::ParmValueSet::getScaleDomain ( ) const

inline

Get access to the scale domain.

getSolvableMask()

const casacore::Array<bool>& dp3::parmdb::ParmValueSet::getSolvableMask ( ) const

inline

Get/set the mask telling which coefficients are solvable. The array can be empty meaning that all coefficients are solvable.

getType()

ParmValue::FunkletType dp3::parmdb::ParmValueSet::getType ( ) const

inline

Get the funklet type.

isDirty()

bool dp3::parmdb::ParmValueSet::isDirty ( ) const

inline

Get/set the dirty flag. The dirty flag has to be set when a new value is given to a ParmValue. It indicates that the value has to be written later on. When written, the flag will be cleared.

operator=()

ParmValueSet& dp3::parmdb::ParmValueSet::operator=

(

const ParmValueSet &

)

Assignment.

setDirty()

void dp3::parmdb::ParmValueSet::setDirty ( bool  dirty = true )

inline

setScaleDomain()

void dp3::parmdb::ParmValueSet::setScaleDomain ( const Box &  domain )

inline

setSolvableMask()

void dp3::parmdb::ParmValueSet::setSolvableMask ( const casacore::Array< bool > &  mask )

inline

setSolveGrid()

void dp3::parmdb::ParmValueSet::setSolveGrid

(

const Grid &

solveGrid

)

Create the parameterset for the given grid from the given ParmValueSet which should have only one ParmValue. This is meant for solvable parameters using a default value.

size()

unsigned int dp3::parmdb::ParmValueSet::size ( ) const

inline

Get the nr of ParmValues.

---

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

• ParmValue.h