Author: bugman
Date: Tue Oct 27 15:25:08 2009
New Revision: 9800
URL: http://svn.gna.org/viewcvs/relax?rev=9800&view=rev
Log:
Created the structure.get_pos() user function for extracting atomic positions.
Modified:
1.3/generic_fns/structure/main.py
1.3/prompt/structure.py
Modified: 1.3/generic_fns/structure/main.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/structure/main.py?rev=9800&r1=9799&r2=9800&view=diff
==============================================================================
--- 1.3/generic_fns/structure/main.py (original)
+++ 1.3/generic_fns/structure/main.py Tue Oct 27 15:25:08 2009
@@ -31,7 +31,7 @@
# relax module imports.
from generic_fns import molmol, relax_re
-from generic_fns.mol_res_spin import exists_mol_res_spin_data,
generate_spin_id, return_molecule, return_residue, return_spin, spin_loop
+from generic_fns.mol_res_spin import exists_mol_res_spin_data,
generate_spin_id, linear_ave, return_molecule, return_residue, return_spin,
spin_loop
from generic_fns import pipes
from generic_fns.structure.internal import Internal
from generic_fns.structure.scientific import Scientific_data
@@ -59,7 +59,89 @@
if hasattr(spin, 'xh_vect'):
del spin.xh_vect
-
+
+def get_pos(spin_id=None, str_id=None, ave_pos=False):
+ """Load the spins from the structural object into the relax data store.
+
+ @keyword spin_id: The molecule, residue, and spin identifier
string.
+ @type spin_id: str
+ @keyword str_id: The structure identifier. This can be the
file name, model number,
+ or structure number.
+ @type str_id: int or str
+ @keyword ave_pos: A flag specifying if the average atom
position or the atom position
+ from all loaded structures is loaded into
the SpinContainer.
+ @type ave_pos: bool
+ """
+
+ # Test if the current data pipe exists.
+ pipes.test()
+
+ # Test if the structure exists.
+ if not hasattr(cdp, 'structure') or not cdp.structure.num_models() or
not cdp.structure.num_molecules():
+ raise RelaxNoPdbError
+
+ # Loop over all atoms of the spin_id selection.
+ model_index = -1
+ last_model = None
+ for model_num, mol_name, res_num, res_name, atom_num, atom_name,
element, pos in cdp.structure.atom_loop(atom_id=spin_id, str_id=str_id,
model_num_flag=True, mol_name_flag=True, res_num_flag=True,
res_name_flag=True, atom_num_flag=True, atom_name_flag=True,
element_flag=True, pos_flag=True, ave=ave_pos):
+ # Update the model info.
+ if last_model != model_num:
+ model_index = model_index + 1
+ last_model = model_num
+
+ # Remove the '+' regular expression character from the mol, res, and
spin names!
+ if mol_name and search('\+', mol_name):
+ mol_name = replace(mol_name, '+', '')
+ if res_name and search('\+', res_name):
+ res_name = replace(res_name, '+', '')
+ if atom_name and search('\+', atom_name):
+ atom_name = replace(atom_name, '+', '')
+
+ # The spin identification string. The residue name and spin num is
not included to allow molecules with point mutations to be used as different
models.
+ id = generate_spin_id(mol_name=mol_name, res_num=res_num,
res_name=None, spin_name=atom_name)
+
+ # Get the spin container.
+ spin_cont = return_spin(id)
+
+ # Skip the spin if it doesn't exist.
+ if spin_cont == None:
+ continue
+
+ # Add the position vector to the spin container.
+ if ave_pos:
+ spin_cont.pos = pos
+ else:
+ if not hasattr(spin_cont, 'pos'):
+ spin_cont.pos = []
+ spin_cont.pos.append(pos)
+
+ # Update pseudo-atoms.
+ for spin in spin_loop():
+ if hasattr(spin, 'members'):
+ # Get the spin positions.
+ positions = []
+ for atom in spin.members:
+ # Get the spin container.
+ subspin = return_spin(atom)
+
+ # Test that the spin exists.
+ if subspin == None:
+ raise RelaxNoSpinError(atom)
+
+ # Test the position.
+ if not hasattr(subspin, 'pos') or not subspin.pos:
+ raise RelaxError("Positional information is not
available for the atom '%s'." % atom)
+
+ # Store the position.
+ positions.append([])
+ for i in range(len(subspin.pos)):
+ positions[-1].append(subspin.pos[i].tolist())
+
+ # The averaging.
+ if spin.averaging == 'linear':
+ spin.pos = linear_ave(positions)
+
+
def load_spins(spin_id=None, str_id=None, combine_models=True,
ave_pos=False):
"""Load the spins from the structural object into the relax data store.
@@ -200,7 +282,7 @@
=======
A number of parsers are available for reading PDB files. These include:
-
+
- 'scientific', the Scientific Python PDB parser.
- 'internal', a low quality yet fast PDB parser built into relax.
Modified: 1.3/prompt/structure.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/prompt/structure.py?rev=9800&r1=9799&r2=9800&view=diff
==============================================================================
--- 1.3/prompt/structure.py (original)
+++ 1.3/prompt/structure.py Tue Oct 27 15:25:08 2009
@@ -204,6 +204,55 @@
generic_fns.structure.geometric.create_vector_dist(length=length,
symmetry=symmetry, file=file, dir=dir, force=force)
+ def get_pos(self, spin_id=None, ave_pos=True):
+ """Extract the atomic positions from the loaded structures for the
given spins.
+
+ Keyword Arguments
+ ~~~~~~~~~~~~~~~~~
+
+ spin_id: The spin identification string.
+
+ ave_pos: A flag specifying if the position of the atom is to be
averaged across models.
+
+
+ Description
+ ~~~~~~~~~~~
+
+ This function allows the atomic positions of the spins to be
extracted from the loaded
+ structures. This is automatically performed by the
structure.load_spins() user function,
+ but if the sequence information is generated in other ways, this
user function allows the
+ structural information to be obtained.
+
+ If the ave_pos flag is True, the average position of all models will
be loaded into the spin
+ container. If False, then the positions from all models will be
loaded.
+
+
+ Example
+ ~~~~~~~
+
+ For a model-free backbone amide nitrogen analysis whereby the N
spins have already been
+ created, to obtain the backbone N positions from the file '1F3Y.pdb'
(which is a single
+ protein), type the following two user functions:
+
+ relax> structure.read_pdb('1F3Y.pdb')
+ relax> structure.get_pos(spin_id='@N')
+ """
+
+ # Function intro text.
+ if self.__relax__.interpreter.intro:
+ text = sys.ps3 + "structure.get_pos("
+ text = text + "spin_id=" + repr(spin_id)
+ text = text + ", ave_pos=" + repr(ave_pos) + ")"
+ print(text)
+
+ # The argument checks.
+ check.is_str(spin_id, 'spin identification string', can_be_none=True)
+ check.is_bool(ave_pos, 'average position flag')
+
+ # Execute the functional code.
+ generic_fns.structure.main.get_pos(spin_id=spin_id, ave_pos=ave_pos)
+
+
def delete(self):
"""Delete all structural information from the current data pipe.
@@ -241,7 +290,7 @@
combine_models: A flag which specifies if spins from separate
models should be combined.
- ave_pos: A flag specifying if the position of the atom is to be
averaged.
+ ave_pos: A flag specifying if the position of the atom is to be
averaged across models.
Description
@@ -256,15 +305,15 @@
If the combine_models flag is True, then the spins from only a
single structure from the
ensemble of models will be taken. If False, then spins will be
loaded for each model.
- If the ave_pos flag is True, the average position of all structures
will be loaded into the spin
- container. If False, then the positions from all structures will be
loaded.
+ If the ave_pos flag is True, the average position of all models will
be loaded into the spin
+ container. If False, then the positions from all models will be
loaded.
Example
~~~~~~~
For a model-free backbone amide nitrogen analysis, to load just the
backbone N sequence from
- the file '1F3Y.pdb' (which is a single protein), type the follow two
user functions:
+ the file '1F3Y.pdb' (which is a single protein), type the following
two user functions:
relax> structure.read_pdb('1F3Y.pdb')
relax> structure.load_spins(spin_id='@N')
@@ -278,7 +327,6 @@
relax> structure.load_spins(spin_id=':G@C8&@N1')
relax> structure.load_spins(spin_id=':C@C5&@C6')
relax> structure.load_spins(spin_id=':U@N3&@C5&@C6')
-
"""
# Function intro text.
r9800 - in /1.3: generic_fns/structure/main.py prompt/structure.py