Struct opencv::cudaoptflow::CUDA_NvidiaOpticalFlow_2_0

pub struct CUDA_NvidiaOpticalFlow_2_0 { /* private fields */ }

Class for computing the optical flow vectors between two images using NVIDIA Optical Flow hardware and Optical Flow SDK 2.0.

Note:

• A sample application demonstrating the use of NVIDIA Optical Flow can be found at opencv_contrib_source_code/modules/cudaoptflow/samples/nvidia_optical_flow.cpp
• An example application comparing accuracy and performance of NVIDIA Optical Flow with other optical flow algorithms in OpenCV can be found at opencv_contrib_source_code/modules/cudaoptflow/samples/optical_flow.cpp

Implementations

impl CUDA_NvidiaOpticalFlow_2_0

pub fn create( image_size: Size, perf_preset: CUDA_NvidiaOpticalFlow_2_0_NVIDIA_OF_PERF_LEVEL, output_grid_size: CUDA_NvidiaOpticalFlow_2_0_NVIDIA_OF_OUTPUT_VECTOR_GRID_SIZE, hint_grid_size: CUDA_NvidiaOpticalFlow_2_0_NVIDIA_OF_HINT_VECTOR_GRID_SIZE, enable_temporal_hints: bool, enable_external_hints: bool, enable_cost_buffer: bool, gpu_id: i32, input_stream: &mut impl StreamTrait, output_stream: &mut impl StreamTrait ) -> Result<Ptr<CUDA_NvidiaOpticalFlow_2_0>>

Instantiate NVIDIA Optical Flow

Parameters

• imageSize: Size of input image in pixels.
• perfPreset: Optional parameter. Refer NV OF SDK documentation for details about presets. Defaults to NV_OF_PERF_LEVEL_SLOW.
• outputGridSize: Optional parameter. Refer NV OF SDK documentation for details about output grid sizes. Defaults to NV_OF_OUTPUT_VECTOR_GRID_SIZE_1.
• hintGridSize: Optional parameter. Refer NV OF SDK documentation for details about hint grid sizes. Defaults to NV_OF_HINT_VECTOR_GRID_SIZE_1.
• enableTemporalHints: Optional parameter. Flag to enable temporal hints. When set to true, the hardware uses the flow vectors generated in previous call to calc() as internal hints for the current call to calc(). Useful when computing flow vectors between successive video frames. Defaults to false.
• enableExternalHints: Optional Parameter. Flag to enable passing external hints buffer to calc(). Defaults to false.
• enableCostBuffer: Optional Parameter. Flag to enable cost buffer output from calc(). Defaults to false.
• gpuId: Optional parameter to select the GPU ID on which the optical flow should be computed. Useful in multi-GPU systems. Defaults to 0.
• inputStream: Optical flow algorithm may optionally involve cuda preprocessing on the input buffers. The input cuda stream can be used to pipeline and synchronize the cuda preprocessing tasks with OF HW engine. If input stream is not set, the execute function will use default stream which is NULL stream;
• outputStream: Optical flow algorithm may optionally involve cuda post processing on the output flow vectors. The output cuda stream can be used to pipeline and synchronize the cuda post processing tasks with OF HW engine. If output stream is not set, the execute function will use default stream which is NULL stream;

C++ default parameters

• perf_preset: cv::cuda::NvidiaOpticalFlow_2_0::NV_OF_PERF_LEVEL_SLOW
• output_grid_size: cv::cuda::NvidiaOpticalFlow_2_0::NV_OF_OUTPUT_VECTOR_GRID_SIZE_1
• hint_grid_size: cv::cuda::NvidiaOpticalFlow_2_0::NV_OF_HINT_VECTOR_GRID_SIZE_1
• enable_temporal_hints: false
• enable_external_hints: false
• enable_cost_buffer: false
• gpu_id: 0
• input_stream: Stream::Null()
• output_stream: Stream::Null()

pub fn create_def(image_size: Size) -> Result<Ptr<CUDA_NvidiaOpticalFlow_2_0>>

Instantiate NVIDIA Optical Flow

Parameters

• imageSize: Size of input image in pixels.
• perfPreset: Optional parameter. Refer NV OF SDK documentation for details about presets. Defaults to NV_OF_PERF_LEVEL_SLOW.
• outputGridSize: Optional parameter. Refer NV OF SDK documentation for details about output grid sizes. Defaults to NV_OF_OUTPUT_VECTOR_GRID_SIZE_1.
• hintGridSize: Optional parameter. Refer NV OF SDK documentation for details about hint grid sizes. Defaults to NV_OF_HINT_VECTOR_GRID_SIZE_1.
• enableTemporalHints: Optional parameter. Flag to enable temporal hints. When set to true, the hardware uses the flow vectors generated in previous call to calc() as internal hints for the current call to calc(). Useful when computing flow vectors between successive video frames. Defaults to false.
• enableExternalHints: Optional Parameter. Flag to enable passing external hints buffer to calc(). Defaults to false.
• enableCostBuffer: Optional Parameter. Flag to enable cost buffer output from calc(). Defaults to false.
• gpuId: Optional parameter to select the GPU ID on which the optical flow should be computed. Useful in multi-GPU systems. Defaults to 0.
• inputStream: Optical flow algorithm may optionally involve cuda preprocessing on the input buffers. The input cuda stream can be used to pipeline and synchronize the cuda preprocessing tasks with OF HW engine. If input stream is not set, the execute function will use default stream which is NULL stream;
• outputStream: Optical flow algorithm may optionally involve cuda post processing on the output flow vectors. The output cuda stream can be used to pipeline and synchronize the cuda post processing tasks with OF HW engine. If output stream is not set, the execute function will use default stream which is NULL stream;

Note

This alternative version of CUDA_NvidiaOpticalFlow_2_0::create function uses the following default values for its arguments:

• perf_preset: cv::cuda::NvidiaOpticalFlow_2_0::NV_OF_PERF_LEVEL_SLOW
• output_grid_size: cv::cuda::NvidiaOpticalFlow_2_0::NV_OF_OUTPUT_VECTOR_GRID_SIZE_1
• hint_grid_size: cv::cuda::NvidiaOpticalFlow_2_0::NV_OF_HINT_VECTOR_GRID_SIZE_1
• enable_temporal_hints: false
• enable_external_hints: false
• enable_cost_buffer: false
• gpu_id: 0
• input_stream: Stream::Null()
• output_stream: Stream::Null()

pub fn create_1( image_size: Size, roi_data: Vector<Rect>, perf_preset: CUDA_NvidiaOpticalFlow_2_0_NVIDIA_OF_PERF_LEVEL, output_grid_size: CUDA_NvidiaOpticalFlow_2_0_NVIDIA_OF_OUTPUT_VECTOR_GRID_SIZE, hint_grid_size: CUDA_NvidiaOpticalFlow_2_0_NVIDIA_OF_HINT_VECTOR_GRID_SIZE, enable_temporal_hints: bool, enable_external_hints: bool, enable_cost_buffer: bool, gpu_id: i32, input_stream: &mut impl StreamTrait, output_stream: &mut impl StreamTrait ) -> Result<Ptr<CUDA_NvidiaOpticalFlow_2_0>>

Instantiate NVIDIA Optical Flow with ROI Feature

Parameters

• imageSize: Size of input image in pixels.
• roiData: Pointer to ROI data.
• perfPreset: Optional parameter. Refer NV OF SDK documentation for details about presets. Defaults to NV_OF_PERF_LEVEL_SLOW.
• outputGridSize: Optional parameter. Refer NV OF SDK documentation for details about output grid sizes. Defaults to NV_OF_OUTPUT_VECTOR_GRID_SIZE_1.
• hintGridSize: Optional parameter. Refer NV OF SDK documentation for details about hint grid sizes. Defaults to NV_OF_HINT_VECTOR_GRID_SIZE_1.
• enableTemporalHints: Optional parameter. Flag to enable temporal hints. When set to true, the hardware uses the flow vectors generated in previous call to calc() as internal hints for the current call to calc(). Useful when computing flow vectors between successive video frames. Defaults to false.
• enableExternalHints: Optional Parameter. Flag to enable passing external hints buffer to calc(). Defaults to false.
• enableCostBuffer: Optional Parameter. Flag to enable cost buffer output from calc(). Defaults to false.
• gpuId: Optional parameter to select the GPU ID on which the optical flow should be computed. Useful in multi-GPU systems. Defaults to 0.
• inputStream: Optical flow algorithm may optionally involve cuda preprocessing on the input buffers. The input cuda stream can be used to pipeline and synchronize the cuda preprocessing tasks with OF HW engine. If input stream is not set, the execute function will use default stream which is NULL stream;
• outputStream: Optical flow algorithm may optionally involve cuda post processing on the output flow vectors. The output cuda stream can be used to pipeline and synchronize the cuda post processing tasks with OF HW engine. If output stream is not set, the execute function will use default stream which is NULL stream;

C++ default parameters

• perf_preset: cv::cuda::NvidiaOpticalFlow_2_0::NV_OF_PERF_LEVEL_SLOW
• output_grid_size: cv::cuda::NvidiaOpticalFlow_2_0::NV_OF_OUTPUT_VECTOR_GRID_SIZE_1
• hint_grid_size: cv::cuda::NvidiaOpticalFlow_2_0::NV_OF_HINT_VECTOR_GRID_SIZE_1
• enable_temporal_hints: false
• enable_external_hints: false
• enable_cost_buffer: false
• gpu_id: 0
• input_stream: Stream::Null()
• output_stream: Stream::Null()

pub fn create_def_1( image_size: Size, roi_data: Vector<Rect> ) -> Result<Ptr<CUDA_NvidiaOpticalFlow_2_0>>

Instantiate NVIDIA Optical Flow with ROI Feature

Parameters

• imageSize: Size of input image in pixels.
• roiData: Pointer to ROI data.
• perfPreset: Optional parameter. Refer NV OF SDK documentation for details about presets. Defaults to NV_OF_PERF_LEVEL_SLOW.
• outputGridSize: Optional parameter. Refer NV OF SDK documentation for details about output grid sizes. Defaults to NV_OF_OUTPUT_VECTOR_GRID_SIZE_1.
• hintGridSize: Optional parameter. Refer NV OF SDK documentation for details about hint grid sizes. Defaults to NV_OF_HINT_VECTOR_GRID_SIZE_1.
• enableTemporalHints: Optional parameter. Flag to enable temporal hints. When set to true, the hardware uses the flow vectors generated in previous call to calc() as internal hints for the current call to calc(). Useful when computing flow vectors between successive video frames. Defaults to false.
• enableExternalHints: Optional Parameter. Flag to enable passing external hints buffer to calc(). Defaults to false.
• enableCostBuffer: Optional Parameter. Flag to enable cost buffer output from calc(). Defaults to false.
• gpuId: Optional parameter to select the GPU ID on which the optical flow should be computed. Useful in multi-GPU systems. Defaults to 0.
• inputStream: Optical flow algorithm may optionally involve cuda preprocessing on the input buffers. The input cuda stream can be used to pipeline and synchronize the cuda preprocessing tasks with OF HW engine. If input stream is not set, the execute function will use default stream which is NULL stream;
• outputStream: Optical flow algorithm may optionally involve cuda post processing on the output flow vectors. The output cuda stream can be used to pipeline and synchronize the cuda post processing tasks with OF HW engine. If output stream is not set, the execute function will use default stream which is NULL stream;

Note

This alternative version of CUDA_NvidiaOpticalFlow_2_0::create function uses the following default values for its arguments:

• perf_preset: cv::cuda::NvidiaOpticalFlow_2_0::NV_OF_PERF_LEVEL_SLOW
• output_grid_size: cv::cuda::NvidiaOpticalFlow_2_0::NV_OF_OUTPUT_VECTOR_GRID_SIZE_1
• hint_grid_size: cv::cuda::NvidiaOpticalFlow_2_0::NV_OF_HINT_VECTOR_GRID_SIZE_1
• enable_temporal_hints: false
• enable_external_hints: false
• enable_cost_buffer: false
• gpu_id: 0
• input_stream: Stream::Null()
• output_stream: Stream::Null()

Trait Implementations

impl AlgorithmTrait for CUDA_NvidiaOpticalFlow_2_0

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

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

Clears the algorithm state

fn read(&mut self, fn_: &impl FileNodeTraitConst) -> Result<()>

Reads algorithm parameters from a file storage

impl AlgorithmTraitConst for CUDA_NvidiaOpticalFlow_2_0

fn as_raw_Algorithm(&self) -> *const c_void

fn write(&self, fs: &mut impl FileStorageTrait) -> Result<()>

Stores algorithm parameters in a file storage

fn write_1(&self, fs: &mut impl FileStorageTrait, name: &str) -> Result<()>

Stores algorithm parameters in a file storage

fn write_with_name(&self, fs: &Ptr<FileStorage>, name: &str) -> Result<()>

@deprecated

fn write_with_name_def(&self, fs: &Ptr<FileStorage>) -> Result<()>

👎Deprecated:

Note

Deprecated: ## Note This alternative version of AlgorithmTraitConst::write_with_name function uses the following default values for its arguments:

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

Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read

fn save(&self, filename: &str) -> Result<()>

Saves the algorithm to a file. In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).

fn get_default_name(&self) -> Result<String>

Returns the algorithm string identifier. This string is used as top level xml/yml node tag when the object is saved to a file or string.

impl Boxed for CUDA_NvidiaOpticalFlow_2_0

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl CUDA_NvidiaHWOpticalFlowTrait for CUDA_NvidiaOpticalFlow_2_0

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

fn calc( &mut self, input_image: &impl ToInputArray, reference_image: &impl ToInputArray, flow: &mut impl ToInputOutputArray, stream: &mut impl StreamTrait, hint: &impl ToInputArray, cost: &mut impl ToOutputArray ) -> Result<()>

Calculates Optical Flow using NVIDIA Optical Flow SDK.

fn calc_def( &mut self, input_image: &impl ToInputArray, reference_image: &impl ToInputArray, flow: &mut impl ToInputOutputArray ) -> Result<()>

Calculates Optical Flow using NVIDIA Optical Flow SDK.

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

Releases all buffers, contexts and device pointers.

impl CUDA_NvidiaHWOpticalFlowTraitConst for CUDA_NvidiaOpticalFlow_2_0

fn as_raw_CUDA_NvidiaHWOpticalFlow(&self) -> *const c_void

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

Returns grid size of output buffer as per the hardware’s capability.

impl CUDA_NvidiaOpticalFlow_2_0Trait for CUDA_NvidiaOpticalFlow_2_0

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

fn convert_to_float( &mut self, flow: &impl ToInputArray, float_flow: &mut impl ToInputOutputArray ) -> Result<()>

convertToFloat() helper function converts the hardware-generated flow vectors to floating point representation (1 flow vector for gridSize). gridSize can be queried via function getGridSize().

impl CUDA_NvidiaOpticalFlow_2_0TraitConst for CUDA_NvidiaOpticalFlow_2_0

fn as_raw_CUDA_NvidiaOpticalFlow_2_0(&self) -> *const c_void

impl Debug for CUDA_NvidiaOpticalFlow_2_0

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

Formats the value using the given formatter.

impl Drop for CUDA_NvidiaOpticalFlow_2_0

fn drop(&mut self)

Executes the destructor for this type.

impl From<CUDA_NvidiaOpticalFlow_2_0> for Algorithm

fn from(s: CUDA_NvidiaOpticalFlow_2_0) -> Self

Converts to this type from the input type.

impl From<CUDA_NvidiaOpticalFlow_2_0> for CUDA_NvidiaHWOpticalFlow

fn from(s: CUDA_NvidiaOpticalFlow_2_0) -> Self

Converts to this type from the input type.

impl TryFrom<CUDA_NvidiaHWOpticalFlow> for CUDA_NvidiaOpticalFlow_2_0

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: CUDA_NvidiaHWOpticalFlow) -> Result<Self>

Performs the conversion.

impl Send for CUDA_NvidiaOpticalFlow_2_0