Difference between revisions of "GetNamesInSel"

From PyMOLWiki
Jump to navigation Jump to search
Line 6: Line 6:
 
from pymol import cmd, stored
 
from pymol import cmd, stored
 
def getNamesInSel(sel, sorted=False, reversed=False):
 
def getNamesInSel(sel, sorted=False, reversed=False):
     """"
+
     """
 
     PARAMETERS
 
     PARAMETERS
 
         sel,
 
         sel,

Revision as of 14:39, 23 March 2009

Overview

This script returns the list of object names that exist in any given selection. For example, if you have 100 objects loaded (viz. ligand poses from small molecule docking) and select all atoms w/in some cutoff, then you have a selection. What objects are actually in that selection? This script will tell you.

The Code

from pymol import cmd, stored
def getNamesInSel(sel, sorted=False, reversed=False):
    """
    PARAMETERS
        sel,
            The selection, object or group to iterate over
        sorted (boolean),
            Should the list be sorted?
        reversed (boolean)
            Should the list be reversed before returned?  (Combined
            with the above, you can return a decreasing-sorted list
            of names
 
    RETURNS
        list[] of strings, representing the object names desired.

    """
    stored.tempNames = set()
    cmd.iterate_state(1, sel, "stored.tempNames.add(model)")
    rList = list(stored.tempNames)

    # if you want the list reversed or sorted,
    # uncomment the following lines
    if sorted:
        rList.sort()
    if reversed:
        rList.reverse()

    return rList

cmd.extend("getNamesInSel", getNamesInSel)

See Also