# SpiceProbeTrace

A SpiceProbe 2D trace.

## Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/SpiceProbeTest.fek]])
spiceProbeData = app.Models[1].Configurations[1].SpiceProbes["CableProbe1"]

-- Create a cartesian graph and the SPICE probe data

cartesianGraph = app.CartesianGraphs:Add()
spiceProbeTrace = cartesianGraph.Traces:Add(spiceProbeData)

-- Configure the SPICE probe trace quantity

spiceProbeTrace.Signal = "Cable1.Signal2"


## Inheritance

The SpiceProbeTrace object is derived from the ResultTrace object.

## Property List

Axes
The trace axes properties. (Read only TraceAxes)
AxisNames
The names of all the axes on the ResultPlot. (Read only List of string)
DataSource
The source of the trace. (Read/Write ResultData)
IndependentAxesAvailable
The list of available independent axes. (Read only List of string)
IndependentAxis
The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string)
Label
The object label. (Read/Write string)
Legend
The trace legend properties. (Read only TraceLegendFormat)
Line
The trace line format properties. (Read only TraceLineFormat)
Markers
The trace marker format properties. (Read only TraceMarkersFormat)
Quantity
The SPICE probe quantity properties. (Read only SpiceProbeQuantity)
Sampling
The continuous trace sampling settings. These settings only apply to traces when the independent axis is continuously sampled. (Read only TraceSamplingFormat)
Signal
The signal that must be plotted. (Read/Write string)
Signals
The signal names that can be plotted. (Read only List of string)
Type
The object type string. (Read only string)
Values
The values that are plotted on the graph for this trace. The first column represents the independent axis and the second column represents the scalar quantity being displayed on the graph. Each row represents a sampled coordinate pair. (Read only Matrix)
Visible
Specifies whether the trace must be shown or hidden. (Read/Write boolean)

## Method List

Delete ()
Delete the trace.
Duplicate ()
Duplicate the trace. (Returns a ResultTrace object.)
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
Lower ()
Lower the trace.
Raise ()
Raise the trace.
SetProperties (properties table)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Store ()
Store a copy of the trace. (Returns a ResultTrace object.)

## Property Details

Axes
The trace axes properties.
Type
TraceAxes
Access
Read only
AxisNames
The names of all the axes on the ResultPlot.
Access
Read only
DataSource
The source of the trace.
Type
ResultData
Access
Read/Write
IndependentAxesAvailable
The list of available independent axes.
Access
Read only
IndependentAxis
The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc.
Type
string
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
Legend
The trace legend properties.
Type
TraceLegendFormat
Access
Read only
Line
The trace line format properties.
Type
TraceLineFormat
Access
Read only
Markers
The trace marker format properties.
Type
TraceMarkersFormat
Access
Read only
Quantity
The SPICE probe quantity properties.
Type
SpiceProbeQuantity
Access
Read only
Sampling
The continuous trace sampling settings. These settings only apply to traces when the independent axis is continuously sampled.
Type
TraceSamplingFormat
Access
Read only
Signal
The signal that must be plotted.
Type
string
Access
Read/Write
Signals
The signal names that can be plotted.
Access
Read only
Type
The object type string.
Type
string
Access
Read only
Values
The values that are plotted on the graph for this trace. The first column represents the independent axis and the second column represents the scalar quantity being displayed on the graph. Each row represents a sampled coordinate pair.
Type
Matrix
Access
Read only
Visible
Specifies whether the trace must be shown or hidden.
Type
boolean
Access
Read/Write

## Method Details

Delete ()
Delete the trace.
Duplicate ()
Duplicate the trace.
Return
ResultTrace
The duplicated trace.
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
Return
table
A properties table.
Lower ()
Lower the trace.
Raise ()
Raise the trace.
SetProperties (properties table)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Input Parameters
properties(table)
A table of properties defining the new state of the object.
Store ()
Store a copy of the trace.
Return
ResultTrace
A copy of the trace.