Struct GCompiled

pub struct GCompiled { /* private fields */ }

\addtogroup gapi_main_classes /

Represents a compiled computation (graph). Can only be used with image / data formats & resolutions it was compiled for, with some exceptions.

This class represents a product of graph compilation (calling cv::GComputation::compile()). Objects of this class actually do data processing, and graph execution is incapsulated into objects of this class. Execution model itself depends on kernels and backends which were using during the compilation, see [gapi_compile_args] for details.

In a general case, GCompiled objects can be applied to data only in that formats/resolutions they were compiled for (see [gapi_meta_args]). However, if the underlying backends allow, a compiled object can be reshaped to handle data (images) of different resolution, though formats and types must remain the same.

GCompiled is very similar to std::function<> in its semantics – running it looks like a function call in the user code.

At the moment, GCompiled objects are not reentrant – generally, the objects are stateful since graph execution itself is a stateful process and this state is now maintained in GCompiled’s own memory (not on the process stack).

At the same time, two different GCompiled objects produced from the single cv::GComputation are completely independent and can be used concurrently.

See also

GStreamingCompiled

Implementations

impl GCompiled

pub fn default() -> Result<GCompiled>

Constructs an empty object

Trait Implementations

impl Boxed for GCompiled

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Debug for GCompiled

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

Formats the value using the given formatter.

impl Drop for GCompiled

fn drop(&mut self)

Executes the destructor for this type.

impl GCompiledTrait for GCompiled

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

fn apply(&mut self, in_: impl MatTrait, out: &mut impl MatTrait) -> Result<()>

Execute an unary computation

fn apply_1(&mut self, in_: impl MatTrait, out: &mut Scalar) -> Result<()>

Execute an unary computation

fn apply_2( &mut self, in1: impl MatTrait, in2: impl MatTrait, out: &mut impl MatTrait, ) -> Result<()>

Execute a binary computation

fn apply_3( &mut self, in1: impl MatTrait, in2: impl MatTrait, out: &mut Scalar, ) -> Result<()>

Execute an binary computation

fn apply_4(&mut self, ins: &Vector<Mat>, outs: &Vector<Mat>) -> Result<()>

Execute a computation with arbitrary number of inputs/outputs.

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

Prepare inner kernels states for a new video-stream.

impl GCompiledTraitConst for GCompiled

fn as_raw_GCompiled(&self) -> *const c_void

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

Check if compiled object is valid (non-empty)

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

Check if the underlying backends support reshape or not.

impl Send for GCompiled