Package schrodinger :: Package structutils :: Module structalign :: Class StructAlign
[hide private]
[frames] | no frames]

Class StructAlign

object --+
         |
        StructAlign

This is the class used to perform the structural alignment. This class will check at initialization time if Prime is installed by trying to import schrodinger.applications.ska and will fail if it's not installed as nothing more can be done.

There are a number of properties that can be set for instances of this class which are used to control how the alignment is done:

gap_penalty - default = 2.0 deletion_penalty = default = 1.0 use_scanning_alignment - default = False window_length - default = 5 minimum_similarity - default = 1.0 minimum_length - default = 2 use_automatic_settings - default = False use_standard_residues - default = False reorder_by_connectivity - default = False

Instance Methods [hide private]
 
__init__(self)
Construct an instance of a StructAlign object.
 
_setGapPenalty(self, penalty)
 
_getGapPenalty(self)
 
_setDeletionPenalty(self, penalty)
 
_getDeletionPenalty(self)
 
_setUseScanningAlignment(self, scanning_alignment)
 
_getUseScanningAlignment(self)
 
_setWindowLength(self, length)
 
_getWindowLength(self)
 
_setMinimumSimilarity(self, min_sim)
 
_getMinimumSimilarity(self)
 
_setMinimumLength(self, min_length)
 
_getMinimumLength(self)
 
align(self, ref_st, sts)
Perform a structural alignment on the Structure objects in the list 'sts' relative to the reference structure 'ref_st' Each structure in the list is aligned relative to the reference structure.
 
alignStructure(self, ref_st, mob_st)
Perform a structural alignment on the mob_st structure relative to the ref_st structure.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]
  gap_penalty
Access to the gap penalty for the alignment
  deletion_penalty
Access to the deletion penalty for the alignment
  use_scanning_alignment
Access to the use scanning alignment flag
  window_length
Access to the window length for the aligment
  minimum_similarity
Access to the minimum similarity used in the alignment
  minimum_length
Access to the minimum length used in the alignment

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

 

Construct an instance of a StructAlign object. This method will check that schrodinger.application.ska is available and fail with a RuntimeError if it's not

Overrides: object.__init__

align(self, ref_st, sts)

 

Perform a structural alignment on the Structure objects in the list 'sts' relative to the reference structure 'ref_st' Each structure in the list is aligned relative to the reference structure. The coordinates of the input structures are modified to give the best structural alignment.

alignStructure(self, ref_st, mob_st)

 

Perform a structural alignment on the mob_st structure relative to the ref_st structure. The coordinates of the input mob_st structure are modified to give the best structural alignment.


Property Details [hide private]

gap_penalty

Access to the gap penalty for the alignment

Get Method:
_getGapPenalty(self)
Set Method:
_setGapPenalty(self, penalty)

deletion_penalty

Access to the deletion penalty for the alignment

Get Method:
_getDeletionPenalty(self)
Set Method:
_setDeletionPenalty(self, penalty)

use_scanning_alignment

Access to the use scanning alignment flag

Get Method:
_getUseScanningAlignment(self)
Set Method:
_setUseScanningAlignment(self, scanning_alignment)

window_length

Access to the window length for the aligment

Get Method:
_getWindowLength(self)
Set Method:
_setWindowLength(self, length)

minimum_similarity

Access to the minimum similarity used in the alignment

Get Method:
_getMinimumSimilarity(self)
Set Method:
_setMinimumSimilarity(self, min_sim)

minimum_length

Access to the minimum length used in the alignment

Get Method:
_getMinimumLength(self)
Set Method:
_setMinimumLength(self, min_length)