`ExcitationStoredData`

Stored excitation results.

Example

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

    -- Retrieve the 'ExcitationData' called 'VoltageSource'

excitationData = app.Models[1].Configurations[1].Excitations["VoltageSource"]

    -- Store a copy of the excitation data.
    
storedData = excitationData:GetDataSet():StoreData(pf.Enums.StoredDataTypeEnum.Source)

Inheritance

The ExcitationStoredData 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, frequencyunit FrequencyUnitEnum, networkparametertype NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, referenceimpedance number, samples number): Export the result S-parameter data to the specified Touchstone file.
GetDataSet (): Returns a data set containing the source values. (Returns a DataSet object.)
GetDataSet (samplePoints number): Returns a data set containing the source values. (Returns a DataSet object.)
GetDataSet (startFrequency number, endFrequency number, samplePoints number): Returns a data set containing the source 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, frequencyunit FrequencyUnitEnum, networkparametertype NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, referenceimpedance number, samples number)

Export the result S-parameter data to the specified Touchstone file.

Input Parameters

filename(string): The name of the exported data file without its extension.
frequencyunit(FrequencyUnitEnum): The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc.
networkparametertype(NetworkParameterTypeEnum): The network parameter type specified by the NetworkParameterTypeEnum, e.g. Scattering, Admittance or Impedance.
networkparameterformat(NetworkParameterFormatEnum): The network parameter format specified by the NetworkParameterFormatEnum, e.g. DB, MA or RI.
referenceimpedance(number): Specify the reference impedance.
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 source values.

Return

DataSet: The data set containing the source values.

GetDataSet (samplePoints number)

Returns a data set containing the source values.

Input Parameters

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

Return

DataSet: The data set containing the source values.

GetDataSet (startFrequency number, endFrequency number, samplePoints number)

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