Struct MappedImageMut 

pub struct MappedImageMut<'a> { /* private fields */ }

A handle to a colour-mapped image created by mapped_image.

use ironlab::prelude::*;

let field = Matrix::from_fn(20, 30, |row, col| (row as f64 - 10.0) * (col as f64 - 15.0));
let mut fig = Figure::new();
fig.axes(0, 0)
    .mapped_image(&field)
    .plane(ImagePlane::Xz { y: Some(0.0) })
    .below(Color::BLACK)
    .above(Color::WHITE)
    .non_finite(OutOfRange::Strict);

Implementations

impl MappedImageMut<'_>

pub fn id(&self) -> NodeId

Returns the node identifier of the image.

pub fn display_name(&mut self, name: impl Into<Text>) -> &mut Self

Sets the name shown for the image in the legend.

pub fn pixel_columns(&mut self, first: f64, last: f64) -> &mut Self

Places the centres of the first and last columns of the image at the given coordinates along the first axis of its plane (MATLAB’s XData).

The pitch between centres follows from the number of columns, and the image covers half a pitch beyond each centre; a last less than first mirrors the image. Without a range the centres lie at 0, 1, …, n − 1. The coordinates must be finite and may coincide only when the image has one column, as Figure::validate checks.

pub fn pixel_rows(&mut self, first: f64, last: f64) -> &mut Self

Places the centres of the first and last rows of the image at the given coordinates along the second axis of its plane (MATLAB’s YData), as pixel_columns places the columns.

Row 0 of the pixels lies at first, so an image whose rows count down from its top is placed the right way up by a first greater than last.

pub fn plane(&mut self, plane: ImagePlane) -> &mut Self

Sets the plane of the axes in which the image lies, with its offset along the third axis.

The xz and yz planes are the walls of a three-dimensional axes, so placing the image in one of them converts a two-dimensional axes to three dimensions with the default view, as surf does; an axes that is already three-dimensional keeps its view. The xy plane never changes the projection: it is the only plane of a two-dimensional axes, which ignores its height, and the floor of a three-dimensional one.

impl MappedImageMut<'_>

pub fn below(&mut self, policy: impl Into<OutOfRange>) -> &mut Self

Sets what is drawn for a pixel whose value is less than the lower colour limit.

A Color gives the fixed-colour policy OutOfRange::Rgba. OutOfRange::Strict makes such a pixel a validation error, OutOfRange::Transparent, the default, draws nothing, and OutOfRange::Clamp draws the first entry of the colormap.

pub fn above(&mut self, policy: impl Into<OutOfRange>) -> &mut Self

Sets what is drawn for a pixel whose value is greater than the upper colour limit.

The policies are as for below, except that a clamp draws the last entry of the colormap.

pub fn non_finite(&mut self, policy: impl Into<OutOfRange>) -> &mut Self

Sets what is drawn for a pixel whose value is NaN or infinite.

The policies are as for below, except that a clamp draws nothing, because a non-finite value has no nearest end of the colormap.

Trait Implementations

impl<'a> Debug for MappedImageMut<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.