Struct opencv::core::UMat

pub struct UMat { /* fields omitted */ }

@todo document

Implementations

impl UMat

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

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

impl UMat

pub fn new(usage_flags: UMatUsageFlags) -> Result<UMat>

default constructor

C++ default parameters

• 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 unsafe fn new_size(
    size: Size,
    typ: i32,
    usage_flags: UMatUsageFlags
) -> Result<UMat>

C++ default parameters

• 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_size_with_default(
    size: Size,
    typ: i32,
    s: Scalar,
    usage_flags: UMatUsageFlags
) -> Result<UMat>

C++ default parameters

• 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_with_default(
    sizes: &[i32],
    typ: i32,
    s: Scalar,
    usage_flags: UMatUsageFlags
) -> Result<UMat>

C++ default parameters

• usage_flags: USAGE_DEFAULT

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

copy constructor

pub fn rowscols(m: &UMat, row_range: &Range, col_range: &Range) -> Result<UMat>

creates a matrix header for a part of the bigger matrix

C++ default parameters

• col_range: Range::all()

pub fn roi(m: &UMat, roi: Rect) -> Result<UMat>

pub fn ranges(m: &UMat, ranges: &Vector<Range>) -> Result<UMat>

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

constructs a square diagonal matrix which main diagonal is vector "d"

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

Matlab-style matrix initialization

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

pub fn zeros_2(ndims: i32, sz: &i32, typ: i32) -> Result<UMat>

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

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

pub fn ones_2(ndims: i32, sz: &i32, typ: i32) -> Result<UMat>

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

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

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

Trait Implementations

impl Boxed for UMat

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 Clone for UMat

pub fn clone(&self) -> Self

Calls try_clone() and panics if that fails

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

Performs copy-assignment from source.

impl Drop for UMat

pub fn drop(&mut self)

Executes the destructor for this type.

impl Send for UMat

impl ToInputArray for UMat

pub fn input_array(&self) -> Result<_InputArray>

impl<'_> ToInputArray for &'_ UMat

pub fn input_array(&self) -> Result<_InputArray>

impl ToInputOutputArray for UMat

pub fn input_output_array(&mut self) -> Result<_InputOutputArray>

impl<'_> ToInputOutputArray for &'_ mut UMat

pub fn input_output_array(&mut self) -> Result<_InputOutputArray>

impl ToOutputArray for UMat

pub fn output_array(&mut self) -> Result<_OutputArray>

impl<'_> ToOutputArray for &'_ mut UMat

pub fn output_array(&mut self) -> Result<_OutputArray>

impl UMatTrait for UMat

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

pub fn as_raw_mut_UMat(&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 usage_flags(&self) -> UMatUsageFlags

pub fn set_usage_flags(&mut self, val: UMatUsageFlags)

pub fn u(&mut self) -> UMatData

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

pub fn offset(&self) -> size_t

pub fn set_offset(&mut self, val: size_t)

pub fn mat_size(&self) -> MatSize

pub fn mat_step(&self) -> MatStep

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

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

returns a new matrix header for the specified row

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

returns a new matrix header for the specified column

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

... for the specified row span

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

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

... for the specified column span

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

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

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

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

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

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

copies the matrix content to "m".

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

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

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

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

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

C++ default parameters

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

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

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

creates alternative matrix header for the same data, with different

pub fn reshape_1(&self, cn: i32, newndims: i32, newsz: &i32) -> Result<UMat>

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

matrix transposition by means of matrix expressions

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

matrix inversion by means of matrix expressions

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

per-element matrix multiplication by means of matrix expressions

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

computes dot-product

pub 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.

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

C++ default parameters

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

C++ default parameters

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

C++ default parameters

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

increases the reference counter; use with care to avoid memleaks

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

decreases reference counter;

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

deallocates the matrix data

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

locates matrix header within a parent matrix. See below

pub 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.

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

returns true iff the matrix data is continuous

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 element size in bytes,

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

returns the size of element channel in bytes.

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

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

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

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

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

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

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

returns step/elemSize1()

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

returns true if matrix data is NULL

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

returns the total number of matrix elements

pub 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

pub 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.

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

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

internal use method: updates the continuity flag

impl VectorElement for UMat where
    Vector<UMat>: VectorExtern<UMat>, 

pub fn opencv_vector_to_vec(v: &Vector<UMat>) -> Vec<UMat>