FarFieldSphericalModeSettings

Far field spherical mode settings.

Example

application = cf.Application.GetInstance()
project = application:NewProject()

    -- Create a far field request

farFieldRequest = project.Contents.SolutionConfigurations[1].FarFields:Add3DPattern()

    -- Calculate spherical expansion mode coefficients

farFieldRequest.Advanced.SphericalModes.CalculationEnabled = true

Inheritance

The FarFieldSphericalModeSettings object is derived from the CompositeValue object.

Usage locations

The FarFieldSphericalModeSettings object can be accessed from the following locations:

Property List

CalculationEnabled
Calculate spherical expansion mode coefficients. (Read/Write boolean)
ExportToASCIIEnabled
Export spherical expansion coefficients to ASCII file. This property is only valid if CalculationEnabled is true. (Read/Write boolean)
ModeMaximumIndex
Specify maximum mode index N. Changing this property will set ModeMaximumIndexEnabled to true. (Read/Write Dimension)
ModeMaximumIndexEnabled
Specify number of spherical modes. This property is only valid if CalculationEnabled is true. (Read/Write boolean)

Property Details

CalculationEnabled
Calculate spherical expansion mode coefficients.
Type
boolean
Access
Read/Write
ExportToASCIIEnabled
Export spherical expansion coefficients to ASCII file. This property is only valid if CalculationEnabled is true.
Type
boolean
Access
Read/Write
ModeMaximumIndex
Specify maximum mode index N. Changing this property will set ModeMaximumIndexEnabled to true.
Type
Dimension
Access
Read/Write
ModeMaximumIndexEnabled
Specify number of spherical modes. This property is only valid if CalculationEnabled is true.
Type
boolean
Access
Read/Write