Acoular 16.5 documentation

PointSourceDipole

«  PointSource   ::   sources   ::   MovingPointSource  »

PointSourceDipole

class acoular.sources.PointSourceDipole

Bases: acoular.sources.PointSource

Class to define a fixed point source with an arbitrary signal and dipole characteristics via superposition of two nearby inversely phased monopoles. This can be used in simulations.

The output is being generated via the result() generator.

direction = Tuple((0.0, 0.0, 1.0), desc="dipole orientation and distance of the inversely phased monopoles")

Vector to define the orientation of the dipole lobes. Its magnitude governs the distance between the monopoles (dist = [lowest wavelength in spectrum] x [magnitude] x 1e-5). Note: Use vectors with order of magnitude around 1.0 or less for good results.

result(num=128)

Python generator that yields the output at microphones 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.

«  PointSource   ::   sources   ::   MovingPointSource  »