StarVine
starvine.bvcopula.copula.t_copula.StudentTCopula Class Reference

Student T copula 2 parameter model. More...

Inheritance diagram for starvine.bvcopula.copula.t_copula.StudentTCopula:
starvine.bvcopula.copula.copula_base.CopulaBase

Public Member Functions

def __init__ (self, rotation=0)
 
- Public Member Functions inherited from starvine.bvcopula.copula.copula_base.CopulaBase
def __init__ (self, rotation=0)
 Init copula. More...
 
def cdf (self, u, v, theta)
 Evaluate the copula's CDF function. More...
 
def pdf (self, u, v, theta)
 Public facing PDF function. More...
 
def h (self, u, v, theta)
 
def hinv (self, u, v, theta)
 
def fitMLE (self, u, v, theta0, kwargs)
 Maximum likelyhood copula fit. More...
 
def sample (self, n=1000, mytheta)
 Draw N samples from the copula. More...
 
def setRotation (self, rotation=0)
 Set the copula's orientation: Allows for modeling negative dependence with the frank, gumbel, and clayton copulas (Archimedean Copula family is non-symmetric) More...
 
def kTau (self, rotation=0, theta)
 Public facing kendall's tau function.
 

Public Attributes

 thetaBounds
 
 theta0
 
 name
 
 rotation
 
- Public Attributes inherited from starvine.bvcopula.copula.copula_base.CopulaBase
 rotation
 
 fittedParams
 

Private Member Functions

def _pdf (self, u, v, rotation=0, theta)
 Probability density function of T copula. More...
 
def _cdf (self, u, v, rotation=0, theta)
 
def _h (self, v, u, rotation=0, theta)
 H function (Conditional distribution) of T copula. More...
 
def _hinv (self, v, u, rotation=0, theta)
 Inverse H function (Inv Conditional distribution) of T copula. More...
 
def _kTau (self, rotation=0, theta)
 

Detailed Description

Student T copula 2 parameter model.

$ \theta_0 == \rho $ (shape param, related to pearson's corr coeff)

$ \theta_1 == \nu $ (degrees of freedom)

$ \theta_0 \in (-1, 1), $ $ \theta_1 \in (2, \infty) $

Member Function Documentation

§ _h()

def starvine.bvcopula.copula.t_copula.StudentTCopula._h (   self,
  v,
  u,
  rotation = 0,
  theta 
)
private

H function (Conditional distribution) of T copula.

TODO: CHECK UU and VV ordering!

§ _hinv()

def starvine.bvcopula.copula.t_copula.StudentTCopula._hinv (   self,
  v,
  u,
  rotation = 0,
  theta 
)
private

Inverse H function (Inv Conditional distribution) of T copula.

TODO: CHECK UU and VV ordering!

§ _pdf()

def starvine.bvcopula.copula.t_copula.StudentTCopula._pdf (   self,
  u,
  v,
  rotation = 0,
  theta 
)
private

Probability density function of T copula.

Parameters
unp_1darary
vnp_1darary
rotationint Optional copula rotation.
thetalist of float list of parameters to T-copula [Shape, DoF]

The documentation for this class was generated from the following file: