teradataml 17.20.0.7__py3-none-any.whl → 20.0.0.1__py3-none-any.whl

teradataml/data/jsons/uaf/17.20/TD_CONVOLVE2.json

@@ -1,68 +1,68 @@
-{
-        "FuncName": "TD_CONVOLVE2",
-        "FuncDescriptionShort": "TD_CONVOLVE2 expands the DSP processing to the image domain",
-        "FuncDescriptionLong": [
-                "This function, the TD_CONVOLVE2, takes two matrices as inputs: one representing the source matrix (image) to be filtered; and, the other matrix being the PSF itself.  The resultant output is the source matrix with the filtering PSF applied."
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "Temporal and Spatial",
-        "JSONVersion": "1",
-        "FuncRName": "td_Convolve2",
-        "MaxInputFiles": 2,
-        "Input": [
-                {
-                        "Type": "MATRIX",
-                        "Description": [
-                                "The source series to be filtered"
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
-                        "Optional": false
-                },
-                {
-                        "Type": "MATRIX",
-                        "Description": [
-                                "The filter kernel itself"
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
-                        "Optional": false
-                }
-        ],
-        "Output": [
-                {
-                        "Type": "ART",
-                        "PrimaryLayer": true,
-                        "LayerName": "ARTPRIMARY",
-                        "ResultTableColumnTypes": [
-                                "integer",
-                                "integer",
-                                "float",
-                                "float"
-                        ],
-                        "Description": [
-                                "The TD_CONVOLVE2 function returns only a primary result set.   There are no secondary or tertiary result sets produced by this function.  The primary result set can be retrieved by issuing a SELECT against the analytical table containing the results."
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
-                }
-        ],
-        "IsPlottable": true,
-        "Params": [
-
-        ],
-        "InputFmt": [
-                {
-                        "Name": "INPUT_MODE",
-                        "Type": "string",
-                        "Optional": false,
-                        "PermittedValues": [
-                                "ONE2ONE",
-                                "MANY2ONE",
-                                "MATCH"
-                        ],
-                        "Description": [
-                                "Specifies the input mode supported by the function."
-                        ],
-                        "LangName": "input_fmt_input_mode"
-                }
-        ],
-        "OutputFmt": false
+{
+        "FuncName": "TD_CONVOLVE2",
+        "FuncDescriptionShort": "TD_CONVOLVE2 expands the DSP processing to the image domain",
+        "FuncDescriptionLong": [
+                "This function, the TD_CONVOLVE2, takes two matrices as inputs: one representing the source matrix (image) to be filtered; and, the other matrix being the PSF itself.  The resultant output is the source matrix with the filtering PSF applied."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Temporal and Spatial",
+        "JSONVersion": "1",
+        "FuncRName": "td_Convolve2",
+        "MaxInputFiles": 2,
+        "Input": [
+                {
+                        "Type": "MATRIX",
+                        "Description": [
+                                "The source series to be filtered"
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": false
+                },
+                {
+                        "Type": "MATRIX",
+                        "Description": [
+                                "The filter kernel itself"
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": false
+                }
+        ],
+        "Output": [
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": true,
+                        "LayerName": "ARTPRIMARY",
+                        "ResultTableColumnTypes": [
+                                "integer",
+                                "integer",
+                                "float",
+                                "float"
+                        ],
+                        "Description": [
+                                "The TD_CONVOLVE2 function returns only a primary result set.   There are no secondary or tertiary result sets produced by this function.  The primary result set can be retrieved by issuing a SELECT against the analytical table containing the results."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+
+        ],
+        "InputFmt": [
+                {
+                        "Name": "INPUT_MODE",
+                        "Type": "string",
+                        "Optional": false,
+                        "PermittedValues": [
+                                "ONE2ONE",
+                                "MANY2ONE",
+                                "MATCH"
+                        ],
+                        "Description": [
+                                "Specifies the input mode supported by the function."
+                        ],
+                        "LangName": "input_fmt_input_mode"
+                }
+        ],
+        "OutputFmt": false
 }

teradataml/data/jsons/uaf/17.20/TD_CUMUL_PERIODOGRAM.json

@@ -1,92 +1,92 @@
-{
-        "FuncName": "TD_CUMUL_PERIODOGRAM",
-        "FuncDescriptionShort": "Help selecting the model which best describes the data modeled",
-        "FuncDescriptionLong": [
-                "The Cumulative Periodogram statistical test, also known as the Bartlett’s test, is aimed at assisting the data scientist in selecting the model candidate which is the best choice for the data they are modeling.  The test which works off the residuals generated during the model validation / model selection processing phase.  As mentioned previously, typically the data scientists divide their series sample set into two portions: the first portion to be used for the 'model fitting' exercise; and, the second portion to be used for the 'model validation' exercise.  The TD_CUMUL_PERIODOGRAM function is usually executed against the residuals produced during the second 'model validation' exercise, meaning against the 'in-sample' forecasted data points."
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "Diagnostic Statistical Test",
-        "JSONVersion": "1",
-        "FuncRName": "td_Cumul_Periodogram",
-        "MaxInputFiles": 1,
-        "Input": [
-                {
-                        "Type": [
-                                "SERIES",
-                                "ART"
-                        ],
-                        "Description": [
-                                "This section outlines the syntax associated with invoking the TD_CUMUL_PERIODOGRAM function.   This function can accept either a single univariate series (containing the in-sample generated residuals) as an input, or alternatively can accept an ART table containing the residual results from a previously run validation (example: TD_ARIMAVALIDATE) operation. ",
-                                "For the case in which the input is a univariate series, the payload should contain a reference to a single field containing the residuals: the single field references the calculated residual: original_value minus calculated_value",
-                                "For the scenario in which the residuals reside within the tertiary result set associated with an ART table, then the caller merely needs to pass in the TABLE_NAME identify the ART containing the residuals - the DBS software will perform the extraction of the original series, calculated series, and residuals as part of the execution of this function.",
-                                "The TD_CUMUL_PERIODOGRAM function will create a two layered art table.   "
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
-                        "Optional": false
-                }
-        ],
-        "Output": [
-                {
-                        "Type": "ART",
-                        "PrimaryLayer": true,
-                        "LayerName": "ARTPRIMARY",
-                        "ResultTableColumnTypes": [
-
-                                "float",
-                                "float",
-                                "varchar(40)"
-                        ],
-                        "Description": [
-
-                                "This primary layer will contain the Bartlett test statistics and p-value, significant level and test results.",
-                                "The primary result set can be retrieved by issuing a SELECT against the analytical result table (ART) containing the results whereas the secondary results set can be accessed via the TD_EXTRACT_RESULTS utility function. ",
-                                "For the case in which the input is a univariate series, the payload should contain a reference to a single field containing the residuals: the single field references the calculated residual: original_value minus calculated_value",
-                                "there is one result row per series for each series acted upon."
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
-                },
-                {
-                        "Type": "ART",
-                        "PrimaryLayer": false,
-                        "LayerName": "ARTCPDATA",
-                        "ResultTableColumnTypes": [
-
-                                "integer",
-                                "integer",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float"
-                        ],
-                        "Description": [
- 
-                                "The secondary layer ARTCPDATA will contain the cumulative periodogram at each periodicity, related intermediate calculation result and confidence band result at each periodicity in order to be used to plot the cumulative periodograms.",
-                                "there will be one result row per unique periodicity returned for each series acted upon."
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
-                }
-        ],
-        "IsPlottable": true,
-        "Params": [
-
-                {
-                        "Name": "SIGNIFICANCE_LEVEL",
-                        "Type": "double",
-                        "Optional": false,
-                        "PermittedValues": [
-                                0.05,
-                                0.01
-                        ],
-                        "AllowNaN": false,
-                        "Description": [
-                                "The significance level to be associated with the Cumulative Periodogram test.  Choices are limited to 0.05 (95%) or 0.01 (99%) ."
-                        ]
-                }
-        ],
-        "InputFmt": false,
-        "OutputFmt": false
+{
+        "FuncName": "TD_CUMUL_PERIODOGRAM",
+        "FuncDescriptionShort": "Help selecting the model which best describes the data modeled",
+        "FuncDescriptionLong": [
+                "The Cumulative Periodogram statistical test, also known as the Bartlett’s test, is aimed at assisting the data scientist in selecting the model candidate which is the best choice for the data they are modeling.  The test which works off the residuals generated during the model validation / model selection processing phase.  As mentioned previously, typically the data scientists divide their series sample set into two portions: the first portion to be used for the 'model fitting' exercise; and, the second portion to be used for the 'model validation' exercise.  The TD_CUMUL_PERIODOGRAM function is usually executed against the residuals produced during the second 'model validation' exercise, meaning against the 'in-sample' forecasted data points."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Diagnostic Statistical Test",
+        "JSONVersion": "1",
+        "FuncRName": "td_Cumul_Periodogram",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": [
+                                "SERIES",
+                                "ART"
+                        ],
+                        "Description": [
+                                "This section outlines the syntax associated with invoking the TD_CUMUL_PERIODOGRAM function.   This function can accept either a single univariate series (containing the in-sample generated residuals) as an input, or alternatively can accept an ART table containing the residual results from a previously run validation (example: TD_ARIMAVALIDATE) operation. ",
+                                "For the case in which the input is a univariate series, the payload should contain a reference to a single field containing the residuals: the single field references the calculated residual: original_value minus calculated_value",
+                                "For the scenario in which the residuals reside within the tertiary result set associated with an ART table, then the caller merely needs to pass in the TABLE_NAME identify the ART containing the residuals - the DBS software will perform the extraction of the original series, calculated series, and residuals as part of the execution of this function.",
+                                "The TD_CUMUL_PERIODOGRAM function will create a two layered art table.   "
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": false
+                }
+        ],
+        "Output": [
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": true,
+                        "LayerName": "ARTPRIMARY",
+                        "ResultTableColumnTypes": [
+
+                                "float",
+                                "float",
+                                "varchar(40)"
+                        ],
+                        "Description": [
+
+                                "This primary layer will contain the Bartlett test statistics and p-value, significant level and test results.",
+                                "The primary result set can be retrieved by issuing a SELECT against the analytical result table (ART) containing the results whereas the secondary results set can be accessed via the TD_EXTRACT_RESULTS utility function. ",
+                                "For the case in which the input is a univariate series, the payload should contain a reference to a single field containing the residuals: the single field references the calculated residual: original_value minus calculated_value",
+                                "there is one result row per series for each series acted upon."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                },
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": false,
+                        "LayerName": "ARTCPDATA",
+                        "ResultTableColumnTypes": [
+
+                                "integer",
+                                "integer",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float"
+                        ],
+                        "Description": [
+ 
+                                "The secondary layer ARTCPDATA will contain the cumulative periodogram at each periodicity, related intermediate calculation result and confidence band result at each periodicity in order to be used to plot the cumulative periodograms.",
+                                "there will be one result row per unique periodicity returned for each series acted upon."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+
+                {
+                        "Name": "SIGNIFICANCE_LEVEL",
+                        "Type": "double",
+                        "Optional": false,
+                        "PermittedValues": [
+                                0.05,
+                                0.01
+                        ],
+                        "AllowNaN": false,
+                        "Description": [
+                                "The significance level to be associated with the Cumulative Periodogram test.  Choices are limited to 0.05 (95%) or 0.01 (99%) ."
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": false
 }

teradataml/data/jsons/uaf/17.20/TD_DFFT.json

@@ -1,137 +1,137 @@
-{
-        "FuncName": "TD_DFFT",
-        "FuncDescriptionShort": "transforms the series from the time or spatial domain to the temporal frequency or spatial frequency domain",
-        "FuncDescriptionLong": [
-                "At its core, this function takes a logical-runtime series - time series or spatial series - as an input and transforms the series from the time or spatial domain to the temporal frequency or spatial frequency domain, respectively.  The input logical-runtime series can contain elements which are either real numbers PAYLOAD(CONTENT(REAL) | CONTENT(MULTIVAR_REAL)) or complex numbers PAYLOAD(CONTENT(COMPLEX) | CONTENT(MULTIVAR_COMPLEX)).    The result series is always a multivariate series containing Fourier coefficients, whose elements are either complex numbers with real and imaginary components - OUTPUT_FMT(CONTENT(COMPLEX) | CONTENT(MULTIVAR_COMPLEX)); or, alternatively, whose elements consist of amplitude and phase number pairs - OUTPUT_FMT(CONTENT(AMPL_PHASE_DEGREES) | CONTENT(AMPL_PHASE_RADIANS)  | CONTENT(AMPL_PHASE) | CONTENT(MULTIVAR_AMPL_PHASE_DEGREES) | CONTENT(MULTIVAR_AMPL_PHASE_RADIANS) | CONTENT(MULTIVAR_AMPL_PHASE)  ). The default index of this output series is integer-based. It starts at the negative Nyquist frequency (-N/2) and goes up to the positive Nyquist frequency (N/2).  Other choices for output indexes are also available to the user."
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "Temporal and Spatial",
-        "JSONVersion": "1",
-        "FuncRName": "td_DFFT",
-        "MaxInputFiles": 1,
-        "Input": [
-                {
-                        "Type": ["SERIES", "ART"],
-                        "Description": [
-                                "a logical-runtime series - time series or spatial series - as an input"
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
-                        "Optional": false
-                }
-        ],
-        "Output": [
-                {
-                        "Type": "ART",
-                        "PrimaryLayer": true,
-                        "LayerName": "ARTPRIMARY",
-                        "ResultTableColumnTypes": [
-	 
-                                "integer",
-                                "float",
-                                "float"
-                        ],
-                        "Description": [
-
-                                "The result series is always a multivariate series containing Fourier coefficients, whose elements are either complex numbers with real and imaginary component",
-                                "The TD_DFFT function returns only a primary result set.   There are no secondary or tertiary result sets produced by this function.  ",
-                                "The primary result set can be accessed either via a subsequent SELECT * FROM <art table> statement or by issuing a TD_EXTRACT_RESULTS(…,LAYER(ARTPRIMARY),…) .",
-                                "The data scientist has the choice of outputting the result set with the produced  Fourier Coefficients being realized in the form of: complex numbers - OUTPUT_FMT(CONTENT(COMPLEX) | CONTENT(MULTIVAR_COMPLEX)); or, in polar form, meaning in the form of amplitude and phase number pairs - OUTPUT_FMT(CONTENT(AMPL_PHASE_RADIANS) | CONTENT(AMPL_PHASE_DEGREES) | CONTENT(AMPL_PHASE) | CONTENT(MULTIVAR_AMPL_PHASE_RADIANS)  | CONTENT(AMPL_PHASE_RADIANS) | CONTENT(MULTIVAR_AMPL_PHASE) ).  This will, of course, affect the composition of the produced output columns.",
-                                "The TD_DFFT functions comes with many options relative to the contents of the output rows.  The data scientist has both the ability to affect the style of index used within the result series, as well as whether the Fourier coefficients should be output in rectangular (complex number) or polar (amplitude-phase) form.  Using the FREQ_STYLE and K_HERTZ parameters, the data scientist can choose between different ways of outputting the “index” associated with the output series of Fourier coefficients, choosing between: a simple monotonically increasing integer index; an index based on the normalized sample rate; an index based on radians; and, an index based on the original sampling frequency used to capture the series.  See FREQ_STYLE section which follows, for additional information. ",
-                                "The OUTPUT_FMT (CONTENT()) construct can be used by the data scientist to choose how they would like their Fourier coefficients to be output.  The can use CONTENT(COMPLEX) or CONTENT(MULTIVAR_COMPLEX) to request the Fourier coefficients in rectangular form.  Alternatively, they can use CONTENT(AMPL_PHASE_RADIANS), CONTENT(AMPL_PHASE_DEGREES), CONTENT(AMPL_PHASE), CONTENT(MULTIVAR_AMPL_PHASE_RADIANS), CONTENT(MULTIVAR_AMPL_PHASE), or CONTENT(MULTIVAR_AMPL_PHASE_DEGREES) to request that the Fourier coefficients be output in the polar form; and to further request the phase to be output in radians or degrees. "
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
-                }
-        ],
-        "IsPlottable": true,
-        "Params": [
-
-                {
-                        "Name": "ZERO_PADDING_OK",
-                        "Type": "integer",
-                        "Optional": true,
-                        "DefaultValue": 1,
-                        "PermittedValues": [
-                                0,
-                                1
-                        ],
-                        "Description": [
-                                "Optional Parameter.  Determines whether it is OK to add zeros to the end of a given Series to achieve a more efficient  computation of the FFT coefficients.  A value of '1' means true; a value of '0' means false.  Default is true."
-                        ]
-                },
-                {
-                        "Name": "FREQ_STYLE",
-                        "Type": "string",
-                        "Optional": true,
-                        "DefaultValue": "K_INTEGRAL",
-                        "PermittedValues": [
-                                "K_INTEGRAL",
-                                "K_SAMPLE_RATE",
-                                "K_RADIANS",
-                                "K_HERTZ"
-                        ],
-                        "Description": [
-                                "Optional Parameter.  Determines format/values associated with the x-axis of the output.  Choices are: 'K_INTEGRAL', an integer representation.; 'K_SAMPLE_RATE': normalized to 'Number Entries', ranges from -0.5 to +0.5;  'K_RADIANS', ranges from -PI to +PI; and, 'K_HERTZ', must be used in conjunction with the 'HERTZ_SAMPLE_RATE', this represents the frequency in hertz. The Default is 'K_INTEGRAL'. "
-                        ]
-                },
-                {
-                        "Name": "HERTZ_SAMPLE_RATE",
-                        "Type": "float",
-                        "Optional": true,
-                        "LowerBound": 0,
-                        "LowerBoundType": "INCLUSIVE",
-                        "AllowNaN": false,
-                        "Description": [
-                                "Optional Parameter.  Only valid with a FREQ_STYLE(K_HERTZ).  A Floating point constant representing the sample rate, in hertz.  A value of 10000.0 means that the sample points were obtained by sampling at a rate of 10,000 hertz."
-                        ]
-                },
-                {
-                        "Name": "ALGORITHM",
-                        "Type": "string",
-                        "Optional": true,
-                        "PermittedValues": [
-                                "COOLEY_TUKEY",
-                                "SINGLETON"
-                        ],
-                        "Description": [
-                                "Optional Parameter.  Bypasses the internal DFFT Planner and influences the core DFFT algorithm associated with the primary DFFT calculation.  Choices are: 'COOLEY_TUKEY', or 'SINGLETON'.  When this parameter is NOT PRESENT.  The internal DFFT 'Planner' will select the most efficient algorithm for the operation. "
-                        ]
-                },
-                {
-                        "Name": "HUMAN_READABLE",
-                        "Type": "integer",
-                        "Optional": true,
-                        "DefaultValue": 1,
-                        "PermittedValues": [
-                                0,
-                                1
-                        ],
-                        "Description": [
-                                "Optional Parameter.  Determines whether the produced output rows are in a human-readable / plottable form; or if they are output in the raw-form, which is equivalent to how the 'R' and 'PYTHON' programs would output the results.     A value of '1' means true, output in human readable form; a value of '0' means false, output in raw form.  Default is true – output in Human Readable format."
-                        ]
-                }
-        ],
-        "InputFmt": false,
-        "OutputFmt": [
-                {
-                        "Name": "CONTENT",
-                        "Type": "string",
-                        "Optional": true,
-                        "PermittedValues": [
-                                "COMPLEX",
-                                "AMPL_PHASE_RADIANS",
-                                "AMPL_PHASE_DEGREES",
-                                "AMPL_PHASE",
-                                "MULTIVAR_COMPLEX",
-                                "MULTIVAR_AMPL_PHASE_RADIANS",
-                                "MULTIVAR_AMPL_PHASE_DEGREES",
-                                "MULTIVAR_AMPL_PHASE"
-                        ],
-                        "Description": [
-                                "The OUTPUT_FMT (CONTENT()) construct can be used by the data scientist to choose how they would like their Fourier coefficients to be output.  The can use CONTENT(COMPLEX) or CONTENT(MULTIVAR_COMPLEX) to request the Fourier coefficients in rectangular form.  Alternatively, they can use CONTENT(AMPL_PHASE_RADIANS), CONTENT(AMPL_PHASE_DEGREES), CONTENT(AMPL_PHASE), CONTENT(MULTIVAR_AMPL_PHASE_RADIANS), CONTENT(MULTIVAR_AMPL_PHASE), or CONTENT(MULTIVAR_AMPL_PHASE_DEGREES) to request that the Fourier coefficients be output in the polar form; and to further request the phase to be output in radians or degrees. ",
-                                "AMPL_PHASE is one of the permitted values, it is synonymous with AMPL_PHASE_RADIANS. Similarly MULTIVAR_AMPL_PHASE is equivalent to MULTIVAR_AMPL_PHASE_RADIANS.",
-                                "The default value is dependent on the datatype of the input series; a single var input will generate COMPLEX output CONTENT by default; a multi var input will generate MULTIVAR_COMPLEX output CONTENT by default."
-                        ],
-                        "LangName": "output_fmt_content"
-                }
-        ]
+{
+        "FuncName": "TD_DFFT",
+        "FuncDescriptionShort": "transforms the series from the time or spatial domain to the temporal frequency or spatial frequency domain",
+        "FuncDescriptionLong": [
+                "At its core, this function takes a logical-runtime series - time series or spatial series - as an input and transforms the series from the time or spatial domain to the temporal frequency or spatial frequency domain, respectively.  The input logical-runtime series can contain elements which are either real numbers PAYLOAD(CONTENT(REAL) | CONTENT(MULTIVAR_REAL)) or complex numbers PAYLOAD(CONTENT(COMPLEX) | CONTENT(MULTIVAR_COMPLEX)).    The result series is always a multivariate series containing Fourier coefficients, whose elements are either complex numbers with real and imaginary components - OUTPUT_FMT(CONTENT(COMPLEX) | CONTENT(MULTIVAR_COMPLEX)); or, alternatively, whose elements consist of amplitude and phase number pairs - OUTPUT_FMT(CONTENT(AMPL_PHASE_DEGREES) | CONTENT(AMPL_PHASE_RADIANS)  | CONTENT(AMPL_PHASE) | CONTENT(MULTIVAR_AMPL_PHASE_DEGREES) | CONTENT(MULTIVAR_AMPL_PHASE_RADIANS) | CONTENT(MULTIVAR_AMPL_PHASE)  ). The default index of this output series is integer-based. It starts at the negative Nyquist frequency (-N/2) and goes up to the positive Nyquist frequency (N/2).  Other choices for output indexes are also available to the user."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Temporal and Spatial",
+        "JSONVersion": "1",
+        "FuncRName": "td_DFFT",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": ["SERIES", "ART"],
+                        "Description": [
+                                "a logical-runtime series - time series or spatial series - as an input"
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": false
+                }
+        ],
+        "Output": [
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": true,
+                        "LayerName": "ARTPRIMARY",
+                        "ResultTableColumnTypes": [
+	 
+                                "integer",
+                                "float",
+                                "float"
+                        ],
+                        "Description": [
+
+                                "The result series is always a multivariate series containing Fourier coefficients, whose elements are either complex numbers with real and imaginary component",
+                                "The TD_DFFT function returns only a primary result set.   There are no secondary or tertiary result sets produced by this function.  ",
+                                "The primary result set can be accessed either via a subsequent SELECT * FROM <art table> statement or by issuing a TD_EXTRACT_RESULTS(…,LAYER(ARTPRIMARY),…) .",
+                                "The data scientist has the choice of outputting the result set with the produced  Fourier Coefficients being realized in the form of: complex numbers - OUTPUT_FMT(CONTENT(COMPLEX) | CONTENT(MULTIVAR_COMPLEX)); or, in polar form, meaning in the form of amplitude and phase number pairs - OUTPUT_FMT(CONTENT(AMPL_PHASE_RADIANS) | CONTENT(AMPL_PHASE_DEGREES) | CONTENT(AMPL_PHASE) | CONTENT(MULTIVAR_AMPL_PHASE_RADIANS)  | CONTENT(AMPL_PHASE_RADIANS) | CONTENT(MULTIVAR_AMPL_PHASE) ).  This will, of course, affect the composition of the produced output columns.",
+                                "The TD_DFFT functions comes with many options relative to the contents of the output rows.  The data scientist has both the ability to affect the style of index used within the result series, as well as whether the Fourier coefficients should be output in rectangular (complex number) or polar (amplitude-phase) form.  Using the FREQ_STYLE and K_HERTZ parameters, the data scientist can choose between different ways of outputting the “index” associated with the output series of Fourier coefficients, choosing between: a simple monotonically increasing integer index; an index based on the normalized sample rate; an index based on radians; and, an index based on the original sampling frequency used to capture the series.  See FREQ_STYLE section which follows, for additional information. ",
+                                "The OUTPUT_FMT (CONTENT()) construct can be used by the data scientist to choose how they would like their Fourier coefficients to be output.  The can use CONTENT(COMPLEX) or CONTENT(MULTIVAR_COMPLEX) to request the Fourier coefficients in rectangular form.  Alternatively, they can use CONTENT(AMPL_PHASE_RADIANS), CONTENT(AMPL_PHASE_DEGREES), CONTENT(AMPL_PHASE), CONTENT(MULTIVAR_AMPL_PHASE_RADIANS), CONTENT(MULTIVAR_AMPL_PHASE), or CONTENT(MULTIVAR_AMPL_PHASE_DEGREES) to request that the Fourier coefficients be output in the polar form; and to further request the phase to be output in radians or degrees. "
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+
+                {
+                        "Name": "ZERO_PADDING_OK",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 1,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "Optional Parameter.  Determines whether it is OK to add zeros to the end of a given Series to achieve a more efficient  computation of the FFT coefficients.  A value of '1' means true; a value of '0' means false.  Default is true."
+                        ]
+                },
+                {
+                        "Name": "FREQ_STYLE",
+                        "Type": "string",
+                        "Optional": true,
+                        "DefaultValue": "K_INTEGRAL",
+                        "PermittedValues": [
+                                "K_INTEGRAL",
+                                "K_SAMPLE_RATE",
+                                "K_RADIANS",
+                                "K_HERTZ"
+                        ],
+                        "Description": [
+                                "Optional Parameter.  Determines format/values associated with the x-axis of the output.  Choices are: 'K_INTEGRAL', an integer representation.; 'K_SAMPLE_RATE': normalized to 'Number Entries', ranges from -0.5 to +0.5;  'K_RADIANS', ranges from -PI to +PI; and, 'K_HERTZ', must be used in conjunction with the 'HERTZ_SAMPLE_RATE', this represents the frequency in hertz. The Default is 'K_INTEGRAL'. "
+                        ]
+                },
+                {
+                        "Name": "HERTZ_SAMPLE_RATE",
+                        "Type": "float",
+                        "Optional": true,
+                        "LowerBound": 0,
+                        "LowerBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "Optional Parameter.  Only valid with a FREQ_STYLE(K_HERTZ).  A Floating point constant representing the sample rate, in hertz.  A value of 10000.0 means that the sample points were obtained by sampling at a rate of 10,000 hertz."
+                        ]
+                },
+                {
+                        "Name": "ALGORITHM",
+                        "Type": "string",
+                        "Optional": true,
+                        "PermittedValues": [
+                                "COOLEY_TUKEY",
+                                "SINGLETON"
+                        ],
+                        "Description": [
+                                "Optional Parameter.  Bypasses the internal DFFT Planner and influences the core DFFT algorithm associated with the primary DFFT calculation.  Choices are: 'COOLEY_TUKEY', or 'SINGLETON'.  When this parameter is NOT PRESENT.  The internal DFFT 'Planner' will select the most efficient algorithm for the operation. "
+                        ]
+                },
+                {
+                        "Name": "HUMAN_READABLE",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 1,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "Optional Parameter.  Determines whether the produced output rows are in a human-readable / plottable form; or if they are output in the raw-form, which is equivalent to how the 'R' and 'PYTHON' programs would output the results.     A value of '1' means true, output in human readable form; a value of '0' means false, output in raw form.  Default is true – output in Human Readable format."
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": [
+                {
+                        "Name": "CONTENT",
+                        "Type": "string",
+                        "Optional": true,
+                        "PermittedValues": [
+                                "COMPLEX",
+                                "AMPL_PHASE_RADIANS",
+                                "AMPL_PHASE_DEGREES",
+                                "AMPL_PHASE",
+                                "MULTIVAR_COMPLEX",
+                                "MULTIVAR_AMPL_PHASE_RADIANS",
+                                "MULTIVAR_AMPL_PHASE_DEGREES",
+                                "MULTIVAR_AMPL_PHASE"
+                        ],
+                        "Description": [
+                                "The OUTPUT_FMT (CONTENT()) construct can be used by the data scientist to choose how they would like their Fourier coefficients to be output.  The can use CONTENT(COMPLEX) or CONTENT(MULTIVAR_COMPLEX) to request the Fourier coefficients in rectangular form.  Alternatively, they can use CONTENT(AMPL_PHASE_RADIANS), CONTENT(AMPL_PHASE_DEGREES), CONTENT(AMPL_PHASE), CONTENT(MULTIVAR_AMPL_PHASE_RADIANS), CONTENT(MULTIVAR_AMPL_PHASE), or CONTENT(MULTIVAR_AMPL_PHASE_DEGREES) to request that the Fourier coefficients be output in the polar form; and to further request the phase to be output in radians or degrees. ",
+                                "AMPL_PHASE is one of the permitted values, it is synonymous with AMPL_PHASE_RADIANS. Similarly MULTIVAR_AMPL_PHASE is equivalent to MULTIVAR_AMPL_PHASE_RADIANS.",
+                                "The default value is dependent on the datatype of the input series; a single var input will generate COMPLEX output CONTENT by default; a multi var input will generate MULTIVAR_COMPLEX output CONTENT by default."
+                        ],
+                        "LangName": "output_fmt_content"
+                }
+        ]
 }