extract_scalar_statistics()

MAYAFLUX_API double MayaFlux::Yantra::extract_scalar_statistics ( const StatisticalAnalysis &  analysis, const std::string &  qualifier  )

inline

Extract a named scalar from a StatisticalAnalysis result.

Maps qualifier strings to scalar fields of the first channel in analysis. All scalar-valued fields of ChannelStatistics are addressable.

Supported qualifiers:

• "mean_stat" arithmetic mean of the statistical values
• "max_stat" maximum statistical value
• "min_stat" minimum statistical value
• "variance" variance of the statistical values
• "std_dev" standard deviation
• "skewness" third moment
• "kurtosis" fourth moment
• "median" 50th percentile
• "window_count" number of analysis windows

An empty qualifier resolves to "mean_stat". Unknown qualifiers fall back to mean_stat.

Parameters

analysis	Result produced by StatisticalAnalyzer.
qualifier	Name of the scalar to extract.

Returns

Extracted double value, or 0.0 if channel_statistics is empty.

Definition at line 720 of file StatisticalAnalyzer.hpp.

{
    if (analysis.channel_statistics.empty())
        return 0.0;
 
    const auto& ch = analysis.channel_statistics[0];
    const std::string q = qualifier.empty() ? "mean_stat" : qualifier;
 
    if (q == "mean_stat")
        return ch.mean_stat;
    if (q == "max_stat")
        return ch.max_stat;
    if (q == "min_stat")
        return ch.min_stat;
    if (q == "variance")
        return ch.stat_variance;
    if (q == "std_dev")
        return ch.stat_std_dev;
    if (q == "skewness")
        return ch.skewness;
    if (q == "kurtosis")
        return ch.kurtosis;
    if (q == "median")
        return ch.median;
    if (q == "window_count")
        return static_cast<double>(ch.statistical_values.size());
 
    return ch.mean_stat;
}

References MayaFlux::Yantra::StatisticalAnalysis::channel_statistics, and q.

Referenced by MayaFlux::Yantra::Granular::AttributeOp::compute_grain_attribute().

Here is the caller graph for this function: