Module gapi

Module gapi 

Source
Expand description

\defgroup gapi_ref G-API framework

§G-API Main Classes

§G-API Data Types

§G-API Standard Backends

§G-API Graph Compilation Arguments

§G-API Serialization functionality

Modules§

prelude

Structs§

Circle
This structure represents a circle to draw.
Data
This aggregate type represents all types which G-API can handle (via variant).
Detail_ExtractArgsCallback
Detail_ExtractMetaCallback
Detail_GArrayU
Detail_GOpaqueU
GArg
GArrayDesc
\addtogroup gapi_meta_args
GBackend
@private
GCall
GCompileArg
Represents an arbitrary compilation argument.
GCompiled
\addtogroup gapi_main_classes /
GComputation
GComputation class represents a captured computation graph. GComputation objects form boundaries for expression code user writes with G-API, allowing to compile and execute it.
GFrame
\addtogroup gapi_data_objects /
GFrameDesc
\addtogroup gapi_meta_args
GFunctor
@private
GKernel
GKernelImpl
GKernelPackage
A container class for heterogeneous kernel implementation collections and graph transformations.
GMat
GMat class represents image or tensor data in the graph.
GMatDesc
\addtogroup gapi_meta_args
GMatP
GOpaqueDesc
\addtogroup gapi_meta_args
GRunArg
GScalar
\addtogroup gapi_data_objects /
GScalarDesc
\addtogroup gapi_meta_args
GStreamingCompiled
\addtogroup gapi_main_classes /
GTransform
GTypeInfo
Image
This structure represents an image to draw.
Line
This structure represents a line to draw.
MediaFrame
cv::MediaFrame class represents an image/media frame obtained from an external source.
MediaFrame_IAdapter
An interface class for MediaFrame data adapters.
MediaFrame_View
Provides access to the MediaFrame’s underlying data.
Mosaic
This structure represents a mosaicing operation.
Poly
This structure represents a polygon to draw.
RMat
\addtogroup gapi_data_structures
RMat_IAdapter
RMat_View
Rect
This structure represents a rectangle to draw.
Scalar
Text
This structure represents a text string to draw.Parameters match cv::putText().
any
queue_capacity
Specify queue capacity for streaming execution.
use_only
\addtogroup gapi_compile_args /
use_threaded_executor
Ask G-API to use threaded executor when cv::GComputation is compiled via cv::GComputation::compile method.

Enums§

Detail_ArgKind
Detail_OpaqueKind
GShape
MediaFormat
MediaFrame_Access
This enum defines different types of cv::MediaFrame provided access to the underlying data. Note that different flags can’t be combined in this version.
RMat_Access

Constants§

Detail_ArgKind_GARRAY
Detail_ArgKind_GFRAME
Detail_ArgKind_GMAT
Detail_ArgKind_GMATP
Detail_ArgKind_GOBJREF
Detail_ArgKind_GOPAQUE
Detail_ArgKind_GSCALAR
Detail_ArgKind_OPAQUE
Detail_ArgKind_OPAQUE_VAL
Detail_OpaqueKind_CV_BOOL
Detail_OpaqueKind_CV_DOUBLE
Detail_OpaqueKind_CV_DRAW_PRIM
Detail_OpaqueKind_CV_FLOAT
Detail_OpaqueKind_CV_INT
Detail_OpaqueKind_CV_INT64
Detail_OpaqueKind_CV_MAT
Detail_OpaqueKind_CV_POINT
Detail_OpaqueKind_CV_POINT2F
Detail_OpaqueKind_CV_POINT3F
Detail_OpaqueKind_CV_RECT
Detail_OpaqueKind_CV_SCALAR
Detail_OpaqueKind_CV_SIZE
Detail_OpaqueKind_CV_STRING
Detail_OpaqueKind_CV_UINT64
Detail_OpaqueKind_CV_UNKNOWN
GShape_GARRAY
GShape_GFRAME
GShape_GMAT
GShape_GOPAQUE
GShape_GSCALAR
MediaFormat_BGR
MediaFormat_GRAY
MediaFormat_NV12
MediaFrame_Access_R
Access data for reading
MediaFrame_Access_W
Access data for writing
RMat_Access_R
RMat_Access_W

Traits§

DataTrait
Mutable methods for crate::gapi::Data
DataTraitConst
Constant methods for crate::gapi::Data
Detail_ExtractArgsCallbackTrait
Mutable methods for crate::gapi::Detail_ExtractArgsCallback
Detail_ExtractArgsCallbackTraitConst
Constant methods for crate::gapi::Detail_ExtractArgsCallback
Detail_ExtractMetaCallbackTrait
Mutable methods for crate::gapi::Detail_ExtractMetaCallback
Detail_ExtractMetaCallbackTraitConst
Constant methods for crate::gapi::Detail_ExtractMetaCallback
Detail_GArrayUTrait
Mutable methods for crate::gapi::Detail_GArrayU
Detail_GArrayUTraitConst
Constant methods for crate::gapi::Detail_GArrayU
Detail_GOpaqueUTrait
Mutable methods for crate::gapi::Detail_GOpaqueU
Detail_GOpaqueUTraitConst
Constant methods for crate::gapi::Detail_GOpaqueU
GArgTrait
Mutable methods for crate::gapi::GArg
GArgTraitConst
Constant methods for crate::gapi::GArg
GArrayDescTrait
Mutable methods for crate::gapi::GArrayDesc
GArrayDescTraitConst
Constant methods for crate::gapi::GArrayDesc
GBackendTrait
Mutable methods for crate::gapi::GBackend
GBackendTraitConst
Constant methods for crate::gapi::GBackend
GCallTrait
Mutable methods for crate::gapi::GCall
GCallTraitConst
Constant methods for crate::gapi::GCall
GCompileArgTrait
Mutable methods for crate::gapi::GCompileArg
GCompileArgTraitConst
Constant methods for crate::gapi::GCompileArg
GCompiledTrait
Mutable methods for crate::gapi::GCompiled
GCompiledTraitConst
Constant methods for crate::gapi::GCompiled
GComputationTrait
Mutable methods for crate::gapi::GComputation
GComputationTraitConst
Constant methods for crate::gapi::GComputation
GFrameDescTrait
Mutable methods for crate::gapi::GFrameDesc
GFrameDescTraitConst
Constant methods for crate::gapi::GFrameDesc
GFrameTrait
Mutable methods for crate::gapi::GFrame
GFrameTraitConst
Constant methods for crate::gapi::GFrame
GFunctorTrait
Mutable methods for crate::gapi::GFunctor
GFunctorTraitConst
Constant methods for crate::gapi::GFunctor
GKernelImplTrait
Mutable methods for crate::gapi::GKernelImpl
GKernelImplTraitConst
Constant methods for crate::gapi::GKernelImpl
GKernelPackageTrait
Mutable methods for crate::gapi::GKernelPackage
GKernelPackageTraitConst
Constant methods for crate::gapi::GKernelPackage
GKernelTrait
Mutable methods for crate::gapi::GKernel
GKernelTraitConst
Constant methods for crate::gapi::GKernel
GMatDescTrait
Mutable methods for crate::gapi::GMatDesc
GMatDescTraitConst
Constant methods for crate::gapi::GMatDesc
GMatPTrait
Mutable methods for crate::gapi::GMatP
GMatPTraitConst
Constant methods for crate::gapi::GMatP
GMatTrait
Mutable methods for crate::gapi::GMat
GMatTraitConst
Constant methods for crate::gapi::GMat
GOpaqueDescTrait
Mutable methods for crate::gapi::GOpaqueDesc
GOpaqueDescTraitConst
Constant methods for crate::gapi::GOpaqueDesc
GRunArgTrait
Mutable methods for crate::gapi::GRunArg
GRunArgTraitConst
Constant methods for crate::gapi::GRunArg
GScalarDescTrait
Mutable methods for crate::gapi::GScalarDesc
GScalarDescTraitConst
Constant methods for crate::gapi::GScalarDesc
GScalarTrait
Mutable methods for crate::gapi::GScalar
GScalarTraitConst
Constant methods for crate::gapi::GScalar
GStreamingCompiledTrait
Mutable methods for crate::gapi::GStreamingCompiled
GStreamingCompiledTraitConst
Constant methods for crate::gapi::GStreamingCompiled
GTransformTrait
Mutable methods for crate::gapi::GTransform
GTransformTraitConst
Constant methods for crate::gapi::GTransform
GTypeInfoTrait
Mutable methods for crate::gapi::GTypeInfo
GTypeInfoTraitConst
Constant methods for crate::gapi::GTypeInfo
ImageTrait
Mutable methods for crate::gapi::Image
ImageTraitConst
Constant methods for crate::gapi::Image
MediaFrameTrait
Mutable methods for crate::gapi::MediaFrame
MediaFrameTraitConst
Constant methods for crate::gapi::MediaFrame
MediaFrame_IAdapterTrait
Mutable methods for crate::gapi::MediaFrame_IAdapter
MediaFrame_IAdapterTraitConst
Constant methods for crate::gapi::MediaFrame_IAdapter
MediaFrame_ViewTrait
Mutable methods for crate::gapi::MediaFrame_View
MediaFrame_ViewTraitConst
Constant methods for crate::gapi::MediaFrame_View
PolyTrait
Mutable methods for crate::gapi::Poly
PolyTraitConst
Constant methods for crate::gapi::Poly
RMatTrait
Mutable methods for crate::gapi::RMat
RMatTraitConst
Constant methods for crate::gapi::RMat
RMat_IAdapterTrait
Mutable methods for crate::gapi::RMat_IAdapter
RMat_IAdapterTraitConst
Constant methods for crate::gapi::RMat_IAdapter
RMat_ViewTrait
Mutable methods for crate::gapi::RMat_View
RMat_ViewTraitConst
Constant methods for crate::gapi::RMat_View
ScalarTrait
Mutable methods for crate::gapi::Scalar
ScalarTraitConst
Constant methods for crate::gapi::Scalar
TextTrait
Mutable methods for crate::gapi::Text
TextTraitConst
Constant methods for crate::gapi::Text
anyTrait
Mutable methods for crate::gapi::any
anyTraitConst
Constant methods for crate::gapi::any
use_onlyTrait
Mutable methods for crate::gapi::use_only
use_onlyTraitConst
Constant methods for crate::gapi::use_only
use_threaded_executorTrait
Mutable methods for crate::gapi::use_threaded_executor
use_threaded_executorTraitConst
Constant methods for crate::gapi::use_threaded_executor

Functions§

abs_diff
Calculates the per-element absolute difference between two matrices.
abs_diff_c
Calculates absolute value of matrix elements.
add
Calculates the per-element sum of two matrices.
add_c
Calculates the per-element sum of matrix and given scalar.
add_c_1
Calculates the per-element sum of matrix and given scalar.
add_c_1_def
Calculates the per-element sum of matrix and given scalar.
add_c_def
Calculates the per-element sum of matrix and given scalar.
add_def
Calculates the per-element sum of two matrices.
add_gmat_gmat
add_gmat_gscalar
add_gscalar_gmat
add_weighted
Calculates the weighted sum of two matrices.
add_weighted_def
Calculates the weighted sum of two matrices.
and_gmat_gmat
and_gmat_gscalar
and_gscalar_gmat
bayer_gr2_rgb
Converts an image from BayerGR color space to RGB. The function converts an input image from BayerGR color space to RGB. The conventional ranges for G, R, and B channel values are 0 to 255.
bgr
Gets bgr plane from input frame
bgr2_gray
Converts an image from BGR color space to gray-scaled.
bgr2_i420
Converts an image from BGR color space to I420 color space.
bgr2_luv
Converts an image from BGR color space to LUV color space.
bgr2_rgb
Converts an image from BGR color space to RGB color space.
bgr2_yuv
Converts an image from BGR color space to YUV color space.
bilateral_filter
Applies the bilateral filter to an image.
bilateral_filter_def
Applies the bilateral filter to an image.
bitwise_and
computes bitwise conjunction of the two matrixes (src1 & src2) Calculates the per-element bit-wise logical conjunction of two matrices of the same size.
bitwise_and_1
computes bitwise conjunction of the two matrixes (src1 & src2) Calculates the per-element bit-wise logical conjunction of two matrices of the same size.
bitwise_not
Inverts every bit of an array.
bitwise_or
computes bitwise disjunction of the two matrixes (src1 | src2) Calculates the per-element bit-wise logical disjunction of two matrices of the same size.
bitwise_or_1
computes bitwise disjunction of the two matrixes (src1 | src2) Calculates the per-element bit-wise logical disjunction of two matrices of the same size.
bitwise_xor
computes bitwise logical “exclusive or” of the two matrixes (src1 ^ src2) Calculates the per-element bit-wise logical “exclusive or” of two matrices of the same size.
bitwise_xor_1
computes bitwise logical “exclusive or” of the two matrixes (src1 ^ src2) Calculates the per-element bit-wise logical “exclusive or” of two matrices of the same size.
blur
Blurs an image using the normalized box filter.
blur_def
Blurs an image using the normalized box filter.
box_filter
Blurs an image using the box filter.
box_filter_def
Blurs an image using the box filter.
canny
Finds edges in an image using the Canny algorithm.
canny_def
Finds edges in an image using the Canny algorithm.
cart_to_polar
Calculates the magnitude and angle of 2D vectors.
cart_to_polar_def
Calculates the magnitude and angle of 2D vectors.
cmp_eq
Performs the per-element comparison of two matrices checking if elements from first matrix are equal to elements in second.
cmp_eq_1
Performs the per-element comparison of two matrices checking if elements from first matrix are equal to elements in second.
cmp_ge
Performs the per-element comparison of two matrices checking if elements from first matrix are greater or equal compare to elements in second.
cmp_ge_1
Performs the per-element comparison of two matrices checking if elements from first matrix are greater or equal compare to elements in second.
cmp_gt
Performs the per-element comparison of two matrices checking if elements from first matrix are greater compare to elements in second.
cmp_gt_1
Performs the per-element comparison of two matrices checking if elements from first matrix are greater compare to elements in second.
cmp_le
Performs the per-element comparison of two matrices checking if elements from first matrix are less or equal compare to elements in second.
cmp_le_1
Performs the per-element comparison of two matrices checking if elements from first matrix are less or equal compare to elements in second.
cmp_lt
Performs the per-element comparison of two matrices checking if elements from first matrix are less than elements in second.
cmp_lt_1
Performs the per-element comparison of two matrices checking if elements from first matrix are less than elements in second.
cmp_ne
Performs the per-element comparison of two matrices checking if elements from first matrix are not equal to elements in second.
cmp_ne_1
Performs the per-element comparison of two matrices checking if elements from first matrix are not equal to elements in second.
combine
Create a new package based on lhs and rhs.
concat_hor
Applies horizontal concatenation to given matrices.
concat_hor_1
Applies horizontal concatenation to given matrices.
concat_vert
Applies vertical concatenation to given matrices.
concat_vert_1
Applies vertical concatenation to given matrices.
convert_to
Converts a matrix to another data depth with optional scaling.
convert_to_def
Converts a matrix to another data depth with optional scaling.
copy
Makes a copy of the input image. Note that this copy may be not real (no actual data copied). Use this function to maintain graph contracts, e.g when graph’s input needs to be passed directly to output, like in Streaming mode.
copy_1
Makes a copy of the input frame. Note that this copy may be not real (no actual data copied). Use this function to maintain graph contracts, e.g when graph’s input needs to be passed directly to output, like in Streaming mode.
crop
Crops a 2D matrix.
descr_of
descr_of_1
descr_of_2
descr_of_3
descr_of_4
desync
Starts a desynchronized branch in the graph.
desync_1
dilate
Dilates an image by using a specific structuring element.
dilate3x3
Dilates an image by using 3 by 3 rectangular structuring element.
dilate3x3_def
Dilates an image by using 3 by 3 rectangular structuring element.
dilate_def
Dilates an image by using a specific structuring element.
div
Performs per-element division of two matrices.
div_c
Divides matrix by scalar.
div_c_def
Divides matrix by scalar.
div_def
Performs per-element division of two matrices.
div_gmat_gmat
div_gmat_gscalar
div_gscalar_gmat
div_rc
Divides scalar by matrix.
div_rc_def
Divides scalar by matrix.
empty_array_desc
empty_gopaque_desc
empty_scalar_desc
equalize_hist
Equalizes the histogram of a grayscale image.
equals_gmat_gmat
equals_gmat_gscalar
equals_gscalar_gmat
erode
Erodes an image by using a specific structuring element.
erode3x3
Erodes an image by using 3 by 3 rectangular structuring element.
erode3x3_def
Erodes an image by using 3 by 3 rectangular structuring element.
erode_def
Erodes an image by using a specific structuring element.
filter_2d
Convolves an image with the kernel.
filter_2d_def
Convolves an image with the kernel.
flip
Flips a 2D matrix around vertical, horizontal, or both axes.
gaussian_blur
Blurs an image using a Gaussian filter.
gaussian_blur_def
Blurs an image using a Gaussian filter.
greater_than_gmat_gmat
greater_than_gmat_gscalar
greater_than_gscalar_gmat
greater_than_or_equal_gmat_gmat
greater_than_or_equal_gmat_gscalar
greater_than_or_equal_gscalar_gmat
i4202_bgr
Converts an image from I420 color space to BGR color space.
i4202_rgb
Converts an image from I420 color space to BGR color space.
in_range
Applies a range-level threshold to each matrix element.
integral
Calculates the integral of an image.
integral_def
Calculates the integral of an image.
kernels
laplacian
Calculates the Laplacian of an image.
laplacian_def
Calculates the Laplacian of an image.
less_than_gmat_gmat
less_than_gmat_gscalar
less_than_gscalar_gmat
less_than_or_equal_gmat_gmat
less_than_or_equal_gmat_gscalar
less_than_or_equal_gscalar_gmat
lut
Performs a look-up table transform of a matrix.
luv2_bgr
Converts an image from LUV color space to BGR color space.
mask
Applies a mask to a matrix.
max
Calculates per-element maximum of two matrices.
mean
Calculates an average (mean) of matrix elements.
median_blur
Blurs an image using the median filter.
merge3
Creates one 3-channel matrix out of 3 single-channel ones.
merge4
Creates one 4-channel matrix out of 4 single-channel ones.
min
Calculates per-element minimum of two matrices.
morphology_ex
Performs advanced morphological transformations.
morphology_ex_def
Performs advanced morphological transformations.
mul
Calculates the per-element scaled product of two matrices.
mul_c
Multiplies matrix by scalar.
mul_c_1
Multiplies matrix by scalar.
mul_c_2
Multiplies matrix by scalar.
mul_c_1_def
Multiplies matrix by scalar.
mul_c_2_def
Multiplies matrix by scalar.
mul_c_def
Multiplies matrix by scalar.
mul_def
Calculates the per-element scaled product of two matrices.
mul_f32_gmat
mul_gmat_f32
mul_gmat_gscalar
mul_gscalar_gmat
negate
norm_inf
Calculates the absolute infinite norm of a matrix.
norm_l1
Calculates the absolute L1 norm of a matrix.
norm_l2
Calculates the absolute L2 norm of a matrix.
normalize
Normalizes the norm or value range of an array.
normalize_def
Normalizes the norm or value range of an array.
not_equals_gmat_gmat
not_equals_gmat_gscalar
not_equals_gscalar_gmat
nv12to_bg_rp
Converts an image from NV12 (YUV420p) color space to BGR. The function converts an input image from NV12 color space to BGR. The conventional ranges for Y, U, and V channel values are 0 to 255.
nv12to_bgr
Converts an image from NV12 (YUV420p) color space to BGR. The function converts an input image from NV12 color space to RGB. The conventional ranges for Y, U, and V channel values are 0 to 255.
nv12to_gray
Converts an image from NV12 (YUV420p) color space to gray-scaled. The function converts an input image from NV12 color space to gray-scaled. The conventional ranges for Y, U, and V channel values are 0 to 255.
nv12to_rg_bp
Converts an image from NV12 (YUV420p) color space to RGB. The function converts an input image from NV12 color space to RGB. The conventional ranges for Y, U, and V channel values are 0 to 255.
nv12to_rgb
Converts an image from NV12 (YUV420p) color space to RGB. The function converts an input image from NV12 color space to RGB. The conventional ranges for Y, U, and V channel values are 0 to 255.
or_gmat_gmat
or_gmat_gscalar
or_gscalar_gmat
phase
Calculates the rotation angle of 2D vectors.
phase_def
Calculates the rotation angle of 2D vectors.
polar_to_cart
Calculates x and y coordinates of 2D vectors from their magnitude and angle.
polar_to_cart_def
Calculates x and y coordinates of 2D vectors from their magnitude and angle.
remap
Applies a generic geometrical transformation to an image.
remap_def
Applies a generic geometrical transformation to an image.
resize
Resizes an image.
resize_def
Resizes an image.
resize_p
Resizes a planar image.
resize_p_def
Resizes a planar image.
rgb2_gray
Converts an image from RGB color space to gray-scaled.
rgb2_gray_1
Converts an image from RGB color space to gray-scaled.
rgb2_hsv
Converts an image from RGB color space to HSV. The function converts an input image from RGB color space to HSV. The conventional ranges for R, G, and B channel values are 0 to 255.
rgb2_i420
Converts an image from RGB color space to I420 color space.
rgb2_lab
Converts an image from RGB color space to Lab color space.
rgb2_yuv
Converts an image from RGB color space to YUV color space.
rgb2_yuv422
Converts an image from RGB color space to YUV422. The function converts an input image from RGB color space to YUV422. The conventional ranges for R, G, and B channel values are 0 to 255.
select
Select values from either first or second of input matrices by given mask. The function set to the output matrix either the value from the first input matrix if corresponding value of mask matrix is 255, or value from the second input matrix (if value of mask matrix set to 0).
sep_filter
Applies a separable linear filter to a matrix(image).
sep_filter_def
Applies a separable linear filter to a matrix(image).
sobel
Calculates the first, second, third, or mixed image derivatives using an extended Sobel operator.
sobel_def
Calculates the first, second, third, or mixed image derivatives using an extended Sobel operator.
sobel_xy
Calculates the first, second, third, or mixed image derivatives using an extended Sobel operator.
sobel_xy_def
Calculates the first, second, third, or mixed image derivatives using an extended Sobel operator.
split3
Divides a 3-channel matrix into 3 single-channel matrices.
split4
Divides a 4-channel matrix into 4 single-channel matrices.
sqrt
Calculates a square root of array elements.
sub
Calculates the per-element difference between two matrices.
sub_c
Calculates the per-element difference between matrix and given scalar.
sub_c_def
Calculates the per-element difference between matrix and given scalar.
sub_def
Calculates the per-element difference between two matrices.
sub_gmat_gmat
sub_gmat_gscalar
sub_gscalar_gmat
sub_rc
Calculates the per-element difference between given scalar and the matrix.
sub_rc_def
Calculates the per-element difference between given scalar and the matrix.
sum
Calculates sum of all matrix elements.
threshold
Applies a fixed-level threshold to each matrix element.
threshold_1
Applies a fixed-level threshold to each matrix element.
transpose
Transposes a matrix.
uv
Extracts UV plane from media frame.
validate_input_arg
validate_input_args
warp_affine
Applies an affine transformation to an image.
warp_affine_def
Applies an affine transformation to an image.
warp_perspective
Applies a perspective transformation to an image.
warp_perspective_def
Applies a perspective transformation to an image.
xor_gmat_gmat
xor_gmat_gscalar
xor_gscalar_gmat
y
Extracts Y plane from media frame.
yuv2_bgr
Converts an image from YUV color space to BGR color space.
yuv2_rgb
Converts an image from YUV color space to RGB. The function converts an input image from YUV color space to RGB. The conventional ranges for Y, U, and V channel values are 0 to 255.

Type Aliases§

GArgs
GCompileArgs
GKinds
GMat2
GMat3
GMat4
GMatScalar
GRunArgs
GShapes
GTypesInfo
ImgProc_ContMethod
ImgProc_GMat2
ImgProc_GMat3
ImgProc_RetrMode
RMat_Adapter
RMat_View_stepsT