SamplesGenerator

class acoular.base.SamplesGenerator

Bases: Generator

Interface for any generating multi-channel time domain signal processing block.

It provides a common interface for all SamplesGenerator classes, which generate an output via the generator result() in block-wise manner. This class has no real functionality on its own and should not be used directly.

digest = Property(depends_on=['sample_freq', 'num_samples', 'num_channels'])

A unique identifier for the generator, based on its properties. (read-only)

abstractmethod result(num)

Python generator that yields the output block-wise.

Parameters:

numint

This parameter defines the size of the blocks to be yielded (i.e. the number of samples per block)

Yields:

numpy.ndarray

The two-dimensional time-data block of shape (num, num_channels).