Struct autd3_link_visualizer::Visualizer
source · pub struct Visualizer<D: Directivity, B: Backend> { /* private fields */ }
Expand description
Link to monitoring the status of AUTD and acoustic field
Implementations§
source§impl Visualizer<Sphere, PlottersBackend>
impl Visualizer<Sphere, PlottersBackend>
pub fn builder() -> VisualizerBuilder<Sphere, PlottersBackend>
source§impl Visualizer<Sphere, PlottersBackend>
impl Visualizer<Sphere, PlottersBackend>
sourcepub fn plotters() -> VisualizerBuilder<Sphere, PlottersBackend>
pub fn plotters() -> VisualizerBuilder<Sphere, PlottersBackend>
Constructor with Plotters backend
source§impl Visualizer<Sphere, NullBackend>
impl Visualizer<Sphere, NullBackend>
sourcepub fn null() -> VisualizerBuilder<Sphere, NullBackend>
pub fn null() -> VisualizerBuilder<Sphere, NullBackend>
Constructor with Null backend
source§impl<D: Directivity, B: Backend> Visualizer<D, B>
impl<D: Directivity, B: Backend> Visualizer<D, B>
sourcepub fn duties_of(&self, idx: usize) -> Vec<f64>
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.
sourcepub fn modulation_raw(&self) -> Vec<f64>
pub fn modulation_raw(&self) -> Vec<f64>
Get raw modulation data
sourcepub fn modulation(&self) -> Vec<f64>
pub fn modulation(&self) -> Vec<f64>
Get modulation data
sourcepub fn calc_field<'a, T: Transducer, I: IntoIterator<Item = &'a Vector3>>(
&self,
observe_points: I,
geometry: &Geometry<T>
) -> Vec<Complex>
pub fn calc_field<'a, T: Transducer, I: IntoIterator<Item = &'a Vector3>>( &self, observe_points: I, geometry: &Geometry<T> ) -> Vec<Complex>
Calculate acoustic field at specified points
Arguments
observe_points
- Observe points iteratorgeometry
- Geometry
sourcepub fn calc_field_of<'a, T: Transducer, I: IntoIterator<Item = &'a Vector3>>(
&self,
observe_points: I,
geometry: &Geometry<T>,
idx: usize
) -> Vec<Complex>
pub fn calc_field_of<'a, T: Transducer, I: IntoIterator<Item = &'a Vector3>>( &self, observe_points: I, geometry: &Geometry<T>, idx: usize ) -> Vec<Complex>
Calculate acoustic field at specified points
Arguments
observe_points
- Observe points iteratorgeometry
- Geometryidx
- Index of STM. If you use Gain, this value should be 0.
sourcepub fn plot_field<T: Transducer>(
&self,
config: B::PlotConfig,
range: PlotRange,
geometry: &Geometry<T>
) -> Result<(), VisualizerError>
pub fn plot_field<T: Transducer>( &self, config: B::PlotConfig, range: PlotRange, geometry: &Geometry<T> ) -> Result<(), VisualizerError>
sourcepub fn plot_field_of<T: Transducer>(
&self,
config: B::PlotConfig,
range: PlotRange,
geometry: &Geometry<T>,
idx: usize
) -> Result<(), VisualizerError>
pub fn plot_field_of<T: Transducer>( &self, config: B::PlotConfig, range: PlotRange, geometry: &Geometry<T>, idx: usize ) -> Result<(), VisualizerError>
Plot acoustic field
Arguments
config
- Plot configurationrange
- Plot rangegeometry
- Geometryidx
- Index of STM. If you use Gain, this value should be 0.
sourcepub fn plot_phase<T: Transducer>(
&self,
config: B::PlotConfig,
geometry: &Geometry<T>
) -> Result<(), VisualizerError>
pub fn plot_phase<T: Transducer>( &self, config: B::PlotConfig, geometry: &Geometry<T> ) -> Result<(), VisualizerError>
sourcepub fn plot_phase_of<T: Transducer>(
&self,
config: B::PlotConfig,
geometry: &Geometry<T>,
idx: usize
) -> Result<(), VisualizerError>
pub fn plot_phase_of<T: Transducer>( &self, config: B::PlotConfig, geometry: &Geometry<T>, idx: usize ) -> Result<(), VisualizerError>
Plot transducers with phases
Arguments
config
- Plot configurationgeometry
- Geometryidx
- Index of STM. If you use Gain, this value should be 0.
sourcepub fn plot_modulation(
&self,
config: B::PlotConfig
) -> Result<(), VisualizerError>
pub fn plot_modulation( &self, config: B::PlotConfig ) -> Result<(), VisualizerError>
Plot modulation data
sourcepub fn plot_modulation_raw(
&self,
config: B::PlotConfig
) -> Result<(), VisualizerError>
pub fn plot_modulation_raw( &self, config: B::PlotConfig ) -> Result<(), VisualizerError>
Plot raw modulation data
Trait Implementations§
source§impl<D: Directivity, B: Backend> Link for Visualizer<D, B>
impl<D: Directivity, B: Backend> Link for Visualizer<D, B>
source§fn send(&mut self, tx: &TxDatagram) -> Result<bool, AUTDInternalError>
fn send(&mut self, tx: &TxDatagram) -> Result<bool, AUTDInternalError>
Send data to devices
source§fn receive(&mut self, rx: &mut [RxMessage]) -> Result<bool, AUTDInternalError>
fn receive(&mut self, rx: &mut [RxMessage]) -> Result<bool, AUTDInternalError>
Receive data from devices
source§fn send_receive(
&mut self,
tx: &TxDatagram,
rx: &mut [RxMessage],
timeout: Option<Duration>
) -> Result<bool, AUTDInternalError>
fn send_receive( &mut self, tx: &TxDatagram, rx: &mut [RxMessage], timeout: Option<Duration> ) -> Result<bool, AUTDInternalError>
Send and receive data
source§fn wait_msg_processed(
&mut self,
tx: &TxDatagram,
rx: &mut [RxMessage],
timeout: Duration
) -> Result<bool, AUTDInternalError>
fn wait_msg_processed( &mut self, tx: &TxDatagram, rx: &mut [RxMessage], timeout: Duration ) -> Result<bool, AUTDInternalError>
Wait until message is processed
Auto Trait Implementations§
impl<D, B> RefUnwindSafe for Visualizer<D, B>where B: RefUnwindSafe, D: RefUnwindSafe,
impl<D, B> Send for Visualizer<D, B>
impl<D, B> Sync for Visualizer<D, B>
impl<D, B> Unpin for Visualizer<D, B>where B: Unpin, D: Unpin,
impl<D, B> UnwindSafe for Visualizer<D, B>where B: UnwindSafe, D: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,
Causes
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,
Causes
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,
Causes
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,
Causes
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,
Causes
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,
Causes
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,
Causes
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,
Causes
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,
Borrows
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,
Mutably borrows
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,
Borrows
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,
Mutably borrows
self
, then passes self.as_mut()
into the pipe
function.§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
Immutable access to the
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
Mutable access to the
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
Immutable access to the
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
Mutable access to the
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,
Immutable access to the
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,
Mutable access to the
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
Calls
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
Calls
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds.