FarFieldQuantity
The far field quantity properties.
Example
app = pf.GetApplication() app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) farFieldData = app.Models[1].Configurations[1].FarFields["FarFields"] -- Create a polar graph and the far field data polarGraph = app.PolarGraphs:Add() farFieldTrace = polarGraph.Traces:Add(farFieldData) -- Configure the trace quantity farFieldTrace.Quantity.Type = pf.Enums.FarFieldQuantityTypeEnum.Directivity farFieldTrace.Quantity.Component = pf.Enums.FarFieldQuantityComponentEnum.Ludwig3Co farFieldTrace.Quantity.ValuesScaledToDB = true
Usage locations
The FarFieldQuantity object can be accessed from the following locations:
- Properties
- FarField3DPlot object has property Quantity.
- FarFieldSurfacePlot object has property Quantity.
- FarFieldTrace object has property Quantity.
Property List
- ComplexComponent
- The complex component of the far field value to plot, specified by the ComplexComponentEnum, e.g. Magnitude, Phase, Real, Imaginary. (Read/Write ComplexComponentEnum)
- Component
- The component of the far field quantity type to be plotted, specified by the FarFieldQuantityComponentEnum, e.g., Total, Theta, Phi, Ludwig3Co, Ludwig3Cross, MajorMinor, MinorMajor, etc. (Read/Write FarFieldQuantityComponentEnum)
- 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 far field quantity to be plotted, specified by the FarFieldQuantityTypeEnum, e.g. EField, Gain, Directivity, RCS, etc. (Read/Write FarFieldQuantityTypeEnum)
- 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 far field value to plot, specified by the ComplexComponentEnum, e.g. Magnitude, Phase, Real, Imaginary.
- Type
- ComplexComponentEnum
- Access
- Read/Write
- Component
- The component of the far field quantity type to be plotted, specified by the FarFieldQuantityComponentEnum, e.g., Total, Theta, Phi, Ludwig3Co, Ludwig3Cross, MajorMinor, MinorMajor, etc.
- Type
- FarFieldQuantityComponentEnum
- 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 far field quantity to be plotted, specified by the FarFieldQuantityTypeEnum, e.g. EField, Gain, Directivity, RCS, etc.
- Type
- FarFieldQuantityTypeEnum
- 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