The FarField namespace

Far field data set functions.

Function List

GetDataSet (name string): Returns the data set for the given far field. (Returns a DataSet object.)
GetDataSet (name string, sample number): Returns the data set for the given far field. (Returns a DataSet object.)
GetDataSet (name string, startFreq number, endFreq number, sample number): Returns the data set for the given far field. (Returns a DataSet object.)
GetNames (): Returns a list containing the names of the far fields. (Returns a List of string object.)
GetSampledDataSet (name string, theta number, phi number): Returns the data set for the continuous far field sampled using the given theta and phi sample densities. (Returns a DataSet object.)
GetSampledDataSet (name string, thetaStart number, thetaEnd number, thetaCount number, phiStart number, phiEnd number, phiCount number): Returns the data set for the continuous far field sampled using the given theta and phi sample densities. (Returns a DataSet object.)
GetSampledDataSet (name string, freq number, theta number, phi number): Returns the data set for the continuous far field sampled using the given theta and phi sample densities. (Returns a DataSet object.)
GetSampledDataSet (name string, freqStart number, freqEnd number, freqCount number, thetaStart number, thetaEnd number, thetaCount number, phiStart number, phiEnd number, phiCount number): Returns the data set for the continuous far field sampled using the given theta and phi sample densities. (Returns a DataSet object.)

Function Details

GetDataSet (name string)

Returns the data set for the given far field.

Input Parameters

name(string): The full name of the far field.

Return

DataSet: A far field data set.

GetDataSet (name string, sample number)

Returns the data set for the given far field.

Input Parameters

name(string): The full name of the far field.
sample(number): The sample density for the continuous frequency axis.

Return

DataSet: A far field data set.

GetDataSet (name string, startFreq number, endFreq number, sample number)

Returns the data set for the given far field.

Input Parameters

name(string): The full name of the far field.
startFreq(number): The start frequency to use when sampling the continuous frequency axis.
endFreq(number): The end frequency to use when sampling the continuous frequency axis.
sample(number): The sample density for the continuous frequency axis.

Return

DataSet: A far field data set.

GetNames ()

Returns a list containing the names of the far fields.

Return

List of string: A list of far field names.

GetSampledDataSet (name string, theta number, phi number)

Returns the data set for the continuous far field sampled using the given theta and phi sample densities.

Input Parameters

name(string): The full name of the far field.
theta(number): The theta sample density.
phi(number): The phi sample density.

Return

DataSet: A far field data set.

GetSampledDataSet (name string, thetaStart number, thetaEnd number, thetaCount number, phiStart number, phiEnd number, phiCount number)

Returns the data set for the continuous far field sampled using the given theta and phi sample densities.

Input Parameters

name(string): The full name of the far field.
thetaStart(number): The start of the theta range to sample.
thetaEnd(number): The end of the theta range to sample.
thetaCount(number): The theta sample density.
phiStart(number): The start of the phi range to sample.
phiEnd(number): The end of the phi range to sample.
phiCount(number): The phi sample density.

Return

DataSet: A far field data set.

GetSampledDataSet (name string, freq number, theta number, phi number)

Returns the data set for the continuous far field sampled using the given theta and phi sample densities.

Input Parameters

name(string): The full name of the far field.
freq(number): The frequency sample density.
theta(number): The theta sample density.
phi(number): The phi sample density.

Return

DataSet: A far field data set.

GetSampledDataSet (name string, freqStart number, freqEnd number, freqCount number, thetaStart number, thetaEnd number, thetaCount number, phiStart number, phiEnd number, phiCount number)

Returns the data set for the continuous far field sampled using the given theta and phi sample densities.

Input Parameters

name(string): The full name of the far field.
freqStart(number): The start of the frequency range to sample.
freqEnd(number): The end of the frequency range to sample.
freqCount(number): The frequency sample density.
thetaStart(number): The start of the theta range to sample.
thetaEnd(number): The end of the theta range to sample.
thetaCount(number): The theta sample density.
phiStart(number): The start of the phi range to sample.
phiEnd(number): The end of the phi range to sample.
phiCount(number): The phi sample density.

Return

DataSet: A far field data set.