:autogenerated:

analysis.msd
===============================

.. automodule:: PQAnalysis.analysis.msd
    



    Submodules
    ----------

    .. toctree::
       :maxdepth: 1

       PQAnalysis.analysis.msd.api
       PQAnalysis.analysis.msd.exceptions
       PQAnalysis.analysis.msd.msd
       PQAnalysis.analysis.msd.msd_input_file_reader
       PQAnalysis.analysis.msd.msd_output_file_writer




    Summary
    -------

    ``__all__`` Exceptions:


    .. list-table::
    
       * - :exc:`MSDError <PQAnalysis.analysis.msd.exceptions.MSDError>`
         - Exception raised if something goes wrong during the MSD setup or calculation.
       * - :exc:`MSDWarning <PQAnalysis.analysis.msd.exceptions.MSDWarning>`
         - Warning raised if something goes wrong during the MSD setup or calculation.
    

    ``__all__`` Classes:


    .. list-table::
    
       * - :class:`MSD <PQAnalysis.analysis.msd.msd.MSD>`
         - A class for calculating the mean square displacement (MSD) of a target selection using multiple simultaneously active time origins.
       * - :class:`MSDDataWriter <PQAnalysis.analysis.msd.msd_output_file_writer.MSDDataWriter>`
         - Class for writing the data of an :py:class:`~PQAnalysis.analysis.msd.msd.MSD` analysis to a file.
       * - :class:`MSDDiffusionFit <PQAnalysis.analysis.msd.msd.MSDDiffusionFit>`
         - A container for the result of a linear diffusion fit of an MSD component.
       * - :class:`MSDInputFileReader <PQAnalysis.analysis.msd.msd_input_file_reader.MSDInputFileReader>`
         - A class to read input files to setup the     :py:class:`~PQAnalysis.analysis.msd.msd.MSD` class.
       * - :class:`MSDLogWriter <PQAnalysis.analysis.msd.msd_output_file_writer.MSDLogWriter>`
         - Class for writing the log (setup parameters) of an :py:class:`~PQAnalysis.analysis.msd.msd.MSD` analysis to a file.
    

    ``__all__`` Functions:


    .. list-table::
    
       * - :func:`msd <PQAnalysis.analysis.msd.api.msd>`
         - Calculates the mean square displacement (MSD) using a given input file.