gravelamps.lensing.waveform_generator
=====================================

.. py:module:: gravelamps.lensing.waveform_generator

.. autoapi-nested-parse::

   Gravelamps Waveform Generators

   Following contains class definitions for Gravelamps waveform generators. These are child classes of
   the standard bilby WaveformGenerator class.

   Written by Mick Wright
              Isaac C. F. Wong 2022

   Classes
   -------
   LensedWaveformGenerator
       Standard total lensed waveform generator used throughout Gravelamps

   ..
       !! processed by numpydoc !!


Classes
-------

.. autoapisummary::

   gravelamps.lensing.waveform_generator.SingleImageGenerator
   gravelamps.lensing.waveform_generator.LensedWaveformGenerator


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

.. py:class:: SingleImageGenerator(duration=None, sampling_frequency=None, start_time=0, frequency_domain_source_model=None, time_domain_source_model=None, parameters=None, parameter_conversion=None, waveform_arguments=None)

   Bases: :py:obj:`bilby.gw.waveform_generator.WaveformGenerator`


   
   Single Image of Strong Lensing Waveform Generator class

   Based upon the general bilby WaveformGenerator class, this waveform generator will seek
   a lensing module from the waveform arguments as well as an indication of the image to generate
   and will construct the amplification factor accordingly when calculating the strain















   ..
       !! processed by numpydoc !!

   .. py:property:: lens_parameters
      
      Lens Parameters to Infer
















      ..
          !! processed by numpydoc !!


.. py:class:: LensedWaveformGenerator(duration=None, sampling_frequency=None, start_time=0, frequency_domain_source_model=None, time_domain_source_model=None, parameters=None, parameter_conversion=None, waveform_arguments=None)

   Bases: :py:obj:`bilby.gw.waveform_generator.WaveformGenerator`


   
   Standard total lensed waveform generator used throughout Gravelamps

   This waveform generator will seek a lensing module from the waveform arguments from which to
   extract the amplification factor calculation function it will then use during calculation of
   the strain data.













   :Attributes:

       **lens_module** : ModuleType
           The module used to extract lensing amplification factor function from

       **lens_parameters** : dict
           Additional lens model parameters and their values


   ..
       !! processed by numpydoc !!

   .. py:property:: lens_parameters
      
      Additional lens model parameters and their value



      :Returns:

          dict
              Contains the parameters as keys and the associated values













      ..
          !! processed by numpydoc !!