Function bars

pytta/_plot.py:504–758

Plot the analysis data in fractinal octave bands. Parameters (default), (type): ----------------------------- * analyses (), (list): a list with Analyses. * xLabel ('Time [s]'), (str): x axis label. * yLabel ('Amplitude'), (str):

(analyses, xLabel, yLabel, yLim, xLim, title, decimalSep, barWidth,
         errorStyle, forceZeroCentering, overlapBars, color)

def bars(analyses, xLabel, yLabel, yLim, xLim, title, decimalSep, barWidth,
         errorStyle, forceZeroCentering, overlapBars, color):
    """
    Plot the analysis data in fractinal octave bands.

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

       * analyses (), (list):
            a list with Analyses.

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

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

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

            >>> yLim = [-100, 100]

        * xLim (), (list):
            bands limits.

            >>> xLim = [100, 10000]

        * title (), (str):
            plot title

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

            >>> decimalSep = ',' # in Brazil

        * barWidth (0.75), float:
            width of the bars from one fractional octave band.
            0 < barWidth < 1.

        * errorStyle ('standard'), str:
            error curve style. May be 'laza' or None/'standard'.

        * forceZeroCentering ('False'), bool:
            force centered bars at Y zero.

        * overlapBars ('False'), bool:
            overlap bars. No side by side bars of different data.

        * color (None), list:
            list containing the color of each Analysis.


    Return:
    --------

        matplotlib.figure.Figure object.
    """
    if isinstance(color, list):