OpenCV

https://docs.rs/opencv/latest
Admin
OpenCV provides Rust bindings for the OpenCV computer vision library, enabling Rust developers to...
Tokens:19,595,753
Snippets:96,786
Trust Score:9.7
Update:10 months ago
Show doc for...
Tokens:
Raw
### Backend Initialization and Support

Source: https://docs.rs/opencv/latest/latest/opencv/boxed_ref/struct.BoxedRefMut

Methods for initializing various hardware backends (CUDA, OpenVINO, Halide, etc.) and checking backend support.

```APIDOC
## Backend Initialization and Support

### Description
Methods for initializing various hardware backends (CUDA, OpenVINO, Halide, etc.) and checking backend support.

### `update_memory_shapes`

#### Description
Updates memory shapes based on input shapes.

#### Method
`&mut self, inputs: &Vector<MatShape>`

#### Endpoint
N/A (Method within a struct)

#### Parameters
- **inputs** (Vector<MatShape>) - Input shapes.

#### Returns
Result<bool>

### `try_quantize`

#### Description
Tries to quantize the given layer and compute the quantization parameters required for fixed point implementation. Read more.

#### Method
`&mut self, scales: &Vector<Vector<f32>>, zeropoints: &Vector<Vector<i32>>, params: &mut impl LayerParamsTrait`

#### Endpoint
N/A (Method within a struct)

#### Parameters
- **scales** (Vector<Vector<f32>>) - Quantization scales.
- **zeropoints** (Vector<Vector<i32>>) - Quantization zero points.
- **params** (impl LayerParamsTrait) - Layer parameters.

#### Returns
Result<bool>

### `input_name_to_index`

#### Description
Returns the index of an input blob into the input array. Read more.

#### Method
`&mut self, input_name: &str`

#### Endpoint
N/A (Method within a struct)

#### Parameters
- **input_name** (str) - The name of the input.

#### Returns
Result<i32>

### `output_name_to_index`

#### Description
Returns the index of an output blob in the output array. Read more.

#### Method
`&mut self, output_name: &str`

#### Endpoint
N/A (Method within a struct)

#### Parameters
- **output_name** (str) - The name of the output.

#### Returns
Result<i32>

### `support_backend`

#### Description
Asks the layer if it supports a specific backend for computation. Read more.

#### Method
`&mut self, backend_id: i32`

#### Endpoint
N/A (Method within a struct)

#### Parameters
- **backend_id** (i32) - The ID of the backend to check.

#### Returns
Result<bool>

### `init_halide`

#### Description
Returns the Halide backend node. Read more.

#### Method
`&mut self, inputs: &Vector<Ptr<BackendWrapper>>`

#### Endpoint
N/A (Method within a struct)

#### Parameters
- **inputs** (Vector<Ptr<BackendWrapper>>) - Input wrappers.

#### Returns
Result<Ptr<BackendNode>>

### `init_ngraph`

#### Description
Initializes the nGraph backend node.

#### Method
`&mut self, inputs: &Vector<Ptr<BackendWrapper>>, nodes: &Vector<Ptr<BackendNode>>`

#### Endpoint
N/A (Method within a struct)

#### Parameters
- **inputs** (Vector<Ptr<BackendWrapper>>) - Input wrappers.
- **nodes** (Vector<Ptr<BackendNode>>) - Backend nodes.

#### Returns
Result<Ptr<BackendNode>>

### `init_vk_com`

#### Description
Initializes the Vulkan compute backend node.

#### Method
`&mut self, inputs: &Vector<Ptr<BackendWrapper>>, outputs: &mut Vector<Ptr<BackendWrapper>>`

#### Endpoint
N/A (Method within a struct)

#### Parameters
- **inputs** (Vector<Ptr<BackendWrapper>>) - Input wrappers.
- **outputs** (Vector<Ptr<BackendWrapper>>) - Output wrappers.

#### Returns
Result<Ptr<BackendNode>>

### `init_webnn`

#### Description
Initializes the WebNN backend node.

#### Method
`&mut self, inputs: &Vector<Ptr<BackendWrapper>>, nodes: &Vector<Ptr<BackendNode>>`

#### Endpoint
N/A (Method within a struct)

#### Parameters
- **inputs** (Vector<Ptr<BackendWrapper>>) - Input wrappers.
- **nodes** (Vector<Ptr<BackendNode>>) - Backend nodes.

#### Returns
Result<Ptr<BackendNode>>

### `init_cuda`

#### Description
Returns a CUDA backend node. Read more.

#### Method
`unsafe fn init_cuda(&mut self, context: *mut c_void, inputs: &Vector<Ptr<BackendWrapper>>, outputs: &Vector<Ptr<BackendWrapper>>)`

#### Endpoint
N/A (Method within a struct)

#### Parameters
- **context** (*mut c_void) - CUDA context pointer.
- **inputs** (Vector<Ptr<BackendWrapper>>) - Input wrappers.
- **outputs** (Vector<Ptr<BackendWrapper>>) - Output wrappers.

#### Returns
Result<Ptr<BackendNode>>

### `init_tim_vx`

#### Description
Returns a TimVX backend node. Read more.

#### Method
`unsafe fn init_tim_vx(&mut self, tim_vx_info: *mut c_void, inputs_wrapper: &Vector<Ptr<BackendWrapper>>, outputs_wrapper: &Vector<Ptr<BackendWrapper>>, is_last: bool)`

#### Endpoint
N/A (Method within a struct)

#### Parameters
- **tim_vx_info** (*mut c_void) - TimVX info pointer.
- **inputs_wrapper** (Vector<Ptr<BackendWrapper>>) - Input wrappers.
- **outputs_wrapper** (Vector<Ptr<BackendWrapper>>) - Output wrappers.
- **is_last** (bool) - Flag indicating if this is the last layer.

#### Returns
Result<Ptr<BackendNode>>

### `init_cann`

#### Description
Returns a CANN backend node. Read more.

#### Method
`&mut self, inputs: &Vector<Ptr<BackendWrapper>>, outputs: &Vector<Ptr<BackendWrapper>>, nodes: &Vector<Ptr<BackendNode>>`

#### Endpoint
N/A (Method within a struct)

#### Parameters
- **inputs** (Vector<Ptr<BackendWrapper>>) - Input wrappers.
- **outputs** (Vector<Ptr<BackendWrapper>>) - Output wrappers.
- **nodes** (Vector<Ptr<BackendNode>>) - Backend nodes.

#### Returns
Result<Ptr<BackendNode>>

### `try_attach`

#### Description
Implement layers fusing. Read more.

#### Method
`&mut self, node: &Ptr<BackendNode>`

#### Endpoint
N/A (Method within a struct)

#### Parameters
- **node** (Ptr<BackendNode>) - The backend node to attach.

#### Returns
Result<Ptr<BackendNode>>

```

--------------------------------

### Range: Start Index

Source: https://docs.rs/opencv/latest/latest/opencv/boxed_ref/struct.BoxedRef_search=

Gets the starting index of the range. The range is inclusive of the start value.

```rust
fn start(&self) -> i32
```

--------------------------------

### Backend Initialization and Support

Source: https://docs.rs/opencv/latest/latest/opencv/dnn/struct.ReciprocalLayer

Methods for checking backend support and initializing specific backends like Halide, nGraph, Vulkan, WebNN, CUDA, and TimVX.

```APIDOC
## GET /layer/support_backend

### Description
Asks the layer if it supports a specific backend for computations.

### Method
GET

### Endpoint
/layer/support_backend

### Parameters
#### Path Parameters
None

#### Query Parameters
- **backend_id** (i32) - Required - The ID of the backend to check.

### Request Example
```
GET /layer/support_backend?backend_id=1
```

### Response
#### Success Response (200)
- **Result** (Result<bool>) - True if the backend is supported, false otherwise.

#### Response Example
```json
{
  "result": true
}
```

## POST /layer/init_halide

### Description
Returns a Halide backend node.

### Method
POST

### Endpoint
/layer/init_halide

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - Input wrappers for the backend.

### Request Example
```json
{
  "inputs": []
}
```

### Response
#### Success Response (200)
- **Result** (Result<Ptr<BackendNode>>) - A pointer to the Halide backend node.

#### Response Example
```json
{
  "result": "<backend_node_pointer>"
}
```

## POST /layer/init_ngraph

### Description
Initializes the nGraph backend.

### Method
POST

### Endpoint
/layer/init_ngraph

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - Input wrappers for the backend.
- **nodes** (Vector<Ptr<BackendNode>>) - Required - Backend nodes.

### Request Example
```json
{
  "inputs": [],
  "nodes": []
}
```

### Response
#### Success Response (200)
- **Result** (Result<Ptr<BackendNode>>) - A pointer to the nGraph backend node.

#### Response Example
```json
{
  "result": "<backend_node_pointer>"
}
```

## POST /layer/init_vk_com

### Description
Initializes the Vulkan (vk_com) backend node.

### Method
POST

### Endpoint
/layer/init_vk_com

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - Input wrappers for the backend.
- **outputs** (Vector<Ptr<BackendWrapper>>) - Required - Output wrappers for the backend.

### Request Example
```json
{
  "inputs": [],
  "outputs": []
}
```

### Response
#### Success Response (200)
- **Result** (Result<Ptr<BackendNode>>) - A pointer to the Vulkan backend node.

#### Response Example
```json
{
  "result": "<backend_node_pointer>"
}
```

## POST /layer/init_webnn

### Description
Initializes the WebNN backend node.

### Method
POST

### Endpoint
/layer/init_webnn

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - Input wrappers for the backend.
- **nodes** (Vector<Ptr<BackendNode>>) - Required - Backend nodes.

### Request Example
```json
{
  "inputs": [],
  "nodes": []
}
```

### Response
#### Success Response (200)
- **Result** (Result<Ptr<BackendNode>>) - A pointer to the WebNN backend node.

#### Response Example
```json
{
  "result": "<backend_node_pointer>"
}
```

## UNSAFE POST /layer/init_cuda

### Description
Returns a CUDA backend node. This is an unsafe operation.

### Method
POST

### Endpoint
/layer/init_cuda

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **context** (*mut c_void) - Required - CUDA context.
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - Input wrappers for the backend.
- **outputs** (Vector<Ptr<BackendWrapper>>) - Required - Output wrappers for the backend.

### Request Example
```json
{
  "context": "<c_void_pointer>",
  "inputs": [],
  "outputs": []
}
```

### Response
#### Success Response (200)
- **Result** (Result<Ptr<BackendNode>>) - A pointer to the CUDA backend node.

#### Response Example
```json
{
  "result": "<backend_node_pointer>"
}
```

## UNSAFE POST /layer/init_tim_vx

### Description
Returns a TimVX backend node. This is an unsafe operation.

### Method
POST

### Endpoint
/layer/init_tim_vx

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **tim_vx_info** (*mut c_void) - Required - TimVX information pointer.
- **inputs_wrapper** (Vector<Ptr<BackendWrapper>>) - Required - Input wrappers for the backend.
- **outputs_wrapper** (Vector<Ptr<BackendWrapper>>) - Required - Output wrappers for the backend.
- **is_last** (bool) - Required - Boolean indicating if this is the last layer.

### Request Example
```json
{
  "tim_vx_info": "<c_void_pointer>",
  "inputs_wrapper": [],
  "outputs_wrapper": [],
  "is_last": false
}
```

### Response
#### Success Response (200)
- **Result** (Result<Ptr<BackendNode>>) - A pointer to the TimVX backend node.

#### Response Example
```json
{
  "result": "<backend_node_pointer>"
}
```

## POST /layer/init_cann

### Description
Returns a CANN backend node.

### Method
POST

### Endpoint
/layer/init_cann

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - Input wrappers for the backend.
- **outputs** (Vector<Ptr<BackendWrapper>>) - Required - Output wrappers for the backend.
- **nodes** (Vector<Ptr<BackendNode>>) - Required - Backend nodes.

### Request Example
```json
{
  "inputs": [],
  "outputs": [],
  "nodes": []
}
```

### Response
#### Success Response (200)
- **Result** (Result<Ptr<BackendNode>>) - A pointer to the CANN backend node.

#### Response Example
```json
{
  "result": "<backend_node_pointer>"
}
```
```

--------------------------------

### Get GpuMat Channels and Step

Source: https://docs.rs/opencv/latest/latest/opencv/boxed_ref/struct.BoxedRef

Returns the number of channels in the GpuMat and the step size (in bytes) between the start of one row and the start of the next.

```rust
fn channels(&self) -> Result<i32>
```

```rust
fn step1(&self) -> Result<size_t>
```

--------------------------------

### Backend Support and Initialization

Source: https://docs.rs/opencv/latest/latest/opencv/boxed_ref/struct.BoxedRefMut

Methods for checking backend compatibility and initializing layers for specific backends. `support_backend` checks if a layer supports a given backend ID. Initialization functions like `init_halide`, `init_ngraph`, `init_vk_com`, `init_webnn`, `init_cuda`, `init_tim_vx`, and `init_cann` prepare the layer for execution on different hardware or frameworks.

```rust
fn support_backend(&mut self, backend_id: i32) -> Result<bool>
Ask layer if it support specific backend for doing computations. Read more
Source§

fn init_halide( &mut self, inputs: &Vector<Ptr<BackendWrapper>>, ) -> Result<Ptr<BackendNode>>
Returns Halide backend node. Read more
Source§

fn init_ngraph( &mut self, inputs: &Vector<Ptr<BackendWrapper>>, nodes: &Vector<Ptr<BackendNode>>, ) -> Result<Ptr<BackendNode>>
Source§

fn init_vk_com( &mut self, inputs: &Vector<Ptr<BackendWrapper>>, outputs: &mut Vector<Ptr<BackendWrapper>>, ) -> Result<Ptr<BackendNode>>
Source§

fn init_webnn( &mut self, inputs: &Vector<Ptr<BackendWrapper>>, nodes: &Vector<Ptr<BackendNode>>, ) -> Result<Ptr<BackendNode>>
Source§

unsafe fn init_cuda( &mut self, context: *mut c_void, inputs: &Vector<Ptr<BackendWrapper>>, outputs: &Vector<Ptr<BackendWrapper>>, ) -> Result<Ptr<BackendNode>>
Returns a CUDA backend node Read more
Source§

unsafe fn init_tim_vx( &mut self, tim_vx_info: *mut c_void, inputs_wrapper: &Vector<Ptr<BackendWrapper>>, outputs_wrapper: &Vector<Ptr<BackendWrapper>>, is_last: bool, ) -> Result<Ptr<BackendNode>>
Returns a TimVX backend node Read more
Source§

fn init_cann( &mut self, inputs: &Vector<Ptr<BackendWrapper>>, outputs: &Vector<Ptr<BackendWrapper>>, nodes: &Vector<Ptr<BackendNode>>, ) -> Result<Ptr<BackendNode>>
Returns a CANN backend node Read more
Source§
```

--------------------------------

### Get GpuMat Data Start Pointer in Rust

Source: https://docs.rs/opencv/latest/0.97.2/opencv/boxed_ref/struct.BoxedRef

Provides a helper pointer to the start of the GpuMat data, used internally for ROI (Region of Interest) operations.

```rust
fn datastart(&self) -> *const u8
```

--------------------------------

### GET /parameters

Source: https://docs.rs/opencv/latest/latest/opencv/prelude/trait.TransientAreasSegmentationModuleTrait

Retrieves the current segmentation parameters setup.

```APIDOC
## GET /parameters

### Description
Retrieves the current parameters setup for the segmentation module.

### Method
GET

### Endpoint
/parameters

### Parameters
None

### Response
#### Success Response (200)
- **SegmentationParameters** (object) - A structure containing the updated target configuration.

#### Response Example
```json
{
  "parameter1": "value1",
  "parameter2": "value2"
}
```
```

--------------------------------

### Layer Initialization and Backend Support

Source: https://docs.rs/opencv/latest/latest/opencv/boxed_ref/struct.BoxedRefMut

Methods for initializing layers with different backends (Halide, Ngraph, Vulkan, WebNN, CUDA, TimVX, CANN) and checking backend support.

```APIDOC
## POST /layer/init_halide

### Description
Initializes the layer with the Halide backend and returns the corresponding backend node.

### Method
POST

### Endpoint
/layer/init_halide

### Parameters
#### Query Parameters
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - Input backend wrappers.

### Request Example
```json
{
  "inputs": [
    {"ptr": "<backend_wrapper_ptr_1>"},
    {"ptr": "<backend_wrapper_ptr_2>"}
  ]
}
```

### Response
#### Success Response (200)
- **Ptr<BackendNode>** (Ptr<BackendNode>) - A pointer to the Halide backend node.

#### Response Example
```json
{
  "backend_node": {"ptr": "<halide_backend_node_ptr>"}
}
```

## POST /layer/init_ngraph

### Description
Initializes the layer with the Ngraph backend and returns the corresponding backend node.

### Method
POST

### Endpoint
/layer/init_ngraph

### Parameters
#### Query Parameters
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - Input backend wrappers.
- **nodes** (Vector<Ptr<BackendNode>>) - Required - Backend nodes for Ngraph.

### Request Example
```json
{
  "inputs": [
    {"ptr": "<backend_wrapper_ptr_1>"}
  ],
  "nodes": [
    {"ptr": "<backend_node_ptr_1>"}
  ]
}
```

### Response
#### Success Response (200)
- **Ptr<BackendNode>** (Ptr<BackendNode>) - A pointer to the Ngraph backend node.

#### Response Example
```json
{
  "backend_node": {"ptr": "<ngraph_backend_node_ptr>"}
}
```

## POST /layer/init_vk_com

### Description
Initializes the layer with the Vulkan backend and returns the corresponding backend node.

### Method
POST

### Endpoint
/layer/init_vk_com

### Parameters
#### Query Parameters
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - Input backend wrappers.
- **outputs** (Vector<Ptr<BackendWrapper>>) - Required - Output backend wrappers.

### Request Example
```json
{
  "inputs": [
    {"ptr": "<backend_wrapper_ptr_1>"}
  ],
  "outputs": [
    {"ptr": "<backend_wrapper_ptr_1>"}
  ]
}
```

### Response
#### Success Response (200)
- **Ptr<BackendNode>** (Ptr<BackendNode>) - A pointer to the Vulkan backend node.

#### Response Example
```json
{
  "backend_node": {"ptr": "<vk_com_backend_node_ptr>"}
}
```

## POST /layer/init_webnn

### Description
Initializes the layer with the WebNN backend and returns the corresponding backend node.

### Method
POST

### Endpoint
/layer/init_webnn

### Parameters
#### Query Parameters
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - Input backend wrappers.
- **nodes** (Vector<Ptr<BackendNode>>) - Required - Backend nodes for WebNN.

### Request Example
```json
{
  "inputs": [
    {"ptr": "<backend_wrapper_ptr_1>"}
  ],
  "nodes": [
    {"ptr": "<backend_node_ptr_1>"}
  ]
}
```

### Response
#### Success Response (200)
- **Ptr<BackendNode>** (Ptr<BackendNode>) - A pointer to the WebNN backend node.

#### Response Example
```json
{
  "backend_node": {"ptr": "<webnn_backend_node_ptr>"}
}
```

## UNSAFE POST /layer/init_cuda

### Description
Initializes the layer with the CUDA backend and returns the corresponding backend node. This operation is unsafe.

### Method
POST

### Endpoint
/layer/init_cuda

### Parameters
#### Query Parameters
- **context** (*mut c_void) - Required - The CUDA context.
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - Input backend wrappers.
- **outputs** (Vector<Ptr<BackendWrapper>>) - Required - Output backend wrappers.

### Request Example
```json
{
  "context": "<cuda_context_ptr>",
  "inputs": [
    {"ptr": "<backend_wrapper_ptr_1>"}
  ],
  "outputs": [
    {"ptr": "<backend_wrapper_ptr_1>"}
  ]
}
```

### Response
#### Success Response (200)
- **Ptr<BackendNode>** (Ptr<BackendNode>) - A pointer to the CUDA backend node.

#### Response Example
```json
{
  "backend_node": {"ptr": "<cuda_backend_node_ptr>"}
}
```

## UNSAFE POST /layer/init_tim_vx

### Description
Initializes the layer with the TimVX backend and returns the corresponding backend node. This operation is unsafe.

### Method
POST

### Endpoint
/layer/init_tim_vx

### Parameters
#### Query Parameters
- **tim_vx_info** (*mut c_void) - Required - TimVX information pointer.
- **inputs_wrapper** (Vector<Ptr<BackendWrapper>>) - Required - Input backend wrappers.
- **outputs_wrapper** (Vector<Ptr<BackendWrapper>>) - Required - Output backend wrappers.
- **is_last** (bool) - Required - Flag indicating if this is the last layer.

### Request Example
```json
{
  "tim_vx_info": "<tim_vx_info_ptr>",
  "inputs_wrapper": [
    {"ptr": "<backend_wrapper_ptr_1>"}
  ],
  "outputs_wrapper": [
    {"ptr": "<backend_wrapper_ptr_1>"}
  ],
  "is_last": true
}
```

### Response
#### Success Response (200)
- **Ptr<BackendNode>** (Ptr<BackendNode>) - A pointer to the TimVX backend node.

#### Response Example
```json
{
  "backend_node": {"ptr": "<tim_vx_backend_node_ptr>"}
}
```

## POST /layer/init_cann

### Description
Initializes the layer with the CANN backend and returns the corresponding backend node.

### Method
POST

### Endpoint
/layer/init_cann

### Parameters
#### Query Parameters
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - Input backend wrappers.
- **outputs** (Vector<Ptr<BackendWrapper>>) - Required - Output backend wrappers.
- **nodes** (Vector<Ptr<BackendNode>>) - Required - Backend nodes for CANN.

### Request Example
```json
{
  "inputs": [
    {"ptr": "<backend_wrapper_ptr_1>"}
  ],
  "outputs": [
    {"ptr": "<backend_wrapper_ptr_1>"}
  ],
  "nodes": [
    {"ptr": "<backend_node_ptr_1>"}
  ]
}
```

### Response
#### Success Response (200)
- **Ptr<BackendNode>** (Ptr<BackendNode>) - A pointer to the CANN backend node.

#### Response Example
```json
{
  "backend_node": {"ptr": "<cann_backend_node_ptr>"}
}
```

## POST /layer/support_backend

### Description
Checks if the layer supports computations for a specific backend ID.

### Method
POST

### Endpoint
/layer/support_backend

### Parameters
#### Query Parameters
- **backend_id** (i32) - Required - The ID of the backend to check support for.

### Request Example
```json
{
  "backend_id": 1
}
```

### Response
#### Success Response (200)
- **bool** (bool) - True if the backend is supported, false otherwise.

#### Response Example
```json
{
  "supported": true
}
```
```

--------------------------------

### Get Matrix Slice Start Pointer (Rust)

Source: https://docs.rs/opencv/latest/0.97.2/opencv/boxed_ref/struct.BoxedRef

Retrieves a raw pointer to the start of the matrix's data slice. This function is part of the low-level memory access for matrices. It does not perform bounds checking.

```rust
fn slice_start(&self) -> *const u8
```

--------------------------------

### Initialize Halide, nGraph, and Vulkan COM Backends in Rust

Source: https://docs.rs/opencv/latest/latest/opencv/boxed_ref/struct.BoxedRefMut

Initializes backend nodes for Halide, nGraph, and Vulkan COM. Each function takes specific input/output structures required by the respective backend and returns a Result containing a pointer to the BackendNode or an error.

```rust
fn init_halide( &mut self, inputs: &Vector<Ptr<BackendWrapper>>, ) -> Result<Ptr<BackendNode>>
```

```rust
fn init_ngraph( &mut self, inputs: &Vector<Ptr<BackendWrapper>>, nodes: &Vector<Ptr<BackendNode>>, ) -> Result<Ptr<BackendNode>>
```

```rust
fn init_vk_com( &mut self, inputs: &Vector<Ptr<BackendWrapper>>, outputs: &mut Vector<Ptr<BackendWrapper>>, ) -> Result<Ptr<BackendNode>>
```

--------------------------------

### CAP_PROP_POS_AVI_RATIO

Source: https://docs.rs/opencv/latest/0.97.2/opencv/videoio/index

Gets or sets the relative position of the video file. 0 indicates the start, and 1 indicates the end.

```APIDOC
## CAP_PROP_POS_AVI_RATIO

### Description
Relative position of the video file: 0=start of the film, 1=end of the film.

### Method
GET/SET

### Endpoint
N/A (This is a property of VideoCapture)

### Parameters
#### Path Parameters
None

#### Query Parameters
- **prop** (int) - Required - `CAP_PROP_POS_AVI_RATIO`

#### Request Body
None

### Request Example
```python
# Get current position ratio
position_ratio = cap.get(cv2.CAP_PROP_POS_AVI_RATIO)

# Set position to the beginning of the video
# cap.set(cv2.CAP_PROP_POS_AVI_RATIO, 0)

# Set position to the end of the video
# cap.set(cv2.CAP_PROP_POS_AVI_RATIO, 1)
```

### Response
#### Success Response (200)
- **ratio** (float) - The relative position of the video file (0.0 to 1.0).

#### Response Example
```json
{
  "ratio": 0.5
}
```
```

--------------------------------

### datastart

Source: https://docs.rs/opencv/latest/latest/opencv/boxed_ref/struct.BoxedRef_search=

Returns a pointer to the datastart.

```APIDOC
## datastart

### Description
Returns a pointer to the datastart helper fields used in locateROI and adjustROI.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- ***const u8** (Pointer) - A pointer to datastart.
```

--------------------------------

### Quantization and Backend Initialization Methods

Source: https://docs.rs/opencv/latest/latest/opencv/boxed_ref/struct.BoxedRefMut

Methods for trying to quantize the layer and initializing various backend specific nodes.

```APIDOC
## POST /websites/rs_opencv/try_quantize

### Description
Tries to quantize the given layer and compute the quantization parameters required for fixed-point implementation.

### Method
POST

### Endpoint
/websites/rs_opencv/try_quantize

### Parameters
#### Request Body
- **scales** (Vector<Vector<f32>>) - Required - The scales for quantization.
- **zeropoints** (Vector<Vector<i32>>) - Required - The zero points for quantization.
- **params** (LayerParamsTrait) - Required - The layer parameters trait object.

### Request Example
```json
{
  "scales": [[0.1, 0.2]],
  "zeropoints": [[0, 1]],
  "params": {
    "some_param": "value"
  }
}
```

### Response
#### Success Response (200)
- **result** (Result<bool>) - A boolean indicating whether quantization was successful.

### Response Example
```json
{
  "result": {
    "Ok": true
  }
}
```

## POST /websites/rs_opencv/init_halide

### Description
Returns a Halide backend node. Used for initializing the Halide backend for computation.

### Method
POST

### Endpoint
/websites/rs_opencv/init_halide

### Parameters
#### Request Body
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - The input backend wrappers.

### Request Example
```json
{
  "inputs": [
    {
      "ptr": "0x12345678"
    }
  ]
}
```

### Response
#### Success Response (200)
- **result** (Result<Ptr<BackendNode>>) - The Halide backend node.

### Response Example
```json
{
  "result": {
    "Ok": {
      "ptr": "0xabcdef12"
    }
  }
}
```

## POST /websites/rs_opencv/init_ngraph

### Description
Initializes the nGraph backend node. Used for integrating with the nGraph framework.

### Method
POST

### Endpoint
/websites/rs_opencv/init_ngraph

### Parameters
#### Request Body
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - The input backend wrappers.
- **nodes** (Vector<Ptr<BackendNode>>) - Required - The backend nodes.

### Request Example
```json
{
  "inputs": [
    {
      "ptr": "0x12345678"
    }
  ],
  "nodes": [
    {
      "ptr": "0xabcdef12"
    }
  ]
}
```

### Response
#### Success Response (200)
- **result** (Result<Ptr<BackendNode>>) - The nGraph backend node.

### Response Example
```json
{
  "result": {
    "Ok": {
      "ptr": "0xabcdef12"
    }
  }
}
```

## POST /websites/rs_opencv/init_vk_com

### Description
Initializes the Vulkan compute backend node. Used for Vulkan-based computations.

### Method
POST

### Endpoint
/websites/rs_opencv/init_vk_com

### Parameters
#### Request Body
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - The input backend wrappers.
- **outputs** (Vector<Ptr<BackendWrapper>>) - Required - The output backend wrappers.

### Request Example
```json
{
  "inputs": [
    {
      "ptr": "0x12345678"
    }
  ],
  "outputs": [
    {
      "ptr": "0xabcdef12"
    }
  ]
}
```

### Response
#### Success Response (200)
- **result** (Result<Ptr<BackendNode>>) - The Vulkan compute backend node.

### Response Example
```json
{
  "result": {
    "Ok": {
      "ptr": "0xabcdef12"
    }
  }
}
```

## POST /websites/rs_opencv/init_webnn

### Description
Initializes the WebNN backend node. Used for WebNN computations.

### Method
POST

### Endpoint
/websites/rs_opencv/init_webnn

### Parameters
#### Request Body
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - The input backend wrappers.
- **nodes** (Vector<Ptr<BackendNode>>) - Required - The backend nodes.

### Request Example
```json
{
  "inputs": [
    {
      "ptr": "0x12345678"
    }
  ],
  "nodes": [
    {
      "ptr": "0xabcdef12"
    }
  ]
}
```

### Response
#### Success Response (200)
- **result** (Result<Ptr<BackendNode>>) - The WebNN backend node.

### Response Example
```json
{
  "result": {
    "Ok": {
      "ptr": "0xabcdef12"
    }
  }
}
```

## POST /websites/rs_opencv/init_cuda

### Description
Returns a CUDA backend node. Used for initializing the CUDA backend for computation.

### Method
POST

### Endpoint
/websites/rs_opencv/init_cuda

### Parameters
#### Request Body
- **context** (*mut c_void) - Required - The CUDA context pointer.
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - The input backend wrappers.
- **outputs** (Vector<Ptr<BackendWrapper>>) - Required - The output backend wrappers.

### Request Example
```json
{
  "context": "0x7ffc12345678",
  "inputs": [
    {
      "ptr": "0x12345678"
    }
  ],
  "outputs": [
    {
      "ptr": "0xabcdef12"
    }
  ]
}
```

### Response
#### Success Response (200)
- **result** (Result<Ptr<BackendNode>>) - The CUDA backend node.

### Response Example
```json
{
  "result": {
    "Ok": {
      "ptr": "0xabcdef12"
    }
  }
}
```

## POST /websites/rs_opencv/init_tim_vx

### Description
Returns a TimVX backend node. Used for initializing the TimVX backend for computation.

### Method
POST

### Endpoint
/websites/rs_opencv/init_tim_vx

### Parameters
#### Request Body
- **tim_vx_info** (*mut c_void) - Required - The TimVX info pointer.
- **inputs_wrapper** (Vector<Ptr<BackendWrapper>>) - Required - The input backend wrappers.
- **outputs_wrapper** (Vector<Ptr<BackendWrapper>>) - Required - The output backend wrappers.
- **is_last** (bool) - Required - Flag indicating if this is the last layer.

### Request Example
```json
{
  "tim_vx_info": "0x7ffc12345678",
  "inputs_wrapper": [
    {
      "ptr": "0x12345678"
    }
  ],
  "outputs_wrapper": [
    {
      "ptr": "0xabcdef12"
    }
  ],
  "is_last": false
}
```

### Response
#### Success Response (200)
- **result** (Result<Ptr<BackendNode>>) - The TimVX backend node.

### Response Example
```json
{
  "result": {
    "Ok": {
      "ptr": "0xabcdef12"
    }
  }
}
```

## POST /websites/rs_opencv/init_cann

### Description
Returns a CANN backend node. Used for initializing the CANN backend for computation.

### Method
POST

### Endpoint
/websites/rs_opencv/init_cann

### Parameters
#### Request Body
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - The input backend wrappers.
- **outputs** (Vector<Ptr<BackendWrapper>>) - Required - The output backend wrappers.
- **nodes** (Vector<Ptr<BackendNode>>) - Required - The backend nodes.

### Request Example
```json
{
  "inputs": [
    {
      "ptr": "0x12345678"
    }
  ],
  "outputs": [
    {
      "ptr": "0xabcdef12"
    }
  ],
  "nodes": [
    {
      "ptr": "0x11223344"
    }
  ]
}
```

### Response
#### Success Response (200)
- **result** (Result<Ptr<BackendNode>>) - The CANN backend node.

### Response Example
```json
{
  "result": {
    "Ok": {
      "ptr": "0xabcdef12"
    }
  }
}
```
```

--------------------------------

### GET /setup

Source: https://docs.rs/opencv/latest/latest/opencv/prelude/trait.TransientAreasSegmentationModuleTrait

Returns a formatted string containing the current parameters setup.

```APIDOC
## GET /setup

### Description
Provides a display method for the current parameters setup as a formatted string.

### Method
GET

### Endpoint
/setup

### Parameters
None

### Response
#### Success Response (200)
- **String** (string) - A string which contains formatted parameters information.

#### Response Example
```json
"Parameter1: value1, Parameter2: value2"
```
```

--------------------------------

### Get Retina Parameters

Source: https://docs.rs/opencv/latest/0.97.2/opencv/mod_prelude/trait.RetinaTrait

Retrieves the current parameter setup of the retina instance.

```APIDOC
## GET /websites/rs_opencv/get_parameters

### Description
Retrieves the current parameter setup of the retina instance.

### Method
GET

### Endpoint
/websites/rs_opencv/get_parameters

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
* **parameters** (RetinaParameters) - The current parameters setup.

#### Response Example
```json
{
  "parameters": {
    "retinaParameterFile": "default.xml",
    "applyDefaultSetupOnFailure": true
  }
}
```
```

--------------------------------

### Backend Initialization Methods

Source: https://docs.rs/opencv/latest/latest/opencv/dnn/struct.ResizeLayer

Methods for initializing various backend nodes for computation.

```APIDOC
## POST /websites/rs_opencv/init_halide

### Description
Returns a Halide backend node.

### Method
POST

### Endpoint
/websites/rs_opencv/init_halide

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - Input wrappers for the backend.

### Request Example
```json
{
  "inputs": ["...", "..."]
}
```

### Response
#### Success Response (200)
- **backend_node** (Ptr<BackendNode>) - A pointer to the Halide backend node.

#### Response Example
```json
{
  "backend_node": "..."
}
```

## POST /websites/rs_opencv/init_ngraph

### Description
Initializes the nGraph backend.

### Method
POST

### Endpoint
/websites/rs_opencv/init_ngraph

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - Input wrappers for the backend.
- **nodes** (Vector<Ptr<BackendNode>>) - Required - Backend nodes.

### Request Example
```json
{
  "inputs": ["..."],
  "nodes": ["...", "..."]
}
```

### Response
#### Success Response (200)
- **backend_node** (Ptr<BackendNode>) - A pointer to the nGraph backend node.

#### Response Example
```json
{
  "backend_node": "..."
}
```

## POST /websites/rs_opencv/init_vk_com

### Description
Initializes the Vulkan backend.

### Method
POST

### Endpoint
/websites/rs_opencv/init_vk_com

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - Input wrappers for the backend.
- **outputs** (Vector<Ptr<BackendWrapper>>) - Required - Output wrappers for the backend.

### Request Example
```json
{
  "inputs": ["..."],
  "outputs": ["...", "..."]
}
```

### Response
#### Success Response (200)
- **backend_node** (Ptr<BackendNode>) - A pointer to the Vulkan backend node.

#### Response Example
```json
{
  "backend_node": "..."
}
```

## POST /websites/rs_opencv/init_webnn

### Description
Initializes the WebNN backend.

### Method
POST

### Endpoint
/websites/rs_opencv/init_webnn

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - Input wrappers for the backend.
- **nodes** (Vector<Ptr<BackendNode>>) - Required - Backend nodes.

### Request Example
```json
{
  "inputs": ["..."],
  "nodes": ["...", "..."]
}
```

### Response
#### Success Response (200)
- **backend_node** (Ptr<BackendNode>) - A pointer to the WebNN backend node.

#### Response Example
```json
{
  "backend_node": "..."
}
```

## UNSAFE POST /websites/rs_opencv/init_cuda

### Description
Returns a CUDA backend node.

### Method
POST

### Endpoint
/websites/rs_opencv/init_cuda

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **context** (*mut c_void) - Required - CUDA context pointer.
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - Input wrappers for the backend.
- **outputs** (Vector<Ptr<BackendWrapper>>) - Required - Output wrappers for the backend.

### Request Example
```json
{
  "context": "...",
  "inputs": ["..."],
  "outputs": ["...", "..."]
}
```

### Response
#### Success Response (200)
- **backend_node** (Ptr<BackendNode>) - A pointer to the CUDA backend node.

#### Response Example
```json
{
  "backend_node": "..."
}
```

## UNSAFE POST /websites/rs_opencv/init_tim_vx

### Description
Returns a TimVX backend node.

### Method
POST

### Endpoint
/websites/rs_opencv/init_tim_vx

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **tim_vx_info** (*mut c_void) - Required - TimVX info pointer.
- **inputs_wrapper** (Vector<Ptr<BackendWrapper>>) - Required - Input wrappers for the backend.
- **outputs_wrapper** (Vector<Ptr<BackendWrapper>>) - Required - Output wrappers for the backend.
- **is_last** (bool) - Required - Flag indicating if this is the last node.

### Request Example
```json
{
  "tim_vx_info": "...",
  "inputs_wrapper": ["..."],
  "outputs_wrapper": ["...", "..."],
  "is_last": true
}
```

### Response
#### Success Response (200)
- **backend_node** (Ptr<BackendNode>) - A pointer to the TimVX backend node.

#### Response Example
```json
{
  "backend_node": "..."
}
```

## POST /websites/rs_opencv/init_cann

### Description
Returns a CANN backend node.

### Method
POST

### Endpoint
/websites/rs_opencv/init_cann

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **inputs** (Vector<Ptr<BackendWrapper>>) - Required - Input wrappers for the backend.
- **outputs** (Vector<Ptr<BackendWrapper>>) - Required - Output wrappers for the backend.
- **nodes** (Vector<Ptr<BackendNode>>) - Required - Backend nodes.

### Request Example
```json
{
  "inputs": ["..."],
  "outputs": ["...", "..."],
  "nodes": ["..."]
}
```

### Response
#### Success Response (200)
- **backend_node** (Ptr<BackendNode>) - A pointer to the CANN backend node.

#### Response Example
```json
{
  "backend_node": "..."
}
```
```
Tokens:
Raw