:py:mod:`mosum.persp3D`
=======================

.. py:module:: mosum.persp3D


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   mosum.persp3D.persp3D_multiscaleMosum



.. py:function:: persp3D_multiscaleMosum(x, mosum_args=dict(), threshold=['critical_value', 'custom'][0], alpha=0.1, threshold_function=None, palette=cm.coolwarm, xlab='G', ylab='time', zlab='MOSUM')

   3D Visualisation of multiscale MOSUM statistics

   :param x: input data
   :type x: list
   :param mosum_args: dictionary of keyword arguments to `mosum`
   :type mosum_args: dict
   :param threshold: indicates which threshold should be used to determine significance.
                     By default, it is chosen from the asymptotic distribution at the given significance level 'alpha`.
                     Alternatively it is possible to parse a user-defined function with 'threshold_function'.
   :type threshold: Str
   :param alpha: numeric value for the significance level with '0 <= alpha <= 1';
                 use iff 'threshold = "critical_value"'
   :type alpha: float
   :param threshold_function:
   :type threshold_function: function
   :param palette: colour palette for plotting, accessible from `matplotlib.cm`
   :type palette: matplotlib.colors.LinearSegmentedColormap
   :param xlab: axis labels for plot
   :type xlab: Str
   :param ylab: axis labels for plot
   :type ylab: Str
   :param zlab: axis labels for plot
   :type zlab: Str

   .. rubric:: Examples

   >>> import mosum
   >>> xx = mosum.testData("blocks")["x"]
   >>> mosum.persp3D_multiscaleMosum(xx)