CustomDataQuantity

The custom data quantity properties.

Example

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

    -- Retrieve the custom math script and plot it on a Cartesian graph
    
customData = app.MathScripts["CustomMath1"]
graph = app.CartesianGraphs:Add()
customDataTrace = graph.Traces:Add(customData)
customDataTrace.IndependentAxis = "X position"

    -- SetProperties the custom data trace
    
customDataTrace.Quantity.Type = "TotalEField"
customDataTrace.Quantity.ComplexComponent = pf.Enums.ComplexComponentEnum.Real
customDataTrace.Quantity.ValuesNormalised = true
graph:ZoomToExtents()

Usage locations (object properties)

The following objects have properties using the CustomDataQuantity 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)
PhaseUnwrapped
Specifies whether the phase is unwrapped before plotting. This property is only valid when the ComplexComponent is Phase. (Read/Write boolean)
Type
The type of quantity to be plotted. (Read/Write string)
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 ComplexComponent is Phase. (Read/Write boolean)
ValuesScaledToDB
Specifies whether the quantity values are scaled to dB before plotting. This property is only valid when 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
PhaseUnwrapped
Specifies whether the phase is unwrapped before plotting. This property is only valid when the ComplexComponent is Phase.
Type
boolean
Access
Read/Write
Type
The type of quantity to be plotted.
Type
string
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 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 ComplexComponent is Magnitude.
Type
boolean
Access
Read/Write