Public Member Functions | List of all members
TwoDFourierTransformParameter Class Reference

TwoDFourierTransformParameter class is used to specify a required parameter when running a 2D Fourier transformation for graph data.
The class can be called from Application class.
. More...

Public Member Functions

bool IsValid ()
 Returns True if an object is valid. More...
 
void SetAlgorithmType (String &type)
 Specifies the algorithm of a Fourier transform. More...
 
void SetAxisType (String &mapper)
 Specifies the time axis type (time, steps). More...
 
void SetDataSet (DataSet *dataset)
 Specifies a data set to run a 2D Fourier transformation on. More...
 
void SetDBMultiplier (double multiplier)
 Specifies the multiplier for decibel output. More...
 
void SetDBRefValue (Variant &value)
 Specifies the reference value for decibel output. More...
 
void SetDBRefValueType (String &type)
 Specifies the type of the reference value for decibel output. More...
 
void SetFrequencyDomainAxisType (String &type)
 Specifies the frequency domain axis type. More...
 
void SetFrequencyMultiplier (Variant &multiplier)
 Specifies the Frequency Multiplier value. More...
 
void SetMax (Variant &val)
 Specifies the maximum time range value. More...
 
void SetMin (Variant &val)
 Specifies the minimum time range value. More...
 
void SetSpaceOrderLimit (Variant &limit)
 Specifies the upper limit of the space orders. More...
 
void SetSpaceOrderMultiplier (Variant &multiplier)
 Specifies the Space Order Multiplier value. More...
 
void SetSpacePeriodicity (int type)
 Specifies the space periodicity. More...
 
void SetTimeOrderLimit (Variant &limit)
 Specifies the upper limit of the time orders. More...
 
void SetTimePeriodicity (int type)
 Specifies the time periodicity. More...
 
void SetType (String &type)
 Specifies the type of output. More...
 
void SetUseSpaceOrderLimit (bool useOrderLimit)
 Specifies whether or not to specify the upper limit of the space orders. More...
 
void SetUseTimeOrderLimit (bool useOrderLimit)
 Specifies whether or not to specify the upper limit of the time orders. More...
 

Detailed Description

TwoDFourierTransformParameter class is used to specify a required parameter when running a 2D Fourier transformation for graph data.
The class can be called from Application class.
.

Example of creating the class object:

app.Create2DFourierTransformParameter("2D_Fourier_transform_title")

Member Function Documentation

bool TwoDFourierTransformParameter::IsValid ( )

Returns True if an object is valid.

Returns
Whether or not the TwoDFourierTransformParameter object is valid
void TwoDFourierTransformParameter::SetAlgorithmType ( String &  type)

Specifies the algorithm of a Fourier transform.

Parameters
typeAlgorithm of fourier transform
DFT
FFT
void TwoDFourierTransformParameter::SetAxisType ( String &  mapper)

Specifies the time axis type (time, steps).

Parameters
typeName of the time axis type
void TwoDFourierTransformParameter::SetDataSet ( DataSet dataset)

Specifies a data set to run a 2D Fourier transformation on.

Parameters
datasetDataSet object
void TwoDFourierTransformParameter::SetDBMultiplier ( double  multiplier)

Specifies the multiplier for decibel output.

Parameters
multiplier
10
20
void TwoDFourierTransformParameter::SetDBRefValue ( Variant &  val)

Specifies the reference value for decibel output.

Parameters
valReference value
void TwoDFourierTransformParameter::SetDBRefValueType ( String &  type)

Specifies the type of the reference value for decibel output.

Parameters
typeName of the reference value type
Specify
Max
void TwoDFourierTransformParameter::SetFrequencyDomainAxisType ( String &  type)

Specifies the frequency domain axis type.

Parameters
typeFrequency domain axis type
Order
Frequency
void TwoDFourierTransformParameter::SetFrequencyMultiplier ( Variant &  val)

Specifies the Frequency Multiplier value.

Parameters
valFrequency multiplier value
void TwoDFourierTransformParameter::SetMax ( Variant &  max)

Specifies the maximum time range value.

Parameters
maxMaximum time range value
void TwoDFourierTransformParameter::SetMin ( Variant &  min)

Specifies the minimum time range value.

Parameters
minMinimum time range value
void TwoDFourierTransformParameter::SetSpaceOrderLimit ( Variant &  val)

Specifies the upper limit of the space orders.

Parameters
val
void TwoDFourierTransformParameter::SetSpaceOrderMultiplier ( Variant &  val)

Specifies the Space Order Multiplier value.

Parameters
valSpace order multiplier value
void TwoDFourierTransformParameter::SetSpacePeriodicity ( int  type)

Specifies the space periodicity.

Parameters
typeSpace periodicity type
True=1 : None
False=0 : 1/2
void TwoDFourierTransformParameter::SetTimeOrderLimit ( Variant &  val)

Specifies the upper limit of the time orders.

Parameters
val
void TwoDFourierTransformParameter::SetTimePeriodicity ( int  type)

Specifies the time periodicity.

Parameters
typeTime periodicity type
True=1 : None
False=0 : 1/2
void TwoDFourierTransformParameter::SetType ( String &  type)

Specifies the type of output.

Parameters
typeOutput type
Amplitude
Decibel
void TwoDFourierTransformParameter::SetUseSpaceOrderLimit ( bool  use)

Specifies whether or not to specify the upper limit of the space orders.

Parameters
use
True=1 : Specify the upper limit
False=0 : Do not specify the upper limit
void TwoDFourierTransformParameter::SetUseTimeOrderLimit ( bool  use)

Specifies whether or not to specify the upper limit of the time orders.

Parameters
use
True=1 : Specify the upper limit
False=0 : Do not specify the upper limit