NearFieldStoredData

Stored near field results.

Example

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

    -- Retrieve the 'NearFieldData' called 'NearFields'

nearFieldData = app.Models[1].Configurations[1].NearFields["NearFields"]

    -- Store a copy of the network data.
    
storedData = nearFieldData:GetDataSet():StoreData(pf.Enums.StoredDataTypeEnum.NearField)

Inheritance

The NearFieldStoredData 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, components NearFieldsExportTypeEnum, samples number)
Export the stored near field data to the specified *.efe / *.hfe file.
GetDataSet ()
Returns a data set containing the near field values. (Returns a DataSet object.)
GetDataSet (samplePoints number)
Returns a data set containing the near field values. (Returns a DataSet object.)
GetDataSet (startFrequency number, endFrequency number, samplePoints number)
Returns a data set containing the near 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, components NearFieldsExportTypeEnum, samples number)
Export the stored near field data to the specified *.efe / *.hfe file.
Input Parameters
filename(string)
The name of the exported data file without its extension.
components(NearFieldsExportTypeEnum)
The components to export specified by the NearFieldsExportTypeEnum, e.g. Both (*.efe and *.hfe), Electric (*.efe) or Magnetic (*.hfe).
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 near field values.
Return
DataSet
The data set containing the near field values.
GetDataSet (samplePoints number)
Returns a data set containing the near 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 near field values.
GetDataSet (startFrequency number, endFrequency number, samplePoints number)
Returns a data set containing the near 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 near field values.