OpenStructure
Loading...
Searching...
No Matches
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
ContactEntity Class Reference

Public Member Functions

 __init__ (self, ent, contact_d=5.0, contact_mode="aa")
 
 view (self)
 
 contact_mode (self)
 
 contact_d (self)
 
 chain_names (self)
 
 interacting_chains (self)
 
 contacts (self)
 
 hr_contacts (self)
 
 interface_residues (self)
 
 hr_interface_residues (self)
 
 GetChain (self, chain_name)
 
 GetSequence (self, chain_name)
 

Data Fields

 contact_mode
 
 chain_names
 

Protected Member Functions

 _SetupContacts (self)
 
 _SetupInterfaceResidues (self)
 
 _SetupHRInterfaceResidues (self)
 

Protected Attributes

 _contact_mode
 
 _view
 
 _contact_d
 
 _chain_names
 
 _interacting_chains
 
 _sequence
 
 _contacts
 
 _hr_contacts
 
 _interface_residues
 
 _hr_interface_residues
 

Detailed Description

 Helper object for Contact-score computation

Definition at line 9 of file contact_score.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self,
  ent,
  contact_d = 5.0,
  contact_mode = "aa" 
)

Definition at line 12 of file contact_score.py.

Member Function Documentation

◆ _SetupContacts()

_SetupContacts (   self)
protected

Definition at line 190 of file contact_score.py.

◆ _SetupHRInterfaceResidues()

_SetupHRInterfaceResidues (   self)
protected

Definition at line 294 of file contact_score.py.

◆ _SetupInterfaceResidues()

_SetupInterfaceResidues (   self)
protected

Definition at line 287 of file contact_score.py.

◆ chain_names()

chain_names (   self)
 Chain names in :attr:`~view`

Names are sorted

:type: :class:`list` of :class:`str`

Definition at line 96 of file contact_score.py.

◆ contact_d()

contact_d (   self)
 Pairwise distance of residues to be considered as contacts

Given at :class:`ContactScorer` construction

:type: :class:`float`

Definition at line 86 of file contact_score.py.

◆ contact_mode()

contact_mode (   self)
 The contact mode

Can either be "aa", meaning that all atoms are considered to identify
contacts, or "repr" which only considers distances between
representative atoms. For peptides thats CB (CA for GLY), for
nucleotides thats C3'.

:type: :class:`str`

Definition at line 73 of file contact_score.py.

◆ contacts()

contacts (   self)
 Interchain contacts

Organized as :class:`dict` with key (cname1, cname2) and values being
a set of tuples with the respective residue indices. 
cname1 < cname2 evaluates to True.

Definition at line 118 of file contact_score.py.

◆ GetChain()

GetChain (   self,
  chain_name 
)
 Get chain by name

:param chain_name: Chain in :attr:`~view`
:type chain_name: :class:`str`

Definition at line 165 of file contact_score.py.

◆ GetSequence()

GetSequence (   self,
  chain_name 
)
 Get sequence of chain

Returns sequence of specified chain as raw :class:`str`

:param chain_name: Chain in :attr:`~view`
:type chain_name: :class:`str`

Definition at line 176 of file contact_score.py.

◆ hr_contacts()

hr_contacts (   self)
 Human readable interchain contacts

Human readable version of :attr:`~contacts`. Simple list with tuples
containing two strings specifying the residues in contact. Format:
<cname>.<rnum>.<ins_code>

Definition at line 130 of file contact_score.py.

◆ hr_interface_residues()

hr_interface_residues (   self)
 Human readable interface residues

Human readable version of :attr:`interface_residues`. :class:`list` of
strings specifying the interface residues in format:
<cname>.<rnum>.<ins_code>

Definition at line 154 of file contact_score.py.

◆ interacting_chains()

interacting_chains (   self)
 Pairs of chains in :attr:`~view` with at least one contact

:type: :class:`list` of :class:`tuples`

Definition at line 108 of file contact_score.py.

◆ interface_residues()

interface_residues (   self)
 Interface residues

Residues in each chain that are in contact with any other chain.
Organized as :class:`dict` with key cname and values the respective
residue indices in a :class:`set`.

Definition at line 142 of file contact_score.py.

◆ view()

view (   self)
 The structure depending on *contact_mode*

Full view in case of "aa", view that only contains representative
atoms in case of "repr".

:type: :class:`ost.mol.EntityView`

Definition at line 62 of file contact_score.py.

Field Documentation

◆ _chain_names

_chain_names
protected

Definition at line 53 of file contact_score.py.

◆ _contact_d

_contact_d
protected

Definition at line 50 of file contact_score.py.

◆ _contact_mode

_contact_mode
protected

Definition at line 42 of file contact_score.py.

◆ _contacts

_contacts
protected

Definition at line 56 of file contact_score.py.

◆ _hr_contacts

_hr_contacts
protected

Definition at line 57 of file contact_score.py.

◆ _hr_interface_residues

_hr_interface_residues
protected

Definition at line 59 of file contact_score.py.

◆ _interacting_chains

_interacting_chains
protected

Definition at line 54 of file contact_score.py.

◆ _interface_residues

_interface_residues
protected

Definition at line 58 of file contact_score.py.

◆ _sequence

_sequence
protected

Definition at line 55 of file contact_score.py.

◆ _view

_view
protected

Definition at line 45 of file contact_score.py.

◆ chain_names

chain_names

Definition at line 239 of file contact_score.py.

◆ contact_mode

contact_mode

Definition at line 44 of file contact_score.py.


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