gstlal-inspiral  0.4.2
 All Classes Namespaces Files Functions Variables Pages
List of all members | Public Member Functions | Public Attributes
emcee.mh.MHSampler Class Reference
Inheritance diagram for emcee.mh.MHSampler:
[legend]
Collaboration diagram for emcee.mh.MHSampler:
[legend]

Public Member Functions

def __init__
def reset
def sample

Public Attributes

 cov
 random_state

Detailed Description

The most basic possible Metropolis-Hastings style MCMC sampler

:param cov:
    The covariance matrix to use for the proposal distribution.

:param dim:
    Number of dimensions in the parameter space.

:param lnpostfn:
    A function that takes a vector in the parameter space as input and
    returns the natural logarithm of the posterior probability for that
    position.

:param args: (optional)
    A list of extra arguments for ``lnpostfn``. ``lnpostfn`` will be
    called with the sequence ``lnpostfn(p, *args)``.

Definition at line 19 of file mh.py.

Member Function Documentation

def emcee.mh.MHSampler.sample (   self,
  p0,
  lnprob = None,
  randomstate = None,
  thin = 1,
  storechain = True,
  iterations = 1 
)
Advances the chain ``iterations`` steps as an iterator

:param p0:
    The initial position vector.

:param lnprob0: (optional)
    The log posterior probability at position ``p0``. If ``lnprob``
    is not provided, the initial value is calculated.

:param rstate0: (optional)
    The state of the random number generator. See the
    :func:`random_state` property for details.

:param iterations: (optional)
    The number of steps to run.

:param thin: (optional)
    If you only want to store and yield every ``thin`` samples in the
    chain, set thin to an integer greater than 1.

:param storechain: (optional)
    By default, the sampler stores (in memory) the positions and
    log-probabilities of the samples in the chain. If you are
    using another method to store the samples to a file or if you
    don't need to analyse the samples after the fact (for burn-in
    for example) set ``storechain`` to ``False``.

At each iteration, this generator yields:

* ``pos`` — The current positions of the chain in the parameter
  space.

* ``lnprob`` — The value of the log posterior at ``pos`` .

* ``rstate`` — The current state of the random number generator.

Definition at line 49 of file mh.py.


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