SamplingConfig

SamplingConfig represents the sampling frequency of Modulation or STM. The sampling frequency must be the ultrasound frequency (40 kHz) divided by an integer.

Rust

SamplingConfig::new(NonZeroU16::new(10).unwrap());
SamplingConfig::from_freq(4. * kHz)?;
SamplingConfig::from_period(Duration::from_micros(250))?;

Python

SamplingConfig(10)
SamplingConfig(4.0 * kHz)
SamplingConfig(Duration.from_micros(250))

C#

new SamplingConfig(10);
new SamplingConfig(4.0f * kHz);
new SamplingConfig(TimeSpan.FromMicroseconds(250));

All of the above represent 4 kHz (division ratio 10) and are equivalent to one another.

Internal Representation

SamplingConfig is ultimately converted to a division ratio (u16).

The relationship between the division ratio , the sampling frequency , and the sampling period is as follows.

When specified by frequency or period, it is an error if it does not evenly divide 40 kHz (i.e., does not yield an integer division ratio).

Presets

Frequently used constants are provided in advance.

Constant	Sampling frequency	Division ratio
FREQ_40K	40 kHz	1
FREQ_4K	4 kHz	10