ReceivingAntennaQuantity

The receiving antenna quantity properties.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]])
rxAntennaData = app.Models[1].Configurations[1].ReceivingAntennas["FarFieldReceivingAntenna1"]

    -- Add the receiving antenna data to a Cartesian graph
    
graph = app.CartesianGraphs:Add()
receivingAntennaTrace1 = graph.Traces:Add(rxAntennaData)

    -- SetProperties the quantity

receivingAntennaTrace1.Quantity.Type = pf.Enums.PowerQuantityTypeEnum.Efficiency

Usage locations (object properties)

The following objects have properties using the ReceivingAntennaQuantity object:

Property List

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, specified by the PowerQuantityTypeEnum, e.g. Active power, Loss power or Efficiency. (Read/Write ReceivingAntennaQuantityTypeEnum)
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

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, specified by the PowerQuantityTypeEnum, e.g. Active power, Loss power or Efficiency.
Type
ReceivingAntennaQuantityTypeEnum
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