:py:mod:`nessai.gw.proposal`
============================

.. py:module:: nessai.gw.proposal

.. autoapi-nested-parse::

   Specific proposal methods for sampling gravitational-wave models.

   ..
       !! processed by numpydoc !!


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

Classes
~~~~~~~

.. autoapisummary::

   nessai.gw.proposal.GWFlowProposal
   nessai.gw.proposal.AugmentedGWFlowProposal




Attributes
~~~~~~~~~~

.. autoapisummary::

   nessai.gw.proposal.logger


.. py:data:: logger
   

   
















   ..
       !! processed by numpydoc !!

.. py:class:: GWFlowProposal(model, flow_config=None, output='./', poolsize=None, rescale_parameters=True, latent_prior='truncated_gaussian', constant_volume_mode=True, volume_fraction=0.95, fuzz=1.0, plot='min', fixed_radius=False, drawsize=None, check_acceptance=False, truncate=False, rescale_bounds=[-1, 1], expansion_fraction=4.0, boundary_inversion=False, inversion_type='split', update_bounds=True, min_radius=False, max_radius=50.0, max_poolsize_scale=10, update_poolsize=True, save_training_data=False, compute_radius_with_all=False, draw_latent_kwargs=None, detect_edges=False, detect_edges_kwargs=None, reparameterisations=None, fallback_reparameterisation=None, use_default_reparameterisations=None, **kwargs)

   Bases: :py:obj:`nessai.proposal.FlowProposal`

   
   Wrapper for FlowProposal that has defaults for CBC-PE
















   ..
       !! processed by numpydoc !!
   .. py:attribute:: aliases
      

      
      Dictionary of aliases used to determine the default reparameterisations
      for common gravitational-wave parameters.
















      ..
          !! processed by numpydoc !!

   .. py:attribute:: use_default_reparameterisations
      :annotation: = True

      
      GW specific reparameterisations will be used by default. This is different
      to the parent class where they are disabled by default.
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_reparameterisation(self, reparameterisation)

      
      Function to get reparameterisations that checks GW defaults and
      aliases
















      ..
          !! processed by numpydoc !!

   .. py:method:: add_default_reparameterisations(self)

      
      Add default reparameterisations for parameters that have not been
      specified.
















      ..
          !! processed by numpydoc !!


.. py:class:: AugmentedGWFlowProposal(model, augment_dims=1, generate_augment='gaussian', marginalise_augment=False, n_marg=50, **kwargs)

   Bases: :py:obj:`nessai.proposal.augmented.AugmentedFlowProposal`, :py:obj:`GWFlowProposal`

   
   Augmented version of GWFlowProposal.

   See :obj:`~nessai.proposal.augmented.AugmentedFlowProposal` and
   :obj:`~nessai.gw.proposal.GWFlowPropsosal`















   ..
       !! processed by numpydoc !!