Ignore:
File:
1 edited

Legend:

Unmodified
Added
Removed

  • python/lib/aubio/__init__.py

    r7cfad8e r883b499  
    11#! /usr/bin/env python
    2 # -*- coding: utf8 -*-
    3 
    4 """
    5 aubio
    6 =====
    7 
    8 Provides a number of classes and functions for music and audio signal
    9 analysis.
    10 
    11 How to use the documentation
    12 ----------------------------
    13 
    14 Documentation of the python module is available as docstrings provided
    15 within the code, and a reference guide available online from `the
    16 aubio homepage <https://aubio.org/documentation>`_.
    17 
    18 The docstrings examples are written assuming `aubio` and `numpy` have been
    19 imported with:
    20 
    21 >>> import aubio
    22 >>> import numpy as np
    23 """
    242
    253import numpy
    … …  
    319
    3210class fvec(numpy.ndarray):
    33     """fvec(input_arg=1024, **kwargs)
    34     A vector holding float samples.
     11    """a numpy vector holding audio samples"""
    3512
    36     If `input_arg` is an `int`, a 1-dimensional vector of length `input_arg`
    37     will be created and filled with zeros. Otherwise, if `input_arg` is an
    38     `array_like` object, it will be converted to a 1-dimensional vector of
    39     type :data:`float_type`.
    40 
    41     Parameters
    42     ----------
    43     input_arg : `int` or `array_like`
    44         Can be a positive integer, or any object that can be converted to
    45         a numpy array with :func:`numpy.array`.
    46     **kwargs
    47         Additional keyword arguments passed to :func:`numpy.zeros`, if
    48         `input_arg` is an integer, or to :func:`numpy.array`. Should not
    49         include `dtype`, which is already specified as
    50         :data:`aubio.float_type`.
    51 
    52     Returns
    53     -------
    54     numpy.ndarray
    55         Array of shape `(length,)`.
    56 
    57     Examples
    58     --------
    59     >>> aubio.fvec(10)
    60     array([0., 0., 0., 0., 0., 0., 0., 0., 0., 0.], dtype=float32)
    61     >>> aubio.fvec([0,1,2])
    62     array([0., 1., 2.], dtype=float32)
    63     >>> a = np.arange(10); type(a), type(aubio.fvec(a))
    64     (<class 'numpy.ndarray'>, <class 'numpy.ndarray'>)
    65     >>> a.dtype, aubio.fvec(a).dtype
    66     (dtype('int64'), dtype('float32'))
    67 
    68     Notes
    69     -----
    70 
    71     In the Python world, `fvec` is simply a subclass of
    72     :class:`numpy.ndarray`. In practice, any 1-dimensional `numpy.ndarray` of
    73     `dtype` :data:`float_type` may be passed to methods accepting
    74     `fvec` as parameter. For instance, `sink()` or `pvoc()`.
    75 
    76     See Also
    77     --------
    78     cvec : a container holding spectral data
    79     numpy.ndarray : parent class of :class:`fvec`
    80     numpy.zeros : create a numpy array filled with zeros
    81     numpy.array : create a numpy array from an existing object
    82     """
    8313    def __new__(cls, input_arg=1024, **kwargs):
    8414        if isinstance(input_arg, int):
Note: See TracChangeset for help on using the changeset viewer.