laneBoundaryPlotter

Lane boundary plotter for bird's-eye plot

collapse all in page

Syntax

lbPlotter = laneBoundaryPlotter(bep)
lbPlotter = laneBoundaryPlotter(bep,Name,Value)

Description

lbPlotter = laneBoundaryPlotter(bep) creates a LaneBoundaryPlotter object that configures the display of lane boundaries on a bird's-eye plot. The LaneBoundaryPlotter object is stored in the Plotters property of the input birdsEyePlot object, bep. To display the lane boundaries, use the plotLaneBoundary function.

example

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

Examples

collapse all

Open Live Script

Create left-lane and right-lane boundaries.

leftlb = parabolicLaneBoundary([-0.001,0.01,-1.8]);
rightlb = parabolicLaneBoundary([-0.001,0.01,1.8]);

Create a bird's-eye plot with an x-axis range from 0 to 30 meters and a y-axis range from –5 to 5 meters.

bep = birdsEyePlot('XLimits',[0 30],'YLimits',[-5 5]);

Figure contains an axes object. The axes object with xlabel X (m), ylabel Y (m) is empty.

Create a lane boundary plotter.

lbPlotter = laneBoundaryPlotter(bep,'DisplayName','Lane boundaries');

Figure contains an axes object. The axes object with xlabel X (m), ylabel Y (m) contains an object of type line. This object represents Lane boundaries.

Display the lane boundaries on the bird's-eye plot.

plotLaneBoundary(lbPlotter,[leftlb rightlb]);

Figure contains an axes object. The axes object with xlabel X (m), ylabel Y (m) contains an object of type line. This object represents Lane boundaries.

Input Arguments

collapse all

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

Name-Value Arguments

collapse all

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: laneBoundaryPlotter('Color','red') sets the color of lane boundaries to red.

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.

Lane boundary color, specified as the comma-separated pair consisting of 'Color' 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 string scalar or character vector 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. Therefore, 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 the hexadecimal color codes.

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

Sample of the color red

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

Sample of the color green

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

Sample of the color blue

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

Sample of the color cyan

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

Sample of the color magenta

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

Sample of the color yellow

"black""k"[0 0 0]"#000000"

Sample of the color black

"white""w"[1 1 1]"#FFFFFF"

Sample of the color white

"none"Not applicableNot applicableNot applicableNo color

This table lists the default color palettes for plots in the light and dark themes.

PalettePalette Colors

"gem" — Light theme default

Before R2025a: Most plots use these colors by default.

Sample of the "gem" color palette

"glow" — Dark theme default

Sample of the "glow" color palette

You can get the RGB triplets and hexadecimal color codes for these palettes using the orderedcolors and rgb2hex functions. For example, get the RGB triplets for the "gem" palette and convert them to hexadecimal color codes.

RGB = orderedcolors("gem");
H = rgb2hex(RGB);

Before R2023b: Get the RGB triplets using RGB = get(groot,"FactoryAxesColorOrder").

Before R2024a: Get the hexadecimal color codes using H = compose("#%02X%02X%02X",round(RGB*255)).

Lane boundary line style, specified as the comma-separated pair consisting of 'LineStyle' and one of the options listed in this table.

Line StyleDescriptionResulting Line
"-"Solid line

Sample of solid line

"--"Dashed line

Sample of dashed line

":"Dotted line

Sample of dotted line

"-."Dash-dotted line

Sample of dash-dotted line, with alternating dashes and dots

"none"No lineNo line

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

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

lbPlotter is stored in the Plotters property of the input birdsEyePlot object, bep. To plot the lane boundaries, use the plotLaneBoundary function.

Version History

Introduced in R2017a

See Also

| | | |