# acoular.tools.return_result¶

acoular.tools.return_result(source, nmax=- 1, num=128)

Collects the output from a SamplesGenerator.result() generator and returns an assembled array with all the data.

Parameters
source: SamplesGenerator or derived object.

This is the SamplesGenerator data source.

nmax: integer

With this parameter, a maximum number of output samples can be set (first dimension of array). If set to -1 (default), samples are collected as long as the generator yields them.

numinteger

This parameter defines the size of the blocks that are fetched. Defaults to 128.

Returns
array of floats (number of samples, source.numchannels)

Array that holds all the data.