`SphericalModesReceivingAntennaData`

Receiving antenna results generated by the Feko Solver.

Example

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

    -- Obtain a 'SphericalModesReceivingAntennaData' object

receivingAntennas = app.Models[1].Configurations[1].ReceivingAntennas
sphericalModeReceivingAntennaData = receivingAntennas["ReceivingAntenna1"]   

    -- Get the 'SphericalModesReceivingAntennaData' object's dataset
    
dataSet = sphericalModeReceivingAntennaData:GetDataSet()

Inheritance

The SphericalModesReceivingAntennaData object is derived from the ReceivingAntennaData object.

Property List

Configuration: The result data's solution configuration in the model. (Read only SolutionConfiguration)
ContinuousFrequencyAxis: Continuous frequency axis exists. (Read only boolean)
DataSetAvailable: Valid result data exist. (Read only boolean)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Method List

GetDataSet (): Returns a data set containing the power values. (Returns a DataSet object.)
GetDataSet (samplePoints number): Returns a data set containing the power values. (Returns a DataSet object.)
GetDataSet (startFrequency number, endFrequency number, samplePoints number): Returns a data set containing the power values. (Returns a DataSet object.)

Property Details

Configuration

The result data's solution configuration in the model.

Type: SolutionConfiguration
Access: Read only

ContinuousFrequencyAxis

Continuous frequency axis exists.

Type: boolean
Access: Read only

DataSetAvailable

Valid result data exist.

Type: boolean
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Method Details

GetDataSet ()

Returns a data set containing the power values.

Return

DataSet: The data set containing the power values.

GetDataSet (samplePoints number)

Returns a data set containing the power values.

Input Parameters

samplePoints(number): The number of sample points used to sample the continuous frequency axis.

Return

DataSet: The data set containing the power values.

GetDataSet (startFrequency number, endFrequency number, samplePoints number)

Returns a data set containing the power values.

Input Parameters

startFrequency(number): The start frequency used to sample the continuous frequency axis.
endFrequency(number): The end frequency used to sample the continuous frequency axis.
samplePoints(number): The number of sample points used to sample the continuous frequency axis.

Return

DataSet: The data set containing the power values.