teradataml 20.0.0.8__py3-none-any.whl

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

@@ -0,0 +1,134 @@
+{
+        "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": "EXCLUSIVE",
+                        "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"
+                }
+        ]
+}

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

@@ -0,0 +1,144 @@
+{
+        "FuncName": "TD_DFFT2",
+        "FuncDescriptionShort": "This function executes the two-dimensional Fourier Transform ",
+        "FuncDescriptionLong": [
+                "TD_DFFT2 takes a matrix (two-dimensional array) as an input, and returns a result matrix whose elements are the compute two-dimension Fourier Coefficients for the input matrix. The coefficients can be output as complex numbers in either rectangular (real, imaginary) or polar (amplitude, phase) form."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Temporal and Spatial",
+        "JSONVersion": "1",
+        "FuncRName": "td_DFFT2",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": ["ART", "MATRIX"],
+                        "Description": [
+                                "This function executes the two-dimensional Fourier Transform against a logical matrix having elements which are either real numbers or complex numbers."
+                        ],
+                        "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_DFFT2 returns ONLY a Primary Result set.  There is no Secondary or Tertiary Result set returned by this function.  The Primary Result set can be retrieved by issuing a SELECT statement against the analytical result 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": [
+                {
+                        "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 both the 'row-series' and 'column-series' comprising the matrix.  Zeros are added to the end of  these 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 (ROW_I index) and y-axis (COLUMN_I index) 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": "EXCLUSIVE",
+                        "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.  This hertz interpretation will be applied to both the ROW_I and COLUMN_I indexes."
+                        ]
+                },
+                {
+                        "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 comprising the matrix 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"
+                },
+                {
+                        "Name": "ROW_MAJOR",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 1,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "The data scientist may explicity declare whether they want the matrix output in a row-major-centric or column-major-centric manner, via the OUTPUT_FMT(ROW_MAJOR()) construct."
+                        ],
+                        "LangName": "output_fmt_row_major"
+                }
+        ]
+}

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

@@ -0,0 +1,108 @@
+{
+        "FuncName": "TD_DFFT2CONV",
+        "FuncDescriptionShort": "Convert an ART generated by TD_DFFT2",
+        "FuncDescriptionLong": [
+                "The fast fourier transform converter is used to convert an ART generated by TD_DFFT2. TD_DFFT2 outputs results in human readable and raw form. Also, it may output different payload types such as AMPL_PHASE_DEGREES, MULTIVAR_AMPL_PHASE_RADIANS, COMPLEX, etc. In normal workflow the user may want a different result form in order to pass the results to another AF, plot the results in human readable form, compare the results to python, etc. Instead of rerunning TD_DFFT2 to produce a different result form, TD_DFFT2CONV can be used to accomplish the task faster and with less memory consumption. "
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Temporal and Spatial",
+        "JSONVersion": "1",
+        "FuncRName": "td_DFFT2_Conv",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": [
+                                "MATRIX",
+                                "ART"
+                        ],
+                        "Description": [
+                                "Takes as input, the output from computing DFFT2"
+                        ],
+                        "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 TD_DFFT2CONV 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.",
+                                "The data scientist has the choice of outputting the result set with the produced Fourier Coefficients being realized in rectangular form, meaning: complex numbers - OUTPUT_FMT(CONTENT(COMPLEX)); or, in polar form, meaning amplitude and phase number pairs - OUTPUT_FMT(CONTENT(AMPL_PHASE_RADIANS) | CONTENT(AMPL_PHASE_DEGREES) | CONTENT(AMPL_PHASE)).  This will, of course, affect the composition of the produced output columns. Note that the multivar-variety of content types : complex and amplitude-phase; are also supported and have the same result table output format.",
+                                "The two float values are AMPLITUDE and PHASE if 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)).   Fourier Amplitude coefficient corresponding to ROW_I index",
+                                "The two float values are REAL and IMAGINARY if OUTPUT_FMT(CONTENT(COMPLEX)).   Fourier Real coefficient corresponding to ROW_I index"
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+                {
+                        "Name": "CONV",
+                        "Type": "string",
+                        "Optional": false,
+                        "PermittedValues": [
+                                "RAW_TO_HR",
+                                "HR_TO_RAW"
+                        ],
+                        "Description": [
+                                "Required Parameter that specifies the type of conversion to be performed by this function: convert from human readable to raw form; or, convert from raw form to human readable form."
+                        ]
+                },
+                {
+                        "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": "EXCLUSIVE",
+                        "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."
+                        ]
+                }
+        ],
+        "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"
+                }
+        ]
+}

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

@@ -0,0 +1,108 @@
+{
+        "FuncName": "TD_DFFTCONV",
+        "FuncDescriptionShort": "Convert an ART generated by TD_DFFT",
+        "FuncDescriptionLong": [
+                "The fast fourier transform converter is used to convert an ART generated by TD_DFFT. TD_DFFT outputs results in human readable and raw form. Also, it may output different payload types such as AMPL_PHASE_DEGREES, MULTIVAR_AMPL_PHASE_RADIANS, COMPLEX, etc. In normal workflow the user may want a different result form in order to pass the results to another AF, plot the results in human readable form, compare the results to python, etc. Instead of rerunning TD_DFFT to produce a different result form, TD_DFFTCONV can be used to accomplish the task faster and with almost no memory consumption. "
+        ],
+        "FunctionVersion": "21Nov24",
+        "FunctionCategory": "Temporal and Spatial",
+        "JSONVersion": "1",
+        "FuncRName": "td_DFFT_Conv",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": [
+                                "ART",
+                                "SERIES"
+                        ],
+                        "Description": [
+                                "Takes as input, the output from computing DFFT"
+                        ],
+                        "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 TD_DFFTCONV 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.",
+                                "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)); or, in the form of amplitude and phase number pairs - OUTPUT_FMT(CONTENT(AMPL_PHASE)).  This will, of course, affect the composition of the produced output columns. Multivar content types such as MULTIVAR_COMPLEX are also supported and have the same result table format.",
+                                "The two float values are AMPLITUDE and PHASE if 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)).   Fourier Amplitude coefficient corresponding to ROW_I index",
+                                "The two float values are REAL and IMAGINARY Only output if OUTPUT_FMT(CONTENT(COMPLEX)).   Fourier Real coefficient corresponding to ROW_I index"
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+                {
+                        "Name": "CONV",
+                        "Type": "string",
+                        "Optional": false,
+                        "PermittedValues": [
+                                "RAW_TO_HR",
+                                "HR_TO_RAW"
+                        ],
+                        "Description": [
+                                "Required Parameter that specifies the type of conversion to be performed by this function: convert from human readable to raw form; or, convert from raw form to human readable form."
+                        ]
+                },
+                {
+                        "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": "EXCLUSIVE",
+                        "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."
+                        ]
+                }
+        ],
+        "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"
+                }
+        ]
+}

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

@@ -0,0 +1,78 @@
+{
+        "FuncName": "TD_DICKEY_FULLER",
+        "FuncDescriptionShort": "The Dickey-Fuller test is a statistical test for the presence of one or more unit roots",
+        "FuncDescriptionLong": [
+                "The Dickey-Fuller test is a statistical test for the presence of one or more unit roots within a given series generating process, thus, the test strives to answer the question, 'given the sample data available, is it possible that the true data generating process for y contains one or more unit roots?''."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Diagnostic Statistical Test",
+        "JSONVersion": "1",
+        "FuncRName": "td_Dickey_Fuller",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": ["SERIES", "ART"],
+                        "Description": [
+                                "This section outlines the syntax associated with invoking the TD_DICKEY_FULLER function.   The function takes in a single logical-runtime series as an input.  The series is only permitted to have univariate elements.  "
+                        ],
+                        "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",
+                                "varchar(16)",
+                                "float",
+                                "float",
+                                "varchar(16)"
+                        ],
+                        "Description": [
+                                "The TD_DICKEY_FULLER function internally executes an OLS regression,  linear regression.    function returns only a primary result set consisting of one row per unique series acted upon.   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": false,
+        "Params": [
+                {
+                        "Name": "ALGORITHM",
+                        "Type": "string",
+                        "Optional": false,
+                        "PermittedValues": [
+                                "NONE",
+                                "DRIFT",
+                                "SQUARED",
+                                "DRIFTNTREND"
+                        ],
+                        "Description": [
+                                "An enumerated type with values of:  NONE, DRIFT, TREND, DRIFTNTREND, or FORMULA, which influences the type of regression that will be run for the test.",
+                                "NONE: Random walk",
+                                "DRIFT: Random walk with drift",
+                                "DRIFTNTREND: Random walk with drift and trend",
+                                "SQUARED: Random walk with drift, trend, and quadratic trend."]
+                },
+                {
+                        "Name": "MAXLAGS",
+                        "Type": "integer",
+                        "Optional": true,
+                        "LowerBound": 0,
+                        "LowerBoundType": "INCLUSIVE",
+                        "UpperBound": 100,
+                        "UpperBoundType": "INCLUSIVE",
+                        "DefaultValue": 0,
+                        "AllowNaN": false,
+                        "Description": [
+                                "The presence of the MAXLAGS parameter means the data scientist wishes to run the augmented Dickey-Fuller test. This is the maximum number of lags that will be used to form the regression equation. "
+                        ],
+                        "LangName": "max_lags"
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": false
+}