Aleph-w 3.0
A C++ Library for Data Structures and Algorithms
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Aleph::FFT< Real >::BatchedSTFTProcessor Class Reference

Stateful multichannel STFT processor with one analyzer per channel. More...

#include <fft.H>

Collaboration diagram for Aleph::FFT< Real >::BatchedSTFTProcessor:
[legend]

Public Member Functions

 BatchedSTFTProcessor (const size_t num_channels, const Array< Real > &window, const STFTOptions &options)
 
 BatchedSTFTProcessor (const size_t num_channels, const size_t frame_size, const STFTOptions &options)
 
template<typename WindowContainer >
requires Is_Real_Container<WindowContainer>
 BatchedSTFTProcessor (const size_t num_channels, const WindowContainer &window, const STFTOptions &options)
 
size_t num_channels () const noexcept
 
STFTProcessor & channel (const size_t index)
 
const STFTProcessor & channel (const size_t index) const
 
void reset ()
 
Array< Array< Array< Complex > > > process_block (const Array< Array< Real > > &block)
 
Array< Array< Array< Complex > > > pprocess_block (ThreadPool &pool, const Array< Array< Real > > &block, const size_t chunk_size=0)
 
Array< Array< Array< Complex > > > flush ()
 
Array< Array< Array< Complex > > > pflush (ThreadPool &pool, const size_t chunk_size=0)
 

Private Member Functions

void validate_batch_size (const size_t size, const char *ctx) const
 

Private Attributes

Array< STFTProcessor > processors_
 

Detailed Description

template<std::floating_point Real = double>
class Aleph::FFT< Real >::BatchedSTFTProcessor

Stateful multichannel STFT processor with one analyzer per channel.

Definition at line 10883 of file fft.H.

Constructor & Destructor Documentation

◆ BatchedSTFTProcessor() [1/3]

template<std::floating_point Real = double>
Aleph::FFT< Real >::BatchedSTFTProcessor::BatchedSTFTProcessor ( const size_t  num_channels,
const Array< Real > &  window,
const STFTOptions &  options 
)
inlineexplicit

Definition at line 10896 of file fft.H.

References ah_invalid_argument_if, Aleph::FFT< Real >::BatchedSTFTProcessor::num_channels(), options, and Aleph::FFT< Real >::BatchedSTFTProcessor::processors_.

◆ BatchedSTFTProcessor() [2/3]

template<std::floating_point Real = double>
Aleph::FFT< Real >::BatchedSTFTProcessor::BatchedSTFTProcessor ( const size_t  num_channels,
const size_t  frame_size,
const STFTOptions &  options 
)
inlineexplicit

Definition at line 10907 of file fft.H.

◆ BatchedSTFTProcessor() [3/3]

template<std::floating_point Real = double>
template<typename WindowContainer >
requires Is_Real_Container<WindowContainer>
Aleph::FFT< Real >::BatchedSTFTProcessor::BatchedSTFTProcessor ( const size_t  num_channels,
const WindowContainer &  window,
const STFTOptions &  options 
)
inlineexplicit

Definition at line 10915 of file fft.H.

Member Function Documentation

◆ channel() [1/2]

template<std::floating_point Real = double>
STFTProcessor & Aleph::FFT< Real >::BatchedSTFTProcessor::channel ( const size_t  index)
inline

Definition at line 10929 of file fft.H.

References ah_out_of_range_error_if, and Aleph::FFT< Real >::BatchedSTFTProcessor::processors_.

◆ channel() [2/2]

template<std::floating_point Real = double>
const STFTProcessor & Aleph::FFT< Real >::BatchedSTFTProcessor::channel ( const size_t  index) const
inline

Definition at line 10938 of file fft.H.

References ah_out_of_range_error_if, and Aleph::FFT< Real >::BatchedSTFTProcessor::processors_.

◆ flush()

template<std::floating_point Real = double>
Array< Array< Array< Complex > > > Aleph::FFT< Real >::BatchedSTFTProcessor::flush ( )
inline

Definition at line 10987 of file fft.H.

References output, and Aleph::FFT< Real >::BatchedSTFTProcessor::processors_.

◆ num_channels()

template<std::floating_point Real = double>
size_t Aleph::FFT< Real >::BatchedSTFTProcessor::num_channels ( ) const
inlinenoexcept

Definition at line 10923 of file fft.H.

References Aleph::FFT< Real >::BatchedSTFTProcessor::processors_.

Referenced by Aleph::FFT< Real >::BatchedSTFTProcessor::BatchedSTFTProcessor().

◆ pflush()

template<std::floating_point Real = double>
Array< Array< Array< Complex > > > Aleph::FFT< Real >::BatchedSTFTProcessor::pflush ( ThreadPool &  pool,
const size_t  chunk_size = 0 
)
inline

Definition at line 10997 of file fft.H.

References output, Aleph::parallel_for_index(), and Aleph::FFT< Real >::BatchedSTFTProcessor::processors_.

◆ pprocess_block()

template<std::floating_point Real = double>
Array< Array< Array< Complex > > > Aleph::FFT< Real >::BatchedSTFTProcessor::pprocess_block ( ThreadPool &  pool,
const Array< Array< Real > > &  block,
const size_t  chunk_size = 0 
)
inline

Definition at line 10964 of file fft.H.

References output, Aleph::parallel_for_index(), Aleph::FFT< Real >::BatchedSTFTProcessor::processors_, and Aleph::FFT< Real >::BatchedSTFTProcessor::validate_batch_size().

◆ process_block()

template<std::floating_point Real = double>
Array< Array< Array< Complex > > > Aleph::FFT< Real >::BatchedSTFTProcessor::process_block ( const Array< Array< Real > > &  block)
inline

Definition at line 10953 of file fft.H.

References output, Aleph::FFT< Real >::BatchedSTFTProcessor::processors_, and Aleph::FFT< Real >::BatchedSTFTProcessor::validate_batch_size().

◆ reset()

template<std::floating_point Real = double>
void Aleph::FFT< Real >::BatchedSTFTProcessor::reset ( )
inline

Definition at line 10946 of file fft.H.

References Aleph::FFT< Real >::BatchedSTFTProcessor::processors_.

◆ validate_batch_size()

template<std::floating_point Real = double>
void Aleph::FFT< Real >::BatchedSTFTProcessor::validate_batch_size ( const size_t  size,
const char *  ctx 
) const
inlineprivate

Definition at line 10888 of file fft.H.

References ah_invalid_argument_if, Aleph::FFT< Real >::BatchedSTFTProcessor::processors_, and Aleph::size().

Referenced by Aleph::FFT< Real >::BatchedSTFTProcessor::pprocess_block(), and Aleph::FFT< Real >::BatchedSTFTProcessor::process_block().

Member Data Documentation

◆ processors_

template<std::floating_point Real = double>
Array<STFTProcessor> Aleph::FFT< Real >::BatchedSTFTProcessor::processors_
private

Definition at line 10885 of file fft.H.

Referenced by Aleph::FFT< Real >::BatchedSTFTProcessor::BatchedSTFTProcessor(), Aleph::FFT< Real >::BatchedSTFTProcessor::channel(), Aleph::FFT< Real >::BatchedSTFTProcessor::channel(), Aleph::FFT< Real >::BatchedSTFTProcessor::flush(), Aleph::FFT< Real >::BatchedSTFTProcessor::num_channels(), Aleph::FFT< Real >::BatchedSTFTProcessor::pflush(), Aleph::FFT< Real >::BatchedSTFTProcessor::pprocess_block(), Aleph::FFT< Real >::BatchedSTFTProcessor::process_block(), Aleph::FFT< Real >::BatchedSTFTProcessor::reset(), and Aleph::FFT< Real >::BatchedSTFTProcessor::validate_batch_size().

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