Struct ImageBase

pub struct ImageBase<T, C>
where
    C: ColourModel,
    T: Data,
{
    pub data: ArrayBase<T, Ix3>,
    /* private fields */
}

Basic structure containing an image.

Fields

data: ArrayBase<T, Ix3>

Images are always going to be 3D to handle rows, columns and colour channels

This should allow for max compatibility with maths ops in ndarray. Caution should be taken if performing any operations that change the number of channels in an image as this may cause other functionality to perform incorrectly. Use conversions to one of the Generic colour models instead.

Implementations

impl<T, U, C> ImageBase<U, C>

where U: Data<Elem = T>, T: Copy + Clone + FromPrimitive + Num + NumCast + PixelBound, C: ColourModel,

pub fn into_type<T2>(self) -> Image<T2, C>

where T2: Copy + Clone + FromPrimitive + Num + NumCast + PixelBound,

Converts image into a different type - doesn’t scale to new pixel bounds

impl<S, T, C> ImageBase<S, C>

where S: Data<Elem = T>, T: Clone, C: ColourModel,

pub fn to_owned(&self) -> Image<T, C>

pub fn from_shape_data(rows: usize, cols: usize, data: Vec<T>) -> Image<T, C>

Given the shape of the image and a data vector create an image. If the data sizes don’t match a zero filled image will be returned instead of panicking

impl<T, C> ImageBase<OwnedRepr<T>, C>

where T: Clone + Num, C: ColourModel,

pub fn new(rows: usize, columns: usize) -> Self

Construct a new image filled with zeros using the given dimensions and a colour model

impl<T, U, C> ImageBase<T, C>

where T: Data<Elem = U>, C: ColourModel,

pub fn from_data(data: ArrayBase<T, Ix3>) -> Self

Construct the image from a given Array3

pub fn rows(&self) -> usize

Returns the number of rows in an image

pub fn cols(&self) -> usize

Returns the number of channels in an image

pub fn channels(&self) -> usize

Convenience method to get number of channels

pub fn pixel(&self, row: usize, col: usize) -> ArrayView<'_, U, Ix1>

Get a view of all colour channels at a pixels location

pub fn into_type_raw<C2>(self) -> ImageBase<T, C2>

where C2: ColourModel,

impl<T, U, C> ImageBase<T, C>

where T: DataMut<Elem = U>, C: ColourModel,

pub fn pixel_mut(&mut self, row: usize, col: usize) -> ArrayViewMut<'_, U, Ix1>

Get a mutable view of a pixels colour channels given a location

Trait Implementations

impl<T, U, C> CannyEdgeDetectorExt<T> for ImageBase<U, C>

where U: DataMut<Elem = T>, T: Copy + Clone + FromPrimitive + Real + Num + NumAssignOps, C: ColourModel,

type Output = ImageBase<OwnedRepr<bool>, C>

Output type, this is different as canny outputs a binary image

fn canny_edge_detector( &self, params: CannyParameters<T>, ) -> Result<Self::Output, Error>

Run the edge detection algorithm with the given parameters. Due to Canny being specified as working on greyscale images all current implementations assume a single channel image returning an error otherwise.

impl<S, C> Clone for ImageBase<S, C>

where S: RawDataClone + Data, C: ColourModel,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, U, C> ConvolutionExt<T> for ImageBase<U, C>

where U: DataMut<Elem = T>, T: Copy + Clone + Num + NumAssignOps, C: ColourModel,

type Output = ImageBase<OwnedRepr<T>, C>

Type for the output as data will have to be allocated

fn conv2d<B: Data<Elem = T>>( &self, kernel: ArrayBase<B, Ix3>, ) -> Result<Self::Output, Error>

Perform a convolution returning the resultant data applies the default padding of zero padding

fn conv2d_inplace<B: Data<Elem = T>>( &mut self, kernel: ArrayBase<B, Ix3>, ) -> Result<(), Error>

Performs the convolution inplace mutating the containers data applies the default padding of zero padding

fn conv2d_with_padding<B: Data<Elem = T>>( &self, kernel: ArrayBase<B, Ix3>, strategy: &impl PaddingStrategy<T>, ) -> Result<Self::Output, Error>

Perform a convolution returning the resultant data applies the default padding of zero padding

fn conv2d_inplace_with_padding<B: Data<Elem = T>>( &mut self, kernel: ArrayBase<B, Ix3>, strategy: &impl PaddingStrategy<T>, ) -> Result<(), Error>

Performs the convolution inplace mutating the containers data applies the default padding of zero padding

impl<T, U, C> Debug for ImageBase<U, C>

where U: Data<Elem = T>, T: Debug, C: ColourModel,

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

Formats the value using the given formatter.

impl<T> From<ImageBase<T, CIELAB>> for ImageBase<T, Generic3>

where T: Data,

fn from(image: ImageBase<T, CIELAB>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, CIELUV>> for ImageBase<T, Generic3>

where T: Data,

fn from(image: ImageBase<T, CIELUV>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, CIEXYZ>> for ImageBase<T, Generic3>

where T: Data,

fn from(image: ImageBase<T, CIEXYZ>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, Generic1>> for ImageBase<T, Gray>

where T: Data,

fn from(image: ImageBase<T, Generic1>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, Generic3>> for ImageBase<T, CIELAB>

where T: Data,

fn from(image: ImageBase<T, Generic3>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, Generic3>> for ImageBase<T, CIELUV>

where T: Data,

fn from(image: ImageBase<T, Generic3>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, Generic3>> for ImageBase<T, CIEXYZ>

where T: Data,

fn from(image: ImageBase<T, Generic3>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, Generic3>> for ImageBase<T, HSI>

where T: Data,

fn from(image: ImageBase<T, Generic3>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, Generic3>> for ImageBase<T, HSL>

where T: Data,

fn from(image: ImageBase<T, Generic3>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, Generic3>> for ImageBase<T, HSV>

where T: Data,

fn from(image: ImageBase<T, Generic3>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, Generic3>> for ImageBase<T, RGB>

where T: Data,

fn from(image: ImageBase<T, Generic3>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, Generic3>> for ImageBase<T, YCrCb>

where T: Data,

fn from(image: ImageBase<T, Generic3>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, Generic4>> for ImageBase<T, RGBA>

where T: Data,

fn from(image: ImageBase<T, Generic4>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, Gray>> for ImageBase<T, Generic1>

where T: Data,

fn from(image: ImageBase<T, Gray>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, HSI>> for ImageBase<T, Generic3>

where T: Data,

fn from(image: ImageBase<T, HSI>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, HSL>> for ImageBase<T, Generic3>

where T: Data,

fn from(image: ImageBase<T, HSL>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, HSV>> for ImageBase<T, Generic3>

where T: Data,

fn from(image: ImageBase<T, HSV>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, RGB>> for ImageBase<T, Generic3>

where T: Data,

fn from(image: ImageBase<T, RGB>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, RGBA>> for ImageBase<T, Generic4>

where T: Data,

fn from(image: ImageBase<T, RGBA>) -> Self

Converts to this type from the input type.

impl<T> From<ImageBase<T, YCrCb>> for ImageBase<T, Generic3>

where T: Data,

fn from(image: ImageBase<T, YCrCb>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, CIEXYZ>> for Image<T, RGB>

where U: Data<Elem = T>, T: Copy + Clone + FromPrimitive + Num + NumAssignOps + NumCast + PartialOrd + Display + PixelBound,

fn from(image: ImageBase<U, CIEXYZ>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic1>> for Image<T, Generic2>

where U: Data<Elem = T>, T: Copy + Num,

fn from(image: ImageBase<U, Generic1>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic1>> for Image<T, Generic3>

where U: Data<Elem = T>, T: Copy + Num,

fn from(image: ImageBase<U, Generic1>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic1>> for Image<T, Generic4>

where U: Data<Elem = T>, T: Copy + Num,

fn from(image: ImageBase<U, Generic1>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic1>> for Image<T, Generic5>

where U: Data<Elem = T>, T: Copy + Num,

fn from(image: ImageBase<U, Generic1>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic2>> for Image<T, Generic1>

where U: Data<Elem = T>, T: Copy,

fn from(image: ImageBase<U, Generic2>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic2>> for Image<T, Generic3>

where U: Data<Elem = T>, T: Copy + Num,

fn from(image: ImageBase<U, Generic2>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic2>> for Image<T, Generic4>

where U: Data<Elem = T>, T: Copy + Num,

fn from(image: ImageBase<U, Generic2>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic2>> for Image<T, Generic5>

where U: Data<Elem = T>, T: Copy + Num,

fn from(image: ImageBase<U, Generic2>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic3>> for Image<T, Generic1>

where U: Data<Elem = T>, T: Copy,

fn from(image: ImageBase<U, Generic3>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic3>> for Image<T, Generic2>

where U: Data<Elem = T>, T: Copy,

fn from(image: ImageBase<U, Generic3>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic3>> for Image<T, Generic4>

where U: Data<Elem = T>, T: Copy + Num,

fn from(image: ImageBase<U, Generic3>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic3>> for Image<T, Generic5>

where U: Data<Elem = T>, T: Copy + Num,

fn from(image: ImageBase<U, Generic3>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic4>> for Image<T, Generic1>

where U: Data<Elem = T>, T: Copy,

fn from(image: ImageBase<U, Generic4>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic4>> for Image<T, Generic2>

where U: Data<Elem = T>, T: Copy,

fn from(image: ImageBase<U, Generic4>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic4>> for Image<T, Generic3>

where U: Data<Elem = T>, T: Copy,

fn from(image: ImageBase<U, Generic4>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic4>> for Image<T, Generic5>

where U: Data<Elem = T>, T: Copy + Num,

fn from(image: ImageBase<U, Generic4>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic5>> for Image<T, Generic1>

where U: Data<Elem = T>, T: Copy,

fn from(image: ImageBase<U, Generic5>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic5>> for Image<T, Generic2>

where U: Data<Elem = T>, T: Copy,

fn from(image: ImageBase<U, Generic5>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic5>> for Image<T, Generic3>

where U: Data<Elem = T>, T: Copy,

fn from(image: ImageBase<U, Generic5>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Generic5>> for Image<T, Generic4>

where U: Data<Elem = T>, T: Copy,

fn from(image: ImageBase<U, Generic5>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, Gray>> for Image<T, RGB>

where U: Data<Elem = T>, T: Copy + Clone + FromPrimitive + Num + NumAssignOps + NumCast + PartialOrd + Display + PixelBound,

fn from(image: ImageBase<U, Gray>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, HSV>> for Image<T, RGB>

where U: Data<Elem = T>, T: Copy + Clone + FromPrimitive + Num + NumAssignOps + NumCast + PartialOrd + Display + PixelBound,

fn from(image: ImageBase<U, HSV>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, RGB>> for Image<T, CIEXYZ>

where U: Data<Elem = T>, T: Copy + Clone + FromPrimitive + Num + NumAssignOps + NumCast + PartialOrd + Display + PixelBound,

fn from(image: ImageBase<U, RGB>) -> Self

Converts to this type from the input type.

impl<T, U> From<ImageBase<U, RGB>> for Image<T, Gray>

where U: Data<Elem = T>, T: Copy + Clone + FromPrimitive + Num + NumAssignOps + NumCast + PartialOrd + Display + PixelBound,

fn from(image: ImageBase<U, RGB>) -> Self

Converts to this type from the input type.

impl<U, T> From<ImageBase<U, RGB>> for Image<T, HSV>

where U: Data<Elem = T>, T: Copy + Clone + FromPrimitive + Num + NumAssignOps + NumCast + PartialOrd + Display + PixelBound,

fn from(image: ImageBase<U, RGB>) -> Self

Converts to this type from the input type.

impl<'a, S, C> Hash for ImageBase<S, C>

where S: Data, S::Elem: Hash, C: ColourModel,

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, U, C> HistogramEqExt<T> for ImageBase<U, C>

where U: DataMut<Elem = T>, T: Copy + Clone + Ord + Num + NumAssignOps + ToPrimitive + FromPrimitive + PixelBound, C: ColourModel,

type Output = ImageBase<OwnedRepr<T>, C>

fn equalise_hist(&self, grid: Grid<T>) -> Self::Output

Equalises an image histogram returning a new image. Grids should be for a 1xN image as the image is flattened during processing

fn equalise_hist_inplace(&mut self, grid: Grid<T>)

Equalises an image histogram inplace Grids should be for a 1xN image as the image is flattened during processing

impl<T, U, C> MedianFilterExt for ImageBase<U, C>

where U: Data<Elem = T>, T: Copy + Clone + FromPrimitive + ToPrimitive + Num + Ord, C: ColourModel,

type Output = ImageBase<OwnedRepr<T>, C>

fn median_filter<E>(&self, region: E) -> Self::Output

where E: IntoDimension<Dim = Ix2>,

Run the median filter given the region. Median is assumed to be calculated independently for each channel.

impl<U, C> MorphologyExt for ImageBase<U, C>

where U: DataMut<Elem = bool>, C: ColourModel,

type Output = ImageBase<OwnedRepr<bool>, C>

fn erode(&self, kernel: ArrayView2<'_, bool>) -> Self::Output

fn erode_inplace(&mut self, kernel: ArrayView2<'_, bool>)

fn dilate(&self, kernel: ArrayView2<'_, bool>) -> Self::Output

fn dilate_inplace(&mut self, kernel: ArrayView2<'_, bool>)

fn union(&self, other: &Self) -> Self::Output

fn union_inplace(&mut self, other: &Self)

fn intersection(&self, other: &Self) -> Self::Output

fn intersection_inplace(&mut self, other: &Self)

impl<T, U, C> PaddingExt<T> for ImageBase<U, C>

where U: Data<Elem = T>, T: Copy, C: ColourModel,

type Output = ImageBase<OwnedRepr<T>, C>

Type of the output image

fn pad( &self, padding: (usize, usize), strategy: &dyn PaddingStrategy<T>, ) -> Self::Output

Pad the object with the given padding and strategy

impl<T, U, C> PartialEq for ImageBase<U, C>

where U: Data<Elem = T>, T: PartialEq, C: ColourModel,

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, U, C> SobelExt for ImageBase<U, C>

where U: DataMut<Elem = T>, T: Copy + Clone + Num + NumAssignOps + Neg<Output = T> + FromPrimitive + Real, C: ColourModel,

type Output = ImageBase<OwnedRepr<T>, C>

Type to output

fn apply_sobel(&self) -> Result<Self::Output, Error>

Returns the magnitude output of the sobel - an image of only lines

fn full_sobel(&self) -> Result<(Self::Output, Self::Output), Error>

Returns the magntitude and rotation outputs for use in other algorithms like the Canny edge detector. Rotation is in radians

impl<T, U, C> ThresholdApplyExt<T> for ImageBase<U, C>

where U: Data<Elem = T>, Image<U, C>: Clone, T: Copy + Clone + Ord + Num + NumAssignOps + ToPrimitive + FromPrimitive + PixelBound, C: ColourModel,

type Output = ImageBase<OwnedRepr<bool>, C>

The output is a binary image.

fn threshold_apply(&self, lower: f64, upper: f64) -> Result<Self::Output, Error>

Apply the threshold with the given limits.

impl<T, U, C> ThresholdMeanExt<T> for ImageBase<U, C>

where U: Data<Elem = T>, Image<U, C>: Clone, T: Copy + Clone + Ord + Num + NumAssignOps + ToPrimitive + FromPrimitive + PixelBound, C: ColourModel,

type Output = ImageBase<OwnedRepr<bool>, C>

The Mean thresholding output is a binary image.

fn threshold_mean(&self) -> Result<Self::Output, Error>

Run the Mean threshold algorithm.

impl<T, U, C> ThresholdOtsuExt<T> for ImageBase<U, C>

where U: Data<Elem = T>, Image<U, C>: Clone, T: Copy + Clone + Ord + Num + NumAssignOps + ToPrimitive + FromPrimitive + PixelBound, C: ColourModel,

type Output = ImageBase<OwnedRepr<bool>, C>

The Otsu thresholding output is a binary image.

fn threshold_otsu(&self) -> Result<Self::Output, Error>

Run the Otsu threshold algorithm.

impl<T, U, C, V> TransformExt<V> for ImageBase<U, C>

where U: Data<Elem = T>, T: Copy + Clone + Num + NumAssignOps, C: ColourModel, V: Transform,

type Output = ImageBase<OwnedRepr<T>, C>

Output type for the operation

fn transform( &self, transform: &V, output_size: Option<(usize, usize)>, ) -> Result<Self::Output, TransformError>

Transforms an image given the transformation matrix and output size. Uses the source index coordinate space Assume nearest-neighbour interpolation