gwkokab.parameters
==================

.. py:module:: gwkokab.parameters


Classes
-------

.. autoapisummary::

   gwkokab.parameters.Parameters
   gwkokab.parameters.RelationMesh


Functions
---------

.. autoapisummary::

   gwkokab.parameters.default_relation_mesh


Module Contents
---------------

.. py:class:: Parameters

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Enumeration of common parameter names used in GWKokab.

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: CHIRP_MASS
      :value: 'chirp_mass'



   .. py:attribute:: CHIRP_MASS_DETECTOR
      :value: 'chirp_mass_detector'



   .. py:attribute:: CHIRP_MASS_SOURCE
      :value: 'chirp_mass_source'



   .. py:attribute:: CHI_1
      :value: 'chi_1'



   .. py:attribute:: CHI_2
      :value: 'chi_2'



   .. py:attribute:: CHI_MINUS
      :value: 'chiminus'



   .. py:attribute:: COS_IOTA
      :value: 'cos_iota'



   .. py:attribute:: COS_TILT_1
      :value: 'cos_tilt_1'



   .. py:attribute:: COS_TILT_2
      :value: 'cos_tilt_2'



   .. py:attribute:: DELTA_M
      :value: 'delta_m'



   .. py:attribute:: DETECTION_TIME
      :value: 'detection_time'



   .. py:attribute:: ECCENTRICITY
      :value: 'eccentricity'



   .. py:attribute:: EFFECTIVE_SPIN
      :value: 'chi_eff'



   .. py:attribute:: LUMINOSITY_DISTANCE
      :value: 'luminosity_distance'



   .. py:attribute:: MASS_RATIO
      :value: 'mass_ratio'



   .. py:attribute:: MEAN_ANOMALY
      :value: 'mean_anomaly'



   .. py:attribute:: PHI_1
      :value: 'phi_1'



   .. py:attribute:: PHI_12
      :value: 'phi_12'



   .. py:attribute:: PHI_2
      :value: 'phi_2'



   .. py:attribute:: PHI_ORB
      :value: 'phi_orb'



   .. py:attribute:: POLARIZATION_ANGLE
      :value: 'psi'



   .. py:attribute:: PRECESSING_SPIN
      :value: 'chi_p'



   .. py:attribute:: PRIMARY_MASS_DETECTED
      :value: 'mass_1'



   .. py:attribute:: PRIMARY_MASS_SOURCE
      :value: 'mass_1_source'



   .. py:attribute:: PRIMARY_SPIN_MAGNITUDE
      :value: 'a_1'



   .. py:attribute:: PRIMARY_SPIN_X
      :value: 'spin_1x'



   .. py:attribute:: PRIMARY_SPIN_Y
      :value: 'spin_1y'



   .. py:attribute:: PRIMARY_SPIN_Z
      :value: 'spin_1z'



   .. py:attribute:: REDSHIFT
      :value: 'redshift'



   .. py:attribute:: REDUCED_MASS
      :value: 'reduced_mass'



   .. py:attribute:: RIGHT_ASCENSION
      :value: 'ra'



   .. py:attribute:: SECONDARY_MASS_DETECTED
      :value: 'mass_2'



   .. py:attribute:: SECONDARY_MASS_SOURCE
      :value: 'mass_2_source'



   .. py:attribute:: SECONDARY_SPIN_MAGNITUDE
      :value: 'a_2'



   .. py:attribute:: SECONDARY_SPIN_X
      :value: 'spin_2x'



   .. py:attribute:: SECONDARY_SPIN_Y
      :value: 'spin_2y'



   .. py:attribute:: SECONDARY_SPIN_Z
      :value: 'spin_2z'



   .. py:attribute:: SIN_DECLINATION
      :value: 'dec'



   .. py:attribute:: SYMMETRIC_MASS_RATIO
      :value: 'symmetric_mass_ratio'



   .. py:attribute:: TOTAL_MASS
      :value: 'total_mass'



.. py:class:: RelationMesh

   .. py:method:: add_rule(inputs: Tuple[Any, Ellipsis], output: Any, func: Callable)

      Adds a rule.

      Multiple rules can target the same output.



   .. py:method:: derive_only(initial_state: Dict[Any, Any], targets: Set[Any]) -> Dict[Any, Any]

      Derives specified targets, allowing intermediate parameters to be computed as
      needed.



   .. py:method:: resolve(initial_state: Dict[Any, Any]) -> Dict[Any, Any]


   .. py:method:: resolve_from_arrays(initial_state: numpy.ndarray, param_order: Tuple[Any, Ellipsis]) -> Tuple[numpy.ndarray, Tuple[Any, Ellipsis]]


   .. py:attribute:: rules
      :value: []



.. py:function:: default_relation_mesh() -> RelationMesh

   Constructs the default relation mesh with common gravitational wave parameter
   relations.