extract_scalar_energy()

MAYAFLUX_API double MayaFlux::Yantra::extract_scalar_energy ( const EnergyAnalysis &  analysis, const std::string &  qualifier  )

inline

Extract a named scalar from an EnergyAnalysis result.

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

Supported qualifiers:

• "mean_energy" mean energy across analysis windows
• "max_energy" maximum window energy
• "min_energy" minimum window energy
• "variance" variance of window energy values
• "dynamic_range" max_energy - min_energy
• "event_count" number of detected energy events (peaks, zero crossings, etc.)
• "window_count" number of analysis windows

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

Parameters

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

Returns

Extracted double value, or 0.0 if channels is empty.

Definition at line 638 of file EnergyAnalyzer.hpp.

{
    if (analysis.channels.empty())
        return 0.0;
 
    const auto& ch = analysis.channels[0];
    const std::string q = qualifier.empty() ? "mean_energy" : qualifier;
 
    if (q == "mean_energy")
        return ch.mean_energy;
    if (q == "max_energy")
        return ch.max_energy;
    if (q == "min_energy")
        return ch.min_energy;
    if (q == "variance")
        return ch.variance;
    if (q == "dynamic_range")
        return ch.max_energy - ch.min_energy;
    if (q == "event_count")
        return static_cast<double>(ch.event_positions.size());
    if (q == "window_count")
        return static_cast<double>(ch.energy_values.size());
 
    return ch.mean_energy;
}

References MayaFlux::Yantra::EnergyAnalysis::channels, and q.

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

Here is the caller graph for this function: