.. _f-opwindow:

module ``onnxrt.ops_cpu.op_window``
===================================





.. inheritance-diagram:: mlprodict.onnxrt.ops_cpu.op_window


Short summary
+++++++++++++

module ``mlprodict.onnxrt.ops_cpu.op_window``

Runtime operator.


:githublink:`%|py|7`




Classes
+++++++

+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| class                                                                       | truncated documentation                                                                                                                                                                     |
+=============================================================================+=============================================================================================================================================================================================+
| :class:`_CommonWindow <mlprodict.onnxrt.ops_cpu.op_window._CommonWindow>`   |                                                                                                                                                                                             |
+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`BlackmanWindow <mlprodict.onnxrt.ops_cpu.op_window.BlackmanWindow>` | Returns :math:`\omega_n = 0.42 - 0.5 \cos \left( \frac{2\pi n}{N-1} \right) + 0.08 \cos \left( \frac{4\pi n}{N-1} \right)` ...                                                              |
+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`HammingWindow <mlprodict.onnxrt.ops_cpu.op_window.HammingWindow>`   | Returns :math:`\omega_n = \alpha - \beta \cos \left( \frac{\pi n}{N-1} \right)` where *N* is the window length. ...                                                                         |
+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`HannWindow <mlprodict.onnxrt.ops_cpu.op_window.HannWindow>`         | Returns :math:`\omega_n = \sin^2\left( \frac{\pi n}{N-1} \right)` where *N* is the window length. See `hann_window <https://pytorch.org/docs/stable/generated/torch.hann_window.html>`_ ... |
+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+






Properties
++++++++++

+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| property                                                                                                | truncated documentation                                                                                               |
+=========================================================================================================+=======================================================================================================================+
| :meth:`args_default <mlprodict.onnxrt.ops_cpu.op_window.BlackmanWindow.args_default>`                   | Returns the list of arguments as well as the list of parameters with the default values (close to the signature). ... |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`args_default <mlprodict.onnxrt.ops_cpu.op_window.HammingWindow.args_default>`                    | Returns the list of arguments as well as the list of parameters with the default values (close to the signature). ... |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`args_default <mlprodict.onnxrt.ops_cpu.op_window.HannWindow.args_default>`                       | Returns the list of arguments as well as the list of parameters with the default values (close to the signature). ... |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`args_default_modified <mlprodict.onnxrt.ops_cpu.op_window.BlackmanWindow.args_default_modified>` | Returns the list of modified parameters.                                                                              |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`args_default_modified <mlprodict.onnxrt.ops_cpu.op_window.HammingWindow.args_default_modified>`  | Returns the list of modified parameters.                                                                              |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`args_default_modified <mlprodict.onnxrt.ops_cpu.op_window.HannWindow.args_default_modified>`     | Returns the list of modified parameters.                                                                              |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`args_mandatory <mlprodict.onnxrt.ops_cpu.op_window.BlackmanWindow.args_mandatory>`               | Returns the list of optional arguments.                                                                               |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`args_mandatory <mlprodict.onnxrt.ops_cpu.op_window.HammingWindow.args_mandatory>`                | Returns the list of optional arguments.                                                                               |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`args_mandatory <mlprodict.onnxrt.ops_cpu.op_window.HannWindow.args_mandatory>`                   | Returns the list of optional arguments.                                                                               |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`args_optional <mlprodict.onnxrt.ops_cpu.op_window.BlackmanWindow.args_optional>`                 | Returns the list of optional arguments.                                                                               |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`args_optional <mlprodict.onnxrt.ops_cpu.op_window.HammingWindow.args_optional>`                  | Returns the list of optional arguments.                                                                               |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`args_optional <mlprodict.onnxrt.ops_cpu.op_window.HannWindow.args_optional>`                     | Returns the list of optional arguments.                                                                               |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`atts_value <mlprodict.onnxrt.ops_cpu.op_window.BlackmanWindow.atts_value>`                       | Returns all parameters in a dictionary.                                                                               |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`atts_value <mlprodict.onnxrt.ops_cpu.op_window.HammingWindow.atts_value>`                        | Returns all parameters in a dictionary.                                                                               |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`atts_value <mlprodict.onnxrt.ops_cpu.op_window.HannWindow.atts_value>`                           | Returns all parameters in a dictionary.                                                                               |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+






Methods
+++++++

+----------------------------------------------------------------------------------+-------------------------+
| method                                                                           | truncated documentation |
+==================================================================================+=========================+
| :py:meth:`__init__ <mlprodict.onnxrt.ops_cpu.op_window.BlackmanWindow.__init__>` |                         |
+----------------------------------------------------------------------------------+-------------------------+
| :py:meth:`__init__ <mlprodict.onnxrt.ops_cpu.op_window.HammingWindow.__init__>`  |                         |
+----------------------------------------------------------------------------------+-------------------------+
| :py:meth:`__init__ <mlprodict.onnxrt.ops_cpu.op_window.HannWindow.__init__>`     |                         |
+----------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_begin <mlprodict.onnxrt.ops_cpu.op_window.BlackmanWindow._begin>`     |                         |
+----------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_begin <mlprodict.onnxrt.ops_cpu.op_window.HammingWindow._begin>`      |                         |
+----------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_begin <mlprodict.onnxrt.ops_cpu.op_window.HannWindow._begin>`         |                         |
+----------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_begin <mlprodict.onnxrt.ops_cpu.op_window._CommonWindow._begin>`      |                         |
+----------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_end <mlprodict.onnxrt.ops_cpu.op_window.BlackmanWindow._end>`         |                         |
+----------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_end <mlprodict.onnxrt.ops_cpu.op_window.HammingWindow._end>`          |                         |
+----------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_end <mlprodict.onnxrt.ops_cpu.op_window.HannWindow._end>`             |                         |
+----------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_end <mlprodict.onnxrt.ops_cpu.op_window._CommonWindow._end>`          |                         |
+----------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_run <mlprodict.onnxrt.ops_cpu.op_window.BlackmanWindow._run>`         |                         |
+----------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_run <mlprodict.onnxrt.ops_cpu.op_window.HammingWindow._run>`          |                         |
+----------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_run <mlprodict.onnxrt.ops_cpu.op_window.HannWindow._run>`             |                         |
+----------------------------------------------------------------------------------+-------------------------+


Documentation
+++++++++++++

.. automodule:: mlprodict.onnxrt.ops_cpu.op_window
    :members:
    :special-members: __init__
    :show-inheritance: