Skip to content

Class TempLat::RadialProjectionResult

template <typename T>

ClassList > TempLat > RadialProjectionResult

A class which holds the result of a radial projection, with per bin the average position of each entry (the horizontal axis in your plot..), the variance in the position, the average value, the sample variance (= <f^2> - <f>^2 ) of the values, and the number of entries in a bin (multiplicity). More...

  • #include <radialprojectionresult.h>

Inherits the following classes: std::vector< RadialProjectionSingleBinAndValue< T > >

Public Types

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

Public Functions

Type Name
RadialProjectionResult (size_t nBins, T deltakBins, bool pUseBinCentralValues=false, bool pIsInFourier=false)
RadialProjectionResult (const RadialProjectionResult< U > & other)
Converting constructor: build a RadialProjectionResult<T> from a RadialProjectionResult
DEVICE_INLINE_FUNCTION void add_device (device::Idx i, const T & value, const T & position, const T & weight=(T) 1) const
RadialProjectionResult & finalize (MPICommReference comm)
RadialProjector calls this as the last step, does the transposition of the result vecotrs into one vector of RadialProjectionSingleBinAndValue<T>.
std::vector< T > & getCentralBinBounds ()
auto getNBins ()
auto integrate (bool useCentralBin)
RadialProjectionResult & rebin (device::Idx nBins, T customRange=-1)
Decrease the number of bins on demand.
RadialProjectionResult & rescale (LL rescaler)
Rescale the results with a function of x or k (bin location), using for now a simple lambda function of single float parameter, which is your x in f(x). In other words, you give f(x).
RadialProjectionResult & rescaleBins (T scale)
Rescale the bin positions with a normalization (for example dimensionful).
RadialProjectionResult & sumInsteadOfAverage ()
std::string toString (int verbosity=0) const

Detailed Description

Upon call to finalize, constructs the parent vector, which you can use as you wish.

See RadialProjectionSingleDatum for the single data points in the vector.;

Also serves as the workspace during the integration, can to the data transposition after the integration is done.

Unit test: ctest -R test-radialprojectionresult

Public Types Documentation

typedef floatType

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

Public Functions Documentation

function RadialProjectionResult [2/3]

inline TempLat::RadialProjectionResult::RadialProjectionResult (
    size_t nBins,
    T deltakBins,
    bool pUseBinCentralValues=false,
    bool pIsInFourier=false
)

function RadialProjectionResult [3/3]

Converting constructor: build a RadialProjectionResult<T> from a RadialProjectionResult 

template<typename U>
inline TempLat::RadialProjectionResult::RadialProjectionResult (
    const RadialProjectionResult < U > & other
)

function add_device

inline DEVICE_INLINE_FUNCTION void TempLat::RadialProjectionResult::add_device (
    device::Idx i,
    const T & value,
    const T & position,
    const T & weight=(T) 1
) const

function finalize

RadialProjector calls this as the last step, does the transposition of the result vecotrs into one vector of RadialProjectionSingleBinAndValue<T>. 

inline RadialProjectionResult & TempLat::RadialProjectionResult::finalize (
    MPICommReference comm
)

function getCentralBinBounds

inline std::vector< T > & TempLat::RadialProjectionResult::getCentralBinBounds ()

function getNBins

inline auto TempLat::RadialProjectionResult::getNBins ()

function integrate

inline auto TempLat::RadialProjectionResult::integrate (
    bool useCentralBin
)

function rebin

Decrease the number of bins on demand. 

inline RadialProjectionResult & TempLat::RadialProjectionResult::rebin (
    device::Idx nBins,
    T customRange=-1
)

function rescale

Rescale the results with a function of x or k (bin location), using for now a simple lambda function of single float parameter, which is your x in f(x). In other words, you give f(x). 

template<typename LL>
inline RadialProjectionResult & TempLat::RadialProjectionResult::rescale (
    LL rescaler
)

function rescaleBins

Rescale the bin positions with a normalization (for example dimensionful). 

inline RadialProjectionResult & TempLat::RadialProjectionResult::rescaleBins (
    T scale
)

function sumInsteadOfAverage

inline RadialProjectionResult & TempLat::RadialProjectionResult::sumInsteadOfAverage ()

function toString

inline std::string TempLat::RadialProjectionResult::toString (
    int verbosity=0
) const

Friends Documentation

friend RadialProjectionResult [1/3]

template<typename U>
class TempLat::RadialProjectionResult::RadialProjectionResult (
    RadialProjectionResult
)

friend RadialProjector

template<typename S>
class TempLat::RadialProjectionResult::RadialProjector (
    RadialProjector
)

friend operator+

template<typename S>
RadialProjectionResult < S > TempLat::RadialProjectionResult::operator+ (
    const RadialProjectionResult < S > & a,
    const RadialProjectionResult < S > & b
)

friend operator<<

inline std::ostream & TempLat::RadialProjectionResult::operator<< (
    std::ostream & ostream,
    const RadialProjectionResult & rpr
)

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