Mantid::Kernel::TimeSeriesPropertyStatistics Struct Reference

Struct holding some useful statistics for a TimeSeriesProperty. More...

#include <TimeSeriesProperty.h>

Public Member Functions
void	setAllToNan ()
	TimeSeriesPropertyStatistics ()=default
	TimeSeriesPropertyStatistics (const Statistics &stats)
	Initialize only the statistics that are time-weighted independent.
	TimeSeriesPropertyStatistics (double value)
	Statistics of a value that is constant throughout time.

Public Attributes
double	duration
	Duration in seconds.
double	maximum
	Maximum value.
double	mean
	Mean value.
double	median
	Median value.
double	minimum
	Minimum value.
double	standard_deviation
	standard_deviation of the values
double	time_mean
	time weighted average
double	time_standard_deviation
	time weighted standard deviation

Detailed Description

Struct holding some useful statistics for a TimeSeriesProperty.

Definition at line 32 of file TimeSeriesProperty.h.

Constructor & Destructor Documentation

TimeSeriesPropertyStatistics() [1/3]

Mantid::Kernel::TimeSeriesPropertyStatistics::TimeSeriesPropertyStatistics ( )

default

TimeSeriesPropertyStatistics() [2/3]

Mantid::Kernel::TimeSeriesPropertyStatistics::TimeSeriesPropertyStatistics ( const Statistics &  stats )

inline

Initialize only the statistics that are time-weighted independent.

Quantities are minimum, maximum, median, mean, and standard-deviation.

Parameters

stats

:: a reference to a Statistics object.

Definition at line 57 of file TimeSeriesProperty.h.

References Mantid::Kernel::Statistics::maximum, Mantid::Kernel::Statistics::mean, Mantid::Kernel::Statistics::median, Mantid::Kernel::Statistics::minimum, and Mantid::Kernel::Statistics::standard_deviation.

TimeSeriesPropertyStatistics() [3/3]

Mantid::Kernel::TimeSeriesPropertyStatistics::TimeSeriesPropertyStatistics ( double  value )

inline

Statistics of a value that is constant throughout time.

"duration" is assigned the value of NaN.

Parameters

value

:: the value constant in time.

Definition at line 74 of file TimeSeriesProperty.h.

References value.

Member Function Documentation

setAllToNan()

void Mantid::Kernel::TimeSeriesPropertyStatistics::setAllToNan ( )

inline

Definition at line 85 of file TimeSeriesProperty.h.

Referenced by Mantid::API::LogManager::getStatistics(), and Mantid::Kernel::TimeSeriesProperty< TYPE >::getStatistics().

Member Data Documentation

duration

double Mantid::Kernel::TimeSeriesPropertyStatistics::duration

Duration in seconds.

Definition at line 48 of file TimeSeriesProperty.h.

Referenced by export_TimeSeriesPropertyStatistics(), and Mantid::Kernel::TimeSeriesProperty< TYPE >::getStatistics().

maximum

double Mantid::Kernel::TimeSeriesPropertyStatistics::maximum

Maximum value.

Definition at line 36 of file TimeSeriesProperty.h.

Referenced by export_TimeSeriesPropertyStatistics(), and Mantid::API::Run::getBadPulseRange().

mean

double Mantid::Kernel::TimeSeriesPropertyStatistics::mean

Mean value.

Definition at line 38 of file TimeSeriesProperty.h.

Referenced by Mantid::WorkflowAlgorithms::DgsConvertToEnergyTransfer::exec(), export_TimeSeriesPropertyStatistics(), Mantid::API::Run::getBadPulseRange(), Mantid::DataHandling::SaveGSS::getLogValue(), Mantid::WorkflowAlgorithms::EQSANSLoad::getSourceSlitSize(), Mantid::Kernel::TimeSeriesProperty< TYPE >::getStatistics(), and Mantid::MDAlgorithms::ApplyDetailedBalanceMD::getTemperature().

median

double Mantid::Kernel::TimeSeriesPropertyStatistics::median

Median value.

Definition at line 40 of file TimeSeriesProperty.h.

Referenced by export_TimeSeriesPropertyStatistics().

minimum

double Mantid::Kernel::TimeSeriesPropertyStatistics::minimum

Minimum value.

Definition at line 34 of file TimeSeriesProperty.h.

Referenced by export_TimeSeriesPropertyStatistics().

standard_deviation

double Mantid::Kernel::TimeSeriesPropertyStatistics::standard_deviation

standard_deviation of the values

Definition at line 42 of file TimeSeriesProperty.h.

Referenced by export_TimeSeriesPropertyStatistics(), and Mantid::Kernel::TimeSeriesProperty< TYPE >::getStatistics().

time_mean

double Mantid::Kernel::TimeSeriesPropertyStatistics::time_mean

time weighted average

Definition at line 44 of file TimeSeriesProperty.h.

Referenced by export_TimeSeriesPropertyStatistics(), Mantid::Kernel::TimeSeriesProperty< TYPE >::getStatistics(), and Mantid::API::LogManager::getTimeAveragedValue().

time_standard_deviation

double Mantid::Kernel::TimeSeriesPropertyStatistics::time_standard_deviation

time weighted standard deviation

Definition at line 46 of file TimeSeriesProperty.h.

Referenced by export_TimeSeriesPropertyStatistics(), Mantid::Kernel::TimeSeriesProperty< TYPE >::getStatistics(), and Mantid::API::LogManager::getTimeAveragedStd().

---

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

• Framework/Kernel/inc/MantidKernel/TimeSeriesProperty.h