Skip to content

Struct TempLat::RadialProjectionSingleDatum

template <typename T>

ClassList > TempLat > RadialProjectionSingleDatum

A class which holds a single bin which results from the radial projection of something. Used for describing both the bin position and values, namely combined in RadialProjectionSingleBinAndValue .More...

  • #include <radialprojectionsingledatum.h>

Public Types

Type Name
typedef typename GetFloatType< T >::type floatType

Public Attributes

Type Name
T average
T maxVal
T minVal
floatType multiplicity
T sampleVariance

Public Functions

Type Name
RadialProjectionSingleDatum ()
default constructor: values such that adding a non-default constructed RadialProjectionSingleDatum<T> leads to the right RadialProjectionSingleDatum<T>
RadialProjectionSingleDatum (T sum, T sumOfSquares, T inputMinVal, T inputMaxVal, floatType inputMultiplicity)
RadialProjectionSingleDatum (const RadialProjectionSingleDatum< U > & o)
std::string getHeader (device::Idx start, std::string prefix, bool withMultiplicity, int verbosity=0) const
RadialProjectionSingleDatum< T > & operator*= (floatType value)
For rescaling your results.
RadialProjectionSingleDatum< T > & sumInsteadOfAverage ()
For getting a sum instead of an average.
std::string toString (bool withMultiplicity=false, int verbosity=0, bool fourierMult=true) const

Detailed Description

Unit test: ctest -R test-radialprojectionsingledatum

Public Types Documentation

typedef floatType

using TempLat::RadialProjectionSingleDatum< T >::floatType =  typename GetFloatType<T>::type;

Public Attributes Documentation

variable average

T TempLat::RadialProjectionSingleDatum< T >::average;

variable maxVal

T TempLat::RadialProjectionSingleDatum< T >::maxVal;

variable minVal

T TempLat::RadialProjectionSingleDatum< T >::minVal;

variable multiplicity

floatType TempLat::RadialProjectionSingleDatum< T >::multiplicity;

variable sampleVariance

T TempLat::RadialProjectionSingleDatum< T >::sampleVariance;

Public Functions Documentation

function RadialProjectionSingleDatum [1/3]

default constructor: values such that adding a non-default constructed RadialProjectionSingleDatum<T> leads to the right RadialProjectionSingleDatum<T> 

inline TempLat::RadialProjectionSingleDatum::RadialProjectionSingleDatum ()

function RadialProjectionSingleDatum [2/3]

inline TempLat::RadialProjectionSingleDatum::RadialProjectionSingleDatum (
    T sum,
    T sumOfSquares,
    T inputMinVal,
    T inputMaxVal,
    floatType inputMultiplicity
)

function RadialProjectionSingleDatum [3/3]

template<typename U>
inline TempLat::RadialProjectionSingleDatum::RadialProjectionSingleDatum (
    const RadialProjectionSingleDatum < U > & o
)

function getHeader

inline std::string TempLat::RadialProjectionSingleDatum::getHeader (
    device::Idx start,
    std::string prefix,
    bool withMultiplicity,
    int verbosity=0
) const

function operator*=

For rescaling your results. 

inline RadialProjectionSingleDatum < T > & TempLat::RadialProjectionSingleDatum::operator*= (
    floatType value
)

function sumInsteadOfAverage

For getting a sum instead of an average. 

inline RadialProjectionSingleDatum < T > & TempLat::RadialProjectionSingleDatum::sumInsteadOfAverage ()

function toString

inline std::string TempLat::RadialProjectionSingleDatum::toString (
    bool withMultiplicity=false,
    int verbosity=0,
    bool fourierMult=true
) const

Friends Documentation

friend combine

Summing two instances, lets you do a re-binning without having to think. Combines both values taking into account their original weights. 

inline RadialProjectionSingleDatum < T > TempLat::RadialProjectionSingleDatum::combine (
    const RadialProjectionSingleDatum < T > & a,
    const RadialProjectionSingleDatum < T > & b
)

friend operator<<

inline std::ostream & TempLat::RadialProjectionSingleDatum::operator<< (
    std::ostream & ostream,
    const RadialProjectionSingleDatum & dp
)

The documentation for this class was generated from the following file cosmolatticeweb/tmp/code_source/templat/include/TempLat/lattice/measuringtools/projectionhelpers/radialprojectionsingledatum.h