Struct opencv::core::_OutputArray

pub struct _OutputArray { /* fields omitted */ }

This type is very similar to InputArray except that it is used for input/output and output function parameters.

Just like with InputArray, OpenCV users should not care about OutputArray, they just pass Mat, vector<T> etc. to the functions. The same limitation as for InputArray: Do not explicitly create OutputArray instances applies here too.

If you want to make your function polymorphic (i.e. accept different arrays as output parameters), it is also not very difficult. Take the sample above as the reference. Note that _OutputArray::create() needs to be called before _OutputArray::getMat(). This way you guarantee that the output array is properly allocated.

Optional output parameters. If you do not need certain output array to be computed and returned to you, pass cv::noArray(), just like you would in the case of optional input array. At the implementation level, use _OutputArray::needed() to check if certain output array needs to be computed or not.

There are several synonyms for OutputArray that are used to assist automatic Python/Java/... wrapper generators:

typedef OutputArray OutputArrayOfArrays;
typedef OutputArray InputOutputArray;
typedef OutputArray InputOutputArrayOfArrays;

Methods

impl _OutputArray

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

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

impl _OutputArray

pub fn default() -> Result<_OutputArray>

pub fn new(_flags: i32, _obj: &mut c_void) -> Result<_OutputArray>

pub fn from_mat(m: &mut Mat) -> Result<_OutputArray>

pub fn from_mat_vec(vec: &mut VectorOfMat) -> Result<_OutputArray>

pub fn new_1(vec: &mut VectorOfbool) -> Result<_OutputArray>

pub fn new_2(unnamed_arg: &mut VectorOfVectorOfbool) -> Result<_OutputArray>

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

pub fn from_umat_vec(vec: &mut VectorOfUMat) -> Result<_OutputArray>

Trait Implementations

impl Drop for _OutputArray

fn drop(&mut self)

Executes the destructor for this type.

impl Send for _OutputArray

impl _InputArrayTrait for _OutputArray

fn as_raw__InputArray(&self) -> *mut c_void

fn get_mat(&self, idx: i32) -> Result<Mat>

C++ default parameters * idx: -1

fn get_mat_(&self, idx: i32) -> Result<Mat>

C++ default parameters * idx: -1

fn get_u_mat(&self, idx: i32) -> Result<UMat>

C++ default parameters * idx: -1

fn get_mat_vector(&self, mv: &mut VectorOfMat) -> Result<()>

fn get_u_mat_vector(&self, umv: &mut VectorOfUMat) -> Result<()>

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

fn get_obj(&self) -> Result<&mut c_void>

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

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

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

C++ default parameters * i: -1

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

C++ default parameters * i: -1

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

C++ default parameters * i: -1

fn size(&self, i: i32) -> Result<Size>

C++ default parameters * i: -1

fn sizend(&self, sz: &mut i32, i: i32) -> Result<i32>

C++ default parameters * i: -1

fn same_size(&self, arr: &dyn ToInputArray) -> Result<bool>

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

C++ default parameters * i: -1

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

C++ default parameters * i: -1

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

C++ default parameters * i: -1

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

C++ default parameters * i: -1

fn is_continuous(&self, i: i32) -> Result<bool>

C++ default parameters * i: -1

fn is_submatrix(&self, i: i32) -> Result<bool>

C++ default parameters * i: -1

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

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

fn copy_to_with_mask(
    &self,
    arr: &mut dyn ToOutputArray,
    mask: &dyn ToInputArray
) -> Result<()>

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

C++ default parameters * i: -1

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

C++ default parameters * i: -1

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

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

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

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

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

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

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

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

impl _OutputArrayTrait for _OutputArray

fn as_raw__OutputArray(&self) -> *mut c_void

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

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

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

fn get_mat_ref(&self, i: i32) -> Result<Mat>

C++ default parameters * i: -1

fn get_u_mat_ref(&self, i: i32) -> Result<UMat>

C++ default parameters * i: -1

fn create(
    &self,
    sz: Size,
    _type: i32,
    i: i32,
    allow_transposed: bool,
    fixed_depth_mask: i32
) -> Result<()>

C++ default parameters * i: -1 * allow_transposed: false * fixed_depth_mask: 0

fn create_1(
    &self,
    rows: i32,
    cols: i32,
    _type: i32,
    i: i32,
    allow_transposed: bool,
    fixed_depth_mask: i32
) -> Result<()>

C++ default parameters * i: -1 * allow_transposed: false * fixed_depth_mask: 0

fn create_2(
    &self,
    dims: i32,
    size: &i32,
    _type: i32,
    i: i32,
    allow_transposed: bool,
    fixed_depth_mask: i32
) -> Result<()>

C++ default parameters * i: -1 * allow_transposed: false * fixed_depth_mask: 0

fn create_same_size(&self, arr: &dyn ToInputArray, mtype: i32) -> Result<()>

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

fn clear(&self) -> Result<()>

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

C++ default parameters * mask: _InputArray()

fn assign(&self, u: &UMat) -> Result<()>

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

fn assign_2(&self, v: &VectorOfUMat) -> Result<()>

fn assign_3(&self, v: &VectorOfMat) -> Result<()>

fn _move(&self, u: &mut UMat) -> Result<()>

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