Sine

Modulation to transform sound pressure into a sine wave.

use autd3::prelude::*;
fn main() {
let _ = 
Sine {
    freq: 150 * Hz,
    option: SineOption {
        intensity: u8::MAX,
        offset: 0x80,
        phase: 0. * rad,
        clamp: false,
        sampling_config: SamplingConfig::FREQ_4K,
    },
};
}
#include<autd3.hpp>
int main() {
using namespace autd3;
Sine(150 * Hz, SineOption{
                   .intensity = 0xFF,
                   .offset = 0x80,
                   .phase = 0.0f * rad,
                   .clamp = false,
                   .sampling_config = SamplingConfig::freq_4k(),
               });
return 0; }

using AUTD3Sharp;
using AUTD3Sharp.Modulation;
using static AUTD3Sharp.Units;
new Sine(
    freq: 150u * Hz,
    option: new SineOption
    {
        Intensity = 0xFF,
        Offset = 0x80,
        Phase = 0f * rad,
        Clamp = false,
        SamplingConfig = SamplingConfig.Freq4K
    }
);

from pyautd3 import Hz, SamplingConfig, Sine, SineOption, rad
Sine(
    freq=150 * Hz,
    option=SineOption(
        intensity=0xFF,
        offset=0x80,
        phase=0.0 * rad,
        clamp=False,
        sampling_config=SamplingConfig.FREQ_4K,
    ),
)

Sine applies AM so that the waveform of the sound pressure becomes where represents the floor function.

If clamp is false, it returns an error if intensity, offset are specified such that the above formula results in values outside the range of . To clamp values outside the range to instead of returning an error, specify true for clamp.

The default values for these are as above.

Frequency Constraints

Sine is strict about frequency by default, and if a frequency that cannot be output due to the sampling frequency is specified, it returns an error.

In that case, you have to change the sampling settings or use into_nearest to modulate at the nearest frequency that can be output.

use autd3::prelude::*;
fn main() {
    let _ = 
Sine {
    freq: 150. * Hz,
    option: SineOption::default(),
}
.into_nearest();
}
#include<autd3.hpp>
int main() {
using namespace autd3;
Sine(150.0f * Hz, SineOption{}).into_nearest();
return 0; }

using AUTD3Sharp.Modulation;
using static AUTD3Sharp.Units;
new Sine(freq: 150.0f * Hz, option: new SineOption()).IntoNearest();

from pyautd3 import Hz, Sine, SineOption
Sine(freq=150.0 * Hz, option=SineOption()).into_nearest()