:autogenerated:

analysis.vacf
================================

.. automodule:: PQAnalysis.analysis.vacf
    :members: WINDOW_FUNCTIONS
    :undoc-members:
    :show-inheritance:



    Submodules
    ----------

    .. toctree::
       :maxdepth: 1

       PQAnalysis.analysis.vacf.api
       PQAnalysis.analysis.vacf.exceptions
       PQAnalysis.analysis.vacf.spectrum
       PQAnalysis.analysis.vacf.vacf
       PQAnalysis.analysis.vacf.vacf_input_file_reader
       PQAnalysis.analysis.vacf.vacf_output_file_writer




    Summary
    -------

    ``__all__`` Exceptions:


    .. list-table::
    
       * - :exc:`VACFError <PQAnalysis.analysis.vacf.exceptions.VACFError>`
         - Exception raised if something goes wrong during the VACF setup or calculation.
       * - :exc:`VACFWarning <PQAnalysis.analysis.vacf.exceptions.VACFWarning>`
         - Warning raised if something goes wrong during the VACF setup or calculation.
    

    ``__all__`` Classes:


    .. list-table::
    
       * - :class:`VACF <PQAnalysis.analysis.vacf.vacf.VACF>`
         - A class for calculating the normalized velocity (or charge-flux) auto-correlation function of a target selection of a velocity trajectory.
       * - :class:`VACFDataWriter <PQAnalysis.analysis.vacf.vacf_output_file_writer.VACFDataWriter>`
         - Class for writing the data of an :py:class:`~PQAnalysis.analysis.vacf.vacf.VACF` analysis to a file.
       * - :class:`VACFInputFileReader <PQAnalysis.analysis.vacf.vacf_input_file_reader.VACFInputFileReader>`
         - A class to read input files to setup the     :py:class:`~PQAnalysis.analysis.vacf.vacf.VACF` class.
       * - :class:`VACFLogWriter <PQAnalysis.analysis.vacf.vacf_output_file_writer.VACFLogWriter>`
         - Class for writing the log (setup parameters) of an :py:class:`~PQAnalysis.analysis.vacf.vacf.VACF` analysis to a file.
       * - :class:`VACFSpectrumDataWriter <PQAnalysis.analysis.vacf.vacf_output_file_writer.VACFSpectrumDataWriter>`
         - Class for writing the spectrum of an :py:class:`~PQAnalysis.analysis.vacf.vacf.VACF` analysis to a file.
       * - :class:`VACFWindowedDataWriter <PQAnalysis.analysis.vacf.vacf_output_file_writer.VACFWindowedDataWriter>`
         - Class for writing the windowed (apodized) correlation function of an :py:class:`~PQAnalysis.analysis.vacf.vacf.VACF` analysis to a file.
    

    ``__all__`` Functions:


    .. list-table::
    
       * - :func:`apodization_window <PQAnalysis.analysis.vacf.spectrum.apodization_window>`
         - Calculates the one-sided legacy apodization window.
       * - :func:`read_static_charges <PQAnalysis.analysis.vacf.api.read_static_charges>`
         - Reads a legacy static charge file.
       * - :func:`vacf <PQAnalysis.analysis.vacf.api.vacf>`
         - Calculates the velocity auto-correlation function (VACF) using a given input file.
       * - :func:`vacf_spectrum <PQAnalysis.analysis.vacf.spectrum.vacf_spectrum>`
         - Calculates the legacy cosine-transform spectrum of a correlation function.
    

    ``__all__`` Data:


    .. list-table::
    
       * - :data:`WINDOW_FUNCTIONS <WINDOW_FUNCTIONS>`
         - Built-in immutable sequence.
    



    Reference
    ---------