IMP logo
IMP Reference Guide  develop.c7bc4084d5,2021/01/22
The Integrative Modeling Platform
IMP.pmi1.restraints.basic.CylinderRestraint Class Reference

PMI2 python restraint. More...

+ Inheritance diagram for IMP.pmi1.restraints.basic.CylinderRestraint:

Detailed Description

PMI2 python restraint.

Restrains particles within a Cylinder aligned along the z-axis and centered in x,y=0,0 Optionally, one can restrain the cylindrical angle

This class is only available in Python.

Definition at line 220 of file /restraints/

Public Member Functions

def __init__
- Public Member Functions inherited from IMP::Restraint
 Restraint (Model *m, std::string name)
void add_score_and_derivatives (ScoreAccumulator sa) const
 Perform the actual restraint scoring. More...
Restraintcreate_current_decomposition () const
 Decompose this restraint into constituent terms for the current conf. More...
Restraintcreate_decomposition () const
 Decompose this restraint into constituent terms. More...
virtual ScoringFunctioncreate_scoring_function (double weight=1.0, double max=NO_MAX) const
 Create a scoring function with only this restraint. More...
virtual RestraintInfoget_dynamic_info () const
virtual double get_last_score () const
double get_score () const
virtual RestraintInfoget_static_info () const
bool get_was_good () const
void set_weight (Float weight)
Float get_weight () const
double get_maximum_score () const
void set_maximum_score (double s)
- Public Member Functions inherited from IMP::ModelObject
 ModelObject (Model *m, std::string name)
bool get_has_dependencies () const
 Return whether this object has dependencies computed. More...
bool get_has_required_score_states () const
 Return whether score states are computed. More...
ModelObjectsTemp get_inputs () const
ModelObjectsTemps get_interactions () const
 Get the interacting sets induced by this ModelObject. More...
Modelget_model () const
ModelObjectsTemp get_outputs () const
const ScoreStatesTempget_required_score_states () const
 Get the score states that are ancestors of this in the dependency graph. More...
void set_has_dependencies (bool tf)
 Either invalidate the dependencies or ensure they are correct. More...
void set_has_required_score_states (bool tf)
 Compute the required score states. More...
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
CheckLevel get_check_level () const
LogLevel get_log_level () const
virtual VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
void set_check_level (CheckLevel l)
void set_log_level (LogLevel l)
 Set the logging level used in this object. More...
void set_was_used (bool tf) const
void show (std::ostream &out=std::cout) const
const std::string & get_name () const
void set_name (std::string name)
virtual std::string get_type_name () const

Additional Inherited Members

- Protected Member Functions inherited from IMP::Restraint
virtual void do_add_score_and_derivatives (ScoreAccumulator sa) const
 A restraint should override this to compute the score and derivatives. More...
virtual Restraints do_create_current_decomposition () const
virtual Restraints do_create_decomposition () const
ModelObjectsTemp do_get_outputs () const
- Protected Member Functions inherited from IMP::ModelObject
virtual ModelObjectsTemp do_get_inputs () const =0
virtual ModelObjectsTemps do_get_interactions () const
virtual void handle_set_has_required_score_states (bool)
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
virtual void do_destroy ()

Constructor & Destructor Documentation

def IMP.pmi1.restraints.basic.CylinderRestraint.__init__ (   self,
  mintheta = None,
  maxtheta = None,
  repulsive = False,
  label = 'None' 
objectsPMI2 objects
resolutionthe resolution you want the restraint to be applied
radiusthe radius of the cylinder
minthetaminimum cylindrical angle in degrees
maxthetamaximum cylindrical angle in degrees

Definition at line 228 of file /restraints/

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