SMICA  1.0
Public Member Functions | Public Attributes | List of all members
smica.cparametric.Parametric Class Reference
Inheritance diagram for smica.cparametric.Parametric:
smica.component.Astro smica.component.Component

Public Member Functions

def __init__
 
def parameter
 
def set_parameter
 
def set_theta
 
def get_theta
 
def get_thetascore
 
def get_thetaroot
 
def get_thetafim
 
def covariance
 
def get_dim
 
def __getstate__
 
def __setstate__
 
def special_init
 
- Public Member Functions inherited from smica.component.Astro
def is_astro
 
def set_freqlist
 
def set_convunit
 
def set_bins
 
- Public Member Functions inherited from smica.component.Component
def plot_power
 
def plot_em
 
def set_gaussian_prior
 
def get_penalty
 
def get_score_penalty
 
def get_fim_penalty
 

Public Attributes

 ndet
 
 nbin
 
 name
 
 dim
 
 parkey
 
 npar
 
 defpar
 
 extradict
 
 parval
 
- Public Attributes inherited from smica.component.Astro
 freqlist
 
 convunit
 
 bins
 
 lmin
 
 lmax
 
 b_ws
 
 b_lR
 
- Public Attributes inherited from smica.component.Component
 mu
 
 sigma_inv
 

Detailed Description

A component derived from the Parametric package

Constructor & Destructor Documentation

def smica.cparametric.Parametric.__init__ (   self,
  ndet,
  nbin,
  freqlist,
  bins,
  lmin,
  lmax,
  parlist = [],
  name = '',
  convunit = None,
  default = None,
  extradict 
)
Initialize component parameters arrays.

Member Function Documentation

def smica.cparametric.Parametric.__getstate__ (   self)
Define pickle content.

Need to remove egfs routine instance before pickling
def smica.cparametric.Parametric.__setstate__ (   self,
  state 
)
Define class content from pickle.

Need to restore egfs routine instance.
def smica.cparametric.Parametric.covariance (   self,
  bin = None 
)
Return the covariance matrix(ces) (ie the contribution to the covariance of the model).

Parameters
----------
bin : bin number. If None, return all matrices in a three dimensional array.

Returns
-------
array, shape (ndet, ndet, nbin).
def smica.cparametric.Parametric.get_dim (   self)
Return the number of free parameters of the component.
def smica.cparametric.Parametric.get_theta (   self,
  parval = None 
)
Return component parameters as a vector.

Returns
----------
array-like, shape (N, 1), where N is the number of free parameters.
def smica.cparametric.Parametric.get_thetafim (   self,
  iRr,
  w 
)
Return Fisher Information Matrix.

Parameters
----------
iRr : array-like, shape (ndet, ndet, nbin).
iRr is the square root of the inverse of the covariance of the
model, which is constant for all components.
w : array-like, shape (1, nbin). w is the number of modes for each bin.

Returns
----------
array-like, shape (N, N), where N is the number of free parameters.
def smica.cparametric.Parametric.get_thetaroot (   self,
  iRr,
  bin = 0 
)
Return root contribution to the Fisher Information Matrix for a given bin.

Parameters
----------
iRr : array-like, shape (ndet, ndet).
iRr is the square root of the inverse of the covariance of the
model, which is constant for all components.
bin : int, bin number

Returns
----------
array-like, shape (mxm, N), where N is the number of free parameters.
def smica.cparametric.Parametric.get_thetascore (   self,
  D 
)
Return first derivative of the likelihood wrt component parameters.

Parameters
----------
D : array-like, shape (ndet, ndet, nbin).
D is the first derivative of the likelihood wrt the covariance
of the model, which is constant for all components.
B : array-like, shape (ndet, ndet, nbin).
B is the instrument covariance if any

Returns
-------
array, shape (ndet, nbin).
The score of fixed parameters is set to zero.
def smica.cparametric.Parametric.parameter (   self)
Return parameter dictionnary 
def smica.cparametric.Parametric.set_parameter (   self,
  d 
)
Set parameter value from dictionnary 
def smica.cparametric.Parametric.set_theta (   self,
  theta,
  verbose = False 
)
Set new values for component parameters.

Parameters
----------
theta : array-like, shape (N, 1), where N is the number of free parameters.
def smica.cparametric.Parametric.special_init (   self)
finalize initialization. Must fill _compute with a compute function

Member Data Documentation

smica.cparametric.Parametric.ndet
Initialize component parameters arrays.
smica.cparametric.Parametric.parval
Set new values for component parameters.

Parameters
----------
theta : array-like, shape (N, 1), where N is the number of free parameters.

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