IMP logo
IMP Reference Guide  2.5.0
The Integrative Modeling Platform
IMP.pmi.dof.DegreesOfFreedom Class Reference

A class to simplify create of constraints and movers for an IMP Hierarchy. More...

Inherits object.

Detailed Description

A class to simplify create of constraints and movers for an IMP Hierarchy.

Call the various create() functions to get started.

Note
This class is only available in Python.

Definition at line 41 of file pmi/dof/__init__.py.

Public Member Functions

def create_flexible_beads
 Create a chain of flexible beads. More...
 
def create_rigid_body
 Create rigid body constraint and mover. More...
 
def create_super_rigid_body
 Create SUPER rigid body mover from one or more hierarchies. More...
 
def show
 Make it pretty. More...
 

Member Function Documentation

def IMP.pmi.dof.DegreesOfFreedom.create_flexible_beads (   self,
  hspec,
  max_trans 
)

Create a chain of flexible beads.

Parameters
hspecCan be one of the following inputs: IMP Selection, Hierarchy, PMI Molecule, Residue, or a list/set
max_transMaximum flexible bead translation

Definition at line 84 of file pmi/dof/__init__.py.

def IMP.pmi.dof.DegreesOfFreedom.create_rigid_body (   self,
  hspec,
  max_trans = 1.0,
  max_rot = 0.1 
)

Create rigid body constraint and mover.

Parameters
hspecCan be one of the following inputs: IMP Selection, Hierarchy, PMI Molecule, Residue, or a list/set
max_transMaximum rigid body translation
max_rotMaximum rigid body rotation

Definition at line 48 of file pmi/dof/__init__.py.

def IMP.pmi.dof.DegreesOfFreedom.create_super_rigid_body (   self,
  hspec,
  max_trans = 1.0,
  max_rot = 0.1,
  chain_min_length = None,
  chain_max_length = None 
)

Create SUPER rigid body mover from one or more hierarchies.

Can also create chain of SRBs.

Parameters
hspecCan be one of the following inputs: IMP Selection, Hierarchy, PMI Molecule, Residue, or a list/set
max_transMaximum super rigid body translation
max_rotMaximum super rigid body rotation
chain_min_lengthCreate a CHAIN of super rigid bodies - must provide list This parameter is the minimum chain length.
chain_max_lengthmax chain length

Definition at line 63 of file pmi/dof/__init__.py.

def IMP.pmi.dof.DegreesOfFreedom.show (   self)

Make it pretty.

Definition at line 99 of file pmi/dof/__init__.py.


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