TimeOut

class acoular.base.TimeOut

Bases: SamplesGenerator

Abstract base class receiving from a source and returning time domain signals.

It provides a base class that can be used to create signal processing blocks that receive data from any generating source and generates a time signal output via the generator result() in block-wise manner.

source = Instance(Generator)

Data source; Generator or derived object.

sample_freq = Delegate('source')

Sampling frequency of output signal, as given by source.

num_channels = Delegate('source')

Number of channels in output, as given by source.

num_samples = Delegate('source')

Number of samples in output, as given by source.

digest = Property(depends_on=['source.digest'])

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

abstractmethod result(num)

Python generator that processes the source data and yields the time-signal block-wise.

This method needs to be implemented by the derived classes.

Parameters:

numint

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

Yields:

numpy.ndarray

Two-dimensional output data block of shape (num, num_channels)