# NearFieldQuantity

The near field quantity properties.

## Example

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

-- Adjust 'NearFieldQuantity' of the plot

nearFieldPlot.Quantity.Type = pf.Enums.NearFieldQuantityTypeEnum.SAR
nearFieldPlot.Quantity.ValuesNormalised = true
nearFieldPlot.Quantity.ValuesScaledToDB = true



## Usage locations (object properties)

The following objects have properties using the NearFieldQuantity object:

## Property List

ComplexComponent
The complex component of the near field value to plot, specified by the ComplexComponentEnum, e.g. Magnitude, Phase, Real, Imaginary. (Read/Write ComplexComponentEnum)
IncludesPhi
Specifies whether the Phi component should be included in the near field quantity. (Read/Write boolean)
Specifies whether the Radius component should be included in the near field quantity. (Read/Write boolean)
IncludesRho
Specifies whether the Rho component should be included in the near field quantity. (Read/Write boolean)
IncludesTheta
Specifies whether the Theta component should be included in the near field quantity. (Read/Write boolean)
IncludesX
Specifies whether the X component should be included in the near field quantity. (Read/Write boolean)
IncludesY
Specifies whether the Y component should be included in the near field quantity. (Read/Write boolean)
IncludesZ
Specifies whether the Z component should be included in the near field quantity. (Read/Write boolean)
InstantaneousPhase
The phase value (wt) to use when ComplexComponent is Instantaneous. The value is in degrees [0,360]. (Read/Write number)
PhaseUnwrapped
Specifies whether the phase is unwrapped before plotting. This property is only valid when the ComplexComponent is Phase. (Read/Write boolean)
PowerScalingEnabled
Specifies whether near field power scaling is enabled. (Read/Write boolean)
PowerScalingFactor
The power scaling factor to apply when PowerScalingEnabled is enabled. (Read/Write number)
Type
The type of near field quantity to be plotted, specified by the NearFieldQuantityTypeEnum, e.g. EField, HField, Poynting, SAR, etc. (Read/Write NearFieldQuantityTypeEnum)
ValuesNormalised
Specifies whether the near field 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 near field quantity values is 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 near field value to plot, specified by the ComplexComponentEnum, e.g. Magnitude, Phase, Real, Imaginary.
Type
ComplexComponentEnum
Access
IncludesPhi
Specifies whether the Phi component should be included in the near field quantity.
Type
boolean
Access
Specifies whether the Radius component should be included in the near field quantity.
Type
boolean
Access
IncludesRho
Specifies whether the Rho component should be included in the near field quantity.
Type
boolean
Access
IncludesTheta
Specifies whether the Theta component should be included in the near field quantity.
Type
boolean
Access
IncludesX
Specifies whether the X component should be included in the near field quantity.
Type
boolean
Access
IncludesY
Specifies whether the Y component should be included in the near field quantity.
Type
boolean
Access
IncludesZ
Specifies whether the Z component should be included in the near field quantity.
Type
boolean
Access
InstantaneousPhase
The phase value (wt) to use when ComplexComponent is Instantaneous. The value is in degrees [0,360].
Type
number
Access
PhaseUnwrapped
Specifies whether the phase is unwrapped before plotting. This property is only valid when the ComplexComponent is Phase.
Type
boolean
Access
PowerScalingEnabled
Specifies whether near field power scaling is enabled.
Type
boolean
Access
PowerScalingFactor
The power scaling factor to apply when PowerScalingEnabled is enabled.
Type
number
Access
Type
The type of near field quantity to be plotted, specified by the NearFieldQuantityTypeEnum, e.g. EField, HField, Poynting, SAR, etc.
Type
NearFieldQuantityTypeEnum
Access