Struct Image 

pub struct Image<P, S = ImageSize> { /* private fields */ }

Generic image type

The image is laid out in row-major order, and can be indexed either by a usize index or a (row, column) tuple.

       0 ------------> width (columns)
       |             |
       |             |
       |             |
       V--------------
  height (rows)

Implementations

impl<P: Send, S: ImageSizeLike + Sync> Image<P, S>

pub fn apply_effect<F: Fn(usize, usize) -> P + Send + Sync>( &mut self, f: F, threads: Option<&ThreadPool>, )

Generates an image by computing a per-pixel function

This should be called on the output image; the closure takes (x, y) tuples and is expected to capture one or more source images.

impl<P: Default + Clone, S: ImageSizeLike> Image<P, S>

pub fn new(size: S) -> Self

Builds a new image filled with P::default()

impl<P, S: Clone> Image<P, S>

pub fn size(&self) -> S

Returns the image size

pub fn map<T, F: Fn(&P) -> T>(&self, f: F) -> Image<T, S>

Generates an image by mapping a simple function over each pixel

pub fn take(self) -> (Vec<P>, S)

Decomposes the image into its components

impl<P, S: ImageSizeLike> Image<P, S>

pub fn width(&self) -> usize

Returns the image width

pub fn height(&self) -> usize

Returns the image height

impl<P, S> Image<P, S>

pub fn iter(&self) -> impl Iterator<Item = &P> + '_

Iterates over pixel values

pub fn len(&self) -> usize

Returns the number of pixels in the image

pub fn is_empty(&self) -> bool

Checks whether the image is empty

impl<P: Default + Copy + Clone> Image<P, VoxelSize>

pub fn depth(&self) -> usize

Returns the image depth in voxels

Trait Implementations

impl<P: Clone, S: Clone> Clone for Image<P, S>

fn clone(&self) -> Image<P, S>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<P, S: Default> Default for Image<P, S>

fn default() -> Self

Returns the “default value” for a type.

impl<P, S: ImageSizeLike> Index<(usize, usize)> for Image<P, S>

Indexes an image with (row, col)

type Output = P

The returned type after indexing.

fn index(&self, pos: (usize, usize)) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<P, S> Index<Range<usize>> for Image<P, S>

type Output = [P]

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<P, S> Index<RangeFrom<usize>> for Image<P, S>

type Output = [P]

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<P, S> Index<RangeFull> for Image<P, S>

type Output = [P]

The returned type after indexing.

fn index(&self, index: RangeFull) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<P, S> Index<RangeInclusive<usize>> for Image<P, S>

type Output = [P]

The returned type after indexing.

fn index(&self, index: RangeInclusive<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<P, S> Index<RangeTo<usize>> for Image<P, S>

type Output = [P]

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<P, S> Index<RangeToInclusive<usize>> for Image<P, S>

type Output = [P]

The returned type after indexing.

fn index(&self, index: RangeToInclusive<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<P, S> Index<usize> for Image<P, S>

type Output = P

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<P, S: ImageSizeLike> IndexMut<(usize, usize)> for Image<P, S>

fn index_mut(&mut self, pos: (usize, usize)) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<P, S> IndexMut<Range<usize>> for Image<P, S>

fn index_mut(&mut self, index: Range<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<P, S> IndexMut<RangeFrom<usize>> for Image<P, S>

fn index_mut(&mut self, index: RangeFrom<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<P, S> IndexMut<RangeFull> for Image<P, S>

fn index_mut(&mut self, index: RangeFull) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<P, S> IndexMut<RangeInclusive<usize>> for Image<P, S>

fn index_mut(&mut self, index: RangeInclusive<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<P, S> IndexMut<RangeTo<usize>> for Image<P, S>

fn index_mut(&mut self, index: RangeTo<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<P, S> IndexMut<RangeToInclusive<usize>> for Image<P, S>

fn index_mut(&mut self, index: RangeToInclusive<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<P, S> IndexMut<usize> for Image<P, S>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a, P: 'a, S> IntoIterator for &'a Image<P, S>

type Item = &'a P

The type of the elements being iterated over.

type IntoIter = Iter<'a, P>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<P, S> IntoIterator for Image<P, S>

type Item = P

The type of the elements being iterated over.

type IntoIter = IntoIter<P>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.