SimInspiral
===========

.. currentmodule:: igwn_ligolw.lsctables

.. autoclass:: SimInspiral
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~SimInspiral.alpha
      ~SimInspiral.alpha1
      ~SimInspiral.alpha2
      ~SimInspiral.alpha3
      ~SimInspiral.alpha4
      ~SimInspiral.alpha5
      ~SimInspiral.alpha6
      ~SimInspiral.amp_order
      ~SimInspiral.bandpass
      ~SimInspiral.beta
      ~SimInspiral.coa_phase
      ~SimInspiral.distance
      ~SimInspiral.eff_dist_g
      ~SimInspiral.eff_dist_h
      ~SimInspiral.eff_dist_l
      ~SimInspiral.eff_dist_t
      ~SimInspiral.eff_dist_v
      ~SimInspiral.end_time_gmst
      ~SimInspiral.eta
      ~SimInspiral.f_final
      ~SimInspiral.f_lower
      ~SimInspiral.g_end_time
      ~SimInspiral.g_end_time_ns
      ~SimInspiral.geocent_end_time
      ~SimInspiral.geocent_end_time_ns
      ~SimInspiral.h_end_time
      ~SimInspiral.h_end_time_ns
      ~SimInspiral.inclination
      ~SimInspiral.l_end_time
      ~SimInspiral.l_end_time_ns
      ~SimInspiral.latitude
      ~SimInspiral.longitude
      ~SimInspiral.mass1
      ~SimInspiral.mass2
      ~SimInspiral.mchirp
      ~SimInspiral.numrel_data
      ~SimInspiral.numrel_mode_max
      ~SimInspiral.numrel_mode_min
      ~SimInspiral.phi0
      ~SimInspiral.polarization
      ~SimInspiral.process_id
      ~SimInspiral.psi0
      ~SimInspiral.psi3
      ~SimInspiral.ra_dec
      ~SimInspiral.simulation_id
      ~SimInspiral.source
      ~SimInspiral.spin1
      ~SimInspiral.spin1x
      ~SimInspiral.spin1y
      ~SimInspiral.spin1z
      ~SimInspiral.spin2
      ~SimInspiral.spin2x
      ~SimInspiral.spin2y
      ~SimInspiral.spin2z
      ~SimInspiral.t_end_time
      ~SimInspiral.t_end_time_ns
      ~SimInspiral.taper
      ~SimInspiral.theta0
      ~SimInspiral.time_geocent
      ~SimInspiral.v_end_time
      ~SimInspiral.v_end_time_ns
      ~SimInspiral.waveform

   .. rubric:: Methods Summary

   .. autosummary::

      ~SimInspiral.effective_distances
      ~SimInspiral.expected_snrs
      ~SimInspiral.snr_geometry_factors
      ~SimInspiral.time_at_instrument

   .. rubric:: Attributes Documentation

   .. autoattribute:: alpha
   .. autoattribute:: alpha1
   .. autoattribute:: alpha2
   .. autoattribute:: alpha3
   .. autoattribute:: alpha4
   .. autoattribute:: alpha5
   .. autoattribute:: alpha6
   .. autoattribute:: amp_order
   .. autoattribute:: bandpass
   .. autoattribute:: beta
   .. autoattribute:: coa_phase
   .. autoattribute:: distance
   .. autoattribute:: eff_dist_g
   .. autoattribute:: eff_dist_h
   .. autoattribute:: eff_dist_l
   .. autoattribute:: eff_dist_t
   .. autoattribute:: eff_dist_v
   .. autoattribute:: end_time_gmst
   .. autoattribute:: eta
   .. autoattribute:: f_final
   .. autoattribute:: f_lower
   .. autoattribute:: g_end_time
   .. autoattribute:: g_end_time_ns
   .. autoattribute:: geocent_end_time
   .. autoattribute:: geocent_end_time_ns
   .. autoattribute:: h_end_time
   .. autoattribute:: h_end_time_ns
   .. autoattribute:: inclination
   .. autoattribute:: l_end_time
   .. autoattribute:: l_end_time_ns
   .. autoattribute:: latitude
   .. autoattribute:: longitude
   .. autoattribute:: mass1
   .. autoattribute:: mass2
   .. autoattribute:: mchirp
   .. autoattribute:: numrel_data
   .. autoattribute:: numrel_mode_max
   .. autoattribute:: numrel_mode_min
   .. autoattribute:: phi0
   .. autoattribute:: polarization
   .. autoattribute:: process_id
   .. autoattribute:: psi0
   .. autoattribute:: psi3
   .. autoattribute:: ra_dec
   .. autoattribute:: simulation_id
   .. autoattribute:: source
   .. autoattribute:: spin1
   .. autoattribute:: spin1x
   .. autoattribute:: spin1y
   .. autoattribute:: spin1z
   .. autoattribute:: spin2
   .. autoattribute:: spin2x
   .. autoattribute:: spin2y
   .. autoattribute:: spin2z
   .. autoattribute:: t_end_time
   .. autoattribute:: t_end_time_ns
   .. autoattribute:: taper
   .. autoattribute:: theta0
   .. autoattribute:: time_geocent
   .. autoattribute:: v_end_time
   .. autoattribute:: v_end_time_ns
   .. autoattribute:: waveform

   .. rubric:: Methods Documentation

   .. automethod:: effective_distances
   .. automethod:: expected_snrs
   .. automethod:: snr_geometry_factors
   .. automethod:: time_at_instrument