Struct ndarray_vision::core::image::Image

pub struct Image<T, C> where
    C: ColourModel,  {
    pub data: Array3<T>,
    // some fields omitted
}

Basic structure containing an image.

Fields

data: Array3<T>

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.

Methods

impl<T, C> Image<T, C> where
    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<T, C> Image<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

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

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> Image<T, C> where
    C: ColourModel, 

pub fn from_data(data: Array3<T>) -> 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<T, Ix1>

Get a view of all colour channels at a pixels location

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

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

Trait Implementations

impl<T, C> CannyEdgeDetectorExt<T> for Image<T, C> where
    T: Copy + Clone + FromPrimitive + Real + Num + NumAssignOps,
    C: ColourModel, 

type Output = Image<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<T, C> ConvolutionExt for Image<T, C> where
    T: Copy + Clone + Num + NumAssignOps,
    C: ColourModel, 

type Data = T

Underlying data type to perform the colution on

fn conv2d(&self, kernel: ArrayView3<Self::Data>) -> Result<Self, Error>

Perform a convolution returning the resultant data

fn conv2d_inplace(
    &mut self,
    kernel: ArrayView3<Self::Data>
) -> Result<(), Error>

Performs the convolution inplace mutating the containers data

impl<T, C> MedianFilterExt for Image<T, C> where
    T: Copy + Clone + FromPrimitive + ToPrimitive + Num + Ord,
    C: ColourModel, 

fn median_filter<E>(&self, region: E) -> Self where
    E: IntoDimension<Dim = Ix2>, 

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

impl<T, C> SobelExt for Image<T, C> where
    T: Copy + Clone + Num + NumAssignOps + Neg<Output = T> + FromPrimitive + Real,
    C: ColourModel, 

type Output = Array3<T>

Type to output

fn apply_sobel(&self) -> Result<Self, 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, C> HistogramEqExt<T> for Image<T, C> where
    Image<T, C>: Clone,
    T: Copy + Clone + Ord + Num + NumAssignOps + ToPrimitive + FromPrimitive + PixelBound,
    C: ColourModel, 

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

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: PartialEq, C: PartialEq> PartialEq<Image<T, C>> for Image<T, C> where
    C: ColourModel, 

fn eq(&self, other: &Image<T, C>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Image<T, C>) -> bool

This method tests for !=.

impl<T> From<Image<T, RGB>> for Image<T, HSV> where
    T: Copy + Clone + FromPrimitive + Num + NumAssignOps + NumCast + PartialOrd + Display + PixelBound, 

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

Performs the conversion.

impl<T> From<Image<T, HSV>> for Image<T, RGB> where
    T: Copy + Clone + FromPrimitive + Num + NumAssignOps + NumCast + PartialOrd + Display + PixelBound, 

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

Performs the conversion.

impl<T> From<Image<T, RGB>> for Image<T, Gray> where
    T: Copy + Clone + FromPrimitive + Num + NumAssignOps + NumCast + PartialOrd + Display + PixelBound, 

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

Performs the conversion.

impl<T> From<Image<T, Gray>> for Image<T, RGB> where
    T: Copy + Clone + FromPrimitive + Num + NumAssignOps + NumCast + PartialOrd + Display + PixelBound, 

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

Performs the conversion.

impl<T> From<Image<T, RGB>> for Image<T, CIEXYZ> where
    T: Copy + Clone + FromPrimitive + Num + NumAssignOps + NumCast + PartialOrd + Display + PixelBound, 

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

Performs the conversion.

impl<T> From<Image<T, CIEXYZ>> for Image<T, RGB> where
    T: Copy + Clone + FromPrimitive + Num + NumAssignOps + NumCast + PartialOrd + Display + PixelBound, 

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<T> From<Image<T, Generic5>> for Image<T, Generic4> where
    T: Copy, 

fn from(image: Image<T, Generic5>) -> Self

Performs the conversion.

impl<T> From<Image<T, Generic5>> for Image<T, Generic3> where
    T: Copy, 

fn from(image: Image<T, Generic5>) -> Self

Performs the conversion.

impl<T> From<Image<T, Generic5>> for Image<T, Generic2> where
    T: Copy, 

fn from(image: Image<T, Generic5>) -> Self

Performs the conversion.

impl<T> From<Image<T, Generic5>> for Image<T, Generic1> where
    T: Copy, 

fn from(image: Image<T, Generic5>) -> Self

Performs the conversion.

impl<T> From<Image<T, Generic4>> for Image<T, Generic3> where
    T: Copy, 

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

Performs the conversion.

impl<T> From<Image<T, Generic4>> for Image<T, Generic2> where
    T: Copy, 

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

Performs the conversion.

impl<T> From<Image<T, Generic4>> for Image<T, Generic1> where
    T: Copy, 

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

Performs the conversion.

impl<T> From<Image<T, Generic3>> for Image<T, Generic2> where
    T: Copy, 

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

Performs the conversion.

impl<T> From<Image<T, Generic3>> for Image<T, Generic1> where
    T: Copy, 

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

Performs the conversion.

impl<T> From<Image<T, Generic2>> for Image<T, Generic1> where
    T: Copy, 

fn from(image: Image<T, Generic2>) -> Self

Performs the conversion.

impl<T> From<Image<T, Generic1>> for Image<T, Generic5> where
    T: Copy + Num, 

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

Performs the conversion.

impl<T> From<Image<T, Generic2>> for Image<T, Generic5> where
    T: Copy + Num, 

fn from(image: Image<T, Generic2>) -> Self

Performs the conversion.

impl<T> From<Image<T, Generic3>> for Image<T, Generic5> where
    T: Copy + Num, 

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

Performs the conversion.

impl<T> From<Image<T, Generic4>> for Image<T, Generic5> where
    T: Copy + Num, 

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

Performs the conversion.

impl<T> From<Image<T, Generic1>> for Image<T, Generic4> where
    T: Copy + Num, 

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

Performs the conversion.

impl<T> From<Image<T, Generic2>> for Image<T, Generic4> where
    T: Copy + Num, 

fn from(image: Image<T, Generic2>) -> Self

Performs the conversion.

impl<T> From<Image<T, Generic3>> for Image<T, Generic4> where
    T: Copy + Num, 

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

Performs the conversion.

impl<T> From<Image<T, Generic1>> for Image<T, Generic3> where
    T: Copy + Num, 

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

Performs the conversion.

impl<T> From<Image<T, Generic2>> for Image<T, Generic3> where
    T: Copy + Num, 

fn from(image: Image<T, Generic2>) -> Self

Performs the conversion.

impl<T> From<Image<T, Generic1>> for Image<T, Generic2> where
    T: Copy + Num, 

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

Performs the conversion.

impl<T: Clone, C: Clone> Clone for Image<T, C> where
    C: ColourModel, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Eq, C: Eq> Eq for Image<T, C> where
    C: ColourModel, 

impl<T: Debug, C: Debug> Debug for Image<T, C> where
    C: ColourModel, 

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

Formats the value using the given formatter.

impl<T: Hash, C: Hash> Hash for Image<T, C> where
    C: ColourModel, 

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].