Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALInference 4.1.9.1-3a66518
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
lalinference.bayespputils.BurstPosterior Class Reference

Detailed Description

Data structure for a table of posterior samples .

Definition at line 2233 of file bayespputils.py.

Inherits lalinference.bayespputils.Posterior.

Public Member Functions

def __init__ (self, commonResultsFormatData, SimBurstTableEntry=None, injFref=None, SnglBurstList=None, name=None, description=None)
 Constructor. More...
 
- Public Member Functions inherited from lalinference.bayespputils.Posterior
def __init__ (self, commonResultsFormatData, SimInspiralTableEntry=None, inj_spin_frame='OrbitalL', injFref=100, SnglInspiralList=None, name=None, description=None)
 Constructor. More...
 
def extend_posterior (self)
 Add some useful derived parameters (such as tilt angles, time delays, etc) in the Posterior object. More...
 
def bootstrap (self)
 Returns a new Posterior object that contains a bootstrap sample of self. More...
 
def delete_samples_by_idx (self, samples)
 Remove samples from all OneDPosteriors. More...
 
def delete_NaN_entries (self, param_list)
 Remove samples containing NaN in request params. More...
 
def DIC (self)
 Returns the Deviance Information Criterion estimated from the posterior samples. More...
 
def injection (self)
 Return the injected values. More...
 
def triggers (self)
 Return the trigger values . More...
 
def longest_chain_cycles (self)
 Returns the number of cycles in the longest chain. More...
 
def set_injection (self, injection)
 Set the injected values of the parameters. More...
 
def set_triggers (self, triggers)
 Set the trigger values of the parameters. More...
 
def __getitem__ (self, key)
 Container method . More...
 
def __len__ (self)
 Container method. More...
 
def __iter__ (self)
 Container method. More...
 
def forward (self)
 Generate a forward iterator (in sense of list of names) over Posterior with name,one_d_pos. More...
 
def bySample (self)
 Generate a forward iterator over the list of samples corresponding to the data stored within the Posterior instance. More...
 
def dim (self)
 Return number of parameters. More...
 
def names (self)
 Return list of parameter names. More...
 
def means (self)
 Return dict {paramName:paramMean} . More...
 
def medians (self)
 Return dict {paramName:paramMedian} . More...
 
def stdevs (self)
 Return dict {paramName:paramStandardDeviation} . More...
 
def name (self)
 Return qualified string containing the 'name' of the Posterior instance. More...
 
def description (self)
 Return qualified string containing a 'description' of the Posterior instance. More...
 
def append (self, one_d_posterior)
 Container method. More...
 
def pop (self, param_name)
 Container method. More...
 
def append_mapping (self, new_param_names, func, post_names)
 Append posteriors pos1,pos2,...=func(post_names) More...
 
def di_evidence (self, boxing=64)
 Returns the log of the direct-integration evidence for the posterior samples. More...
 
def elliptical_subregion_evidence (self)
 Returns an approximation to the log(evidence) obtained by fitting an ellipse around the highest-posterior samples and performing the harmonic mean approximation within the ellipse. More...
 
def harmonic_mean_evidence (self)
 Returns the log of the harmonic mean evidence for the set of posterior samples. More...
 
def maxL (self)
 Return the maximum likelihood probability and the corresponding set of parameters. More...
 
def maxP (self)
 Return the maximum a posteriori probability and the corresponding set of parameters. More...
 
def samples (self)
 Return an (M,N) numpy.array of posterior samples; M = len(self); N = dim(self) . More...
 
def write_to_file (self, fname)
 Dump the posterior table to a file in the 'common format'. More...
 
def gelman_rubin (self, pname)
 Returns an approximation to the Gelman-Rubin statistic (see Gelman, A. More...
 
def healpix_map (self, resol, nest=True)
 Returns a healpix map in the pixel ordering that represents the posterior density (per square degree) on the sky. More...
 
def __str__ (self)
 Define a string representation of the Posterior class ; returns a html formatted table of various properties of posteriors. More...
 

Constructor & Destructor Documentation

◆ __init__()

def lalinference.bayespputils.BurstPosterior.__init__ (   self,
  commonResultsFormatData,
  SimBurstTableEntry = None,
  injFref = None,
  SnglBurstList = None,
  name = None,
  description = None 
)

Constructor.

Parameters
commonResultsFormatDataA 2D array containing the posterior samples and related data. The samples chains form the columns.
SimBurstTableEntryA ligolw.lscstables.SimBurst row containing the injected values.
SnglBurstListA list of SnglBurst objects containing the triggers.
injFrefreference frequency in injection
nameoptional name for this Posterior
descriptionoptional description for this Posterior

Reimplemented from lalinference.bayespputils.Posterior.

Definition at line 2245 of file bayespputils.py.