ExcitationQuantity

The excitation quantity properties.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]])
excitationData = app.Models[1].Configurations[1].Excitations["VoltageSource"]

    -- Create a cartesian graph and add the excitation data
    
graph = app.CartesianGraphs:Add()
excitationTrace = graph.Traces:Add(excitationData)

    -- Configure the trace quantity
    
excitationTrace.Quantity.Type = pf.Enums.ImpedanceQuantityTypeEnum.VSWR
excitationTrace.Quantity.LoadSubtractionEnabled = true
excitationTrace.Quantity.LoadSubtractionType = pf.Enums.LoadingTypeEnum.Admittance
excitationTrace.Quantity.LoadExpression = "50"

Usage locations (object properties)

The following objects have properties using the ExcitationQuantity object:

Property List

ComplexComponent
The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. Magnitude, Phase, Real, Imaginary. (Read/Write ComplexComponentEnum)
LoadExpression
The load value to use. The value is a complex expression, e.g. “50+j*0”. (Read/Write Expression)
LoadSubtractionEnabled
Specifies whether the loading value must be subtracted before plotting. (Read/Write boolean)
LoadSubtractionType
The type of load subtraction to be plotted, specified by the LoadingTypeEnum, e.g. Impedance or Admittance. (Read/Write LoadingTypeEnum)
PhaseUnwrapped
Specifies whether the phase is unwrapped before plotting. This property is only valid when the ComplexComponent is Phase. (Read/Write boolean)
ReferenceImpedanceExpression
The reference impedance value to use. The value is a complex expression, e.g. “50+j*0”. (Read/Write Expression)
Type
The type of quantity to be plotted, specified by the ImpedanceQuantityTypeEnum, e.g. Impedance, Admittance, Voltage, Current, etc. (Read/Write ImpedanceQuantityTypeEnum)
UseCustomReferenceImpedance
Specifies whether a custom reference impedance should be used. (Read/Write boolean)
ValuesNormalised
Specifies whether the quantity values must be normalised to the range [0,1] before plotting. This property can be used together with dB scaling. This property is not valid when the ComplexComponent is Phase. (Read/Write boolean)
ValuesScaledToDB
Specifies whether the quantity values are scaled to dB before plotting. This property is only valid when the ComplexComponent is Magnitude. (Read/Write boolean)

Property Details

ComplexComponent
The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. Magnitude, Phase, Real, Imaginary.
Type
ComplexComponentEnum
Access
Read/Write
LoadExpression
The load value to use. The value is a complex expression, e.g. “50+j*0”.
Type
Expression
Access
Read/Write
LoadSubtractionEnabled
Specifies whether the loading value must be subtracted before plotting.
Type
boolean
Access
Read/Write
LoadSubtractionType
The type of load subtraction to be plotted, specified by the LoadingTypeEnum, e.g. Impedance or Admittance.
Type
LoadingTypeEnum
Access
Read/Write
PhaseUnwrapped
Specifies whether the phase is unwrapped before plotting. This property is only valid when the ComplexComponent is Phase.
Type
boolean
Access
Read/Write
ReferenceImpedanceExpression
The reference impedance value to use. The value is a complex expression, e.g. “50+j*0”.
Type
Expression
Access
Read/Write
Type
The type of quantity to be plotted, specified by the ImpedanceQuantityTypeEnum, e.g. Impedance, Admittance, Voltage, Current, etc.
Type
ImpedanceQuantityTypeEnum
Access
Read/Write
UseCustomReferenceImpedance
Specifies whether a custom reference impedance should be used.
Type
boolean
Access
Read/Write
ValuesNormalised
Specifies whether the quantity values must be normalised to the range [0,1] before plotting. This property can be used together with dB scaling. This property is not valid when the ComplexComponent is Phase.
Type
boolean
Access
Read/Write
ValuesScaledToDB
Specifies whether the quantity values are scaled to dB before plotting. This property is only valid when the ComplexComponent is Magnitude.
Type
boolean
Access
Read/Write