Skip to content

Commit 7b1f766

Browse files
authored
Remove some transform pipelines (#3775)
1 parent b8dd966 commit 7b1f766

File tree

1 file changed

+0
-192
lines changed

1 file changed

+0
-192
lines changed

docs/components/camera/transform.md

Lines changed: 0 additions & 192 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,6 @@ The following attributes are available for `transform` views:
118118
| `pipeline` | array | **Required** | Specify an array of transformation objects. |
119119
| `intrinsic_parameters` | object | Optional | The intrinsic parameters of the camera used to do 2D <-> 3D projections: <ul> <li> <code>width_px</code>: The expected width of the aligned image in pixels. Value must be >= 0.</li> <li> <code>height_px</code>: The expected height of the aligned image in pixels. Value must be >= 0.</li> <li> <code>fx</code>: The image center x point. </li> <li> <code>fy</code>: The image center y point. </li> <li> <code>ppx</code>: The image focal x. </li> <li> <code>ppy</code>: The image focal y. </li> </ul> |
120120
| `distortion_parameters` | object | Optional | Modified Brown-Conrady parameters used to correct for distortions caused by the shape of the camera lens: <ul> <li> <code>rk1</code>: The radial distortion x. </li> <li> <code>rk2</code>: The radial distortion y. </li> <li> <code>rk3</code>: The radial distortion z. </li> <li> <code>tp1</code>: The tangential distortion x. </li> <li> <code>tp2</code>: The tangential distortion y. </li> </ul> |
121-
| `debug` | boolean | Optional | Enables the debug outputs from the camera if `true`. <br> Default: `false` |
122121

123122
The following are the transformation objects available for the `pipeline`:
124123

@@ -232,73 +231,6 @@ If you have a 100 x 200 image, and you want to crop to a box between the points
232231
- `y_max_px`: The y coordinate or the relative proportion of the bottom right point of the rectangular area to crop the image to.
233232
- `overlay_crop_box`: Set to `true` to not actually carry out the crop, but instead overlay the cropping box on the original image and visualize where the crop would be applied.
234233

235-
### Depth edges
236-
237-
The Depth Edges transform creates a canny edge detector to detect edges on an input depth map.
238-
239-
```json {class="line-numbers linkable-line-numbers"}
240-
{
241-
"source": "<your-source-camera-name>",
242-
"pipeline": [
243-
{
244-
"type": "depth_edges",
245-
"attributes": {
246-
"high_threshold_pct": <float>,
247-
"low_threshold_pct": <float>,
248-
"blur_radius_px": <float>
249-
}
250-
}
251-
]
252-
}
253-
```
254-
255-
**Attributes:**
256-
257-
- `high_threshold_pct`: The high threshold value: between 0.0 - 1.0.
258-
- `low_threshold_pct`: The low threshold value: between 0.0 - 1.0.
259-
- `blur_radius_px`: The blur radius used to smooth the image before applying the filter.
260-
261-
### Depth preprocess
262-
263-
Depth Preprocessing applies some basic hole-filling and edge smoothing to a depth map.
264-
265-
```json {class="line-numbers linkable-line-numbers"}
266-
{
267-
"source": "<your-source-camera-name>",
268-
"pipeline": [
269-
{
270-
"type": "depth_preprocess",
271-
"attributes": {}
272-
}
273-
]
274-
}
275-
```
276-
277-
**Attributes:**
278-
279-
- None.
280-
281-
### Depth to pretty
282-
283-
The Depth-to-Pretty transform takes a depth image and turns it into a colorful image, with blue indicating distant points and red indicating nearby points.
284-
The actual depth information is lost in the transform.
285-
286-
```json {class="line-numbers linkable-line-numbers"}
287-
{
288-
"source": "<your-source-camera-name>",
289-
"pipeline": [
290-
{
291-
"type": "depth_to_pretty",
292-
"attributes": {}
293-
}
294-
]
295-
}
296-
```
297-
298-
**Attributes:**
299-
300-
- None.
301-
302234
### Detections
303235

304236
The Detections transform takes the input image and overlays the detections from a given detector configured within the [vision service](/services/vision/).
@@ -325,62 +257,6 @@ The Detections transform takes the input image and overlays the detections from
325257
- `confidence_threshold`: Specify to only display detections above the specified threshold (decimal between 0 and 1).
326258
- `valid_labels`: _Optional_. An array of labels that you to see detections for on the camera stream. If not specified, all labels from the classifier are used.
327259

328-
### Identity
329-
330-
The Identity transform does nothing to the image.
331-
You can use this transform to change the underlying camera source's intrinsic parameters or stream type, for example.
332-
333-
```json {class="line-numbers linkable-line-numbers"}
334-
{
335-
"source": "<your-source-camera-name>",
336-
"pipeline": [
337-
{
338-
"type": "identity"
339-
}
340-
]
341-
}
342-
```
343-
344-
**Attributes:**
345-
346-
- None
347-
348-
### Overlay
349-
350-
Overlays the depth and the color 2D images.
351-
Useful to debug the alignment of the two images.
352-
353-
```json {class="line-numbers linkable-line-numbers"}
354-
{
355-
"source": "<your-source-camera-name>",
356-
"pipeline": [
357-
{
358-
"type": "overlay",
359-
"attributes": {
360-
"intrinsic_parameters": {
361-
"width_px": <int>,
362-
"height_px": <int>,
363-
"ppx": <float>,
364-
"ppy": <float>,
365-
"fx": <float>,
366-
"fy": <float>,
367-
}
368-
}
369-
}
370-
]
371-
}
372-
```
373-
374-
**Attributes:**
375-
376-
- `intrinsic_parameters`: The intrinsic parameters of the camera used to do 2D <-> 3D projections.
377-
- `width_px`: The width of the image in pixels. Value must be >= 0.
378-
- `height_px`: The height of the image in pixels. Value must be >= 0.
379-
- `ppx`: The image center x point.
380-
- `ppy`: The image center y point.
381-
- `fx`: The image focal x.
382-
- `fy`: The image focal y.
383-
384260
### Resize
385261

386262
The Resize transform resizes the image to the specified height and width.
@@ -428,74 +304,6 @@ This feature is useful for when the camera is installed upside down or sideways
428304

429305
- `angle_deg`: Rotate the image by a specific angle in degrees.
430306

431-
### Undistort
432-
433-
The Undistort transform undistorts the input image according to the intrinsic and distortion parameters specified within the camera parameters.
434-
Currently only supports a Brown-Conrady model of distortion (20 September 2022).
435-
For further information, please refer to the [OpenCV docs](https://docs.opencv.org/3.4/da/d54/group__imgproc__transform.html#ga7dfb72c9cf9780a347fbe3d1c47e5d5a).
436-
437-
```json {class="line-numbers linkable-line-numbers"}
438-
{
439-
"source": "<your-source-camera-name>",
440-
"pipeline": [
441-
{
442-
"type": "undistort",
443-
"attributes": {
444-
"intrinsic_parameters": {
445-
"width_px": <int>,
446-
"height_px": <int>,
447-
"ppx": <float>,
448-
"ppy": <float>,
449-
"fx": <float>,
450-
"fy": <float>
451-
},
452-
"distortion_parameters": {
453-
"rk1": <float>,
454-
"rk2": <float>,
455-
"rk3": <float>,
456-
"tp1": <float>,
457-
"tp2": <float>
458-
}
459-
}
460-
}
461-
]
462-
}
463-
```
464-
465-
**Attributes:**
466-
467-
- `intrinsic_parameters`: The intrinsic parameters of the camera used to do 2D <-> 3D projections.
468-
- `width_px`: The expected width of the aligned image in pixels. Value must be >= 0.
469-
- `height_px`: The expected height of the aligned image in pixels. Value must be >= 0.
470-
- `ppx`: The image center x point.
471-
- `ppy`: The image center y point.
472-
- `fx`: The image focal x.
473-
- `fy`: The image focal y.
474-
- `distortion_parameters`: Modified Brown-Conrady parameters used to correct for distortions caused by the shape of the camera lens.
475-
- `rk1`: The radial distortion x.
476-
- `rk2`: The radial distortion y.
477-
- `rk3`: The radial distortion z.
478-
- `tp1`: The tangential distortion x.
479-
- `tp2`: The tangential distortion y.
480-
481-
## Example
482-
483-
```json {class="line-numbers linkable-line-numbers"}
484-
{
485-
"name": "camera_name",
486-
"model": "transform",
487-
"type": "camera",
488-
"namespace": "rdk",
489-
"attributes": {
490-
"source": "physical_cam",
491-
"pipeline": [
492-
{ "type": "rotate", "attributes": {} },
493-
{ "type": "resize", "attributes": { "width_px": 200, "height_px": 100 } }
494-
]
495-
}
496-
}
497-
```
498-
499307
## View the camera stream
500308

501309
{{< readfile "/static/include/components/camera-view-camera-stream.md" >}}

0 commit comments

Comments
 (0)