# 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

-- Configure the trace quantity

excitationTrace.Quantity.Type = pf.Enums.ImpedanceQuantityTypeEnum.VSWR
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)
The load value to use. The value is a complex expression, e.g. “50+j*0”. (Read/Write Expression)
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
The load value to use. The value is a complex expression, e.g. “50+j*0”.
Type
Expression
Access
Type
boolean
Access
Type
Access
PhaseUnwrapped
Specifies whether the phase is unwrapped before plotting. This property is only valid when the ComplexComponent is Phase.
Type
boolean
Access
ReferenceImpedanceExpression
The reference impedance value to use. The value is a complex expression, e.g. “50+j*0”.
Type
Expression
Access
Type
The type of quantity to be plotted, specified by the ImpedanceQuantityTypeEnum, e.g. Impedance, Admittance, Voltage, Current, etc.
Type
ImpedanceQuantityTypeEnum
Access
UseCustomReferenceImpedance
Specifies whether a custom reference impedance should be used.
Type
boolean
Access