synthpop.modules.metallicity.gaussian_gradient
==============================================

.. py:module:: synthpop.modules.metallicity.gaussian_gradient

.. autoapi-nested-parse::

   Metallicity class for a Gaussian distribution with a gradient,
   given a mean, standard deviation, gradient, and
   upper and lower limits.



Classes
-------

.. autoapisummary::

   synthpop.modules.metallicity.gaussian_gradient.GaussianGradient


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

.. py:class:: GaussianGradient(mean: float, std: float, low_bound: float = -4, high_bound: float = 0.5, radial_gradient: float = 0.0, **kwargs)

   Bases: :py:obj:`synthpop.modules.metallicity._metallicity.Metallicity`


   Gaussian subclass of Metallicity base class. This subclass is for populations that
   have metallicity characterized by a gaussian metallicity distribution plus a radius gradient.

   Attributes
   ----------
   mean : float [[Fe/H]]
       the mean metallicity in [Fe/H] for the Gaussian distribution at the Solar position
   std : float [[Fe/H]]
       the standard deviation of metallicity in [Fe/H] for the Gaussian distribution
   lower_bound : float [[Fe/H]]
       lower limit for truncation of the distribution
   upper_bound : float [[Fe/H]]
       upper limit for truncation of the distribution
   radial_gradient : float [[Fe/H]/kpc]
       metallicity gradient with Galactocentric radius

   Methods
   -------
   __init__(self,Population) : None
       initialize the metallicity class, and set the control parameters.
   draw_random_metallicity(self, N: int or None = None) : np.ndarray, float [[Fe/H]]
       return a random metallicity drawn from a Gaussian distribution
   average_metallicity(self) : float [[Fe/H]]
       return the average metallicity


   .. py:attribute:: metallicity_func_name
      :value: 'gaussian_gradient'



   .. py:attribute:: mean


   .. py:attribute:: std


   .. py:attribute:: lower
      :value: -4



   .. py:attribute:: upper
      :value: 0.5



   .. py:attribute:: radial_gradient
      :value: 0.0



   .. py:method:: draw_random_metallicity(N, x, y, z, **kwargs) -> np.ndarray or float

      Returns one or more metallicities in [Fe/H] from a Gaussian distribution.

      Parameters
      ----------
      N : int, None, optional
          if N is set to an integer, an array with N random ages is returned

      Returns
      -------
      val : ndarray, float [Gyr]
          single metallicities or ndarray of N metallicities in [Fe/H]



   .. py:method:: average_metallicity() -> float

      Determine the average metallicity of the population