Struct opencv::core::Mat_

pub struct Mat_<T> { /* fields omitted */ }

docs.opencv.org

This struct is freely convertible into and from Mat using into and try_from methods. You might want to convert Mat to Mat_ before calling typed methods (like at, data_typed) when more performance is required because this way you will skip the data type checks (still WIP, not all methods are covered).

Implementations

impl<T: DataType> Mat_<T>

pub fn into_untyped(self) -> Mat

pub fn as_raw_Mat_(&self) -> *const c_void

pub fn as_raw_mut_Mat_(&mut self) -> *mut c_void

pub fn at(&self, i0: i32) -> Result<&T>

pub fn at_mut(&mut self, i0: i32) -> Result<&mut T>

pub fn data_typed(&self) -> Result<&[T]>

pub fn data_typed_mut(&mut self) -> Result<&mut [T]>

Trait Implementations

impl<T> Boxed for Mat_<T>

pub unsafe fn from_raw(ptr: *mut c_void) -> Self

Wrap the specified raw pointer

pub fn into_raw(self) -> *mut c_void

Return an the underlying raw pointer while consuming this wrapper.

pub fn as_raw(&self) -> *const c_void

Return the underlying raw pointer.

pub fn as_raw_mut(&mut self) -> *mut c_void

Return the underlying mutable raw pointer

impl<T> Debug for Mat_<T>

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

Formats the value using the given formatter.

impl<T: DataType> From<Mat_<T>> for Mat

pub fn from(s: Mat_<T>) -> Self

Performs the conversion.

impl<T> MatTrait for Mat_<T>

pub fn as_raw_Mat(&self) -> *const c_void

pub fn as_raw_mut_Mat(&mut self) -> *mut c_void

pub fn flags(&self) -> i32

! includes several bit-fields:

pub fn set_flags(&mut self, val: i32)

! includes several bit-fields:

pub fn dims(&self) -> i32

the matrix dimensionality, >= 2

pub fn set_dims(&mut self, val: i32)

the matrix dimensionality, >= 2

pub fn rows(&self) -> i32

the number of rows and columns or (-1, -1) when the matrix has more than 2 dimensions

pub fn set_rows(&mut self, val: i32)

the number of rows and columns or (-1, -1) when the matrix has more than 2 dimensions

pub fn cols(&self) -> i32

the number of rows and columns or (-1, -1) when the matrix has more than 2 dimensions

pub fn set_cols(&mut self, val: i32)

the number of rows and columns or (-1, -1) when the matrix has more than 2 dimensions

pub fn data_mut(&mut self) -> &mut u8

pointer to the data

pub unsafe fn set_data(&mut self, val: &mut u8)

pointer to the data

pub fn datastart(&self) -> &u8

helper fields used in locateROI and adjustROI

pub fn dataend(&self) -> &u8

pub fn datalimit(&self) -> &u8

pub fn u(&mut self) -> UMatData

interaction with UMat

pub fn set_u(&mut self, val: &mut UMatData)

interaction with UMat

pub fn mat_size(&self) -> MatSize

pub fn mat_step(&self) -> MatStep

pub fn get_umat(
    &self,
    access_flags: AccessFlag,
    usage_flags: UMatUsageFlags
) -> Result<UMat>

retrieve UMat from Mat

pub fn row(&self, y: i32) -> Result<Mat>

Creates a matrix header for the specified matrix row.

pub fn col(&self, x: i32) -> Result<Mat>

Creates a matrix header for the specified matrix column.

pub fn row_bounds(&self, startrow: i32, endrow: i32) -> Result<Mat>

Creates a matrix header for the specified row span.

pub fn row_range(&self, r: &Range) -> Result<Mat>

Creates a matrix header for the specified row span.

pub fn col_bounds(&self, startcol: i32, endcol: i32) -> Result<Mat>

Creates a matrix header for the specified column span.

pub fn col_range(&self, r: &Range) -> Result<Mat>

Creates a matrix header for the specified column span.

pub fn diag(&self, d: i32) -> Result<Mat>

Extracts a diagonal from a matrix

pub fn try_clone(&self) -> Result<Mat>

Creates a full copy of the array and the underlying data.

pub fn copy_to(&self, m: &mut dyn ToOutputArray) -> Result<()>

Copies the matrix to another one.

pub fn copy_to_masked(
    &self,
    m: &mut dyn ToOutputArray,
    mask: &dyn ToInputArray
) -> Result<()>

Copies the matrix to another one.

pub fn convert_to(
    &self,
    m: &mut dyn ToOutputArray,
    rtype: i32,
    alpha: f64,
    beta: f64
) -> Result<()>

Converts an array to another data type with optional scaling.

pub fn assign_to(&self, m: &mut Mat, typ: i32) -> Result<()>

Provides a functional form of convertTo.

pub fn set_to(
    &mut self,
    value: &dyn ToInputArray,
    mask: &dyn ToInputArray
) -> Result<Mat>

Sets all or some of the array elements to the specified value.

pub fn reshape(&self, cn: i32, rows: i32) -> Result<Mat>

Changes the shape and/or the number of channels of a 2D matrix without copying the data.

pub fn reshape_nd(&self, cn: i32, newsz: &[i32]) -> Result<Mat>

Changes the shape and/or the number of channels of a 2D matrix without copying the data.

pub fn reshape_nd_vec(&self, cn: i32, newshape: &Vector<i32>) -> Result<Mat>

Changes the shape and/or the number of channels of a 2D matrix without copying the data.

pub fn t(&self) -> Result<MatExpr>

Transposes a matrix.

pub fn inv(&self, method: i32) -> Result<MatExpr>

Inverses a matrix.

pub fn mul(&self, m: &dyn ToInputArray, scale: f64) -> Result<MatExpr>

Performs an element-wise multiplication or division of the two matrices.

pub fn cross(&self, m: &dyn ToInputArray) -> Result<Mat>

Computes a cross-product of two 3-element vectors.

pub fn dot(&self, m: &dyn ToInputArray) -> Result<f64>

Computes a dot-product of two vectors.

pub unsafe fn create_rows_cols(
    &mut self,
    rows: i32,
    cols: i32,
    typ: i32
) -> Result<()>

Allocates new array data if needed.

pub unsafe fn create_size(&mut self, size: Size, typ: i32) -> Result<()>

Allocates new array data if needed.

pub unsafe fn create_nd(&mut self, sizes: &[i32], typ: i32) -> Result<()>

Allocates new array data if needed.

pub unsafe fn create_nd_vec(
    &mut self,
    sizes: &Vector<i32>,
    typ: i32
) -> Result<()>

Allocates new array data if needed.

pub fn addref(&mut self) -> Result<()>

Increments the reference counter.

pub fn release(&mut self) -> Result<()>

Decrements the reference counter and deallocates the matrix if needed.

pub fn deallocate(&mut self) -> Result<()>

internal use function, consider to use 'release' method instead; deallocates the matrix data

pub fn reserve(&mut self, sz: size_t) -> Result<()>

Reserves space for the certain number of rows.

pub fn reserve_buffer(&mut self, sz: size_t) -> Result<()>

Reserves space for the certain number of bytes.

pub fn resize(&mut self, sz: size_t) -> Result<()>

Changes the number of matrix rows.

pub fn resize_with_default(&mut self, sz: size_t, s: Scalar) -> Result<()>

Changes the number of matrix rows.

pub fn push_back(&mut self, m: &Mat) -> Result<()>

Adds elements to the bottom of the matrix.

pub fn pop_back(&mut self, nelems: size_t) -> Result<()>

Removes elements from the bottom of the matrix.

pub fn locate_roi(&self, whole_size: &mut Size, ofs: &mut Point) -> Result<()>

Locates the matrix header within a parent matrix.

pub fn adjust_roi(
    &mut self,
    dtop: i32,
    dbottom: i32,
    dleft: i32,
    dright: i32
) -> Result<Mat>

Adjusts a submatrix size and position within the parent matrix.

pub fn is_continuous(&self) -> Result<bool>

Reports whether the matrix is continuous or not.

pub fn is_submatrix(&self) -> Result<bool>

returns true if the matrix is a submatrix of another matrix

pub fn elem_size(&self) -> Result<size_t>

Returns the matrix element size in bytes.

pub fn elem_size1(&self) -> Result<size_t>

Returns the size of each matrix element channel in bytes.

pub fn typ(&self) -> Result<i32>

Returns the type of a matrix element.

pub fn depth(&self) -> Result<i32>

Returns the depth of a matrix element.

pub fn channels(&self) -> Result<i32>

Returns the number of matrix channels.

pub fn step1(&self, i: i32) -> Result<size_t>

Returns a normalized step.

pub fn empty(&self) -> Result<bool>

Returns true if the array has no elements.

pub fn total(&self) -> Result<size_t>

Returns the total number of array elements.

pub fn total_slice(&self, start_dim: i32, end_dim: i32) -> Result<size_t>

Returns the total number of array elements.

pub fn check_vector(
    &self,
    elem_channels: i32,
    depth: i32,
    require_continuous: bool
) -> Result<i32>

Parameters

pub unsafe fn ptr_mut(&mut self, i0: i32) -> Result<&mut u8>

Returns a pointer to the specified matrix row.

pub unsafe fn ptr(&self, i0: i32) -> Result<&u8>

Returns a pointer to the specified matrix row.

pub unsafe fn ptr_2d_mut(&mut self, row: i32, col: i32) -> Result<&mut u8>

Returns a pointer to the specified matrix row.

pub unsafe fn ptr_2d(&self, row: i32, col: i32) -> Result<&u8>

Returns a pointer to the specified matrix row.

pub unsafe fn ptr_3d_mut(
    &mut self,
    i0: i32,
    i1: i32,
    i2: i32
) -> Result<&mut u8>

Returns a pointer to the specified matrix row.

pub unsafe fn ptr_3d(&self, i0: i32, i1: i32, i2: i32) -> Result<&u8>

Returns a pointer to the specified matrix row.

pub unsafe fn ptr_nd_mut(&mut self, idx: &[i32]) -> Result<&mut u8>

Returns a pointer to the specified matrix row.

pub unsafe fn ptr_nd(&self, idx: &[i32]) -> Result<&u8>

Returns a pointer to the specified matrix row.

pub fn at_mut<T: DataType>(&mut self, i0: i32) -> Result<&mut T>

Returns a reference to the specified array element.

pub fn at<T: DataType>(&self, i0: i32) -> Result<&T>

Returns a reference to the specified array element.

pub fn at_2d_mut<T: DataType>(&mut self, row: i32, col: i32) -> Result<&mut T>

Returns a reference to the specified array element.

pub fn at_2d<T: DataType>(&self, row: i32, col: i32) -> Result<&T>

Returns a reference to the specified array element.

pub fn at_3d_mut<T: DataType>(
    &mut self,
    i0: i32,
    i1: i32,
    i2: i32
) -> Result<&mut T>

Returns a reference to the specified array element.

pub fn at_3d<T: DataType>(&self, i0: i32, i1: i32, i2: i32) -> Result<&T>

Returns a reference to the specified array element.

pub fn at_nd_mut<T: DataType>(&mut self, idx: &[i32]) -> Result<&mut T>

Returns a reference to the specified array element.

pub fn at_nd<T: DataType>(&self, idx: &[i32]) -> Result<&T>

Returns a reference to the specified array element.

pub fn at_pt_mut<T: DataType>(&mut self, pt: Point) -> Result<&mut T>

Returns a reference to the specified array element.

pub fn at_pt<T: DataType>(&self, pt: Point) -> Result<&T>

Returns a reference to the specified array element.

pub fn update_continuity_flag(&mut self) -> Result<()>

internal use method: updates the continuity flag

impl<T: DataType> TryFrom<Mat> for Mat_<T>

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(mat: Mat) -> Result<Self, Self::Error>

Performs the conversion.