synthpop.modules.metallicity.single_value
=========================================

.. py:module:: synthpop.modules.metallicity.single_value

.. autoapi-nested-parse::

   Metallicity module for a single value



Classes
-------

.. autoapisummary::

   synthpop.modules.metallicity.single_value.SingleValue


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

.. py:class:: SingleValue(met_value: float, **kwargs)

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


   Metallicity distribution for a single value

   Attributes
   ----------
   metallicity_value : float [[Fe/H]]
       [Fe/H] value for all stars


   .. py:attribute:: metallicity_func_name
      :value: 'single_value'



   .. py:attribute:: metallicity_value


   .. py:method:: draw_random_metallicity(N: int or None = None, **kwargs) -> np.ndarray or float

      Generate a "random" metallicity from a single value distribution

      Parameters
      ----------
      N : int, None, optional
          if N is set to an integer, an array with N random metallicities is returned
      Returns
      -------
      met : float, ndarray [[Fe/H]]
          single metallicities or numpy array of N metallicities in [[Fe/H]]



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

      Determine the average metallicity of the population