Function time_dB

pytta/_plot.py:183–295

Plots a signal in decibels in time domain. Parameters (default), (type): ------------------------------ * sigObjs (), (list): a list with SignalObjs. * xLabel ('Time [s]'), (str): x axis label. * yLabel ('Amplitude'), (str):

(sigObjs, xLabel, yLabel, yLim, xLim, title, decimalSep, timeUnit)

def time_dB(sigObjs, xLabel, yLabel, yLim, xLim, title, decimalSep, timeUnit):
    """
    Plots a signal in decibels in time domain.

    Parameters (default), (type):
    ------------------------------

        * sigObjs (), (list):
            a list with SignalObjs.

        * xLabel ('Time [s]'), (str):
            x axis label.

        * yLabel ('Amplitude'), (str):
            y axis label.

        * yLim (), (list):
            inferior and superior limits.

            >>> yLim = [-100, 100]

        * xLim (), (list):
            left and right limits

            >>> xLim = [0, 15]

        * title (), (str):
            plot title

        * decimalSep (','), (str):
            may be dot or comma.

            >>> decimalSep = ',' # in Brazil

        * timeUnit ('s'), (str):
            'ms' or 's'.


    Return:
    --------

        matplotlib.figure.Figure object.
    """
    if decimalSep == ',':
        locale.setlocale(locale.LC_NUMERIC, 'pt_BR.UTF-8')
        plt.rcParams['axes.formatter.use_locale'] = True
    elif decimalSep =='.':
        locale.setlocale(locale.LC_NUMERIC, 'C')
        plt.rcParams['axes.formatter.use_locale'] = False
    else:
        raise ValueError("'decimalSep' must be the string '.' or ','.")

    if timeUnit in ['s', 'seconds', 'S']:
        timeScale = 1
        timeUnit = 's'
    elif timeUnit in ['ms', 'milliseconds', 'mseconds', 'MS']:
        timeScale = 1000
        timeUnit = 'ms'