plane

plane generates a plane wave propagating in the specified direction.

API

Rust

plane(&geometry, direction, wavelength, &option, &mut dst);

Python

plane(geometry, direction, wavelength, option, dst)

C#

Pattern.Plane(geometry, direction, wavelength, option, dst);

Parameter	Type	Description
geometry	&Geometry	Device layout
direction	UnitVector3<f32>	Propagation direction of the plane wave (unit vector)
wavelength	Length	Wavelength
option	&PlaneOption	Additional options (see below)
dst	&mut [[Emission; _]]	Output buffer

PlaneOption

Rust

PlaneOption {
    intensity,
    phase_offset,
}

Python

PlaneOption(
    intensity,
    phase_offset,
)

C#

new PlaneOption(
    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, Vector3};
use autd3_rs::units::{m, s};
use autd3_rs::value::{Intensity, Phase};
use autd3_rs_pattern::{PlaneOption, plane, wavelength};

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

let mut dst = geometry.pattern_buffer();

plane(
    &geometry,
    Vector3::z_axis(),
    wavelength(340.0 * m / s),
    &PlaneOption {
        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 PlaneOption, plane, wavelength

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

dst = geometry.pattern_buffer()

plane(
    geometry,
    np.array([0.0, 0.0, 1.0]),
    wavelength(340 * m / s),
    PlaneOption(
        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.Plane(
    geometry,
    Vector3.UnitZ,
    Pattern.Wavelength(340.0f * m / s),
    new PlaneOption(
        intensity: Intensity.Max,
        phaseOffset: Phase.Zero
    ),
    dst
);