Detailed Description

Definition at line 240 of file stringutils.py.

Inherits lalburst.snglcoinc.LnLikelihoodRatioMixin.

Public Member Functions
def	__init__ (self, instruments)

def	__iadd__ (self, other)

def	__call__ (self, **kwargs)
	Return the natural logarithm of the likelihood ratio for the given parameters,. More...

def	copy (self)

def	coinc_params (self, events, offsetvector)

def	ln_lr_from_triggers (self, events, offsetvector)

def	finish (self)

def	get_xml_root (cls, xml, name)

def	from_xml (cls, xml, name)

def	to_xml (self, name)

Public Member Functions inherited from lalburst.snglcoinc.LnLikelihoodRatioMixin
def	__call__ (self, args, *kwargs)
	Return the natural logarithm of the likelihood ratio for the given parameters,. More...

def	ln_lr_samples (self, random_params_seq, signal_noise_pdfs=None)
	Generator that transforms a sequence of candidate parameter samples into a sequence of log likelihood ratio samples. More...

Data Fields
	triangulators

	numerator

	denominator

	candidates

Static Public Attributes
string	ligo_lw_name_suffix = u"stringcusp_coincparamsdistributions"

Constructor & Destructor Documentation

◆ init()

def lalburst.stringutils.StringCoincParamsDistributions.__init__	(	self,
		instruments
	)

Definition at line 243 of file stringutils.py.

Member Function Documentation

◆ iadd()

def lalburst.stringutils.StringCoincParamsDistributions.__iadd__	(	self,
		other
	)

Definition at line 249 of file stringutils.py.

◆ call()

def lalburst.stringutils.StringCoincParamsDistributions.__call__	(		self,
		**	args
	)

Return the natural logarithm of the likelihood ratio for the given parameters,.

ln P(*args, **kwargs | signal) - ln P(*args, **kwargs | noise)

The arguments are passed verbatim to the .__call__() methods of the .numerator and .denominator attributes of self and the return value is computed from the results.

NOTE: sub-classes may override this method, possibly chaining to it if they wish. The .ln_lr_samples() mechanism does not require this method to return exactly the natural logarithm of the .numerator/.denominator ratio. The .ln_lr_samples() mechanism does not assume the numerator, denominator and ranking statistic are related to each other as the latter being the ratio of the former two, it evaluates all three separately. For this reason, the .__call__() method that implements the ranking statistic is free to include other logic, such as hierarchical cuts or bail-outs that are not stricly equivalent to the ratio of the numerator and denominator.

Special cases:

.numerator/.denominator=0/0 is mapped to ln Lambda = -inf, meaning P(signal | data) = 0. Although this condition is nonsensical because the data is claimed to be inconsistent with both noise and signal — the only two things it can be — our task here is to compute something that is monotonic in the probability the data is the result of a signal, and since this data cannot be from a signal the correct answer is -inf.

.numerator/.denominator = +inf/+inf is mapped to ln Lambda = NaN. This is sufficiently nonsensical that there is no correct interpretation. A warning will be displayed when this is encountered.

Reimplemented from lalburst.snglcoinc.LnLikelihoodRatioMixin.

Definition at line 259 of file stringutils.py.

◆ copy()

def lalburst.stringutils.StringCoincParamsDistributions.copy ( self )

Definition at line 271 of file stringutils.py.

◆ coinc_params()

def lalburst.stringutils.StringCoincParamsDistributions.coinc_params	(	self,
		events,
		offsetvector
	)

Definition at line 279 of file stringutils.py.

◆ ln_lr_from_triggers()

def lalburst.stringutils.StringCoincParamsDistributions.ln_lr_from_triggers	(	self,
		events,
		offsetvector
	)

Definition at line 353 of file stringutils.py.

◆ finish()

def lalburst.stringutils.StringCoincParamsDistributions.finish ( self )

Definition at line 356 of file stringutils.py.

◆ get_xml_root()

def lalburst.stringutils.StringCoincParamsDistributions.get_xml_root	(	cls,
		xml,
		name
	)

Definition at line 363 of file stringutils.py.

◆ from_xml()

def lalburst.stringutils.StringCoincParamsDistributions.from_xml	(	cls,
		xml,
		name
	)

Definition at line 371 of file stringutils.py.

◆ to_xml()

def lalburst.stringutils.StringCoincParamsDistributions.to_xml	(	self,
		name
	)

Definition at line 383 of file stringutils.py.

Field Documentation

◆ ligo_lw_name_suffix

string lalburst.stringutils.StringCoincParamsDistributions.ligo_lw_name_suffix = u"stringcusp_coincparamsdistributions"

static

Definition at line 241 of file stringutils.py.

◆ triangulators

lalburst.stringutils.StringCoincParamsDistributions.triangulators

Definition at line 244 of file stringutils.py.

◆ numerator

lalburst.stringutils.StringCoincParamsDistributions.numerator

Definition at line 245 of file stringutils.py.

◆ denominator

lalburst.stringutils.StringCoincParamsDistributions.denominator

Definition at line 246 of file stringutils.py.

◆ candidates

lalburst.stringutils.StringCoincParamsDistributions.candidates

Definition at line 247 of file stringutils.py.