ResultTrace
A 2D results trace.
Example
app = pf.GetApplication() app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) app.Views[1]:Close() -- Add a Cartesian graph to the application's collection graph = app.CartesianGraphs:Add() -- Add a far field trace to the Traces collection of the Cartesian graph -- and create a copy trace = graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) traceCopy = trace:Duplicate() traceCopy.Label = trace.Label.."_copy" -- Print all the axes defined on the trace print("Trace axes:") printlist(trace.AxisNames) -- Enable filled circle markers on the trace copy traceCopy.Markers.Symbol = pf.Enums.MarkerSymbolEnum.FilledCircle -- Print the available horizontal axes, and set the trace horizontal axis to -- "Theta (wrapped)", the third axes in the list of available axes and the -- copied trace to "Theta" print("Independent axes:") printlist(trace.IndependentAxesAvailable) trace.IndependentAxis = trace.IndependentAxesAvailable[3] traceCopy.IndependentAxis = traceCopy.IndependentAxesAvailable[2] graph:ZoomToExtents() -- SetProperties the legends of the traces accordingly trace.Legend.Text = "Theta wrapped" traceCopy.Legend.Text = "Theta" -- Remove the copied trace and change the remaining trace horizontal -- (independent) axis unit to radians traceCopy:Delete() trace.Axes.Independent.Unit = "rad" graph:ZoomToExtents()
Inheritance
The ResultTrace object is derived from the ResultPlot object.
The following objects are derived (specialisations) from the ResultTrace object:
- CharacteristicModeTrace
- CustomDataSmithTrace
- CustomDataTrace
- ExcitationSmithTrace
- ExcitationTrace
- FarFieldPowerIntegralTrace
- FarFieldTrace
- LoadSmithTrace
- LoadTrace
- MathTrace
- NearFieldPowerIntegralTrace
- NearFieldTrace
- NetworkTrace
- PowerTrace
- ReceivingAntennaTrace
- SARTrace
- SParameterTrace
- SpiceProbeTrace
- TRCoefficientTrace
- WireCurrentsTrace
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)
- Sampling
- The continuous trace sampling settings. These settings only apply to traces when the independent axis is continuously sampled. (Read only TraceSamplingFormat)
- 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.)
- Lower ()
- Lower the trace.
- Raise ()
- Raise the trace.
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
- Sampling
- The continuous trace sampling settings. These settings only apply to traces when the independent axis is continuously sampled.
- Type
- TraceSamplingFormat
- 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.
- Lower ()
- Lower the trace.
- Raise ()
- Raise the trace.