set_intensity / set_phase / add_phase

These functions rewrite a whole phase buffer or intensity buffer at once. Pattern functions such as focus write only to the phase buffer, so set the intensity with set_intensity.

Buffers allocated with phase_buffer / intensity_buffer start at phase 0 and the maximum intensity. Note that, in C#, the elements of new Intensity[n] start at intensity 0.

set_intensity

Sets the intensity of every transducer in an intensity buffer. Passing Intensity::MIN produces no output.

Rust

set_intensity(intensity, &mut intensities);

Python

set_intensity(intensity, intensities)

C#

Pattern.SetIntensity(intensity, intensities);

set_phase

Sets the phase of every transducer in a phase buffer.

Rust

set_phase(phase, &mut phases);

Python

set_phase(phase, phases)

C#

Pattern.SetPhase(phase, phases);

add_phase

Adds a phase uniformly to every transducer in a phase buffer (wrapping at 8 bits).

Rust

add_phase(phase, &mut phases);

Python

add_phase(phase, phases)

C#

Pattern.AddPhase(phase, phases);

Parameter	Type	Description
intensity	Intensity	Intensity
phase	Phase	Phase
dst	&mut [Vec<Intensity>] / &mut [Vec<Phase>]	Target buffer (intensities for set_intensity, phases for set_phase / add_phase)

Example

Rust

use autd3_rs::geometry::{Autd3, Geometry, offset};
use autd3_rs::units::{m, mm, s};
use autd3_rs::value::{Intensity, Phase};
use autd3_rs_pattern::{add_phase, focus, set_intensity, wavelength};

let geometry = Geometry::new(vec![Autd3::default()]);

let mut phases = geometry.phase_buffer();
let mut intensities = geometry.intensity_buffer();

set_intensity(Intensity(0x80), &mut intensities);
focus(
    &geometry,
    geometry.center() + offset(0.0 * mm, 0.0 * mm, 150.0 * mm),
    wavelength(340.0 * m / s),
    &mut phases,
);
add_phase(Phase::PI, &mut phases);

set_intensity(Intensity::MIN, &mut intensities);

Python

import numpy as np
from autd3.geometry import Autd3, Geometry
from autd3.units import m, s
from autd3.value import Intensity, Phase
from autd3_pattern import add_phase, focus, set_intensity, wavelength

geometry = Geometry([Autd3([0.0, 0.0, 0.0], [1.0, 0.0, 0.0, 0.0])])

phases = geometry.phase_buffer()
intensities = geometry.intensity_buffer()

set_intensity(Intensity(0x80), intensities)
focus(
    geometry,
    geometry.center() + np.array([0.0, 0.0, 150.0]),
    wavelength(340 * m / s),
    phases,
)
add_phase(Phase.PI, phases)

set_intensity(Intensity.MIN, intensities)

C#

using System.Numerics;
using AUTD3;
using static AUTD3.Units;

var geometry = new Geometry(new[] { new Autd3(Vector3.Zero) });

var phases = geometry.PhaseBuffer();
var intensities = geometry.IntensityBuffer();

Pattern.SetIntensity(new Intensity(0x80), intensities);
Pattern.Focus(
    geometry,
    geometry.Center + new Vector3(0.0f, 0.0f, 150.0f),
    Pattern.Wavelength(340.0f * m / s),
    phases
);
Pattern.AddPhase(Phase.Pi, phases);

Pattern.SetIntensity(Intensity.Min, intensities);