SphericalModeOptions

For manual specification, each mode must be defined separately per specification entry.

Example

app = cf.GetApplication()
project = app:NewProject()

properties = cf.SphericalModesDataManuallySpecified.GetDefaultProperties()
properties.ModeIndices[1].SphericalMJ = "1"
properties.ModeIndices[1].SphericalMagnitude = "3"
properties.ModeIndices[1].SphericalN = "2"
properties.ModeIndices[1].SphericalPhase = "4"
fieldData = project.FieldDataList:AddSphericalModesDataManuallySpecified(properties)

    -- Modify the first spherical mode

sphericalModeIndex = fieldData.ModeIndices[1]
sphericalModeIndex.IndexSchemeType = 
    cf.Enums.SphericalModesDataIndexSchemeMethodEnum.Compressed

Property List

IndexSchemeType
Index scheme for this specific spherical mode. (Read/Write SphericalModesDataIndexSchemeMethodEnum)
SphericalMJ
The M mode index which is in the azimuth direction for this specific spherical mode. (Read/Write Expression)
SphericalMagnitude
Absolute value of the complex amplitude of this specific spherical mode. (Read/Write Expression)
SphericalN
The N mode index which is in radial direction for this specific spherical mode. (Read/Write Expression)
SphericalPhase
The phase of the complex amplitude of this spherical mode in degrees. (Read/Write Expression)
TeTmType
Select either the TE or TM mode for this specific spherical mode. (Read/Write SphericalModesDataTeTmTypeMethodEnum)

Property Details

IndexSchemeType
Index scheme for this specific spherical mode.
Type
SphericalModesDataIndexSchemeMethodEnum
Access
Read/Write
SphericalMJ
The M mode index which is in the azimuth direction for this specific spherical mode.
Type
Expression
Access
Read/Write
SphericalMagnitude
Absolute value of the complex amplitude of this specific spherical mode.
Type
Expression
Access
Read/Write
SphericalN
The N mode index which is in radial direction for this specific spherical mode.
Type
Expression
Access
Read/Write
SphericalPhase
The phase of the complex amplitude of this spherical mode in degrees.
Type
Expression
Access
Read/Write
TeTmType
Select either the TE or TM mode for this specific spherical mode.
Type
SphericalModesDataTeTmTypeMethodEnum
Access
Read/Write