Pattern

Pattern is a command that sends the phase and intensity of each transducer to the device. The phases and intensities are passed as separate buffers.

API

Rust

Pattern::new(&phases, intensities);

Pattern::with_bank(bank, &phases, intensities);

Pattern {
    bank,
    phases: &phases,
    intensities: intensities.into(),
    transition_mode,
};

Pattern::new sets the destination bank to PatternBank::B0. To write to another bank, use Pattern::with_bank(bank, phases, intensities).

Python

Pattern(phases, intensities)

Pattern(phases, intensities, bank=bank)

Pattern(
    phases,
    intensities,
    bank=bank,
    transition_mode=transition_mode,
)

Pattern sets the destination bank to PatternBank.B0 by default. To write to another bank, use Pattern(phases, intensities, bank=bank).

C#

new Pattern(phases, intensities);

new Pattern(bank, phases, intensities);

new Pattern(
    bank: bank,
    phases: phases,
    intensities: intensities,
    transitionMode: transitionMode
);

new Pattern(phases, intensities) sets the destination bank to PatternBank.B0. To write to another bank, use new Pattern(bank, phases, intensities).

Field	Type	Default	Description
bank	PatternBank	PatternBank::B0	Bank to write to / play back
phases	&[Vec<Phase>]	—	Phases per device
intensities	PatternIntensity	—	Intensity (a uniform Intensity, or a per-device &[Vec<Intensity>] buffer)
transition_mode	TransitionMode	TransitionMode::Immediate	Behavior when switching the bank

Several helper functions are provided for computing patterns.

Equivalent Low-Level Commands

Pattern is equivalent to the three commands WritePatternBuffer + ConfigPattern + ChangePatternBank, which are fused into a single frame. The following is equivalent to Pattern { bank, phases, intensities }.

When transition_mode is TransitionMode::Later, nothing is fused: the command decomposes into the two frames WritePatternBuffer + ConfigPattern and no ChangePatternBank is sent. See the TransitionMode section of ChangePatternBank for details.

Rust

WritePatternBuffer::new(bank, 0, phases, intensities);
ConfigPattern {
    bank,
    config: SamplingConfig::new(NonZeroU16::MAX),
    size: 1,
    loop_behavior: LoopBehavior::Infinite,
};
ChangePatternBank {
    bank,
    transition_mode,
};

Python

WritePatternBuffer(
    bank=bank,
    index=0,
    phases=phases,
    intensities=intensities,
)
ConfigPattern(
    bank=bank,
    config=SamplingConfig(0xFFFF),
    size=1,
    loop_behavior=LoopBehavior.Infinite,
)
ChangePatternBank(
    bank=bank,
    transition_mode=transition_mode,
)

C#

new WritePatternBuffer(
    bank: bank,
    index: 0,
    phases: phases,
    intensities: intensities
);
new ConfigPattern(
    bank: bank,
    config: new SamplingConfig(ushort.MaxValue),
    size: 1,
    loopBehavior: LoopBehavior.Infinite
);
new ChangePatternBank(
    bank: bank,
    transitionMode: transitionMode
);

Example

Rust

use autd3_rs::commands::Pattern;
use autd3_rs::geometry::{Autd3, Geometry, offset};
use autd3_rs::units::{m, mm, s};
use autd3_rs::value::Intensity;
use autd3_rs::{Client, ClientConfig};
use autd3_rs_link_nop::Nop;
use autd3_rs_pattern::{focus, wavelength};

let geometry = Geometry::new(vec![Autd3::default()]);
let client = Client::open(&geometry, Nop, ClientConfig::default()).await?;

let mut phases = geometry.phase_buffer();
focus(
    &geometry,
    geometry.center() + offset(0.0 * mm, 0.0 * mm, 150.0 * mm),
    wavelength(340.0 * m / s),
    &mut phases,
);

let mut builder = client.datagram_builder();
builder.push(Pattern::new(&phases, Intensity::MAX));
let frames = builder.build()?;
for frame in &frames {
    client.send_checked(frame).await?;
}

client.close().await?;

Python

import asyncio

import numpy as np

from autd3 import Client, ClientConfig
from autd3.commands import Pattern
from autd3.geometry import Autd3, Geometry
from autd3.units import m, s
from autd3.value import Intensity
from autd3_link_nop import Nop
from autd3_pattern import focus, wavelength


async def main() -> None:
    geometry = Geometry([Autd3([0.0, 0.0, 0.0], [1.0, 0.0, 0.0, 0.0])])
    async with await Client.open(geometry, Nop(), ClientConfig()) as client:
        phases = geometry.phase_buffer()
        focus(
            geometry,
            geometry.center() + np.array([0.0, 0.0, 150.0]),
            wavelength(340 * m / s),
            phases,
        )

        builder = client.datagram_builder()
        builder.push(Pattern(phases, Intensity.MAX))
        frames = builder.build()
        for frame in frames:
            await client.send_checked(frame)


asyncio.run(main())

C#

using System.Numerics;
using System.Threading.Tasks;
using AUTD3;
using AUTD3.Link;
using Nop = AUTD3.Link.Nop;
using static AUTD3.Units;

var geometry = new Geometry(new[] { new Autd3(Vector3.Zero) });
await using var client = await Client.OpenAsync(geometry, new Nop(), new ClientConfig());

var phases = geometry.PhaseBuffer();
Pattern.Focus(
    geometry,
    geometry.Center + new Vector3(0.0f, 0.0f, 150.0f),
    Pattern.Wavelength(340.0f * m / s),
    phases
);

var builder = client.DatagramBuilder();
builder.Push(new Pattern(phases, Intensity.Max));
var frames = builder.Build();
foreach (var frame in frames)
{
    await client.SendCheckedAsync(frame);
}