Struct opencv::core::UMat

pub struct UMat { /* private fields */ }

@todo document

Implementations

impl UMat

pub fn new(usage_flags: UMatUsageFlags) -> UMat

default constructor

C++ default parameters

• usage_flags: USAGE_DEFAULT

pub fn new_def() -> UMat

default constructor

Note

This alternative version of [new] function uses the following default values for its arguments:

• usage_flags: USAGE_DEFAULT

pub unsafe fn new_rows_cols( rows: i32, cols: i32, typ: i32, usage_flags: UMatUsageFlags ) -> Result<UMat>

constructs 2D matrix of the specified size and type

C++ default parameters

• usage_flags: USAGE_DEFAULT

pub fn new_rows_cols_def(rows: i32, cols: i32, typ: i32) -> Result<UMat>

constructs 2D matrix of the specified size and type

Note

This alternative version of [new_rows_cols] function uses the following default values for its arguments:

• usage_flags: USAGE_DEFAULT

pub unsafe fn new_size( size: Size, typ: i32, usage_flags: UMatUsageFlags ) -> Result<UMat>

C++ default parameters

• usage_flags: USAGE_DEFAULT

pub fn new_size_def(size: Size, typ: i32) -> Result<UMat>

Note

This alternative version of [new_size] function uses the following default values for its arguments:

• usage_flags: USAGE_DEFAULT

pub fn new_rows_cols_with_default( rows: i32, cols: i32, typ: i32, s: Scalar, usage_flags: UMatUsageFlags ) -> Result<UMat>

constructs 2D matrix and fills it with the specified value _s.

C++ default parameters

• usage_flags: USAGE_DEFAULT

pub fn new_rows_cols_with_default_def( rows: i32, cols: i32, typ: i32, s: Scalar ) -> Result<UMat>

constructs 2D matrix and fills it with the specified value _s.

Note

This alternative version of [new_rows_cols_with_default] function uses the following default values for its arguments:

• usage_flags: USAGE_DEFAULT

pub fn new_size_with_default( size: Size, typ: i32, s: Scalar, usage_flags: UMatUsageFlags ) -> Result<UMat>

C++ default parameters

• usage_flags: USAGE_DEFAULT

pub fn new_size_with_default_def( size: Size, typ: i32, s: Scalar ) -> Result<UMat>

Note

This alternative version of [new_size_with_default] function uses the following default values for its arguments:

• usage_flags: USAGE_DEFAULT

pub unsafe fn new_nd( sizes: &[i32], typ: i32, usage_flags: UMatUsageFlags ) -> Result<UMat>

constructs n-dimensional matrix

C++ default parameters

• usage_flags: USAGE_DEFAULT

pub fn new_nd_def(sizes: &[i32], typ: i32) -> Result<UMat>

constructs n-dimensional matrix

Note

This alternative version of [new_nd] function uses the following default values for its arguments:

• usage_flags: USAGE_DEFAULT

pub fn new_nd_with_default( sizes: &[i32], typ: i32, s: Scalar, usage_flags: UMatUsageFlags ) -> Result<UMat>

C++ default parameters

• usage_flags: USAGE_DEFAULT

pub fn new_nd_with_default_def( sizes: &[i32], typ: i32, s: Scalar ) -> Result<UMat>

Note

This alternative version of [new_nd_with_default] function uses the following default values for its arguments:

• usage_flags: USAGE_DEFAULT

pub fn copy(m: &impl UMatTraitConst) -> Result<UMat>

copy constructor

pub fn rowscols<'boxed>( m: &'boxed impl UMatTraitConst, row_range: &impl RangeTraitConst, col_range: &impl RangeTraitConst ) -> Result<BoxedRef<'boxed, UMat>>

creates a matrix header for a part of the bigger matrix

C++ default parameters

• col_range: Range::all()

pub fn rowscols_def_mut<'boxed>( m: &'boxed mut impl UMatTrait, row_range: &impl RangeTraitConst ) -> Result<BoxedRefMut<'boxed, UMat>>

creates a matrix header for a part of the bigger matrix

Note

This alternative version of [rowscols] function uses the following default values for its arguments:

• col_range: Range::all()

pub fn rowscols_def<'boxed>( m: &'boxed impl UMatTraitConst, row_range: &impl RangeTraitConst ) -> Result<BoxedRef<'boxed, UMat>>

creates a matrix header for a part of the bigger matrix

Note

This alternative version of [rowscols] function uses the following default values for its arguments:

• col_range: Range::all()

pub fn rowscols_mut<'boxed>( m: &'boxed mut impl UMatTrait, row_range: &impl RangeTraitConst, col_range: &impl RangeTraitConst ) -> Result<BoxedRefMut<'boxed, UMat>>

creates a matrix header for a part of the bigger matrix

C++ default parameters

• col_range: Range::all()

pub fn roi(m: &impl UMatTraitConst, roi: Rect) -> Result<BoxedRef<'_, UMat>>

pub fn roi_mut( m: &mut impl UMatTrait, roi: Rect ) -> Result<BoxedRefMut<'_, UMat>>

pub fn ranges<'boxed>( m: &'boxed impl UMatTraitConst, ranges: &Vector<Range> ) -> Result<BoxedRef<'boxed, UMat>>

pub fn ranges_mut<'boxed>( m: &'boxed mut impl UMatTrait, ranges: &Vector<Range> ) -> Result<BoxedRefMut<'boxed, UMat>>

pub fn diag_flags( d: &impl UMatTraitConst, usage_flags: UMatUsageFlags ) -> Result<UMat>

constructs a square diagonal matrix which main diagonal is vector “d”

pub fn diag(d: &impl UMatTraitConst) -> Result<UMat>

pub fn zeros_flags( rows: i32, cols: i32, typ: i32, usage_flags: UMatUsageFlags ) -> Result<UMat>

Matlab-style matrix initialization

pub fn zeros_size_flags( size: Size, typ: i32, usage_flags: UMatUsageFlags ) -> Result<UMat>

pub fn zeros_nd_flags( sz: &[i32], typ: i32, usage_flags: UMatUsageFlags ) -> Result<UMat>

pub fn zeros(rows: i32, cols: i32, typ: i32) -> Result<UMat>

pub fn zeros_size(size: Size, typ: i32) -> Result<UMat>

pub fn zeros_nd(sz: &[i32], typ: i32) -> Result<UMat>

pub fn ones_flags( rows: i32, cols: i32, typ: i32, usage_flags: UMatUsageFlags ) -> Result<UMat>

pub fn ones_size_flags( size: Size, typ: i32, usage_flags: UMatUsageFlags ) -> Result<UMat>

pub fn ones_nd_flags( sz: &[i32], typ: i32, usage_flags: UMatUsageFlags ) -> Result<UMat>

pub fn ones(rows: i32, cols: i32, typ: i32) -> Result<UMat>

pub fn ones_size(size: Size, typ: i32) -> Result<UMat>

pub fn ones_nd(sz: &[i32], typ: i32) -> Result<UMat>

pub fn eye_flags( rows: i32, cols: i32, typ: i32, usage_flags: UMatUsageFlags ) -> Result<UMat>

pub fn eye_size_flags( size: Size, typ: i32, usage_flags: UMatUsageFlags ) -> Result<UMat>

pub fn eye(rows: i32, cols: i32, typ: i32) -> Result<UMat>

pub fn eye_size(size: Size, typ: i32) -> Result<UMat>

pub fn copy_mut(m: UMat) -> Result<UMat>

Trait Implementations

impl Boxed for UMat

unsafe fn from_raw(ptr: <UMat as OpenCVFromExtern>::ExternReceive) -> Self

Wrap the specified raw pointer

fn into_raw(self) -> <UMat as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> <UMat as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut(&mut self) -> <UMat as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Clone for UMat

fn clone(&self) -> Self

Calls try_clone() and panics if that fails

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

Performs copy-assignment from source.

impl Debug for UMat

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

Formats the value using the given formatter.

impl Drop for UMat

fn drop(&mut self)

Executes the destructor for this type.

impl ToInputArray for &UMat

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

impl ToInputArray for UMat

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

impl ToInputOutputArray for &mut UMat

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

impl ToInputOutputArray for UMat

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

impl ToOutputArray for &mut UMat

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

impl ToOutputArray for UMat

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

impl UMatTrait for UMat

fn as_raw_mut_UMat(&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)

number of rows in the matrix; -1 when the matrix has more than 2 dimensions

fn set_cols(&mut self, val: i32)

number of columns in the matrix; -1 when the matrix has more than 2 dimensions

fn set_usage_flags(&mut self, val: UMatUsageFlags)

usage flags for allocator; recommend do not set directly, instead set during construct/create/getUMat

fn u(&mut self) -> UMatData

black-box container of UMat data

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

black-box container of UMat data

fn set_offset(&mut self, val: size_t)

offset of the submatrix (or 0)

fn set_size(&mut self, val: MatSize)

dimensional size of the matrix; accessible in various formats

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

assignment operators

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

returns a new matrix header for the specified row

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

returns a new matrix header for the specified column

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

… for the specified row span

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

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

… for the specified column span

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

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

… for the specified diagonal (d=0 - the main diagonal, >0 - a diagonal from the upper half, <0 - a diagonal from the lower half)

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

… for the specified diagonal (d=0 - the main diagonal, >0 - a diagonal from the upper half, <0 - a diagonal from the lower half)

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

sets every matrix element to s

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

sets some of the matrix elements to s, according to the mask

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

sets some of the matrix elements to s, according to the mask

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

creates alternative matrix header for the same data, with different

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

creates alternative matrix header for the same data, with different

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

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

allocates new matrix data unless the matrix already has specified size and type.

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

allocates new matrix data unless the matrix already has specified size and type.

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

C++ default parameters

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

Note

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

C++ default parameters

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

Note

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

C++ default parameters

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

Note

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

increases the reference counter; use with care to avoid memleaks

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

decreases reference counter;

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

deallocates the matrix data

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

moves/resizes the current matrix ROI inside the parent matrix.

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

extracts a rectangular sub-matrix

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

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

fn set_1(&mut self, m: UMat) -> Result<()>

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

internal use method: updates the continuity flag

impl UMatTraitConst for UMat

fn as_raw_UMat(&self) -> *const c_void

fn flags(&self) -> i32

! includes several bit-fields:

fn dims(&self) -> i32

the matrix dimensionality, >= 2

fn rows(&self) -> i32

number of rows in the matrix; -1 when the matrix has more than 2 dimensions

fn cols(&self) -> i32

number of columns in the matrix; -1 when the matrix has more than 2 dimensions

fn usage_flags(&self) -> UMatUsageFlags

usage flags for allocator; recommend do not set directly, instead set during construct/create/getUMat

fn offset(&self) -> size_t

offset of the submatrix (or 0)

fn mat_size(&self) -> MatSize

dimensional size of the matrix; accessible in various formats

fn mat_step(&self) -> MatStep

number of bytes each matrix element/row/plane/dimension occupies

fn get_mat(&self, flags: AccessFlag) -> Result<Mat>

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

returns a new matrix header for the specified row

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

returns a new matrix header for the specified column

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

… for the specified row span

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

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

… for the specified column span

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

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

… for the specified diagonal (d=0 - the main diagonal, >0 - a diagonal from the upper half, <0 - a diagonal from the lower half)

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

… for the specified diagonal (d=0 - the main diagonal, >0 - a diagonal from the upper half, <0 - a diagonal from the lower half)

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

returns deep copy of the matrix, i.e. the data is copied

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

copies the matrix content to “m”.

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

copies those matrix elements to “m” that are marked with non-zero mask elements.

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

converts matrix to another datatype with optional scaling. See cvConvertScale.

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

converts matrix to another datatype with optional scaling. See cvConvertScale.

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

C++ default parameters

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

Note

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

creates alternative matrix header for the same data, with different

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

creates alternative matrix header for the same data, with different

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

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

matrix transposition by means of matrix expressions

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

matrix inversion by means of matrix expressions

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

matrix inversion by means of matrix expressions

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

per-element matrix multiplication by means of matrix expressions

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

per-element matrix multiplication by means of matrix expressions

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

computes dot-product

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

locates matrix header within a parent matrix. See below

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

extracts a rectangular sub-matrix

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

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

fn is_continuous(&self) -> bool

returns true iff the matrix data is continuous

fn is_submatrix(&self) -> bool

returns true if the matrix is a submatrix of another matrix

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

returns element size in bytes,

fn elem_size1(&self) -> size_t

returns the size of element channel in bytes.

fn typ(&self) -> i32

returns element type, similar to CV_MAT_TYPE(cvmat->type)

fn depth(&self) -> i32

returns element type, similar to CV_MAT_DEPTH(cvmat->type)

fn channels(&self) -> i32

returns element type, similar to CV_MAT_CN(cvmat->type)

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

returns step/elemSize1()

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

returns step/elemSize1()

fn empty(&self) -> bool

returns true if matrix data is NULL

fn total(&self) -> size_t

returns the total number of matrix elements

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

returns N if the matrix is 1-channel (N x ptdim) or ptdim-channel (1 x N) or (N x 1); negative number otherwise

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

returns N if the matrix is 1-channel (N x ptdim) or ptdim-channel (1 x N) or (N x 1); negative number otherwise

fn handle(&self, access_flags: AccessFlag) -> Result<*mut c_void>

! Returns the OpenCL buffer handle on which UMat operates on. The UMat instance should be kept alive during the use of the handle to prevent the buffer to be returned to the OpenCV buffer pool.

fn ndoffset(&self, ofs: &mut size_t) -> Result<()>

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

impl Send for UMat