DriveWorks SDK Reference
3.5.78 Release
For Test and Development only

/dvs/git/dirty/gitlab-master_av/dw/sdk/samples/roadmarkclassification/README.md
Go to the documentation of this file.
1 # Copyright (c) 2020, NVIDIA CORPORATION. All rights reserved.
2 
3 @page dwx_roadmark_classification_sample Road Mark Classification Sample
4 @tableofcontents
5 
6 @section dwx_roadmark_classification_description Description
7 
8 The road mark classification sample demonstrates how to use the NVIDIA<sup>&reg;</sup>
9 proprietary deep neural network (DNN) RoadMarkNet to perform classification on detected road markings from a given frame <br>. It classifies the type of road markings that include different
10 types of arrow marks, speed limit mark and its associated value, HOV mark, bike mark, hump mark
11 and a variety of text marks.
12 
13 A user assigned threshold value sets the minimum confidence for the road mark classification to be considered valid.
14 
15 @subsection dwx_roadmark_classification_details Sensor Details
16 
17 The image datasets used to train RoadMarkNet have been captured by a View Sekonix Camera Module (SF3324/5)
18 with AR0231 RCCB sensor.<br>
19 The camera is mounted high up at the rear view mirror position. Demo videos are captured at 2.3 MP and down-sampled to 960 x 604.
20 
21 To achieve the best road mark classification performance, adopt a similar camera setup and align
22 the video center vertically with the horizon before recording new videos.
23 
24 @section dwx_roadmark_classification_running Running the Sample
25 
26 The road mark classification sample, `sample_roadmark_classification` accepts the following optional parameters.<br>
27 If none are specified, it will perform classification on supplied pre-recorded video. **Note:** Do not include angle brackets < and > in the parameters below.
28 
29  ./sample_roadmark_classification --camera-type=<camera>
30  --camera-group=<a|b|c|d>
31  --camera-index=<0|1|2|3>
32  --input-type=<video|camera>
33  --roi=<x,y,w,h>
34  --classificationThreshold=<floating-point number in (0, 1)>
35  --video=<path/to/video>
36 
37 Where:
38 
39  --camera-type=<camera>
40  Is a supported AR0231 `RCCB` sensor.
41  Only applicable if '--input-type=camera'.
42  Default value: ar0231-rccb-bae-sf3324
43 
44  --camera-group=<a|b|c|d>
45  Is the group where the camera is connected to.
46  Only applicable if '--input-type=camera'.
47  Default value: a
48 
49  --camera-index=<0|1|2|3>
50  Indicates the camera index on the given port.
51  Default value: 0
52 
53  --input-type=<video|camera>
54  Defines if the input is from live camera or from a recorded video.
55  Live camera is only supported on On NVIDIA DRIVE platform.
56  Default value: video
57 
58  --roi=<x,y,w,h>
59  Defines a Region of Interest (ROI) where landmark detections occur:
60  X: x-coordinate.
61  Y: y-coordinate.
62  W: width.
63  H: height.
64  Default value: No ROI.
65 
66  --classificationThreshold=<floating-point number in (0, 1)>
67  The classification threshold parameter is used to determine the validity of the road mark
68  type generated by the network. If there is no type above the threshold parameter, then the
69  road mark is assigned as background.
70  Default value: 0.5f
71 
72  --video=<path/to/video>
73  Is the absolute or relative path of a raw/h264/mp4 recording.
74  Default value: path/to/data/samples/recordings/suburb0/video_0_roof_front_120.mp4.
75 
76 @subsection dwx_roadmark_classification_examples Examples
77 
78 #### To run the sample on Linux
79 
80  ./sample_roadmark_classification --video=<video file.h264>
81 or
82 
83  ./sample_roadmark_classification --video=<video file.raw>
84 or
85 
86  ./sample_roadmark_classification --video=<video file.mp4>
87 
88 #### To run the sample on an NVIDIA DRIVE platform with cameras
89 
90  ./sample_roadmark_classification --input-type=camera --camera-type=<camera_type> --camera-group=<camera_group>
91 
92 where `<camera type>` is a supported `RCCB` sensor.
93 See @ref supported_sensors for the list of supported cameras for each platform.
94 
95 @section dwx_roadmark_classification_sample_output Output
96 
97 The sample app creates a window and overlays the bounding box of road mark detection from landmark detector. The type of road marking and it's associated confidence from roadmark classifier is displayed on top of each bounding box.<br>
98 
99 ![RoadMark Classification Sample](sample_roadmark_classification.png)
100 
101 @section dwx_roadmark_classification_more Additional Information
102 
103 For more details see @ref landmarks_mainsection.