SMICA  1.0
Public Member Functions | Public Attributes | List of all members
smica.instrument.Instrument Class Reference
Inheritance diagram for smica.instrument.Instrument:
smica.instrument.LogLinearBeam

Public Member Functions

def __init__
 
def get_dim
 
def get_theta
 
def set_theta
 
def pre_alphascore
 
def transfert_function
 
def apply_beam
 

Public Attributes

 ndet
 
 nvec
 
 nbin
 
 ndim
 
 vectors
 is this actually used ?
 
 alpha
 
 binning
 

Detailed Description

Base implementation of a linear observation model.

The instrumental response is a linear combination of n templates
of size (ndet, nbin).

Constructor & Destructor Documentation

def smica.instrument.Instrument.__init__ (   self,
  vectors,
  alpha,
  binning = None,
  fixed = None 
)
Init a beam model instance

Parameters
----------
vectors : ndarray
A ndarray of shape (nvec, ndet, nbin)
alpha : array-like, shape (nvec, ndet)
binning : the binning matrix
fixed : array-like, shape (nvec, ndet)
      Entries which are not equal to zero point to
      fixed indices.  It is also possible to use keywords 'all' and
      'null' to fix (respectively) all parameters or none.

Member Function Documentation

def smica.instrument.Instrument.apply_beam (   self,
  cov_source,
  bin 
)
Return the application of the transfert function to the
covariance sources
def smica.instrument.Instrument.get_dim (   self)
Return total number of free parameters
def smica.instrument.Instrument.get_theta (   self)
Return instrument parameters as a column vector
def smica.instrument.Instrument.pre_alphascore (   self,
  D,
  observed_cov 
)
Return common precomputation usefull for gradient computation.

Parameters
----------
D : ndarray
  A precomputed ndarray of shape (ndet, ndet, nbin).

observed_covariance : ndarray
  A ndarray of shape (ndet, ndet, nbin) corresponding to the
  sum of observed component covariance.

Notes
-----
  In the current implementation (and math) some computation
  are done and unnecessary.
def smica.instrument.Instrument.set_theta (   self,
  theta 
)
Update parameters with theta values (theta is a column vector)
def smica.instrument.Instrument.transfert_function (   self,
  bin = None 
)
Return transfert function as (ndet, ndet, npole) array. bin
can be specified.

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