`FarFieldStoredData`

Stored far field results.

Example

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

    -- Retrieve the 'FarFieldData' called 'FarFields'

farFieldData = app.Models[1].Configurations[1].FarFields["FarFields"]

    -- Store a copy of the far field data.
    
storedData = farFieldData:GetDataSet():StoreData(pf.Enums.StoredDataTypeEnum.FarField)

Inheritance

The FarFieldStoredData object is derived from the ResultData object.

Property List

ContinuousFrequencyAxis: Continuous frequency axis exists. (Read only boolean)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Method List

Delete (): Delete the stored data.
ExportData (filename string, quantity FarFieldsExportTypeEnum, samples number): Export the result far field data to the specified *.ffe file.
GetDataSet (): Returns a data set containing the far field values. (Returns a DataSet object.)
GetDataSet (samplePoints number): Returns a data set containing the far field values. (Returns a DataSet object.)
GetDataSet (startFrequency number, endFrequency number, samplePoints number): Returns a data set containing the far field values. (Returns a DataSet object.)

Property Details

ContinuousFrequencyAxis

Continuous frequency axis exists.

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

Delete ()

Delete the stored data.

ExportData (filename string, quantity FarFieldsExportTypeEnum, samples number)

Export the result far field data to the specified *.ffe file.

Input Parameters

filename(string): The name of the exported data file without its extension.
quantity(FarFieldsExportTypeEnum): The quantity type to export specified by the FarFieldsExportTypeEnum, e.g. Gain, Directivity, RCS, etc.
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 far field values.

Return

DataSet: The data set containing the far field values.

GetDataSet (samplePoints number)

Returns a data set containing the far field values.

Input Parameters

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

Return

DataSet: The data set containing the far field values.

GetDataSet (startFrequency number, endFrequency number, samplePoints number)

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