Package glue :: Package ligolw :: Module lsctables :: Class MultiInspiral
[hide private]
[frames] | no frames]

Class MultiInspiral

source code

         object --+    
                  |    
table.Table.RowType --+
                      |
                     MultiInspiral

Helpful parent class for row objects. Also used as the default row class by Table instances. Provides an __init__() method that accepts keyword arguments from which the object's attributes are initialized.

Example:

>>> x = Table.RowType(a = 0.0, b = "test", c = True)
>>> x.a
0.0
>>> x.b
'test'
>>> x.c
True

Also provides .__getstate__() and .__setstate__() methods to allow row objects to be pickled (otherwise, because they all use __slots__ to reduce their memory footprint, they aren't pickleable).

Instance Methods [hide private]
 
get_bestnr(self, index=4.0, nhigh=3.0, null_snr_threshold=4.25, null_grad_thresh=20.0, null_grad_val=0.2)
Return the BestNR statistic for this row.
source code
 
get_coinc_chisq(self)
@returns the coincident chisq for this row
source code
 
get_coinc_snr(self)
Get the coincident SNR for this row.
source code
 
get_end(self) source code
 
get_id_parts(self)
Return the three pieces of the int_8s-style event_id.
source code
 
get_ifos(self)
Return a set of the instruments for this row.
source code
 
get_new_snr(self, index=4.0, nhigh=3.0, column='chisq') source code
 
get_null_chisq(self)
@returns the coherent null chisq for this row
source code
 
get_null_snr(self)
Get the coherent Null SNR for this row.
source code
 
get_reduced_bank_chisq(self) source code
 
get_reduced_chisq(self) source code
 
get_reduced_coinc_chisq(self)
@returns the coincident chisq per degree of freedom for this row
source code
 
get_reduced_cont_chisq(self) source code
 
get_reduced_sngl_bank_chisq(self, instrument) source code
 
get_reduced_sngl_chisq(self, instrument) source code
 
get_reduced_sngl_cont_chisq(self, instrument) source code
 
get_slide_number(self)
Return the slide-number for this trigger
source code
 
get_sngl_chisq(self, instrument)
@returns the single-detector chisq for the given instrument for this row
source code
 
get_sngl_chisqs(self)
@returns a dictionary of single-detector chisqs for this row.
source code
 
get_sngl_new_snr(self, ifo, column='chisq', index=4.0, nhigh=3.0) source code
 
get_sngl_new_snrs(self, column='chisq', index=4.0, nhigh=3.0)
@returns a dictionary of single-detector newSNRs for this row.
source code
 
get_sngl_snr(self, instrument)
Get the single-detector SNR for the given instrument for this row
source code
 
get_sngl_snrs(self)
Return a dictionary of single-detector SNRs for this row.
source code
 
set_ifos(self, instruments)
Serialize a sequence of instruments into the ifos attribute.
source code

Inherited from table.Table.RowType: __getstate__, __init__, __setstate__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  instrument_id = {'G1': 'g', 'H1': 'h1', 'H2': 'h2', 'L1': 'l',...
Properties [hide private]
  ampMetricEigenVal1
  ampMetricEigenVal2
  amp_term_1
  amp_term_10
  amp_term_2
  amp_term_3
  amp_term_4
  amp_term_5
  amp_term_6
  amp_term_7
  amp_term_8
  amp_term_9
  amplitude
  autoCorrCohSq
  autoCorrNullSq
  bank_chisq
  bank_chisq_dof
  bank_chisq_g
  bank_chisq_h1
  bank_chisq_h2
  bank_chisq_l
  bank_chisq_t
  bank_chisq_v
  chi
  chisq
  chisq_dof
  chisq_g
  chisq_h1
  chisq_h2
  chisq_l
  chisq_t
  chisq_v
  coa_phase
  cohSnrSqLocal
  coh_snr_h1h2
  cont_chisq
  cont_chisq_dof
  cont_chisq_g
  cont_chisq_h1
  cont_chisq_h2
  cont_chisq_l
  cont_chisq_t
  cont_chisq_v
  crossCorrCohSq
  crossCorrNullSq
  dec
  distance
  eff_dist_g
  eff_dist_h1
  eff_dist_h1h2
  eff_dist_h2
  eff_dist_l
  eff_dist_t
  eff_dist_v
  end_time
  end_time_gmst
  end_time_ns
  eta
  event_id
  g1quad_im
  g1quad_re
  h1quad_im
  h1quad_re
  h2quad_im
  h2quad_re
  ifos
  impulse_time
  impulse_time_ns
  inclination
  kappa
  l1quad_im
  l1quad_re
  ligo_angle
  ligo_angle_sig
  mass1
  mass2
  mchirp
  null_stat_degen
  null_stat_h1h2
  null_statistic
  polarization
  process_id
  ra
  search
  sigmasq_g
  sigmasq_h1
  sigmasq_h2
  sigmasq_l
  sigmasq_t
  sigmasq_v
  sngl_bank_chisq_dof
  sngl_chisq_dof
  sngl_cont_chisq_dof
  snr
  snr_dof
  snr_g
  snr_h1
  snr_h2
  snr_l
  snr_t
  snr_v
  t1quad_im
  t1quad_re
  tau0
  tau2
  tau3
  tau4
  tau5
  time_slide_id
  trace_snr
  ttotal
  v1quad_im
  v1quad_re

Inherited from object: __class__

Method Details [hide private]

set_ifos(self, instruments)

source code 

Serialize a sequence of instruments into the ifos attribute. The instrument names must not contain the "," character.


Class Variable Details [hide private]

instrument_id

Value:
{'G1': 'g', 'H1': 'h1', 'H2': 'h2', 'L1': 'l', 'T1': 't', 'V1': 'v'}