6.3.9.6.2. statsmodels.sandbox.distributions.mv_normal.MVElliptical

class statsmodels.sandbox.distributions.mv_normal.MVElliptical(mean, sigma, *args, **kwds)[source]

Base Class for multivariate elliptical distributions, normal and t

contains common initialization, and some common methods subclass needs to implement at least rvs and logpdf methods

initialize instance

Parameters:

mean : array_like

parameter mu (might be renamed), for symmetric distributions this is the mean

sigma : array_like, 2d

dispersion matrix, covariance matrix in normal distribution, but only proportional to covariance matrix in t distribution

args : list

distribution specific arguments, e.g. df for t distribution

kwds : dict

currently not used

__init__(mean, sigma, *args, **kwds)[source]

initialize instance

Parameters:

mean : array_like

parameter mu (might be renamed), for symmetric distributions this is the mean

sigma : array_like, 2d

dispersion matrix, covariance matrix in normal distribution, but only proportional to covariance matrix in t distribution

args : list

distribution specific arguments, e.g. df for t distribution

kwds : dict

currently not used

6.3.9.6.2.1. Methods

__init__(mean, sigma, *args, **kwds) initialize instance
affine_transformed(shift, scale_matrix) affine transformation define in subclass because of distribution
cdf(x, **kwds) cumulative distribution function
expect_mc(dist[, func, size]) calculate expected value of function by Monte Carlo integration
logpdf(x) logarithm of probability density function
marginal(indices) return marginal distribution for variables given by indices
normalize(x) normalize the random variable, i.e. subtract mean and rescale
normalized([demeaned]) return a normalized distribution where sigma=corr
normalized2([demeaned]) return a normalized distribution where sigma=corr
pdf(x) probability density function
rvs([size]) random variable
standardize(x) standardize the random variable, i.e. subtract mean and whiten
standardized() return new standardized MVNormal instance
whiten(x) whiten the data by linear transformation

6.3.9.6.2.2. Attributes

corr correlation matrix
std standard deviation, square root of diagonal elements of cov
std_sigma standard deviation, square root of diagonal elements of sigma