DSPark 1.8.0
Header-only C++20 DSP for real-time and offline audio
Loading...
Searching...
No Matches
dspark::OfflineTransientAnalyzer< T >::Analysis Class Referencefinal

Read-only analysis with source provenance; no owned audio samples. Threading: energy() is an owner-thread reference view, not an atomic publication. Const readers may share a completed analysis while it remains alive and unmoved; no reader may overlap a move or other mutable access. More...

#include <OfflineTransientAnalyzer.h>

Public Member Functions

 Analysis ()=default
 
 Analysis (Analysis &&) noexcept=default
 
Analysis & operator= (Analysis &&) noexcept=default
 
bool isValid () const noexcept
 
const OfflineEnergyAnalyzer< T >::Analysis & energy () const noexcept
 Borrows the energy map as an owner-thread reference view. Valid while this analysis remains alive and unmoved. No concurrent mutable access is permitted; returning a reference does not publish it.
 
std::span< const Event > attacks () const noexcept
 
std::span< const Event > pulses () const noexcept
 
std::span< const FeatureFrame > features () const noexcept
 
int frameSize () const noexcept
 
int hopFrames () const noexcept
 
std::int64_t featureCenter (std::size_t index) const noexcept
 Spectral window center, before event localization/refinement.
 
Options getOptions () const noexcept
 
std::size_t retainedBytes () const noexcept
 

Friends

class OfflineTransientAnalyzer
 

Detailed Description

template<FloatType T>
class dspark::OfflineTransientAnalyzer< T >::Analysis

Read-only analysis with source provenance; no owned audio samples. Threading: energy() is an owner-thread reference view, not an atomic publication. Const readers may share a completed analysis while it remains alive and unmoved; no reader may overlap a move or other mutable access.

Definition at line 96 of file OfflineTransientAnalyzer.h.

Constructor & Destructor Documentation

◆ Analysis() [1/2]

template<FloatType T>
dspark::OfflineTransientAnalyzer< T >::Analysis::Analysis ( )
default

◆ Analysis() [2/2]

template<FloatType T>
dspark::OfflineTransientAnalyzer< T >::Analysis::Analysis ( Analysis &&  )
defaultnoexcept

Member Function Documentation

◆ attacks()

template<FloatType T>
std::span< const Event > dspark::OfflineTransientAnalyzer< T >::Analysis::attacks ( ) const
inlinenoexcept

Definition at line 115 of file OfflineTransientAnalyzer.h.

◆ energy()

template<FloatType T>
const OfflineEnergyAnalyzer< T >::Analysis & dspark::OfflineTransientAnalyzer< T >::Analysis::energy ( ) const
inlinenoexcept

Borrows the energy map as an owner-thread reference view. Valid while this analysis remains alive and unmoved. No concurrent mutable access is permitted; returning a reference does not publish it.

Definition at line 111 of file OfflineTransientAnalyzer.h.

◆ featureCenter()

template<FloatType T>
std::int64_t dspark::OfflineTransientAnalyzer< T >::Analysis::featureCenter ( std::size_t  index) const
inlinenoexcept

Spectral window center, before event localization/refinement.

Definition at line 140 of file OfflineTransientAnalyzer.h.

◆ features()

template<FloatType T>
std::span< const FeatureFrame > dspark::OfflineTransientAnalyzer< T >::Analysis::features ( ) const
inlinenoexcept

Definition at line 125 of file OfflineTransientAnalyzer.h.

◆ frameSize()

template<FloatType T>
int dspark::OfflineTransientAnalyzer< T >::Analysis::frameSize ( ) const
inlinenoexcept

Definition at line 131 of file OfflineTransientAnalyzer.h.

◆ getOptions()

template<FloatType T>
Options dspark::OfflineTransientAnalyzer< T >::Analysis::getOptions ( ) const
inlinenoexcept

Definition at line 146 of file OfflineTransientAnalyzer.h.

◆ hopFrames()

template<FloatType T>
int dspark::OfflineTransientAnalyzer< T >::Analysis::hopFrames ( ) const
inlinenoexcept

Definition at line 135 of file OfflineTransientAnalyzer.h.

◆ isValid()

template<FloatType T>
bool dspark::OfflineTransientAnalyzer< T >::Analysis::isValid ( ) const
inlinenoexcept

Definition at line 102 of file OfflineTransientAnalyzer.h.

◆ operator=()

template<FloatType T>
Analysis & dspark::OfflineTransientAnalyzer< T >::Analysis::operator= ( Analysis &&  )
defaultnoexcept

◆ pulses()

template<FloatType T>
std::span< const Event > dspark::OfflineTransientAnalyzer< T >::Analysis::pulses ( ) const
inlinenoexcept

Definition at line 120 of file OfflineTransientAnalyzer.h.

◆ retainedBytes()

template<FloatType T>
std::size_t dspark::OfflineTransientAnalyzer< T >::Analysis::retainedBytes ( ) const
inlinenoexcept

Definition at line 150 of file OfflineTransientAnalyzer.h.

Friends And Related Symbol Documentation

◆ OfflineTransientAnalyzer

template<FloatType T>
friend class OfflineTransientAnalyzer
friend

Definition at line 159 of file OfflineTransientAnalyzer.h.


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