SParameterSurfacePlot
A S-parameter surface plot.
Example
app = pf.GetApplication() app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/sparameter.pfs]]) sParameterData = app.StoredData[1] graph = app.CartesianSurfaceGraphs:Add() -- Add the S-parameter data to a Cartesian surface graph sParameterPlot = graph.Plots:Add(sParameterData) -- Configure the plot quantity sParameterPlot:SetFixedAxisValue("S-parameter", "S2,1")
Inheritance
The SParameterSurfacePlot object is derived from the ResultSurfacePlot object.
Property List
- AxisNames
- The names of all the axes on the ResultPlot. (Read only List of string)
- DataSource
- The source of the surface plot. (Read/Write ResultData)
- DiscretePlotEnabled
- Specifies whether the discrete plot property is enabled or disabled for this surface plot. (Read/Write boolean)
- FixedAxes
- The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well as the contents of the ResultData object. The value for a specific fixed axis can be queried and set with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string)
- HorizontalIndependentAxis
- The horizontal independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string)
- IndependentAxesAvailable
- The list of available independent axes. (Read only List of string)
- Label
- The object label. (Read/Write string)
- Legend
- The surface plot legend properties. (Read only SurfacePlotLegendFormat)
- Quantity
- The S-parameter plot quantity properties. (Read only SParameterQuantity)
- Sampling
- The continuous surface plot sampling settings. These settings only apply to traces when the independent axis is continuously sampled. (Read only SurfacePlotSamplingFormat)
- Type
- The object type string. (Read only string)
- VerticalIndependentAxis
- The vertical independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string)
- Visible
- Specifies whether the surface plot must be shown or hidden. (Read/Write boolean)
Method List
- Delete ()
- Delete the surface plot.
- GetAxisUnit (axis string)
- Returns the SI unit of the specified axis. (Returns a string object.)
- GetFixedAxisAvailableValues (axis string)
- Returns the list of available values for the specified axis. (Returns a List of string object.)
- GetFixedAxisValue (axis string)
- Returns the current value for the specified fixed axis. (Returns a string 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.)
- SetFixedAxisValue (axis string, strvalue string)
- Set the fixed axis to the specified value.
- 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 surface plot.
- SwitchIndependentAxes ()
- Switches the horizontal and vertical independent axes.
Property Details
- AxisNames
- The names of all the axes on the ResultPlot.
- Access
- Read only
- DataSource
- The source of the surface plot.
- Type
- ResultData
- Access
- Read/Write
- DiscretePlotEnabled
- Specifies whether the discrete plot property is enabled or disabled for this surface plot.
- Type
- boolean
- Access
- Read/Write
- FixedAxes
- The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well as the contents of the ResultData object. The value for a specific fixed axis can be queried and set with the GetFixedAxisValue() and SetFixedAxisValue() methods.
- Access
- Read only
- HorizontalIndependentAxis
- The horizontal independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc.
- Type
- string
- Access
- Read/Write
- IndependentAxesAvailable
- The list of available independent axes.
- Access
- Read only
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Legend
- The surface plot legend properties.
- Type
- SurfacePlotLegendFormat
- Access
- Read only
- Quantity
- The S-parameter plot quantity properties.
- Type
- SParameterQuantity
- Access
- Read only
- Sampling
- The continuous surface plot sampling settings. These settings only apply to traces when the independent axis is continuously sampled.
- Type
- SurfacePlotSamplingFormat
- Access
- Read only
- Type
- The object type string.
- Type
- string
- Access
- Read only
- VerticalIndependentAxis
- The vertical independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc.
- Type
- string
- Access
- Read/Write
- Visible
- Specifies whether the surface plot must be shown or hidden.
- Type
- boolean
- Access
- Read/Write
Method Details
- Delete ()
- Delete the surface plot.
- GetAxisUnit (axis string)
- Returns the SI unit of the specified axis.
- GetFixedAxisAvailableValues (axis string)
- Returns the list of available values for the specified axis.
- GetFixedAxisValue (axis string)
- Returns the current value for the specified fixed axis.
- 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.
- SetFixedAxisValue (axis string, strvalue string)
- Set the fixed axis to the specified value.
- 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 surface plot.
- SwitchIndependentAxes ()
- Switches the horizontal and vertical independent axes.