SplinePlot Constructor (InArraySingle, Object, NullableColor, DashStyle, Int32, NullableColor, MarkerStyle, NullableInt32, Boolean)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

Constructor defines SplinePlot on the basis of a positions array.

[ILNumerics Drawing2 Toolbox]

Namespace: ILNumerics.Drawing.Plotting
Assembly: ILNumerics.Toolboxes.Drawing2 (in ILNumerics.Toolboxes.Drawing2.dll) Version: 5.5.0.0 (5.5.7503.3146)

Syntax

Copy

public SplinePlot(
	InArray<float> positions,
	Object tag = null,
	Nullable<Color> lineColor = null,
	DashStyle lineStyle = DashStyle.Solid,
	int lineWidth = 1,
	Nullable<Color> markerColor = null,
	MarkerStyle markerStyle = MarkerStyle.None,
	Nullable<int> resolution = 1,
	bool useSplinePathFor1D = true
)

Public Sub New ( 
	positions As InArray(Of Single),
	Optional tag As Object = Nothing,
	Optional lineColor As Nullable(Of Color) = Nothing,
	Optional lineStyle As DashStyle = DashStyle.Solid,
	Optional lineWidth As Integer = 1,
	Optional markerColor As Nullable(Of Color) = Nothing,
	Optional markerStyle As MarkerStyle = MarkerStyle.None,
	Optional resolution As Nullable(Of Integer) = 1,
	Optional useSplinePathFor1D As Boolean = true
)

Dim positions As InArray(Of Single)
Dim tag As Object
Dim lineColor As Nullable(Of Color)
Dim lineStyle As DashStyle
Dim lineWidth As Integer
Dim markerColor As Nullable(Of Color)
Dim markerStyle As MarkerStyle
Dim resolution As Nullable(Of Integer)
Dim useSplinePathFor1D As Boolean

Dim instance As New SplinePlot(positions, 
	tag, lineColor, lineStyle, lineWidth, 
	markerColor, markerStyle, resolution, 
	useSplinePathFor1D)

Parameters

positions: Type: ILNumericsInArraySingle
[1 x n], [2 x n] or [3 x n] matrix.
tag (Optional): Type: SystemObject
[optional] Tag that identifies the spline plot in the scene.
lineColor (Optional): Type: SystemNullableColor
[optional] Line color, default: auto.
lineStyle (Optional): Type: ILNumerics.DrawingDashStyle
[optional] Line style, default: solid.
lineWidth (Optional): Type: SystemInt32
[optional] Line width, default: 1px.
markerColor (Optional): Type: SystemNullableColor
[optional] Marker color, default: auto.
markerStyle (Optional): Type: ILNumerics.DrawingMarkerStyle
[optional] Marker style, default: none.
resolution (Optional): Type: SystemNullableInt32
[optional] Resolution indicates the number of additional query points that are created, default: 1.
useSplinePathFor1D (Optional): Type: SystemBoolean
[optional] Specifies the spline calculation method for one dimensional positions arrays, default: true. If true, the calculation is performed on the basis of splinepath(), otherwise, spline(). Default: true.

Exceptions

Exception	Condition
ArgumentException	If input argument positions have wrong size or shape, or item is not provided.
ArgumentException	If resolution value is less or equals 0.
ArgumentException	If Dimension is larger than 2 and no resolution is specified.

Remarks

Query points are the points between two key points. If the resolution is set to null, it will be calculated automatically based on the current panel size and number of visible points.

If useSplinePathFor1D is true, the spline calculation for one dimensional positions arrays is performed on the basis of splinepath(), otherwise spline().

[ILNumerics Drawing2 Toolbox]

Examples

Creates and plots a smooth SplinePlot through 10 random data points. Use this example in a Windows Forms Application project.

Copy

 private void ilPanel1_Load(object sender, EventArgs e) {
    // define a function in 3D space
    Array<float> Points = tosingle(rand(3, 10));         

    // setup the plot cube ... 
    ilPanel1.Scene.Add(new PlotCube(twoDMode: false) 
    {
         // plot original function points
         new LinePlot(Points, lineColor:Color.Blue, markerStyle: MarkerStyle.Dot),
         // plot smooth Spline plot
         new SplinePlot(Points, lineColor: Color.Red, markerStyle: MarkerStyle.Dot, resolution:4)
    });
}

Reference

SplinePlot Class

SplinePlot Overload

ILNumerics.Drawing.Plotting Namespace