sample_wave

pulserver.ir.sample_wave()

Return a wave as a playout loads it into a region, normalised to unit peak.

wave is the subsequence and the wave’s index there, as play() reports it, and region one that plan_waves() lays out. The wave is sampled at the centres of the region’s samples raster intervals from its start_us, linear between the points play() plays it through and zero outside them.

Returns:

(3, samples), along x, y and z; zero on an axis the wave does not drive.

Return type:

ndarray

Raises:

ValueError – If the cache cannot be loaded or holds no such wave.