TRCoefficientData

Transmission reflection coefficient results generated by the Feko Solver.

Example

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

    -- Retrieve the 'TRCoefficientData' called 'TRCoefficient1'

TRCoefficientData = app.Models[1].Configurations[1].TRCoefficients["TRCoefficients1"]

    -- Add the TRCoefficient to a Cartesian graph
    
graph = app.CartesianGraphs:Add()
transmissionReflectionTrace1 = graph.Traces:Add(TRCoefficientData)

    -- Get the transmission reflection data set
    
TRCoefficientDataSet = TRCoefficientData:GetDataSet()

Inheritance

The TRCoefficientData object is derived from the ResultData object.

Usage locations

The TRCoefficientData 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

ExportData (filename string, samples number)
Export the transmission reflection coefficient data to the specified *.tr file.
GetDataSet ()
Returns a data set containing the transmission reflection coefficient values. (Returns a DataSet object.)
GetDataSet (samplePoints number)
Returns a data set containing the transmission reflection coefficient values. (Returns a DataSet object.)
GetDataSet (startFrequency number, endFrequency number, samplePoints number)
Returns a data set containing the transmission reflection coefficient 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

ExportData (filename string, samples number)
Export the transmission reflection coefficient data to the specified *.tr file.
Input Parameters
filename(string)
The name of the exported data file without its extension.
samples(number)
The number of samples for continuous data. This value will be ignored if the data is discrete.
GetDataSet ()
Returns a data set containing the transmission reflection coefficient values.
Return
DataSet
The data set containing the transmission reflection coefficient values.
GetDataSet (samplePoints number)
Returns a data set containing the transmission reflection coefficient values.
Input Parameters
samplePoints(number)
The number of sample points used to sample the continuous frequency axis.
Return
DataSet
The data set containing the transmission reflection coefficient values.
GetDataSet (startFrequency number, endFrequency number, samplePoints number)
Returns a data set containing the transmission reflection coefficient 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 transmission reflection coefficient values.
StoreData ()
Creates a local stored version of the result data.
Return
ResultData
The new stored data.