DataSetMetaData

Additional information that further helps to define a data set.

Example

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

    -- Retrieve the far field data set
    
farFieldDataSet = app.Models[1].Configurations[1].FarFields["FarFields"]:GetDataSet(51)

    -- Adjust the origin of the far field
    
farFieldDataSet.MetaData.Origin = pf.Point(0,0,0.01)

    -- Store the far field and plot it

storedFarField = farFieldDataSet:StoreData(pf.Enums.StoredDataTypeEnum.FarField)
plot = app.Views[1].Plots:Add(storedFarField)

Usage locations (object properties)

The following objects have properties using the DataSetMetaData object:

Property List

Conical
Indicates whether a near field is defined in the conical coordinate system. Note that “RhoStepSize” must also be set. (Read/Write boolean)
Impedance
The source Impedance. Applies to power data sets. (Read/Write Complex)
MediumNames
The media names for near field media data sets. An index to this table is provided as a quantity that is defined for each point of a qualifying near field. (Read/Write List of string)
ModalExcitationCoefficientIsCalculated
Indicates whether calculating modal excitation coefficients was requested. (Read/Write boolean)
Origin
The origin of a math result data set in Cartesian coordinates. Applies to near field and far field data sets. (Read/Write Point)
PowerScaling
The source power scaling type. Applies to power data sets. (Read/Write PowerScaleSettingsEnum)
RhoStepSize
The Rho step size for conical near fields. Note that “Conical” must also be set. (Read/Write number)
SourcePower
The source power (Watt). This is only applicable when PowerScaling is not “NoPowerScaling”. Applies to power data sets. (Read/Write number)
SourcePowerDecoupled
Whether the source power is decoupled. Applies to power data sets. (Read/Write boolean)
UVector
The U Vector of a math result data set in Cartesian coordinates. Applies to near field and far field data sets. (Read/Write Point)
VVector
The V Vector of a math result data set in Cartesian coordinates. Applies to near field and far field data sets. (Read/Write Point)

Property Details

Conical
Indicates whether a near field is defined in the conical coordinate system. Note that “RhoStepSize” must also be set.
Type
boolean
Access
Read/Write
Impedance
The source Impedance. Applies to power data sets.
Type
Complex
Access
Read/Write
MediumNames
The media names for near field media data sets. An index to this table is provided as a quantity that is defined for each point of a qualifying near field.
Access
Read/Write
ModalExcitationCoefficientIsCalculated
Indicates whether calculating modal excitation coefficients was requested.
Type
boolean
Access
Read/Write
Origin
The origin of a math result data set in Cartesian coordinates. Applies to near field and far field data sets.
Type
Point
Access
Read/Write
PowerScaling
The source power scaling type. Applies to power data sets.
Type
PowerScaleSettingsEnum
Access
Read/Write
RhoStepSize
The Rho step size for conical near fields. Note that “Conical” must also be set.
Type
number
Access
Read/Write
SourcePower
The source power (Watt). This is only applicable when PowerScaling is not “NoPowerScaling”. Applies to power data sets.
Type
number
Access
Read/Write
SourcePowerDecoupled
Whether the source power is decoupled. Applies to power data sets.
Type
boolean
Access
Read/Write
UVector
The U Vector of a math result data set in Cartesian coordinates. Applies to near field and far field data sets.
Type
Point
Access
Read/Write
VVector
The V Vector of a math result data set in Cartesian coordinates. Applies to near field and far field data sets.
Type
Point
Access
Read/Write