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:
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
-
type Algorithm of fourier transform DFTFFT
| void TwoDFourierTransformParameter::SetAxisType | ( | String & | mapper | ) |
Specifies the time axis type (time, steps).
- Parameters
-
type Name of the time axis type
| void TwoDFourierTransformParameter::SetDataSet | ( | DataSet * | dataset | ) |
Specifies a data set to run a 2D Fourier transformation on.
- Parameters
-
dataset DataSet object
| void TwoDFourierTransformParameter::SetDBMultiplier | ( | double | multiplier | ) |
Specifies the multiplier for decibel output.
- Parameters
-
multiplier 1020
| void TwoDFourierTransformParameter::SetDBRefValue | ( | Variant & | val | ) |
Specifies the reference value for decibel output.
- Parameters
-
val Reference value
| void TwoDFourierTransformParameter::SetDBRefValueType | ( | String & | type | ) |
Specifies the type of the reference value for decibel output.
- Parameters
-
type Name of the reference value type SpecifyMax
| void TwoDFourierTransformParameter::SetFrequencyDomainAxisType | ( | String & | type | ) |
Specifies the frequency domain axis type.
- Parameters
-
type Frequency domain axis type OrderFrequency
| void TwoDFourierTransformParameter::SetFrequencyMultiplier | ( | Variant & | val | ) |
Specifies the Frequency Multiplier value.
- Parameters
-
val Frequency multiplier value
| void TwoDFourierTransformParameter::SetMax | ( | Variant & | max | ) |
Specifies the maximum time range value.
- Parameters
-
max Maximum time range value
| void TwoDFourierTransformParameter::SetMin | ( | Variant & | min | ) |
Specifies the minimum time range value.
- Parameters
-
min Minimum 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
-
val Space order multiplier value
| void TwoDFourierTransformParameter::SetSpacePeriodicity | ( | int | type | ) |
Specifies the space periodicity.
- Parameters
-
type Space periodicity type True=1 : NoneFalse=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
-
type Time periodicity type True=1 : NoneFalse=0 : 1/2
| void TwoDFourierTransformParameter::SetType | ( | String & | type | ) |
Specifies the type of output.
- Parameters
-
type Output type AmplitudeDecibel
| 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 limitFalse=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 limitFalse=0 : Do not specify the upper limit