Struct Monitor

pub struct Monitor<D: Directivity, B: Backend> { /* private fields */ }

Link to monitoring the status of AUTD and acoustic field

Implementations

impl<B: Backend> Monitor<Sphere, B>

pub fn new() -> Self

impl Monitor<Sphere, PlottersBackend>

pub fn plotters() -> Self

Constructor with Plotters backend

impl Monitor<Sphere, NullBackend>

pub fn null() -> Self

Constructor with Null backend

impl<D: Directivity, B: Backend> Monitor<D, B>

pub fn with_directivity<U: Directivity>(self) -> Monitor<U, B>

Set directivity

impl<D: Directivity, B: Backend> Monitor<D, B>

pub fn phases_of(&self, idx: usize) -> Vec<f64>

Get phases of transducers

Arguments

• idx - Index of STM. If you use Gain, this value should be 0.

pub fn duties_of(&self, idx: usize) -> Vec<f64>

Get duty ratios of transducers

Arguments

• idx - Index of STM. If you use Gain, this value should be 0.

pub fn phases(&self) -> Vec<f64>

Get phases of transducers

pub fn duties(&self) -> Vec<f64>

Get duty ratios of transducers

pub fn modulation_raw(&self) -> Vec<f64>

Get raw modulation data

pub fn modulation(&self) -> Vec<f64>

Get modulation data

pub fn calc_field<T: Transducer, I: IntoIterator<Item = Vector3>>( &self, observe_points: I, geometry: &Geometry<T>, ) -> Vec<Complex>

Calculate acoustic field at specified points

Arguments

• observe_points - Observe points iterator
• geometry - Geometry

pub fn calc_field_of<T: Transducer, I: IntoIterator<Item = Vector3>>( &self, observe_points: I, geometry: &Geometry<T>, idx: usize, ) -> Vec<Complex>

Calculate acoustic field at specified points

Arguments

• observe_points - Observe points iterator
• geometry - Geometry
• idx - Index of STM. If you use Gain, this value should be 0.

pub fn plot_field<T: Transducer>( &self, range: PlotRange, config: B::PlotConfig, geometry: &Geometry<T>, ) -> Result<(), MonitorError>

Plot acoustic field

Arguments

• range - Plot range
• config - Plot configuration
• geometry - Geometry

pub fn plot_field_of<T: Transducer>( &self, range: PlotRange, config: B::PlotConfig, geometry: &Geometry<T>, idx: usize, ) -> Result<(), MonitorError>

Plot acoustic field

Arguments

• range - Plot range
• config - Plot configuration
• geometry - Geometry
• idx - Index of STM. If you use Gain, this value should be 0.

pub fn plot_phase<T: Transducer>( &self, config: B::PlotConfig, geometry: &Geometry<T>, ) -> Result<(), MonitorError>

Plot transducers with phases

Arguments

• config - Plot configuration
• geometry - Geometry

pub fn plot_phase_of<T: Transducer>( &self, config: B::PlotConfig, geometry: &Geometry<T>, idx: usize, ) -> Result<(), MonitorError>

Plot transducers with phases

Arguments

• config - Plot configuration
• geometry - Geometry
• idx - Index of STM. If you use Gain, this value should be 0.

pub fn plot_modulation(&self, config: B::PlotConfig) -> Result<(), MonitorError>

Plot modulation data

pub fn plot_modulation_raw( &self, config: B::PlotConfig, ) -> Result<(), MonitorError>

Plot raw modulation data

pub fn begin_animation(&self)

Begin acoustic field animation

From this call, the monitor will record the drive data until end_animation is called.

pub fn end_animation<T: Transducer>( &self, range: PlotRange, config: B::PlotConfig, geometry: &Geometry<T>, ) -> Result<(), MonitorError>

End acoustic field animation and plot the result

Trait Implementations

impl Default for Monitor<Sphere, PlottersBackend>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Transducer, D: Directivity, B: Backend> Link<T> for Monitor<D, B>

fn open(&mut self, geometry: &Geometry<T>) -> Result<(), AUTDInternalError>

Open link

fn close(&mut self) -> Result<(), AUTDInternalError>

Close link

fn send(&mut self, tx: &TxDatagram) -> Result<bool, AUTDInternalError>

Send data to devices

fn receive(&mut self, rx: &mut RxDatagram) -> Result<bool, AUTDInternalError>

Receive data from devices

fn is_open(&self) -> bool

Check if link is open

fn timeout(&self) -> Duration

Get timeout

fn send_receive( &mut self, tx: &TxDatagram, rx: &mut RxDatagram, timeout: Duration, ) -> Result<bool, AUTDInternalError>

Send and receive data

fn wait_msg_processed( &mut self, msg_id: u8, rx: &mut RxDatagram, timeout: Duration, ) -> Result<bool, AUTDInternalError>

Wait until message is processed