Struct opencv::core::Mat_

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

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.

Implementations

impl<T: DataType> Mat_<T>

pub fn into_untyped(self) -> Mat

pub fn as_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>

See Mat::at

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

See Mat::at_2d

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

See Mat::at_3d

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

See Mat::at_nd

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

See Mat::at_pt

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

See Mat::at_mut

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

See Mat::at_2d_mut

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

See Mat::at_3d_mut

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

See Mat::at_nd_mut

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

See Mat::at_pt_mut

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

See [Mat::data_typed]

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

See [Mat::data_typed_mut]

Trait Implementations

impl<T> Boxed for Mat_<T>

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

Wrap the specified raw pointer

fn into_raw(self) -> *mut c_void

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> *const c_void

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl<T> Debug for Mat_<T>

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl<T> MatTrait for Mat_<T>

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

fn set_flags(&mut self, val: i32)

! includes several bit-fields:

fn set_dims(&mut self, val: i32)

the matrix dimensionality, >= 2

fn set_rows(&mut self, val: i32)

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

fn set_cols(&mut self, val: i32)

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

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

pointer to the data

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

pointer to the data

fn u(&mut self) -> UMatData

interaction with UMat

fn set_u(&mut self, val: &impl UMatDataTraitConst)

interaction with UMat

fn set_size(&mut self, val: MatSize)

fn set_matexpr(&mut self, expr: &impl MatExprTraitConst) -> Result<()>

assignment operators

fn row_mut(&mut self, y: i32) -> Result<BoxedRefMut<'_, Mat>>

Creates a matrix header for the specified matrix row.

fn col_mut(&mut self, x: i32) -> Result<BoxedRefMut<'_, Mat>>

Creates a matrix header for the specified matrix column.

fn row_bounds_mut( &mut self, startrow: i32, endrow: i32 ) -> Result<BoxedRefMut<'_, Mat>>

Creates a matrix header for the specified row span.

fn row_range_mut( &mut self, r: &impl RangeTraitConst ) -> Result<BoxedRefMut<'_, Mat>>

@overload

fn col_bounds_mut( &mut self, startcol: i32, endcol: i32 ) -> Result<BoxedRefMut<'_, Mat>>

Creates a matrix header for the specified column span.

fn col_range_mut( &mut self, r: &impl RangeTraitConst ) -> Result<BoxedRefMut<'_, Mat>>

@overload

fn diag_def_mut(&mut self) -> Result<BoxedRefMut<'_, Mat>>

Extracts a diagonal from a matrix

fn diag_mut(&mut self, d: i32) -> Result<BoxedRefMut<'_, Mat>>

Extracts a diagonal from a matrix

fn set_scalar(&mut self, s: Scalar) -> Result<()>

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

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

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

fn set_to_def(&mut self, value: &impl ToInputArray) -> Result<Mat>

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

fn reshape_def_mut(&mut self, cn: i32) -> Result<BoxedRefMut<'_, Mat>>

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

fn reshape_mut(&mut self, cn: i32, rows: i32) -> Result<BoxedRefMut<'_, Mat>>

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

fn reshape_nd_mut( &mut self, cn: i32, newsz: &[i32] ) -> Result<BoxedRefMut<'_, Mat>>

@overload

fn reshape_nd_vec_mut( &mut self, cn: i32, newshape: &Vector<i32> ) -> Result<BoxedRefMut<'_, Mat>>

@overload

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

Allocates new array data if needed.

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

Allocates new array data if needed.

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

Allocates new array data if needed.

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

Allocates new array data if needed.

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

Increments the reference counter.

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

Decrements the reference counter and deallocates the matrix if needed.

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

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

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

Reserves space for the certain number of rows.

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

Reserves space for the certain number of bytes.

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

Changes the number of matrix rows.

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

Changes the number of matrix rows.

fn push_back(&mut self, m: &impl MatTraitConst) -> Result<()>

Adds elements to the bottom of the matrix.

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

Removes elements from the bottom of the matrix.

fn pop_back_def(&mut self) -> Result<()>

Removes elements from the bottom of the matrix.

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.

fn rowscols_mut( &mut self, row_range: impl RangeTrait, col_range: impl RangeTrait ) -> Result<BoxedRefMut<'_, Mat>>

Extracts a rectangular submatrix.

fn roi_mut(&mut self, roi: Rect) -> Result<BoxedRefMut<'_, Mat>>

@overload

fn ranges_mut(&mut self, ranges: &Vector<Range>) -> Result<BoxedRefMut<'_, Mat>>

@overload

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

Returns a pointer to the specified matrix row.

fn ptr_mut_def(&mut self) -> Result<*mut u8>

Returns a pointer to the specified matrix row.

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

Returns a pointer to the specified matrix row.

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

Returns a pointer to the specified matrix row.

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

Returns a pointer to the specified matrix row.

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

Returns a reference to the specified array element.

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

Returns a reference to the specified array element.

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.

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

Returns a reference to the specified array element.

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

Returns a reference to the specified array element.

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

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

internal use method: updates the continuity flag

impl<T> MatTraitConst for Mat_<T>

fn as_raw_Mat(&self) -> *const c_void

fn flags(&self) -> i32

! includes several bit-fields:

fn dims(&self) -> i32

the matrix dimensionality, >= 2

fn rows(&self) -> i32

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

fn cols(&self) -> i32

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

fn data(&self) -> *const u8

pointer to the data

fn datastart(&self) -> *const u8

helper fields used in locateROI and adjustROI

fn dataend(&self) -> *const u8

fn datalimit(&self) -> *const u8

fn mat_size(&self) -> MatSize

fn mat_step(&self) -> MatStep

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

retrieve UMat from Mat

fn get_umat_def(&self, access_flags: AccessFlag) -> Result<UMat>

retrieve UMat from Mat

fn row(&self, y: i32) -> Result<BoxedRef<'_, Mat>>

Creates a matrix header for the specified matrix row.

fn col(&self, x: i32) -> Result<BoxedRef<'_, Mat>>

Creates a matrix header for the specified matrix column.

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

Creates a matrix header for the specified row span.

fn row_range(&self, r: &impl RangeTraitConst) -> Result<BoxedRef<'_, Mat>>

Creates a matrix header for the specified row span.

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

Creates a matrix header for the specified column span.

fn col_range(&self, r: &impl RangeTraitConst) -> Result<BoxedRef<'_, Mat>>

Creates a matrix header for the specified column span.

fn diag(&self, d: i32) -> Result<BoxedRef<'_, Mat>>

Extracts a diagonal from a matrix

fn diag_def(&self) -> Result<BoxedRef<'_, Mat>>

Extracts a diagonal from a matrix

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

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

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

Copies the matrix to another one.

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

Copies the matrix to another one.

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

Converts an array to another data type with optional scaling.

fn convert_to_def(&self, m: &mut impl ToOutputArray, rtype: i32) -> Result<()>

Converts an array to another data type with optional scaling.

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

Provides a functional form of convertTo.

fn assign_to_def(&self, m: &mut impl MatTrait) -> Result<()>

Provides a functional form of convertTo.

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

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

fn reshape_def(&self, cn: i32) -> Result<BoxedRef<'_, Mat>>

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

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

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

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

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

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

Transposes a matrix.

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

Inverses a matrix.

fn inv_def(&self) -> Result<MatExpr>

Inverses a matrix.

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

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

fn mul_def(&self, m: &impl ToInputArray) -> Result<MatExpr>

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

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

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

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

Computes a dot-product of two vectors.

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

Locates the matrix header within a parent matrix.

fn rowscols( &self, row_range: impl RangeTrait, col_range: impl RangeTrait ) -> Result<BoxedRef<'_, Mat>>

Extracts a rectangular submatrix.

fn roi(&self, roi: Rect) -> Result<BoxedRef<'_, Mat>>

Extracts a rectangular submatrix.

fn ranges(&self, ranges: &Vector<Range>) -> Result<BoxedRef<'_, Mat>>

Extracts a rectangular submatrix.

fn is_continuous(&self) -> bool

Reports whether the matrix is continuous or not.

fn is_submatrix(&self) -> bool

returns true if the matrix is a submatrix of another matrix

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

Returns the matrix element size in bytes.

fn elem_size1(&self) -> size_t

Returns the size of each matrix element channel in bytes.

fn typ(&self) -> i32

Returns the type of a matrix element.

fn depth(&self) -> i32

Returns the depth of a matrix element.

fn channels(&self) -> i32

Returns the number of matrix channels.

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

Returns a normalized step.

fn step1_def(&self) -> Result<size_t>

Returns a normalized step.

fn empty(&self) -> bool

Returns true if the array has no elements.

fn total(&self) -> size_t

Returns the total number of array elements.

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

Returns the total number of array elements.

fn total_slice_def(&self, start_dim: i32) -> Result<size_t>

Returns the total number of array elements.

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

Parameters

fn check_vector_def(&self, elem_channels: i32) -> Result<i32>

Parameters

fn ptr(&self, i0: i32) -> Result<*const u8>

Returns a pointer to the specified matrix row.

fn ptr_def(&self) -> Result<*const u8>

@overload

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

Returns a pointer to the specified matrix row.

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

Returns a pointer to the specified matrix row.

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

Returns a pointer to the specified matrix row.

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

Returns a reference to the specified array element.

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

Returns a reference to the specified array element.

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

Returns a reference to the specified array element.

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

Returns a reference to the specified array element.

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

Returns a reference to the specified array element.

fn size(&self) -> Result<Size>

impl<T> ToInputArray for Mat_<T>

fn input_array(&self) -> Result<BoxedRef<'_, _InputArray>>

impl<T> ToInputOutputArray for Mat_<T>

fn input_output_array(&mut self) -> Result<BoxedRefMut<'_, _InputOutputArray>>

impl<T> ToOutputArray for Mat_<T>

fn output_array(&mut self) -> Result<BoxedRefMut<'_, _OutputArray>>

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.