ReciprocalExcitationData

Reciprocity data results generated by the Feko Solver.

Example

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

    -- Retrieve the 'ReciprocalExcitationsData' called 'RT1'

reciprocalExcitationData = app.Models[1].Configurations[1].ReciprocalExcitations["RT1"]

    -- Manipulate the far field data. See 'DataSet' for faster and more comprehensive options
    
dataSet = reciprocalExcitationData:GetDataSet()
print(dataSet) -- Describes the structure of the data
inspect(dataSet) -- Gives a list of the data set contents

    -- Find the frequency start and end values

frequencyAxis = dataSet.Axes["Frequency"]
frequencyStartValue = frequencyAxis:ValueAt(1)
frequencyEndValue = frequencyAxis:ValueAt(#frequencyAxis)

    -- Scale the reciprocity values
    
scale = 2.0

for freqIndex = 1, #dataSet.Axes["Frequency"] do
    for loadIndex = 1, #dataSet.Axes["Loads"] do
        indexedValue = dataSet[freqIndex][loadIndex]
        indexedValue.ZLoad.re = indexedValue.ZLoad.re * scale
        indexedValue.ZLoad.im = indexedValue.ZLoad.im * scale
        indexedValue.SourceCurrent.re = indexedValue.SourceCurrent.re * scale
        indexedValue.SourceCurrent.im = indexedValue.SourceCurrent.im * scale
        indexedValue.SourceImpedance.re = indexedValue.SourceImpedance.re * scale
        indexedValue.SourceImpedance.im = indexedValue.SourceImpedance.im * scale
    end
end

Inheritance

The ReciprocalExcitationData object is derived from the ResultData object.

Usage locations

The ReciprocalExcitationData object can be accessed from the following locations:

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 reciprocity data values. (Returns a DataSet object.)
GetDataSet (samplePoints number)
Returns a data set containing the reciprocity data values. (Returns a DataSet object.)
GetDataSet (startFrequency number, endFrequency number, samplePoints number)
Returns a data set containing the reciprocity data values. (Returns a DataSet object.)
StoreData ()
Creates a local stored version of the result data. (Returns a ResultData 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 reciprocity data values.
Return
DataSet
The data set containing the reciprocity data values.
GetDataSet (samplePoints number)
Returns a data set containing the reciprocity data values.
Input Parameters
samplePoints(number)
The number of sample points used to sample the continuous frequency axis.
Return
DataSet
The data set containing the reciprocity data values.
GetDataSet (startFrequency number, endFrequency number, samplePoints number)
Returns a data set containing the reciprocity data 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 reciprocity data values.
StoreData ()
Creates a local stored version of the result data.
Return
ResultData
The new stored data.