SpectraOut

class acoular.base.SpectraOut

Bases: SpectraGenerator

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

It provides a base class that can be used to create signal processing blocks that receive data from any generating source domain and generates a frequency domain 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 snapshots in output, as given by source.

num_freqs = Delegate('source')

Number of frequencies in output, as given by source.

freqs = Delegate('source')

1-D array of frequencies, as given by source.

block_size = Delegate('source')

The size of the block used to calculate the spectra

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

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

abstractmethod result(num=1)

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

This method needs to be implemented by the derived classes.

numinteger

This parameter defines the the number of snapshots to be yielded. Defaults to 1.

Yields:

numpy.ndarray

A two-dimensional block of shape (num, num_channels * num_freqs).