teradataml 20.0.0.8__py3-none-any.whl

teradataml/data/docs/uaf/docs_17_20/DFFT2Conv.py

@@ -0,0 +1,216 @@
+def DFFT2Conv(data=None, data_filter_expr=None, conv=None, 
+              freq_style="K_INTEGRAL", hertz_sample_rate=None, 
+              output_fmt_content=None, **generic_arguments):
+    """
+    DESCRIPTION:
+        The DFFT2Conv() function is a Fast Fourier Transform converter that
+        converts output generated by DFFT2(). DFFT2() results are in
+        human-readable and raw form. DFFT2Conv() can also output different payload types
+        such as AMPL_PHASE_DEGREES, MULTIVAR_AMPL_PHASE_RADIANS, COMPLEX. However,
+        user may want a different result form in order to pass the results to
+        another UAF function, plot the results in human readable form, compare the
+        results to Python, and so on. Instead of rerunning DFFT2() to produce a
+        different result set, user can use DFFT2Conv() to accomplish the task faster and
+        with less memory consumption.
+
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the input matrix or a TDAnalyticResult object
+            created over the output generated by the UAF function.
+            Types: TDMatrix, TDAnalyticResult
+
+        data_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data".
+            Types: ColumnExpression
+
+        conv:
+            Required Argument.
+            Specifies the type of conversion to be performed by the
+            function.
+            Permitted Values:
+                * HR_TO_RAW: Convert from human readable to raw form.
+                * RAW_TO_HR: Convert from raw form to human readable form.
+            Types: str
+
+        freq_style:
+            Optional Argument.
+            Specifies the format or values associated with the x-axis of
+            the output.
+            Permitted Values:
+                * K_INTEGRAL: Integer representation.
+                * K_SAMPLE_RATE: Integer normalized to number entries, ranging from -0.5 to +0.5.
+                * K_RADIANS: Radian ranges from -π to +π.
+                * K_HERTZ: Frequency in hertz. Must be used in conjunction with "hertz_sample_rate".
+            Default Value: K_INTEGRAL
+            Types: str
+
+        hertz_sample_rate:
+            Optional Argument.
+            Specifies the sample rate as a floating point constant,
+            in hertz. A value of 10000.0 indicates that the sample points
+            were obtained by sampling at a rate of 10,000 hertz.
+            Note:
+                * Applicable only when "freq_style" is set to 'K_HERTZ'.
+            Types: int OR float
+
+        output_fmt_content:
+            Optional Argument.
+            Specifies a complex number that can be in rectangular (real, imaginary)
+            or polar (amplitude, phase) form. The default is rectangular (real,
+            imaginary). The output options are as follows:
+                * COMPLEX
+                * AMPL_PHASE_DEGREES
+                * AMPL_PHASE_RADIANS
+                * AMPL_PHASE
+            The MULTIVAR options are below. The default is MULTIVAR_COMPLEX:
+                * MULTIVAR_COMPLEX
+                * MULTIVAR_AMPL_PHASE_DEGREES
+                * MULTIVAR_AMPL_PHASE_RADIANS
+                * MULTIVAR_AMPL_PHASE
+            Valid Conversion:
+                COMPLEX -> COMPLEX
+                COMPLEX -> AMPL_PHASE
+                AMPL_PHASE -> AMPL_PHASE
+                AMPL_PHASE -> COMPLEX
+                MULTIVAR_COMPLEX -> MULTIVAR_COMPLEX
+                MULTIVAR_COMPLEX -> MULTVAR_AMPL_PHASE
+                MULTIVAR_AMPL_PHASE -> MULTIVAR_AMPL_PHASE
+                MULTIVAR_AMPL_PHASE -> MULTIVAR_COMPLEX
+            Rest of conversions are invalid.
+            Permitted Values: COMPLEX,
+                              AMPL_PHASE_RADIANS,
+                              AMPL_PHASE_DEGREES,
+                              AMPL_PHASE,
+                              MULTIVAR_COMPLEX, 
+                              MULTIVAR_AMPL_PHASE_RADIANS, 
+                              MULTIVAR_AMPL_PHASE_DEGREES, 
+                              MULTIVAR_AMPL_PHASE
+            Types: str
+
+        **generic_arguments:
+            Specifies the generic keyword arguments of UAF functions.
+            Below are the generic keyword arguments:
+                persist:
+                    Optional Argument.
+                    Specifies whether to persist the results of the
+                    function in a table or not. When set to True,
+                    results are persisted in a table; otherwise,
+                    results are garbage collected at the end of the
+                    session.
+                    Note that, when UAF function is executed, an 
+                    analytic result table (ART) is created.
+                    Default Value: False
+                    Types: bool
+
+                volatile:
+                    Optional Argument.
+                    Specifies whether to put the results of the
+                    function in a volatile ART or not. When set to
+                    True, results are stored in a volatile ART,
+                    otherwise not.
+                    Default Value: False
+                    Types: bool
+
+                output_table_name:
+                    Optional Argument.
+                    Specifies the name of the table to store results. 
+                    If not specified, a unique table name is internally 
+                    generated.
+                    Types: str
+
+                output_db_name:
+                    Optional Argument.
+                    Specifies the name of the database to create output 
+                    table into. If not specified, table is created into 
+                    database specified by the user at the time of context 
+                    creation or configuration parameter. Argument is ignored,
+                    if "output_table_name" is not specified.
+                    Types: str
+
+
+    RETURNS:
+        Instance of DFFT2Conv.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as DFFT2Conv_obj.<attribute_name>.
+        Output teradataml DataFrame attribute name is:
+            1. result
+
+
+    RAISES:
+        TeradataMlException, TypeError, ValueError
+
+
+    EXAMPLES:
+        # Notes:
+        #     1. Get the connection to Vantage to execute the function.
+        #     2. One must import the required functions mentioned in
+        #        the example from teradataml.
+        #     3. Function will raise error if not supported on the Vantage
+        #        user is connected to.
+
+        # Check the list of available UAF analytic functions.
+        display_analytic_functions(type="UAF")
+
+        # Load the example data.
+        load_example_data("uaf", ["dfft2conv_real_4_4"])
+
+        # Create teradataml DataFrame object.
+        data = DataFrame.from_table("dfft2conv_real_4_4")
+
+        # Create teradataml TDMatrix object.
+        td_matrix = TDMatrix(data=data,
+                             id="id",
+                             row_index="row_i",
+                             row_index_style="SEQUENCE",
+                             column_index="column_i",
+                             column_index_style="SEQUENCE",
+                             payload_field="magnitude",
+                             payload_content="REAL")
+
+        # Compute the two-dimension fourier transform using the
+        # input matrix with real numbers only for the matrix id 33.
+        filter_expr = td_matrix.id==33
+        dfft2_out = DFFT2(data=td_matrix,
+                          data_filter_expr=filter_expr,
+                          freq_style="K_INTEGRAL",
+                          human_readable=False,
+                          output_fmt_content="COMPLEX")
+
+        # Example 1: Convert the complex(REAL,IMAGINARY) output of DFFT2() to
+        #            polar(AMPLITUDE,PHASE) in RADIAN format using TDMatrix
+        #            as input data.
+        # Create teradataml TDMatrix object.
+        matrix_spec = TDMatrix(data=dfft2_out.result,
+                               id="id",
+                               row_index="ROW_I",
+                               column_index="COLUMN_I",
+                               row_index_style="SEQUENCE",
+                               column_index_style="SEQUENCE",
+                               payload_field=["REAL_magnitude", "IMAG_magnitude"],
+                               payload_content="COMPLEX")
+
+        uaf_out1 = DFFT2Conv(data=matrix_spec,
+                             conv="HR_TO_RAW",
+                             output_fmt_content="AMPL_PHASE_RADIANS")
+
+        # Print the result DataFrame.
+        print(uaf_out1.result)
+
+         # Example 2: Convert the complex(REAL,IMAGINARY) output of DFFT2() to
+         #            polar(AMPLITUDE,PHASE) in RADIAN format using TDAnalyticResult
+         #            as input data.
+        # Create teradataml TDAnalyticResult object.
+        art_spec = TDAnalyticResult(data=dfft2_out.result)
+
+        uaf_out2 = DFFT2Conv(data=art_spec,
+                             conv="HR_TO_RAW",
+                             output_fmt_content="AMPL_PHASE_RADIANS")
+
+        # Print the result DataFrame.
+        print(uaf_out2.result)
+
+    """
+    

teradataml/data/docs/uaf/docs_17_20/DFFTConv.py

@@ -0,0 +1,192 @@
+def DFFTConv(data=None, data_filter_expr=None, conv=None, 
+             freq_style="K_INTEGRAL", hertz_sample_rate=None, 
+             output_fmt_content=None, **generic_arguments):
+    """
+    DESCRIPTION:
+        The DFFTConv() function is a Fast Fourier Transform converter
+        that converts output generated by DFFT(). DFFT() results are
+        in human-readable and raw form. DFFTConv() can also output different
+        payload types such as AMPL_PHASE_DEGREES, MULTIVAR_AMPL_PHASE_RADIANS,
+        COMPLEX. However, user may want a different result form in order
+        to pass the results to another UAF function, plot the results in human
+        readable form, compare the results to Python, and so on. Instead of
+        rerunning DFFT() to produce a different result set, user can use DFFTConv()
+        to accomplish the task faster and with less memory consumption.
+
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the input series or a TDAnalyticResult object created over the
+            output generated by the UAF function.
+            Types: TDSeries, TDAnalyticResult
+
+        data_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data".
+            Types: ColumnExpression
+
+        conv:
+            Required Argument.
+            Specifies the type of conversion to be performed by the
+            function.
+            Permitted Values:
+                * HR_TO_RAW: Convert from human readable to raw form.
+                * RAW_TO_HR: Convert from raw form to human readable form.
+            Types: str
+
+        freq_style:
+            Optional Argument.
+            Specifies the format or values associated with the x-axis of
+            the output.
+            Permitted Values:
+                * K_INTEGRAL: Integer representation.
+                * K_SAMPLE_RATE: Integer normalized to number entries, ranging from -0.5 to +0.5.
+                * K_RADIANS: Radian ranges from -π to +π.
+                * K_HERTZ: Frequency in hertz. Must be used in conjunction with "hertz_sample_rate".
+            Default Value: K_INTEGRAL
+            Types: str
+
+        hertz_sample_rate:
+            Optional Argument.
+            Specifies the sample rate as a floating point constant,
+            in hertz. A value of 10000.0 indicates that the sample points
+            were obtained by sampling at a rate of 10,000 hertz.
+            Value should be greater than 0.
+            Notes:
+                * Applicable only when "freq_style" is set to 'K_HERTZ'.
+            Types: int OR float
+
+        output_fmt_content:
+            Optional Argument.
+            Specifies a complex number that can be in rectangular (real, imaginary)
+            or polar (amplitude, phase) form. The default is rectangular (real,
+            imaginary). The output options are as follows:
+                * COMPLEX
+                * AMPL_PHASE_DEGREES
+                * AMPL_PHASE_RADIANS
+                * AMPL_PHASE
+            The MULTIVAR options are below. The default is MULTIVAR_COMPLEX:
+                * MULTIVAR_COMPLEX
+                * MULTIVAR_AMPL_PHASE_DEGREES
+                * MULTIVAR_AMPL_PHASE_RADIANS
+                * MULTIVAR_AMPL_PHASE
+            Valid Conversion:
+                COMPLEX -> COMPLEX
+                COMPLEX -> AMPL_PHASE
+                AMPL_PHASE -> AMPL_PHASE
+                AMPL_PHASE -> COMPLEX
+                MULTIVAR_COMPLEX -> MULTIVAR_COMPLEX
+                MULTIVAR_COMPLEX -> MULTVAR_AMPL_PHASE
+                MULTIVAR_AMPL_PHASE -> MULTIVAR_AMPL_PHASE
+                MULTIVAR_AMPL_PHASE -> MULTIVAR_COMPLEX
+            Rest of conversions are invalid.
+            Permitted Values: COMPLEX,
+                              AMPL_PHASE_RADIANS,
+                              AMPL_PHASE_DEGREES,
+                              AMPL_PHASE,
+                              MULTIVAR_COMPLEX,
+                              MULTIVAR_AMPL_PHASE_RADIANS,
+                              MULTIVAR_AMPL_PHASE_DEGREES,
+                              MULTIVAR_AMPL_PHASE
+            Types: str
+
+        **generic_arguments:
+            Specifies the generic keyword arguments of UAF functions.
+            Below are the generic keyword arguments:
+                persist:
+                    Optional Argument.
+                    Specifies whether to persist the results of the
+                    function in a table or not. When set to True,
+                    results are persisted in a table; otherwise,
+                    results are garbage collected at the end of the
+                    session.
+                    Note that, when UAF function is executed, an 
+                    analytic result table (ART) is created.
+                    Default Value: False
+                    Types: bool
+
+                volatile:
+                    Optional Argument.
+                    Specifies whether to put the results of the
+                    function in a volatile ART or not. When set to
+                    True, results are stored in a volatile ART,
+                    otherwise not.
+                    Default Value: False
+                    Types: bool
+
+                output_table_name:
+                    Optional Argument.
+                    Specifies the name of the table to store results. 
+                    If not specified, a unique table name is internally 
+                    generated.
+                    Types: str
+
+                output_db_name:
+                    Optional Argument.
+                    Specifies the name of the database to create output 
+                    table into. If not specified, table is created into 
+                    database specified by the user at the time of context 
+                    creation or configuration parameter. Argument is ignored,
+                    if "output_table_name" is not specified.
+                    Types: str
+
+
+    RETURNS:
+        Instance of DFFTConv.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as DFFTConv_obj.<attribute_name>.
+        Output teradataml DataFrame attribute name is:
+            1. result
+
+
+    RAISES:
+        TeradataMlException, TypeError, ValueError
+
+
+    EXAMPLES:
+        # Notes:
+        #     1. Get the connection to Vantage to execute the function.
+        #     2. One must import the required functions mentioned in
+        #        the example from teradataml.
+        #     3. Function will raise error if not supported on the Vantage
+        #        user is connected to.
+
+        # Check the list of available UAF analytic functions.
+        display_analytic_functions(type="UAF")
+
+        # Load the example data.
+        load_example_data("uaf", ["DFFTConv_Real_8_8"])
+
+        # Create teradataml DataFrame object.
+        df = DataFrame("DFFTConv_Real_8_8")
+
+        # Create teradataml TDSeries object.
+        td_series = TDSeries(data=df,
+                             id="ID",
+                             row_index="ROW_I",
+                             row_index_style="SEQUENCE",
+                             payload_field="MAGNITUDE",
+                             payload_content="REAL")
+
+        # Compute the complex Fourier Transform Coefficients
+        # using a sequential series.
+        dfft = DFFT(data=td_series,
+                    freq_style="K_INTEGRAL",
+                    human_readable=False,
+                    output_fmt_content="COMPLEX")
+
+        # Create teradataml TDAnalyticResult object.
+        art_spec = TDAnalyticResult(data=dfft.result)
+
+        # Example 1 : Convert the complex(REAL,IMAGINARY) output of DFFT() to
+        #             polar(AMPLITUDE,PHASE) in RADIAN format.
+        dfft_conv = DFFTConv(data=art_spec,
+                             conv="RAW_TO_HR",
+                             output_fmt_content="AMPL_PHASE_RADIANS")
+
+        # Print the result DataFrame.
+        print(dfft_conv.result)
+    
+    """
+    

teradataml/data/docs/uaf/docs_17_20/DIFF.py

@@ -0,0 +1,175 @@
+def DIFF(data=None, data_filter_expr=None, lag=None, 
+         differences=None, seasonal_multiplier=None, 
+         output_fmt_index_style="NUMERICAL_SEQUENCE", 
+         **generic_arguments):
+    """
+    DESCRIPTION:
+        The DIFF() function transforms a stationary, seasonal, or non-stationary
+        time series into a differenced time series by performing both status-quo
+        time series differencing, seasonal based differencing, and multiplicative
+        transforms. Thus, the output of this transform function is always a new
+        time series.
+
+        The following procedure is an example of how to use DIFF() function:
+            1. Detect the unit roots using DickeyFuller() function.
+            2. Use DIFF() function to eliminate unit roots.
+
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the input time series with payload content as 'REAL' or 'MULTIVAR_REAL',
+            or specifies the output of UNDIFF in ART Spec. When passed in a multivariate
+            series, DIFF() function is executed separately against each identified series in
+            the collection and produce a coalesced multivariate style analytical result set.
+            Types: TDSeries, TDAnalyticResult
+
+        data_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data".
+            Types: ColumnExpression
+
+        lag:
+            Required Argument.
+            Specifies the lag between the series elements.
+            It accepts positive integer value, including zero.
+            Types: int
+
+        differences:
+            Required Argument.
+            Specifies the difference between time series elements
+            'Yt' and 'Yt-lag'. It accepts positive integer value,
+            including zero.
+            Types: int
+
+        seasonal_multiplier:
+            Required Argument.
+            Specifies whether a time series is seasonal or not.
+            It accepts positive integer value, including zero.
+            When set to 0, indicates time series is nonseasonal.
+            Positive value indicates it is seasonal.
+            The "seasonal_multiplier determines the formula to
+            be used by function to transform each input time
+            series element, 'Yt', to a differenced time series
+            element, 'Ydt'.
+            Types: int
+
+        output_fmt_index_style:
+            Optional Argument.
+            Specifies the index style of the output format.
+            Permitted Values: NUMERICAL_SEQUENCE
+            Default Value: NUMERICAL_SEQUENCE
+            Types: str
+
+        **generic_arguments:
+            Specifies the generic keyword arguments of UAF functions.
+            Below are the generic keyword arguments:
+                persist:
+                    Optional Argument.
+                    Specifies whether to persist the results of the
+                    function in a table or not. When set to True,
+                    results are persisted in a table; otherwise,
+                    results are garbage collected at the end of the
+                    session.
+                    Note that, when UAF function is executed, an 
+                    analytic result table (ART) is created.
+                    Default Value: False
+                    Types: bool
+
+                volatile:
+                    Optional Argument.
+                    Specifies whether to put the results of the
+                    function in a volatile ART or not. When set to
+                    True, results are stored in a volatile ART,
+                    otherwise not.
+                    Default Value: False
+                    Types: bool
+
+                output_table_name:
+                    Optional Argument.
+                    Specifies the name of the table to store results. 
+                    If not specified, a unique table name is internally 
+                    generated.
+                    Types: str
+
+                output_db_name:
+                    Optional Argument.
+                    Specifies the name of the database to create output 
+                    table into. If not specified, table is created into 
+                    database specified by the user at the time of context 
+                    creation or configuration parameter. Argument is ignored,
+                    if "output_table_name" is not specified.
+                    Types: str
+
+
+    RETURNS:
+        Instance of DIFF.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as DIFF_obj.<attribute_name>.
+        Output teradataml DataFrame attribute name is:
+            1. result
+
+
+    RAISES:
+        TeradataMlException, TypeError, ValueError
+
+
+    EXAMPLES:
+        # Notes:
+        #     1. Get the connection to Vantage to execute the function.
+        #     2. One must import the required functions mentioned in
+        #        the example from teradataml.
+        #     3. Function will raise error if not supported on the Vantage
+        #        user is connected to.
+
+        # Check the list of available UAF analytic functions.
+        display_analytic_functions(type="UAF")
+
+        # Load the example data.
+        load_example_data("uaf", ["ocean_buoy2"])
+
+        # Create teradataml DataFrame object.
+        data = DataFrame.from_table("ocean_buoy2")
+
+        # Example 1: Execute DIFF() function with TDSeries having
+        #            REAL payload content to transform time series
+        #            into a differenced time series.
+
+        # Create teradataml TDSeries object.
+        data_series_df_real = TDSeries(data=data,
+                                       id="buoy_id",
+                                       row_index="n_seq_no",
+                                       row_index_style= "SEQUENCE",
+                                       payload_field="magnitude1",
+                                       payload_content="REAL")
+
+        uaf_out_1 = DIFF(data=data_series_df_real,
+                         lag=1,
+                         differences=2,
+                         seasonal_multiplier=0)
+
+        # Print the result DataFrame.
+        print(uaf_out_1.result)
+
+        # Example 2: Execute DIFF() function with TDSeries having
+        #            MULTIVAR_REAL payload content to transform time
+        #            series into a differenced time series.
+
+        # Create teradataml TDSeries object.
+        data_series_df_multivar = TDSeries(data=data,
+                                           id="buoy_id",
+                                           row_index="n_seq_no",
+                                           row_index_style= "SEQUENCE",
+                                           payload_field=["magnitude1", "magnitude2"],
+                                           payload_content="MULTIVAR_REAL")
+
+        uaf_out_2 = DIFF(data=data_series_df_multivar,
+                         lag=1,
+                         differences=2,
+                         seasonal_multiplier=0)
+
+        # Print the result DataFrame.
+        print(uaf_out_2.result)
+    
+    """
+