Struct opencv::core::GpuMatND

pub struct GpuMatND { /* private fields */ }

Implementations

impl GpuMatND

pub fn default() -> Result<GpuMatND>

default constructor

pub fn new(size: GpuMatND_SizeArray, typ: i32) -> Result<GpuMatND>

default constructor

Overloaded parameters

Parameters

• size: Array of integers specifying an n-dimensional array shape.
• type: Array type. Use CV_8UC1, …, CV_16FC4 to create 1-4 channel matrices, or CV_8UC(n), …, CV_64FC(n) to create multi-channel (up to CV_CN_MAX channels) matrices.

pub unsafe fn new_1( size: GpuMatND_SizeArray, typ: i32, data: *mut c_void, step: GpuMatND_StepArray ) -> Result<GpuMatND>

default constructor

Overloaded parameters

Parameters

• size: Array of integers specifying an n-dimensional array shape.
• type: Array type. Use CV_8UC1, …, CV_16FC4 to create 1-4 channel matrices, or CV_8UC(n), …, CV_64FC(n) to create multi-channel (up to CV_CN_MAX channels) matrices.
• data: Pointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data. Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied. This operation is very efficient and can be used to process external data using OpenCV functions. The external data is not automatically deallocated, so you should take care of it.
• step: Array of _size.size()-1 steps in case of a multi-dimensional array (the last step is always set to the element size). If not specified, the matrix is assumed to be continuous.

C++ default parameters

• step: StepArray()

pub unsafe fn new_def( size: GpuMatND_SizeArray, typ: i32, data: *mut c_void ) -> Result<GpuMatND>

@overload

Parameters

• size: Array of integers specifying an n-dimensional array shape.
• type: Array type. Use CV_8UC1, …, CV_16FC4 to create 1-4 channel matrices, or CV_8UC(n), …, CV_64FC(n) to create multi-channel (up to CV_CN_MAX channels) matrices.
• data: Pointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data. Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied. This operation is very efficient and can be used to process external data using OpenCV functions. The external data is not automatically deallocated, so you should take care of it.
• step: Array of _size.size()-1 steps in case of a multi-dimensional array (the last step is always set to the element size). If not specified, the matrix is assumed to be continuous.

Note

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

• step: StepArray()

pub fn copy(unnamed: &impl GpuMatNDTraitConst) -> GpuMatND

pub fn copy_mut(unnamed: GpuMatND) -> GpuMatND

Trait Implementations

impl Boxed for GpuMatND

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Clone for GpuMatND

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 GpuMatND

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

Formats the value using the given formatter.

impl Drop for GpuMatND

fn drop(&mut self)

Executes the destructor for this type.

impl GpuMatNDTrait for GpuMatND

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

fn set_flags(&mut self, val: i32)

! includes several bit-fields:

fn set_dims(&mut self, val: i32)

matrix dimensionality

fn set_size(&mut self, val: GpuMatND_SizeArray)

shape of this array

fn set_step(&mut self, val: GpuMatND_StepArray)

! step values Their semantics is identical to the semantics of step for Mat.

fn create(&mut self, size: GpuMatND_SizeArray, typ: i32) -> Result<()>

Allocates GPU memory. Suppose there is some GPU memory already allocated. In that case, this method may choose to reuse that GPU memory under the specific condition: it must be of the same size and type, not externally allocated, the GPU memory is continuous(i.e., isContinuous() is true), and is not a sub-matrix of another GpuMatND (i.e., isSubmatrix() is false). In other words, this method guarantees that the GPU memory allocated by this method is always continuous and is not a sub-region of another GpuMatND.

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

fn swap(&mut self, m: &mut impl GpuMatNDTrait)

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

Extracts a sub-matrix. The operator makes a new header for the specified sub-array of *this. The operator is an O(1) operation, that is, no matrix data is copied.

fn create_gpu_mat_header_mut( &mut self, idx: GpuMatND_IndexArray, row_range: impl RangeTrait, col_range: impl RangeTrait ) -> Result<BoxedRefMut<'_, GpuMat>>

Creates a GpuMat header for a 2D plane part of an n-dim matrix.

fn create_gpu_mat_header_mut_1(&mut self) -> Result<BoxedRefMut<'_, GpuMat>>

@overload Creates a GpuMat header if this GpuMatND is effectively 2D.

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

Extracts a 2D plane part of an n-dim matrix. It differs from createGpuMatHeader(IndexArray, Range, Range) in that it clones a part of this GpuMatND to the returned GpuMat.

fn set(&mut self, unnamed: &impl GpuMatNDTraitConst)

fn set_1(&mut self, unnamed: GpuMatND)

fn upload(&mut self, src: &impl ToInputArray) -> Result<()>

fn upload_1( &mut self, src: &impl ToInputArray, stream: &mut impl StreamTrait ) -> Result<()>

impl GpuMatNDTraitConst for GpuMatND

fn as_raw_GpuMatND(&self) -> *const c_void

fn flags(&self) -> i32

! includes several bit-fields:

fn dims(&self) -> i32

matrix dimensionality

fn size(&self) -> GpuMatND_SizeArray

shape of this array

fn step(&self) -> GpuMatND_StepArray

! step values Their semantics is identical to the semantics of step for Mat.

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

Creates a full copy of the array and the underlying data. The method creates a full copy of the array. It mimics the behavior of Mat::clone(), i.e. the original step is not taken into account. So, the array copy is a continuous array occupying total()*elemSize() bytes.

fn clone(&self, stream: &mut impl StreamTrait) -> Result<GpuMatND>

Creates a full copy of the array and the underlying data. The method creates a full copy of the array. It mimics the behavior of Mat::clone(), i.e. the original step is not taken into account. So, the array copy is a continuous array occupying total()*elemSize() bytes.

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

Extracts a sub-matrix. The operator makes a new header for the specified sub-array of *this. The operator is an O(1) operation, that is, no matrix data is copied.

fn create_gpu_mat_header( &self, idx: GpuMatND_IndexArray, row_range: impl RangeTrait, col_range: impl RangeTrait ) -> Result<BoxedRef<'_, GpuMat>>

Creates a GpuMat header for a 2D plane part of an n-dim matrix.

fn create_gpu_mat_header_1(&self) -> Result<BoxedRef<'_, GpuMat>>

Creates a GpuMat header for a 2D plane part of an n-dim matrix.

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

Extracts a 2D plane part of an n-dim matrix. It differs from createGpuMatHeader(IndexArray, Range, Range) in that it clones a part of this GpuMatND to the returned GpuMat.

fn to_gpu_mat(&self) -> Result<GpuMat>

Extracts a 2D plane part of an n-dim matrix if this GpuMatND is effectively 2D. It differs from createGpuMatHeader() in that it clones a part of this GpuMatND.

fn download(&self, dst: &mut impl ToOutputArray) -> Result<()>

fn download_1( &self, dst: &mut impl ToOutputArray, stream: &mut impl StreamTrait ) -> Result<()>

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

returns true iff the GpuMatND data is continuous (i.e. when there are no gaps between successive rows)

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

returns true if the matrix is a sub-matrix of another matrix

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

returns element size in bytes

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

returns the size of element channel in bytes

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

returns true if data is null

fn external(&self) -> Result<bool>

returns true if not empty and points to external(user-allocated) gpu memory

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

returns pointer to the first byte of the GPU memory

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

returns the total number of array elements

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

returns the size of underlying memory in bytes

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

returns element type

impl Send for GpuMatND