focus

focus generates a single focal point.

API

Rust

focus(&geometry, target, wavelength, &option, &mut dst);

Python

focus(geometry, target, wavelength, option, dst)

C#

Pattern.Focus(geometry, target, wavelength, option, dst);

Parameter	Type	Description
geometry	&Geometry	Device layout
target	Point3<f32>	Focal point coordinates [mm]
wavelength	Length	Wavelength
option	&FocusOption	Additional options (see below)
dst	&mut [[Emission; _]]	Output buffer

FocusOption

Rust

FocusOption {
    intensity,
    phase_offset,
}

Python

FocusOption(
    intensity,
    phase_offset,
)

C#

new FocusOption(
    intensity,
    phaseOffset
)

Field	Type	Default	Description
intensity	Intensity	Intensity::MAX	Amplitude of all transducers
phase_offset	Phase	Phase::ZERO	Phase added uniformly to all transducers

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::{FocusOption, focus, wavelength};

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

let mut dst = geometry.pattern_buffer();

focus(
    &geometry,
    geometry.center() + offset(0.0 * mm, 0.0 * mm, 150.0 * mm),
    wavelength(340.0 * m / s),
    &FocusOption {
        intensity: Intensity::MAX,
        phase_offset: Phase::ZERO,
    },
    &mut dst,
);

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 FocusOption, focus, wavelength

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

dst = geometry.pattern_buffer()

focus(
    geometry,
    geometry.center() + np.array([0.0, 0.0, 150.0]),
    wavelength(340 * m / s),
    FocusOption(
        intensity=Intensity.MAX,
        phase_offset=Phase.ZERO,
    ),
    dst,
)

C#

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

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

var dst = geometry.PatternBuffer();

Pattern.Focus(
    geometry,
    geometry.Center + new Vector3(0.0f, 0.0f, 150.0f),
    Pattern.Wavelength(340.0f * m / s),
    new FocusOption(
        intensity: Intensity.Max,
        phaseOffset: Phase.Zero
    ),
    dst
);