openmmtools.multistate.SAMSAnalyzer
===================================

.. currentmodule:: openmmtools.multistate

.. autoclass:: SAMSAnalyzer

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~SAMSAnalyzer.__init__
      ~SAMSAnalyzer.clear
      ~SAMSAnalyzer.generate_mixing_statistics
      ~SAMSAnalyzer.get_effective_energy_timeseries
      ~SAMSAnalyzer.get_enthalpy
      ~SAMSAnalyzer.get_entropy
      ~SAMSAnalyzer.get_free_energy
      ~SAMSAnalyzer.read_energies
      ~SAMSAnalyzer.read_logZ
      ~SAMSAnalyzer.read_log_weights
      ~SAMSAnalyzer.reformat_energies_for_mbar
      ~SAMSAnalyzer.show_mixing_statistics
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~SAMSAnalyzer.effective_length
      ~SAMSAnalyzer.has_log_weights
      ~SAMSAnalyzer.kT
      ~SAMSAnalyzer.max_n_iterations
      ~SAMSAnalyzer.mbar
      ~SAMSAnalyzer.n_equilibration_iterations
      ~SAMSAnalyzer.n_iterations
      ~SAMSAnalyzer.n_replicas
      ~SAMSAnalyzer.n_states
      ~SAMSAnalyzer.name
      ~SAMSAnalyzer.observables
      ~SAMSAnalyzer.reference_states
      ~SAMSAnalyzer.reporter
      ~SAMSAnalyzer.restraint_distance_cutoff
      ~SAMSAnalyzer.restraint_energy_cutoff
      ~SAMSAnalyzer.statistical_inefficiency
      ~SAMSAnalyzer.unbias_restraint
      ~SAMSAnalyzer.use_full_trajectory
      ~SAMSAnalyzer.use_online_data