Main Content

detectionPlotter

Detection plotter for bird's-eye plot

Description

detPlotter = detectionPlotter(bep) creates a DetectionPlotter object that configures the display of object detections on a bird's-eye plot. The DetectionPlotter object is stored in the Plotters property of the input birdsEyePlot object, bep. To plot the object detections, use the plotDetection function.

example

detPlotter = detectionPlotter(bep,Name,Value) sets properties using one or more Name,Value pair arguments. For example, detectionPlotter(bep,'DisplayName','Detections') sets the display name that appears in the bird's-eye-plot legend.

Examples

collapse all

Create a bird's-eye plot with an x-axis range from 0 to 90 meters and a y-axis range from –35 to 35 meters. Create a radar detection plotter that displays detections in blue.

bep = birdsEyePlot('XLim',[0 90],'YLim',[-35 35]);
detPlotter = detectionPlotter(bep,'DisplayName','Radar detections', ...
    'MarkerFaceColor','b');

Display the positions and velocities of three labeled detections.

positions = [30 5; 30 -10; 30 15];
velocities = [-10 0; -10 3; -10 -4];
labels = {'D1','D2','D3'};
plotDetection(detPlotter,positions,velocities,labels);

Input Arguments

collapse all

Bird’s-eye plot, specified as a birdsEyePlot object.

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: detectionPlotter('Marker','+') sets the marker symbol for detections to a plus sign.

Plotter name to display in legend, specified as the comma-separated pair consisting of 'DisplayName' and character vector or string scalar. If you do not specify a name, the bird's-eye plot does not display a legend entry for the plotter.

Marker symbol for detections, specified as the comma-separated pair consisting of 'Marker' and one of the markers in this table.

ValueDescription
'o'Circle
'+'Plus sign
'*'Asterisk
'.'Point
'x'Cross
'_'Horizontal line
'|'Vertical line
'square' or 's'Square
'diamond' or 'd'Diamond
'^'Upward-pointing triangle
'v'Downward-pointing triangle
'>'Right-pointing triangle
'<'Left-pointing triangle
'pentagram' or 'p'Five-pointed star (pentagram)
'hexagram' or 'h'Six-pointed star (hexagram)
'none'No markers

Size of marker, specified as the comma-separated pair consisting of 'MarkerSize' and a positive integer in points.

Marker outline color for detections, specified as the comma-separated pair consisting of 'MarkerEdgeColor' and an RGB triplet, a hexadecimal color code, a color name, or a short color name.

For a custom color, specify an RGB triplet or a hexadecimal color code.

  • An RGB triplet is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range [0,1]; for example, [0.4 0.6 0.7].

  • A hexadecimal color code is a character vector or a string scalar that starts with a hash symbol (#) followed by three or six hexadecimal digits, which can range from 0 to F. The values are not case sensitive. Thus, the color codes '#FF8800', '#ff8800', '#F80', and '#f80' are equivalent.

Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.

Color NameShort NameRGB TripletHexadecimal Color CodeAppearance
'red''r'[1 0 0]'#FF0000'

'green''g'[0 1 0]'#00FF00'

'blue''b'[0 0 1]'#0000FF'

'cyan' 'c'[0 1 1]'#00FFFF'

'magenta''m'[1 0 1]'#FF00FF'

'yellow''y'[1 1 0]'#FFFF00'

'black''k'[0 0 0]'#000000'

'white''w'[1 1 1]'#FFFFFF'

'none'Not applicableNot applicableNot applicableNo color

Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB® uses in many types of plots.

RGB TripletHexadecimal Color CodeAppearance
[0 0.4470 0.7410]'#0072BD'

[0.8500 0.3250 0.0980]'#D95319'

[0.9290 0.6940 0.1250]'#EDB120'

[0.4940 0.1840 0.5560]'#7E2F8E'

[0.4660 0.6740 0.1880]'#77AC30'

[0.3010 0.7450 0.9330]'#4DBEEE'

[0.6350 0.0780 0.1840]'#A2142F'

Marker fill color, specified as the comma-separated pair consisting of 'MarkerFaceColor' and an RGB triplet, a hexadecimal color code, a color name, or a short color name.

For a custom color, specify an RGB triplet or a hexadecimal color code.

  • An RGB triplet is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range [0,1]; for example, [0.4 0.6 0.7].

  • A hexadecimal color code is a character vector or a string scalar that starts with a hash symbol (#) followed by three or six hexadecimal digits, which can range from 0 to F. The values are not case sensitive. Thus, the color codes '#FF8800', '#ff8800', '#F80', and '#f80' are equivalent.

Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.

Color NameShort NameRGB TripletHexadecimal Color CodeAppearance
'red''r'[1 0 0]'#FF0000'

'green''g'[0 1 0]'#00FF00'

'blue''b'[0 0 1]'#0000FF'

'cyan' 'c'[0 1 1]'#00FFFF'

'magenta''m'[1 0 1]'#FF00FF'

'yellow''y'[1 1 0]'#FFFF00'

'black''k'[0 0 0]'#000000'

'white''w'[1 1 1]'#FFFFFF'

'none'Not applicableNot applicableNot applicableNo color

Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.

RGB TripletHexadecimal Color CodeAppearance
[0 0.4470 0.7410]'#0072BD'

[0.8500 0.3250 0.0980]'#D95319'

[0.9290 0.6940 0.1250]'#EDB120'

[0.4940 0.1840 0.5560]'#7E2F8E'

[0.4660 0.6740 0.1880]'#77AC30'

[0.3010 0.7450 0.9330]'#4DBEEE'

[0.6350 0.0780 0.1840]'#A2142F'

Font size for labeling detections, specified as the comma-separated pair consisting of 'FontSize' and a positive integer in font points.

Gap between label and positional point, specified as the comma-separated pair consisting of 'LabelOffset' and a real-valued vector of the form [x y]. Units are in meters.

Scale factor for magnitude length of velocity vectors, specified as the comma-separated pair consisting of 'VelocityScaling' and a positive real scalar. The bird's-eye plot renders the magnitude vector value as M × VelocityScaling, where M is the magnitude of velocity.

Tag associated with the plotter object, specified as the comma-separated pair consisting of 'Tag' and a character vector or string scalar. The default value is 'PlotterN', where N is an integer that corresponds to the Nth plotter associated with the input birdsEyePlot object.

Output Arguments

collapse all

Detection plotter, returned as a DetectionPlotter object. You can modify this object by changing its property values. The property names correspond to the name-value pair arguments of the detectionPlotter function.

detPlotter is stored in the Plotters property of the input birdsEyePlot object, bep. To plot the detections, use the plotDetection function.

Introduced in R2017a