SMICA  1.0
Public Member Functions | Public Attributes | List of all members
smica.component.Fixed Class Reference

Fixed. More...

Inheritance diagram for smica.component.Fixed:
smica.component.Component smica.component.FixedNoiseLike

Public Member Functions

def is_astro
 
def __init__
 
def covariance
 
def set_covariance
 
def get_dim
 
def set_theta
 
def get_theta
 
def get_thetascore
 
def get_thetaroot
 
def get_thetafim
 
def close_form
 
- 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
 
 R
 
- Public Attributes inherited from smica.component.Component
 mu
 
 sigma_inv
 

Detailed Description

Fixed.


A fixed source component.

Constructor & Destructor Documentation

def smica.component.Fixed.__init__ (   self,
  ndet,
  nbin,
  name = None 
)
Initialize component dimensions.

Parameters
----------
ndet : number of detectors
nbin : number of bins
name : name of the component

Member Function Documentation

def smica.component.Fixed.close_form (   self,
  stats,
  N 
)
Update local parameters (ie power spectra array) using a close form algorithm.

Parameters
----------
stats : array-like, shape (ndet, ndet, nbin).
Second order statistics ie empirical covariance matrices of
the observations.
N : array-like, shape (ndet, ndet, nbin).
Covariance matrices of the model deprived from the
contribution of the component.
def smica.component.Fixed.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.component.Fixed.get_dim (   self)
Return the number of free parameters of the component.
def smica.component.Fixed.get_theta (   self,
  mixmat = None,
  powspec = None 
)
Return component parameters as a vector.

Parameters
----------
mixmat : array-like, shape (ndet, 1).
If None, values are read from inner mixing matrix.
powspec : array-like, shape (1, nbin).
If None, values are read from inner power spectrum.

Returns
----------
array-like, shape (N, 1), where N is the number of free parameters.
def smica.component.Fixed.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 half the number of modes for each bin.

Returns
----------
array-like, shape (N, N), where N is the number of free parameters.
def smica.component.Fixed.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.component.Fixed.get_thetascore (   self,
  D 
)
Return likelihood first derivative values wrt component
parameters as a vector.

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.

Returns
----------
array-like, shape (N, 1), where N is the number of free parameters.
def smica.component.Fixed.set_covariance (   self,
  R,
  bin = None 
)
Set the covariance matrix(ces) (ie the contribution to the covariance of the model).

Parameters
----------
bin : bin number. If None, set all matrices in a three dimensional array.
R: array, shape (ndet, ndet, nbin) or (ndet, ndet).
def smica.component.Fixed.set_theta (   self,
  theta 
)
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: