IMP.pmi.tools.RestraintStatScorer Class Reference

Score a single restraint, for use in stat files. More...

Detailed Description

Score a single restraint, for use in stat files.

Every time this object is called, it returns the weighted score of the restraint for the current model configuration. This is primarily used in a PMI restraint's get_output() method to obtain restraint scores for stat file output.

Parameters

name	The name of the score in the stat file.
weight_object	A Python object with a 'weight' attribute (usually a PMI restraint) which is used to weight the score.
restraint	The IMP Restraint to score.

Note

This class is only available in Python.

Definition at line 1631 of file pmi/tools.py.

Public Member Functions
def	__call__
	Get the score for the given JAX data if jax_data is given, otherwise for the current IMP Model. More...

Member Function Documentation

def IMP.pmi.tools.RestraintStatScorer.__call__	(		self,
			jax_data = None
	)

Get the score for the given JAX data if jax_data is given, otherwise for the current IMP Model.

Definition at line 1648 of file pmi/tools.py.

---

The documentation for this class was generated from the following file:

• pmi/tools.py