`SARData`

SAR results generated by the Feko Solver.

Example

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

    -- Retrieve the 'SARData' called 'SAR2'

SARData = app.Models[1].Configurations[1].SAR["SAR2"]

    -- Add the SAR data to the 3D view
    
SARPlot = app.Views[1].Plots:Add(SARData)

    -- Get the SAR data set
    
SARDataSet = SARData:GetDataSet()

Inheritance

The SARData object is derived from the ResultData object.

Usage locations

The SARData object can be accessed from the following locations:

Methods
- SARCollection collection has method Items().
- SARCollection collection has method Item(number).
- SARCollection collection has method Item(string).

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 SAR values. (Returns a DataSet object.)
GetDataSet (samplePoints number): Returns a data set containing the SAR values. (Returns a DataSet object.)
GetDataSet (startFrequency number, endFrequency number, samplePoints number): Returns a data set containing the SAR 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 SAR values.

Return

DataSet: The data set containing the SAR values.

GetDataSet (samplePoints number)

Returns a data set containing the SAR values.

Input Parameters

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

Return

DataSet: The data set containing the near field values.

GetDataSet (startFrequency number, endFrequency number, samplePoints number)

Returns a data set containing the SAR 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 SAR values.

StoreData ()

Creates a local stored version of the result data.

Return

ResultData: The new stored data.