sine

sine generates a sine-wave amplitude modulation.

freq = 200 Hz (clamp = true)

API

Rust

sine(freq, &option, &mut dst)?;

Python

sine(freq, option, dst)

C#

Modulation.Sine(freq, option, dst);

Parameter	Type	Description
freq	Freq<u32> etc.	modulation frequency
option	&SineOption	additional options (see below)
dst	&mut Vec<u8>	output buffer

The value of each sample is given by the following equation, for amplitude (amplitude), offset (offset), and phase (phase).

freq is specified as Freq<u32> (150 * Hz) or Freq<f32> (150.0 * Hz).

SineOption

Rust

SineOption {
    amplitude,
    offset,
    phase,
    clamp,
    sampling_config,
}

Python

SineOption(
    amplitude,
    offset,
    phase,
    clamp,
    sampling_config,
)

C#

new SineOption(
    amplitude,
    offset,
    phase,
    clamp,
    samplingConfig
)

Field	Type	Default	Description
amplitude	u8	0xFF	amplitude of the sine wave
offset	u8	0x80	DC offset
phase	Angle	Angle::ZERO	phase
clamp	bool	false	whether to clamp out-of-range values to [0, 255]
sampling_config	SamplingConfig	SamplingConfig::FREQ_4K	sampling configuration

If the combination of amplitude and offset causes the waveform to fall outside the [0, 255] range, an error occurs when clamp is false. Choose values that stay within range, or set clamp to true.

Constraints

Due to the constraints of SamplingConfig, the specified frequency may not be a representable frequency. In that case, passing Nearest(freq) rounds it to the nearest representable frequency.

Rust

sine(Nearest(150.5 * Hz), &option, &mut dst)?;

Python

sine(Nearest(150.5 * Hz), option, dst)

C#

Modulation.Sine(Nearest(150.5f * Hz), option, dst);

Example

Rust

use autd3_rs::units::{Hz, rad};
use autd3_rs::value::SamplingConfig;
use autd3_rs_modulation::{SineOption, sine};

let mut dst = Vec::new();

sine(
    150 * Hz,
    &SineOption {
        amplitude: 0xFF,
        offset: 0x80,
        phase: 0.0 * rad,
        clamp: false,
        sampling_config: SamplingConfig::FREQ_4K,
    },
    &mut dst,
)?;

Python

from autd3.units import Hz, rad
from autd3.value import SamplingConfig
from autd3_modulation import SineOption, modulation_buffer, sine

dst = modulation_buffer()

sine(
    150 * Hz,
    SineOption(
        amplitude=0xFF,
        offset=0x80,
        phase=0.0 * rad,
        clamp=False,
        sampling_config=SamplingConfig.FREQ_4K,
    ),
    dst,
)

C#

using AUTD3;
using static AUTD3.Units;

var dst = Modulation.ModulationBuffer();

Modulation.Sine(
    150 * Hz,
    new SineOption(
        amplitude: 0xFF,
        offset: 0x80,
        phase: 0.0f * rad,
        clamp: false,
        samplingConfig: SamplingConfig.Freq4k
    ),
    dst
);