TRQuantity

The transmission reflection coefficient quantity properties.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Wire_Cross_tht45_eta0.fek]])
TRCoefficientData = app.Models[1].Configurations[1].TRCoefficients["TRCoefficients1"]
graph = app.CartesianGraphs:Add()
TRCoefficientTrace = graph.Traces:Add(TRCoefficientData)

    -- Configure the 'TRQuantity' of the transmission reflection trace 
    
TRCoefficientTrace.Quantity.Type = pf.Enums.TRCoefficientQuantityTypeEnum.Transmission
TRCoefficientTrace.Quantity.PolarisationType = pf.Enums.PolarisationTypeEnum.CoPolarisation

Usage locations (object properties)

The following objects have properties using the TRQuantity 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)
PolarisationType
The polarisation type of the value to plot, specified by the PolarisationTypeEnum, e.g. Total, CoPolarisation or CrossPolarisation. (Read/Write PolarisationTypeEnum)
Type
The type of quantity to be plotted, specified by the TRCoefficientQuantityTypeEnum, e.g. Transmission or Reflection. (Read/Write TRCoefficientQuantityTypeEnum)
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
PhaseUnwrapped
Specifies whether the phase is unwrapped before plotting. This property is only valid when the ComplexComponent is Phase.
Type
boolean
Access
Read/Write
PolarisationType
The polarisation type of the value to plot, specified by the PolarisationTypeEnum, e.g. Total, CoPolarisation or CrossPolarisation.
Type
PolarisationTypeEnum
Access
Read/Write
Type
The type of quantity to be plotted, specified by the TRCoefficientQuantityTypeEnum, e.g. Transmission or Reflection.
Type
TRCoefficientQuantityTypeEnum
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