pya.ugen

Module Contents

Classes

Ugen

Unit Generator for to create Asig with predefined signal

Functions

get_num_of_rows(dur, n_rows, sr)

Return total number of samples. If dur is set, return dur*sr, if num_samples is set, return num_samples,
pya.ugen.get_num_of_rows(dur, n_rows, sr)

Return total number of samples. If dur is set, return dur*sr, if num_samples is set, return num_samples, if both set, raise an AttributeError. Only use one of the two.

class pya.ugen.Ugen

Bases: pya.Asig

Unit Generator for to create Asig with predefined signal

Currently avaiable:

sine, cos, square, sawtooth, noise

Examples

Create common waveform in Asig.

>>> from pya import Ugen
>>> # Create a sine wave of 440Hz at 44100Hz sr for 2 seconds. Same for cos()
>>> sine = Ugen().sine(freq=440, amp=0.8, dur=2.,label="sine")
>>> # Create a square wave of 25Hz, 2000 samples at 100 sr, stereo.
>>> sq = Ugen().square(freq=25, n_rows=2000, sr=100, channels=2, cn=['l', 'r'])
>>> # Make a white noise, another option is 'pink', at 44100Hz for 1second.
>>> noi = Ugen().noise(type='white')
sine(freq=440, amp=1.0, dur=None, n_rows=None, sr=44100, channels=1, cn=None, label='sine')

Generate Sine signal Asig object.

Parameters:

  • freq (int, float) – signal frequency (Default value = 440)

  • amp (int, float) – signal amplitude (Default value = 1.0)

  • dur (float) – duration in second. dur and num_rows only use one of the two. (Default value = 1.0)

  • num_rows (int) – number of rows (samples). dur and num_rows only use one of the two(Default value = None)

  • sr (int) – sampling rate (Default value = 44100)

  • channels (int) – number of channels (Default value = 1)

  • cn (list of string) – channel names as a list. The size needs to match the number of channels (Default value = None)

  • label (string) – identifier of the object (Default value = “sine”)

Return type:

Asig

cos(freq=440, amp=1.0, dur=None, n_rows=None, sr=44100, channels=1, cn=None, label='cosine')

Generate Cosine signal Asig object.

Parameters:

  • freq (int, float) – signal frequency (Default value = 440)

  • amp (int, float) – signal amplitude (Default value = 1.0)

  • dur (int, float) – duration in second. dur and num_rows only use one of the two. (Default value = 1.0)

  • num_rows (int) – number of rows (samples). dur and num_rows only use one of the two(Default value = None)

  • sr (int) – sampling rate (Default value = 44100)

  • channels (int) – number of channels (Default value = 1)

  • cn (list of string) – channel names as a list. The size needs to match the number of channels (Default value = None)

  • label (string) – identifier of the object (Default value = “cosine”)

Return type:

Asig

square(freq=440, amp=1.0, dur=None, n_rows=None, duty=0.5, sr=44100, sample_shift=0.5, channels=1, cn=None, label='square')

Generate square wave signal Asig object.

Parameters:

  • freq (int, float) – signal frequency (Default value = 440)

  • amp (int, float) – signal amplitude (Default value = 1.0)

  • dur (int, float) – duration in second. dur and num_rows only use one of the two. (Default value = 1.0)

  • num_rows (int) – number of row (samples). dur and num_rows only use one of the two(Default value = None)

  • duty (float) – duty cycle (Default value = 0.4)

  • sr (int) – sampling rate (Default value = 44100)

  • channels (int) – number of channels (Default value = 1)

  • cn (list of string) – channel names as a list. The size needs to match the number of channels (Default value = None)

  • label (string) – identifier of the object (Default value = “square”)

Return type:

Asig

sawtooth(freq=440, amp=1.0, dur=None, n_rows=None, width=1.0, sr=44100, channels=1, cn=None, label='sawtooth')

Generate sawtooth wave signal Asig object.

Parameters:

  • freq (int, float) – signal frequency (Default value = 440)

  • amp (int, float) – signal amplitude (Default value = 1.0)

  • dur (int, float) – duration in second. dur and num_rows only use one of the two. (Default value = 1.0)

  • num_rows (int) – number of rows (samples). dur and num_rows only use one of the two(Default value = None)

  • width (float) – tooth width (Default value = 1.0)

  • sr (int) – sampling rate (Default value = 44100)

  • channels (int) – number of channels (Default value = 1)

  • cn (list of string) – channel names as a list. The size needs to match the number of channels (Default value = None)

  • label (string) – identifier of the object (Default value = “sawtooth”)

Return type:

Asig

noise(type='white', amp=1.0, dur=None, n_rows=None, sr=44100, channels=1, cn=None, label='noise')

Generate noise signal Asig object.

Parameters:

  • type (string) – type of noise, currently available: ‘white’ and ‘pink’ (Default value = ‘white’)

  • amp (int, float) – signal amplitude (Default value = 1.0)

  • dur (int, float) – duration in second. dur and num_rows only use one of the two. (Default value = 1.0)

  • num_rows (int) – number of rows (samples). dur and num_rows only use one of the two(Default value = None)

  • sr (int) – sampling rate (Default value = 44100)

  • channels (int) – number of channels (Default value = 1)

  • cn (list of string) – channel names as a list. The size needs to match the number of channels (Default value = None)

  • label (string) – identifier of the object (Default value = “square”)

Return type:

Asig