teradataml 20.0.0.8__py3-none-any.whl

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

@@ -0,0 +1,106 @@
+{
+        "FuncName": "TD_BINARYSERIESOP",
+        "FuncDescriptionShort": "Perform a point-wise mathematical operation against two series having the same number of elements",
+        "FuncDescriptionLong": [
+                "There is a need in data science to be able to create a new data series that is the result of performing a point-wise mathematical operation against two series having the same number of elements.   The principal mathematical operations of interest being that of subtraction, addition, multiplication, and division.  It is called a point-wise operation because it performs the mathematical operation on one sample point at a time.  For example, if the mathematical operation being performed is subtraction, then for two series each with N sample points,  a new series is generated in which:  ResultSeries1 =  MinuendSeries1 - SubtrahendSeries1 ; ResultSeries2 =  MinuendSeries2 - SubtrahendSeries2 ; ResultSeries3 =  MinuendSeries3 - SubtrahendSeries3 ;  ..., up to ResultSeriesN  = MinuendSeriesN  - SubtrahendSeriesN.   The result series/1D array produced by the TD_BINARYSERIES_OP is the same size, 'N', as its inputs and inherits the identifiers, SERIES_ID(), in this case, from the minuend series.",
+                "Thus the TD_BINARYSERIES_OP takes two equally sized logical-runtime series as input - the first series referenced in the function call is referred to as being the 'primary series', whereas the second series referenced is the secondary series.  The result series always inherits the identifiers, SERIES_ID() from the primary series.  Mathematically, the significance of being a primary series or secondary series is as follows:",
+                "For MATHOP(SUB), subtraction, the secondary series is subtracted from the primary series.",
+                "For MATHOP(ADD), addition, the secondary series is added to the primary series.",
+                "For MATHOP(MUL), multiply, the primary series is multiplied by the secondary series.",
+                "For MATHOP(DIV), divide, the primary series is divided by the secondary series.",
+                "The TD_BINARYSERIES_OP function can be configured to operate in one of three input modes - ONE2ONE, MANY2ONE, and MATCH. These modes determine the number of primary series and number of secondary series involved in the operation, as well as determining how the primary and secondary series will be matched together. See the INPUT_FMT section for more information.",
+                "Some Use Case Examples for these Operators include:",
+                "A use for the subtraction - MATHOP(SUB) - and addition - MATHOP(ADD) - operations is to respectively remove trends from the original series and to later restore the trends while engaged in forecasting with the model.  Some background for this is: In building statistical ARMA-style forecasting models, a necessary precondition is that the time series being modelled be stationary: stationary with respect to mean; stationary with respect to covariance; and, stationary with respect to variance.    Transforming a non-stationary series into a stationary series typically requires the completion of two main tasks: the first task requiring the data scientist to model the trend or periodicity inherent in the data, then use that model to generate a representative series; the second task being to execute an operator that forms a new series, formed by subtracting the just generated trend or periodicity series from the original series.  The TD_BINARYSERIES_OP function supplies just such an operator, it forms one or more new series by enabling the data scientist to perform a point-wise subtraction between the original series, aka, the 'minuend-series', and the series to be subtracted, aka, the 'subtrahend', so minuend minus subtrahend.",
+                "A use case for the multiplication - MATHOP(SUB) - comes with respect to applying a filter function against a time series.   To apply a filter function - low pass, band pass, high pass - to a time series in the time domain requires a complex operation known as conjugation.  In contrast, if one first were to take the Fourier Transform of the time series and the Fourier Transform of the filter series; transitioning both data series from the time domain over to the frequency domain, then while in the frequency domain, the filter could be applied simply by running the two Fourier result series through a point-wise multiplier to produce a filtered result in the frequency domain.  In other words, conjugation in the time domain (a complex process) is equivalent to point-wise multiplication in the frequency domain.  Once the multiplication operation is complete, the data scientist could then take the inverse transform of the multiplied result set, obtaining the filtered version of the time series.",
+                "Use case for TD_BINARYSERIES_OP - Removal of trends present within a time series.   One task frequently performed by the Forecast Model developer is the removal of a trend from a time series, prior to modelling that series.   There are several different approaches available to the data scientist for removing trends.   As inferred in the below diagram, most of those involve executing a function against the original series that produces a new series containing the “trend”.   This initial processing step is followed by another processing step in which the original series and “trend” series is run through a point-wise subtractor, which subtracts - for each sample time point - the trend series from the original, producing a third 'detrended' series.  In other words, given an original series and a 'trend' series with five sample points at times: T0, T1, T2, T2, T4; the subtractor performs, original(T0) - trend(T0); original(T1) - trend(T1); …; original(T4) - trend(T4); producing a detrended series with five sample points.   The net effect of this operation, see diagram below, is to create a new series that is “rotated down”, once the trend has been removed.   Forecast Modelling can then proceed on the 'detrended' series."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Data Preparation",
+        "JSONVersion": "1",
+        "FuncRName": "td_Binary_Series_Op",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": "SERIES",
+                        "Description": [
+                                "This function takes two equally sized data series as inputs, performs the specified mathematical operation - add, subtract, multiply, divide - on a sample point by sample point basis, producing a result series, which is the result of performing the mathematical operation."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": false
+                },
+                {
+                        "Type": "SERIES",
+                        "Description": [
+                                "secondary series of equal size to be operated on"
+                        ],
+                        "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": [
+                                "<varies>",
+                                "float"
+                        ],
+                        "Description": [
+                                "The TD_BINARYSERIES_OP 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.",
+                                "<varies> data type and values dependent upon the OUTPUT_FMT(INDEX_STYLE()) declaration."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+                {
+                        "Name": "MATHOP",
+                        "Type": "string",
+                        "Optional": false,
+                        "PermittedValues": [
+                                "SUB",
+                                "ADD",
+                                "MUL",
+                                "DIV"
+                        ],
+                        "Description": [
+                                "Dictates mathematical operation to be performed between the passed in primary and secondary series.  It is an operation, where:  result-series = primary-series MATHOP secondary-series.   Specifics of the operation depend on the passed in PAYLOAD(CONTENT(); meaning that the operation will be a real operation, a multivariate real operation, a complex number operation, or an amplitude phase operation. "
+                        ],
+                        "LangName": "math_op"
+                }
+        ],
+        "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": [
+                {
+                        "Name": "INDEX_STYLE",
+                        "Type": "string",
+                        "Optional": true,
+                        "DefaultValue": "NUMERICAL_SEQUENCE",
+                        "PermittedValues": [
+                                "NUMERICAL_SEQUENCE",
+                                "FLOW_THROUGH"
+                        ],
+                        "Description": [
+                                "Specifies the INDEX_STYLE of the output format."
+                        ],
+                        "LangName": "output_fmt_index_style"
+                }
+        ]
+}

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

@@ -0,0 +1,89 @@
+{
+        "FuncName": "TD_BREUSCH_GODFREY",
+        "FuncDescriptionShort": "The Breusch-Godfrey statistical test which is run against the residuals associated with a fitted model",
+        "FuncDescriptionLong": [
+                "It is a test which looks for the presence of serial correlation amongst the error/residual terms.  It is mainly employed to analyze the residuals produced by a univariate or multivariate regression (cross-sectional data sets).  With respect to regression models, it is expected that there would exist no serial correlation amongst the error terms in contrast, with time series, the expectation is that most likely their will exist serial correlation amongst the error terms. "
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Diagnostic Statistical Test",
+        "JSONVersion": "1",
+        "FuncRName": "td_Breusch_Godfrey",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": [
+                                "SERIES",
+                                "ART"
+                        ],
+                        "Description": [
+                                "This function is executed against the residuals left over after running a regression."
+                        ],
+                        "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",
+                                "integer",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "varchar(16)"
+                        ],
+                        "Description": [
+                                "The TD_BREUSCH_GODFREY 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": "RESIDUAL_MAXLAGS",
+                        "Type": "integer",
+                        "Optional": false,
+                        "LowerBound": 1,
+                        "LowerBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "Positive Integer value.  Maximum lag number for the residuals used in the auxiliary regression.  Also determines degrees of freedom associated with the test."
+                        ],
+                        "LangName": "residual_max_lags"
+                },
+                {
+                        "Name": "EXPLANATORY_COUNT",
+                        "Type": "integer",
+                        "Optional": false,
+                        "LowerBound": 0,
+                        "LowerBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "The number of explanatory variables that were present in the original regression; plus '1' if a constant was present: Example: the FORMULA('Y = B0 + B1*X1') has a EXPLANATORY_COUNT of '2'; '1' for 'X1' and '1' for the constant 'B0' "
+                        ]
+                },
+                {
+                        "Name": "SIGNIFICANCE_LEVEL",
+                        "Type": "double",
+                        "Optional": true,
+                        "DefaultValue": 0.05,
+                        "LowerBound": 0,
+                        "UpperBound": 1,
+                        "LowerBoundType": "EXCLUSIVE",
+                        "UpperBoundType": "EXCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "The desired significance level for the test. Set to 0.01 or 0.05. Default is 0.05."
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": false
+}

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

@@ -0,0 +1,104 @@
+{
+        "FuncName": "TD_BREUSCH_PAGAN_GODFREY",
+        "FuncDescriptionShort": "This is a statistical test that is performed on behalf of univariate or multivariate regression models",
+        "FuncDescriptionLong": [
+                "The hope relative to building a univariate or multi-variate regression model is to create a regression model (estimator) that can be characterized as being BLUE: meaning the 'Best Linear Unbiased Estimator'.  One of the properties of such an estimator is that the variance should be homoscedastic, meaning that the variance should be constant.   Variances that are not constant, are said to be heteroscedastic.  The test described in the previous section, the Goldfeld-Quandt test strived to determine whether the variance was homoscedastic or heteroscedastic by dividing the sample set into three parts; discarding the central part; determining the variance associated with the two remaining parts; and then performing a statistical test to determine if the two variances were statistically equal. A pitfall of this approach was that for the multivariate case, there was an underlying relationship between the variance and just one of the explanatory variables.  Conducting the test, relied on the data scientist identifying the correct independent variable that was then used to order the data prior to performing the test.   This statistical test, the Breusch, Pagan, Godfrey test;  eliminates the need to select just one variable, and executes against the assumption that any of the explanatory variable may be  correlated with the variance. "
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Diagnostic Statistical Test",
+        "JSONVersion": "1",
+        "FuncRName": "td_Breusch_Pagan_Godfrey",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": [
+                                "SERIES",
+                                "ART"
+                        ],
+                        "Description": [
+                                "This function is executed against the residuals left over after running a regression.  These residuals may either reside within an independent table, or may exist in the form of tertiary results resident within an analytical result table.  The SERIES_SPEC identifies the location and context associated with the residual series.  If the residual series exists as a tertiary result set within an analytical result table, the SERIES_SPEC identifies that location, and the DBS software performs the extraction as part of the execution of this function."
+                        ],
+                        "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",
+                                "float",
+                                "integer",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "varchar(16)"
+                        ],
+                        "Description": [
+                                "The TD_BREUSCH_PAGAN_GODFREY function returns only a primary result set consisting of one row per unique series acted upon.  The row contains data describing the results of running the BPG test upon that series.  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": "VARIABLES_COUNT",
+                        "Type": "integer",
+                        "Optional": false,
+                        "LowerBound": 0,
+                        "LowerBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "An integer indicating how many explanatory variables (N) are referenced within the PAYLOAD() declaration embedded within the original series specification.  These N explanatory variable are the variables that are to be fed into the auxiliary regression."
+                        ]
+                },
+                {
+                        "Name": "FORMULA",
+                        "Type": "<td_formula>",
+                        "Optional": true,
+                        "Description": [
+                                "This is an optional parameter.  If present, it signifies that the data scientist desires that the provided regression formula serve as the driving formula for the auxiliary regression.   In performing the regression, the software will use the explanatory variables identified within the PAYLOAD() portion of the original series specification. ",
+                                "If the FORMULA is not present, then this signifies that the BPG test should be performed using the default auxiliary regression formula, which, based on the number of explanatory variables, runs the auxiliary regression as:",
+                                "p_t = a_0 + a_1 * X1 + a_2 * X2 + ... + a_N * XN ; where N is the VARIABLES_COUNT.",
+                                "When present, the FORMULA is a Teradata formula string that defines the formula that is to be used in the auxiliary regression operation. As an example consider: FORMULA(ρt = α0 + α1 X12 );  in which ρt is the dependent variable whose data is self-generated by this test;  and X1 (which is squared in the formula) is the single explanatory variable, whose data source is identified by the PAYLOAD() portion of the original series specification; and α0 and α1 are the coefficients to be solved. "
+                        ]
+                },
+                {
+                        "Name": "STUDENTIZE",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 0,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "Flag indicating whether the Koenker 'studentized version' of the BPG test is to be executed.   A value of '0' indicates that the standard BPG test is to be run.    A value of '1' indicates that the Koenker studentized version is to be run.  Default is 0. "
+                        ]
+                },
+                {
+                        "Name": "SIGNIFICANCE_LEVEL",
+                        "Type": "double",
+                        "Optional": true,
+                        "DefaultValue": 0.05,
+                        "LowerBound": 0,
+                        "UpperBound": 1,
+                        "LowerBoundType": "EXCLUSIVE",
+                        "UpperBoundType": "EXCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "The desired significance level for the test."
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": false
+}

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

@@ -0,0 +1,78 @@
+{
+        "FuncName": "TD_CONVOLVE",
+        "FuncDescriptionShort": "apply a digital filter by convolving the source signal with the appropriate filter kernel",
+        "FuncDescriptionLong": [
+                "This function, the TD_CONVOLVE, takes two series as inputs: one representing the source series to be filtered; and, the other series being the filter kernel itself.  The resultant output, is the source series with the kernel filter applied. "
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Temporal and Spatial",
+        "JSONVersion": "1",
+        "FuncRName": "td_Convolve",
+        "MaxInputFiles": 2,
+        "Input": [
+                {
+                        "Type": "SERIES",
+                        "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": "SERIES",
+                        "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",
+                                "float",
+                                "float"
+                        ],
+                        "Description": [
+                                "The TD_CONVOLVE 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": [
+                {
+                        "Name": "ALGORITHM",
+                        "Type": "string",
+                        "Optional": true,
+                        "PermittedValues": [
+                                "CONV_SUMMATION",
+                                "CONV_DFFT"
+                        ],
+                        "Description": [
+                                "Optional parameter. Options are CONV_SUMMATION or CONV_DFFT. By default, the function selects the best option based on the number of entries present in the two inputs, and their types ( REAL, COMPLEX, and so on.) CONV_SUMMATION only supports:• REAL,REAL • REAL, MULTIVAR_REAL • MULTIVAR_REAL,REAL • MULTIVAR_REAL,MULTIVAR_REAL. If the CONV_SUMMATION option is passed in when the first input is greater than 64 entries or the second input is greater than 63 entries, then CONV_DFFT is used instead. This parameter is mostly used for testing."
+                        ]
+                }
+        ],
+        "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_CONVOLVE2.json

@@ -0,0 +1,66 @@
+{
+        "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

@@ -0,0 +1,87 @@
+{
+        "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
+}