`SParameterMathScript`

S-parameter math script data that can be plotted.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Waveguide_Divider.fek]])

    -- Create a S-parameter math script
    
sParameterMathScript = app.MathScripts:Add(pf.Enums.MathScriptTypeEnum.SParameter)
script = 
[[
dataSet = pf.SParameter.GetDataSet("Waveguide_Divider.SParameterConfiguration1.SParameter1")
scale = 2
for freqIndex = 1, #dataSet.Axes["Frequency"] do
    for portIndex = 1, #dataSet.Axes["Arbitrary"] do
        indexedValue = dataSet[freqIndex][portIndex]
        indexedValue.SParameter = indexedValue.SParameter * scale
    end
end
return dataSet
]]
sParameterMathScript.Script = script
sParameterMathScript:Run()

    -- Plot the math script

graph = app.CartesianGraphs:Add()
sParameterTrace1 = graph.Traces:Add(sParameterMathScript)

Inheritance

The SParameterMathScript object is derived from the MathScript object.

Property List

ContinuousFrequencyAxis: Continuous frequency axis exists. (Read only boolean)
DataSetAvailable: Valid result data exist. (Read only boolean)
Label: The object label. (Read/Write string)
Script: The script code to execute. (Read/Write string)
Type: The object type string. (Read only string)

Method List

Delete (): Delete the math script.
Duplicate (): Duplicate the math script. (Returns a MathScript object.)
GetDataSet (): Returns a data set containing the math script values. (Returns a DataSet object.)
Run (): Run the math script.
StoreData (): Creates a local stored version of the result data. (Returns a ResultData object.)

Property Details

ContinuousFrequencyAxis

Continuous frequency axis exists.

Type: boolean
Access: Read only

DataSetAvailable

Valid result data exist.

Type: boolean
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Script

The script code to execute.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Method Details

Delete ()

Delete the math script.

Duplicate ()

Duplicate the math script.

Return

MathScript: The duplicated math script.

GetDataSet ()

Returns a data set containing the math script values.

Return

DataSet: The data set containing the math script values.

Run ()

Run the math script.

StoreData ()

Creates a local stored version of the result data.

Return

ResultData: The new stored data.