Author: bugman
Date: Fri Apr 25 12:31:19 2008
New Revision: 6011
URL: http://svn.gna.org/viewcvs/relax?rev=6011&view=rev
Log:
Renamed the prompt.unselect module to prompt.deselect.
Added:
1.3/prompt/deselect.py
- copied unchanged from r6010, 1.3/prompt/unselect.py
Removed:
1.3/prompt/unselect.py
Removed: 1.3/prompt/unselect.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/prompt/unselect.py?rev=6010&view=auto
==============================================================================
--- 1.3/prompt/unselect.py (original)
+++ 1.3/prompt/unselect.py (removed)
@@ -1,284 +1,0 @@
-###############################################################################
-#
#
-# Copyright (C) 2003, 2004 Edward d'Auvergne
#
-#
#
-# This file is part of the program relax.
#
-#
#
-# relax is free software; you can redistribute it and/or modify
#
-# it under the terms of the GNU General Public License as published by
#
-# the Free Software Foundation; either version 2 of the License, or
#
-# (at your option) any later version.
#
-#
#
-# relax is distributed in the hope that it will be useful,
#
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
#
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
#
-# GNU General Public License for more details.
#
-#
#
-# You should have received a copy of the GNU General Public License
#
-# along with relax; if not, write to the Free Software
#
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
-#
#
-###############################################################################
-
-# Python module imports.
-import sys
-
-# relax module imports.
-import help
-from relax_errors import RelaxBinError, RelaxError, RelaxIntError,
RelaxListStrError, RelaxNoneIntStrError, RelaxNoneStrError,
RelaxNoneStrListError, RelaxStrError
-
-
-class Deselect:
- def __init__(self, relax):
- # Help.
- self.__relax_help__ = \
- """Class for deselecting residues."""
-
- # Add the generic help string.
- self.__relax_help__ = self.__relax_help__ + "\n" +
help.relax_class_help
-
- # Place relax in the class namespace.
- self.__relax__ = relax
-
-
- def all(self, run=None):
- """Function for deselecting all residues.
-
- Keyword Arguments
- ~~~~~~~~~~~~~~~~~
-
- run: The name of the run(s). By supplying a single string, array
of strings, or None, a
- single run, multiple runs, or all runs will be selected respectively.
-
-
- Examples
- ~~~~~~~~
-
- To deselect all residues type:
-
- relax> deselect.all()
-
-
- To deselect all residues for the run 'srls_m1', type:
-
- relax> select.all('srls_m1')
- relax> select.all(run='srls_m1')
- """
-
- # Function intro test.
- if self.__relax__.interpreter.intro:
- text = sys.ps3 + "deselect.all("
- text = text + "run=" + `run` + ")"
- print text
-
- # The run argument.
- if run != None and type(run) != str and type(run) != list:
- raise RelaxNoneStrListError, ('run', run)
- if type(run) == list:
- for i in xrange(len(run)):
- if type(run[i]) != str:
- raise RelaxListStrError, ('run', run)
-
- # Execute the functional code.
- self.__relax__.generic.selection.desel_all(run=run)
-
-
- def read(self, run=None, file=None, dir=None, change_all=0, column=0):
- """Function for deselecting the residues contained in a file.
-
- Keyword Arguments
- ~~~~~~~~~~~~~~~~~
-
- run: The name of the run(s). By supplying a single string, array
of strings, or None, a
- single run, multiple runs, or all runs will be selected respectively.
-
- file: The name of the file containing the list of residues to
deselect.
-
- dir: The directory where the file is located.
-
- change_all: A flag specifying if all other residues should be
changed.
-
- column: The column containing the residue numbers (defaulting to 0,
the first column).
-
-
- Description
- ~~~~~~~~~~~
-
- Empty lines and lines beginning with a hash are ignored.
-
- The 'change_all' flag argument default is zero meaning that all
residues currently either
- selected or deselected will remain that way. Setting the argument
to 1 will cause all
- residues not specified in the file to be selected.
-
-
- Examples
- ~~~~~~~~
-
- To deselect all overlapped residues in the file 'unresolved', type:
-
- relax> deselect.read('noe', 'unresolved')
- relax> deselect.read(run='noe', file='unresolved')
-
- To deselect the residues in the second column of the relaxation data
file 'r1.600' while
- selecting all other residues, type one of:
-
- relax> deselect.read('test', 'r1.600', change_all=1, column=1)
- relax> deselect.read(run='test', file='r1.600', change_all=1,
column=1)
- """
-
- # Function intro test.
- if self.__relax__.interpreter.intro:
- text = sys.ps3 + "deselect.read("
- text = text + "run=" + `run`
- text = text + ", file=" + `file`
- text = text + ", dir=" + `dir`
- text = text + ", change_all=" + `change_all`
- text = text + ", column=" + `column` + ")"
- print text
-
- # The run argument.
- if run != None and type(run) != str and type(run) != list:
- raise RelaxNoneStrListError, ('run', run)
- if type(run) == list:
- for i in xrange(len(run)):
- if type(run[i]) != str:
- raise RelaxListStrError, ('run', run)
-
- # File name.
- if type(file) != str:
- raise RelaxStrError, ('file name', file)
-
- # Directory.
- if dir != None and type(dir) != str:
- raise RelaxNoneStrError, ('directory name', dir)
-
- # Change all flag.
- if type(change_all) != int or (change_all != 0 and change_all != 1):
- raise RelaxBinError, ('change_all', change_all)
-
- # The residue column.
- if type(column) != int:
- raise RelaxIntError, ('residue number column', column)
-
- # Execute the functional code.
- self.__relax__.generic.selection.desel_read(run=run, file=file,
dir=dir, change_all=change_all, column=column)
-
-
- def res(self, run=None, num=None, name=None, change_all=0):
- """Function for deselecting specific residues.
-
- Keyword Arguments
- ~~~~~~~~~~~~~~~~~
-
- run: The name of the run(s). By supplying a single string, array
of strings, or None, a
- single run, multiple runs, or all runs will be selected respectively.
-
- num: The residue number.
-
- name: The residue name.
-
- change_all: A flag specifying if all other residues should be
changed.
-
-
- Description
- ~~~~~~~~~~~
-
- The residue number can be either an integer for deselecting a single
residue or a python
- regular expression, in string form, for deselecting multiple
residues. For details about
- using regular expression, see the python documentation for the
module 're'.
-
- The residue name argument must be a string. Regular expression is
also allowed.
-
- The 'change_all' flag argument default is zero meaning that all
residues currently either
- selected or deselected will remain that way. Setting the argument
to 1 will cause all
- residues not specified by 'num' or 'name' to become selected.
-
-
- Examples
- ~~~~~~~~
-
- To deselect all glycines for the run 'm5', type:
-
- relax> deselect.res(run='m5', name='GLY|ALA')
- relax> deselect.res(run='m5', name='[GA]L[YA]')
-
- To deselect residue 12 MET type:
-
- relax> deselect.res('m5', 12)
- relax> deselect.res('m5', 12, 'MET')
- relax> deselect.res('m5', '12')
- relax> deselect.res('m5', '12', 'MET')
- relax> deselect.res(run='m5', num='12', name='MET')
- """
-
- # Function intro test.
- if self.__relax__.interpreter.intro:
- text = sys.ps3 + "deselect.res("
- text = text + "run=" + `run`
- text = text + ", num=" + `num`
- text = text + ", name=" + `name`
- text = text + ", change_all=" + `change_all` + ")"
- print text
-
- # The run argument.
- if run != None and type(run) != str and type(run) != list:
- raise RelaxNoneStrListError, ('run', run)
- if type(run) == list:
- for i in xrange(len(run)):
- if type(run[i]) != str:
- raise RelaxListStrError, ('run', run)
-
- # Residue number.
- if num != None and type(num) != int and type(num) != str:
- raise RelaxNoneIntStrError, ('residue number', num)
-
- # Residue name.
- if name != None and type(name) != str:
- raise RelaxNoneStrError, ('residue name', name)
-
- # Neither are given.
- if num == None and name == None:
- raise RelaxError, "At least one of the number or name arguments
is required."
-
- # Change all flag.
- if type(change_all) != int or (change_all != 0 and change_all != 1):
- raise RelaxBinError, ('change_all', change_all)
-
- # Execute the functional code.
- self.__relax__.generic.selection.desel_res(run=run, num=num,
name=name, change_all=change_all)
-
-
- def reverse(self, run=None):
- """Function for the reversal of the residue selection.
-
- Keyword Arguments
- ~~~~~~~~~~~~~~~~~
-
- run: The name of the run(s). By supplying a single string, array
of strings, or None, a
- single run, multiple runs, or all runs will be selected respectively.
-
-
- Examples
- ~~~~~~~~
-
- To deselect all currently selected residues and select those which
are deselected type:
-
- relax> deselect.reverse()
- """
-
- # Function intro test.
- if self.__relax__.interpreter.intro:
- text = sys.ps3 + "deselect.reverse("
- text = text + "run=" + `run` + ")"
- print text
-
- # The run argument.
- if run != None and type(run) != str and type(run) != list:
- raise RelaxNoneStrListError, ('run', run)
- if type(run) == list:
- for i in xrange(len(run)):
- if type(run[i]) != str:
- raise RelaxListStrError, ('run', run)
-
- # Execute the functional code.
- self.__relax__.generic.selection.reverse(run=run)
r6011 - in /1.3/prompt: deselect.py unselect.py