:autogenerated:

analysis.spectrum_broadening
===============================================

.. automodule:: PQAnalysis.analysis.spectrum_broadening
    :members: DEFAULT_ALPHA, DEFAULT_WAVENUMBER_MAX, DEFAULT_WAVENUMBER_MIN, DEFAULT_WAVENUMBER_STEP
    :undoc-members:
    :show-inheritance:



    Submodules
    ----------

    .. toctree::
       :maxdepth: 1

       PQAnalysis.analysis.spectrum_broadening.api
       PQAnalysis.analysis.spectrum_broadening.exceptions
       PQAnalysis.analysis.spectrum_broadening.spectrum_broadening
       PQAnalysis.analysis.spectrum_broadening.spectrum_broadening_output_file_writer




    Summary
    -------

    ``__all__`` Classes:


    .. list-table::
    
       * - :class:`SpectrumDataWriter <PQAnalysis.analysis.spectrum_broadening.spectrum_broadening_output_file_writer.SpectrumDataWriter>`
         - Class for writing a broadened spectrum to a file.
    

    ``__all__`` Functions:


    .. list-table::
    
       * - :func:`alpha_from_fwhm <PQAnalysis.analysis.spectrum_broadening.spectrum_broadening.alpha_from_fwhm>`
         - Convert a Gaussian full width at half maximum to the exponent alpha.
       * - :func:`broaden <PQAnalysis.analysis.spectrum_broadening.spectrum_broadening.broaden>`
         - Broaden a stick spectrum on a wavenumber grid.
       * - :func:`build_spectrum <PQAnalysis.analysis.spectrum_broadening.api.build_spectrum>`
         - Broaden a two-column stick spectrum file and write the result.
       * - :func:`fwhm_from_alpha <PQAnalysis.analysis.spectrum_broadening.spectrum_broadening.fwhm_from_alpha>`
         - Convert a Gaussian exponent alpha to the full width at half maximum.
       * - :func:`read_stick_spectrum <PQAnalysis.analysis.spectrum_broadening.spectrum_broadening.read_stick_spectrum>`
         - Read a two-column stick spectrum file.
       * - :func:`wavenumber_grid <PQAnalysis.analysis.spectrum_broadening.spectrum_broadening.wavenumber_grid>`
         - Build the regular wavenumber grid of the broadened spectrum.
    

    ``__all__`` Data:


    .. list-table::
    
       * - :data:`DEFAULT_ALPHA <DEFAULT_ALPHA>`
         - Convert a string or number to a floating-point number, if possible.
       * - :data:`DEFAULT_WAVENUMBER_MAX <DEFAULT_WAVENUMBER_MAX>`
         - Convert a string or number to a floating-point number, if possible.
       * - :data:`DEFAULT_WAVENUMBER_MIN <DEFAULT_WAVENUMBER_MIN>`
         - Convert a string or number to a floating-point number, if possible.
       * - :data:`DEFAULT_WAVENUMBER_STEP <DEFAULT_WAVENUMBER_STEP>`
         - Convert a string or number to a floating-point number, if possible.
    



    Reference
    ---------