Teradata Package for Python Function Reference | 20.00 - DFFT2Conv - Teradata Package for Python - Look here for syntax, methods and examples for the functions included in the Teradata Package for Python.

Teradata® Package for Python Function Reference - 20.00

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Teradata Package for Python
Release Number
20.00
Published
March 2024
Language
English (United States)
Last Update
2024-04-10
dita:id
TeradataPython_FxRef_Enterprise_2000
Product Category
Teradata Vantage
 
 
DFFT2Conv

 
Functions
       
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: 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)