clutterRegionPlotter

Create clutter region plotter

Since R2022b

Syntax

plotter = clutterRegionPlotter(tp)

plotter = clutterRegionPlotter(tp,Name=Value)

Description

plotter = clutterRegionPlotter(tp) creates a ClutterRegionPlotter object for use with the theaterPlot object tp. Use the plotClutterRegion function with ClutterRegionPlotter object to plot clutter.

plotter = clutterRegionPlotter(tp,Name=Value) creates a ClutterRegionPlotter object with additional options specified by one or more name-value arguments. For example, clutterRegionPlotter(DisplayName="SurfaceClutter") specifies "SurfaceClutter" as the name displayed in the legend.

Examples

Create Rectangular Clutter Region

Create a clutterRegionPlotter object from a theaterPlot object. Fill a clutter region data structure plotdata and then plot the region.

tp = theaterPlot;
clutrregion = clutterRegionPlotter(tp,'DisplayName','Clutter Regions');
plotdata = struct('X',[0 1 1 0],'Y',[0 0 1.5 1.5],'RegionPlotHeight',25)

plotdata = struct with fields:
                   X: [0 1 1 0]
                   Y: [0 0 1.5000 1.5000]
    RegionPlotHeight: 25

plotClutterRegion(clutrregion,plotdata);

Create Irregular Clutter Region

Create a quadrilateral clutterRegionPlotter object from a theaterPlot object. Set the clutter region data structure plotdata and then plot the region. Set an edge color and a face color.

Choose the four vertices of the quadrilateral. Set the region plot height to 25 m.

p1 = [1 4];
p2 = [5 3.5];
p3 = [3 1];
p4 = [0.9 1];
X = [p1(1) p2(1) p3(1) p4(1)];
Y = [p1(2) p2(2) p3(2) p4(2)];
tp = theaterPlot;
clutrregion = clutterRegionPlotter(tp,'DisplayName', ...
    'Clutter Region','RegionFaceColor','y', ...
    'RegionEdgeColor',[.6 .2 .3]);
plotdata = struct('X',X,'Y',Y,'RegionPlotHeight',25)

plotdata = struct with fields:
                   X: [1 5 3 0.9000]
                   Y: [4 3.5000 1 1]
    RegionPlotHeight: 25

plotClutterRegion(clutrregion,plotdata);

Create Two Adjacent Clutter Regions

Create two clutter adjacent regions.

tp = theaterPlot;
clutp = clutterRegionPlotter(tp,'DisplayName','Clutter Regions');
pd = struct('X',[0 1.1; 1 2.1; 1 2.1; 0 1.1],'Y', ...
    [-1 -1; -1 -1;1 1; 1 1],'RegionPlotHeight',20);
plotClutterRegion(clutp,pd);
view(45,30)

Input Arguments

tp — Theater plot

theaterPlot object

Theater plot, specified as a theaterPlot object.

Name-Value Arguments

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: DisplayName="ClutterSurface"

DisplayName — Plot name to display in legend

character vector | string

Plot name to display in legend, specified as a character vector or string. If you do not specify this argument, the function does not display a plot name.

Tag — Tag associated with plotter

'PlotterN' (default) | character vector | string

Tag associated with the plotter, specified as a character vector or string. You can use the findPlotter function to identify plotters based on their tag. The default value is 'PlotterN', where N is an integer that corresponds to the Nth plotter associated with the theaterPlot.

RegionFaceAlpha — Face alpha value for all plotted regions

1 (default) | scalar in range [0 1]

Face alpha value for plotted regions, specified as a scalar in the range [0 1]. The same value is applied to all regions.

RegionFaceColor — Face color value for all plotted regions

'black' (default) | character vector | scalar | RGB triplet | hexadecimal color code

Face color value for all plotted regions, specified as a color string or [R,G,B] vector .

RegionEdgeAlpha — Edge alpha for all region edges

1 (default) | scalar

The edge alpha value of the region edges, specified as a scalar. The same alpha value is used for all regions.

RegionEdgeColor — Edge color for all plotted regions

'black' (default) | character vector | scalar | RGB triplet | hexadecimal color code

Edge color for all regions, specified as a character vector of a valid color, a string scalar of a valid color, an RGB triplet, or a hexadecimal color code.

PatchMarker — Marker symbol for patches

'.' (default) | char

Marker symbol for patches, specified as a char.

o	circle	s	square	^	triangle (up)
x	x-mark	d	diamond	v	triangle (down)
+	plus	p	pentagram	<	triangle (left)
*	star	h	hexagram	>	triangle (right)
.	dot

PatchMarkerFaceColor — Patch marker fill color

color string | [R, G, B] vector

Patch marker fill color, specified as a color string or an [R, G, B] vector defining a color.

Example: [.1,.1,.1]

PatchMarkerEdgeColor — Patch marker edge color

'blue' (default) | color string | [R, G, B] vector

Patch marker edge color, specified as a color string or an [R, G, B] vector defining a color.

Example: [.1,.5,.4]

PatchMarkerSize — Size of patch marker

3 (default) | positive integer

Size of patch marker, specified as a positive integer.

ShowPatchCenters — Show patch centers

false (default) | true

Show patch centers, specified as false or true.

MaxPatches — Maximum number of clutter patches

100 (default) | scalar

Maximum number of clutter patches to plot, specified as a scalar.

Example: 3

Output Arguments

plotter — Clutter region plotter

ClutterRegionPlotter object

Clutter regions plotter, returned as a ClutterRegionPlotter object. You can modify this object by changing its property values. The property names correspond to the name-value arguments of the clutterRegionPlotter function.

To plot clutter regions, use the plotClutterRegion function.

Version History

Introduced in R2022b