Acoular 18.01 documentation

MaskedTimeSamples

«  TimeSamples   ::   sources   ::   PointSource  »

MaskedTimeSamples

class acoular.sources.MaskedTimeSamples

Bases: acoular.sources.TimeSamples

Container for time data in *.h5 format.

This class loads measured data from h5 files and provides information about this data. It supports storing information about (in)valid samples and (in)valid channels It also serves as an interface where the data can be accessed (e.g. for use in a block chain) via the result() generator.

start = CLong(0, desc="start of valid samples")

Index of the first sample to be considered valid.

stop = Trait(None, None, CLong, desc="stop of valid samples")

Index of the last sample to be considered valid.

invalid_channels = List( desc="list of invalid channels")

Channels that are to be treated as invalid.

channels = Property(depends_on = ['invalid_channels', 'numchannels_total'], desc="channel mask")

Channel mask to serve as an index for all valid channels, is set automatically.

numchannels_total = CLong(0, desc="total number of input channels")

Number of channels (including invalid channels), is set automatically.

numsamples_total = CLong(0, desc="total number of samples per channel")

Number of time data samples (including invalid samples), is set automatically.

numchannels = Property(depends_on = ['invalid_channels',\ 'numchannels_total'], desc="number of valid input channels")

Number of valid channels, is set automatically.

numsamples = Property(depends_on = ['start', 'stop', 'numsamples_total'], desc="number of valid samples per channel")

Number of valid time data samples, is set automatically.

result(num=128)

Python generator that yields the output block-wise.

Parameters:

num : integer, defaults to 128

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

Returns:

Samples in blocks of shape (num, numchannels).

The last block may be shorter than num.

«  TimeSamples   ::   sources   ::   PointSource  »