MLWEMPrimitiveValueListWrapper Class Reference

#include <mlWEMPrimitiveValueListWrapper.h>

Inherits QObject.

Public Slots
void	clampMaxValue (double maxValue)
void	clampMinValue (double minValue)
void	computeAndSetMinMaxFixedValues ()
QString	getDescription () const
double	getMaxValue () const
double	getMeanValue () const
double	getMinValue () const
int	getNumValues () const
double	getRootMeanSquareDeviationValue () const
double	getStandardDeviationValue () const
QString	getUnits () const
double	getValue (int index) const
QList< double >	getValues () const
void	initializeValues (int number, double value)
bool	isValid () const
void	multiplyValues (double modifier)
void	setFromNumPyArray (PyObject *array)
void	setMinMaxValue (double minValue, double maxValue)
void	setUnits (const QString &units)
void	setValue (int index, double value)
void	setValues (const QList< double > &values)
QVariant	toNumPyArray ()
void	updateStatistics ()

Detailed Description

A class that wraps WEMPrimitiveValueList objects for use in scripting.

Member Function Documentation

clampMaxValue

void MLWEMPrimitiveValueListWrapper::clampMaxValue ( double maxValue )

slot

Clamps the max value to the given max value.

This does not update the statistics automatically!

clampMinValue

void MLWEMPrimitiveValueListWrapper::clampMinValue ( double minValue )

slot

Clamps the min value to the given min value.

This does not update the statistics automatically!

computeAndSetMinMaxFixedValues

void MLWEMPrimitiveValueListWrapper::computeAndSetMinMaxFixedValues ( )

slot

Computes and sets the min and max values, and switches to fixed values.

getDescription

QString MLWEMPrimitiveValueListWrapper::getDescription ( ) const

slot

Returns the description of this PVL.

getMaxValue

double MLWEMPrimitiveValueListWrapper::getMaxValue ( ) const

slot

Returns the maximum value.

getMeanValue

double MLWEMPrimitiveValueListWrapper::getMeanValue ( ) const

slot

Returns the mean value. Make sure to have called updateStatistics() before!

getMinValue

double MLWEMPrimitiveValueListWrapper::getMinValue ( ) const

slot

Returns the minimum value.

getNumValues

int MLWEMPrimitiveValueListWrapper::getNumValues ( ) const

slot

Returns the number of values.

getRootMeanSquareDeviationValue

double MLWEMPrimitiveValueListWrapper::getRootMeanSquareDeviationValue ( ) const

slot

Returns the root mean square deviation value. Make sure to have called updateStatistics() before!

getStandardDeviationValue

double MLWEMPrimitiveValueListWrapper::getStandardDeviationValue ( ) const

slot

Returns the standard deviation value. Make sure to have called updateStatistics() before!

getUnits

QString MLWEMPrimitiveValueListWrapper::getUnits ( ) const

slot

Returns the units string.

getValue

double MLWEMPrimitiveValueListWrapper::getValue ( int index ) const

slot

Returns the value at the given index.

getValues

QList< double > MLWEMPrimitiveValueListWrapper::getValues ( ) const

slot

Returns the array of doubles stored in the PrimitiveValueList.

initializeValues

void MLWEMPrimitiveValueListWrapper::initializeValues ( int number, double value )

slot

Initializes the first number of values with the given value.

This does not update the statistics automatically.

isValid

bool MLWEMPrimitiveValueListWrapper::isValid ( ) const

slot

Returns whether the values are valid.

The description needs to be non-empty, the list needs to contain values, and the minimum and maximum values needs to be set.

multiplyValues

void MLWEMPrimitiveValueListWrapper::multiplyValues ( double modifier )

slot

Multiplies values with the given modifier.

Adjusts min and max values, but does not update the statistics!

setFromNumPyArray

void MLWEMPrimitiveValueListWrapper::setFromNumPyArray ( PyObject * array )

slot

Sets the values from a numpy array.

setMinMaxValue

void MLWEMPrimitiveValueListWrapper::setMinMaxValue ( double minValue, double maxValue )

slot

Sets the min and max values, switches to fixed values.

setUnits

void MLWEMPrimitiveValueListWrapper::setUnits ( const QString & units )

slot

Sets the units string.

setValue

void MLWEMPrimitiveValueListWrapper::setValue ( int index, double value )

slot

Sets the given value at the given index.

If index exceeds the size of the vector, the value is appended. This does not update the statistics automatically.

setValues

void MLWEMPrimitiveValueListWrapper::setValues ( const QList< double > & values )

slot

Sets the array of doubles stored in the PrimitiveValueList. Length must match current length of the list.

toNumPyArray

QVariant MLWEMPrimitiveValueListWrapper::toNumPyArray ( )

slot

Returns the values as NumPy array (a copy is returned, not a view to the data).

updateStatistics

void MLWEMPrimitiveValueListWrapper::updateStatistics ( )

slot

Update statistics: mean, standard deviation, and root mean square.