Class BuilderWithClashDetection

Create a Builder object

Parameters:

• basename (str) - The base name for structure files created by this builder
• backend (schrodinger.job.jobcontrol._Backend) - The job control backend we are running under, or None if not running under a backend
• logger (logging.Logger) - The logger for this builder
• color (str or None) - Set to module constant COLOR_BY_MOLECULE to color the structures in the cell by molecule
• vdw_scale (float) - Scale factor for VdW radii during clash detection

Overrides: object.__init__

Log a message

Parameters:

• msg (str) - The message to log
• level (logging constant) - A log level constant from the logging module such as INFO, WARNING, ERROR...

Override in subclasses to check if any of the building blocks have rings. If none do, it will be a waste of time to look for them in the larger structure.

Returns: bool

If any of the building blocks have rings

Find all the rings in the provided structure. Since ring-finding is expensive, its best to pre-calculate them once. Since the coordinates of the ring don't matter, we can use these rings over and over as long as the atom numbering doesn't change.

Parameters:

• struct (schrodinger.structure.Structure) - The structure to find the rings for

Returns: list

List of schrodinger.structure._Ring objects in the given structure.

Find all cases where a bond spears a ring

Parameters:

• ring_struct (schrodinger.structure.Structure) - The structure containing the rings
• spear_struct (schrodinger.structure.Structure) - The structure containing the atoms that might spear the rings. If not provided, ring_struct will be used.
• rings (list) - Each item of the list is a schrodinger.structure._Ring object. This is the list returned by the findRings() method. If not provided, they will be calculated on the fly - which takes considerable time. If findRingSpears will be run more than once on the same structure (even if the geometry changes), the rings should be precalculated via findRings and passed in via this parameter.
• ring_based (bool) - Whether the returned dictionary should contain keys that are atom indexes of the speared ring (True), or of the bond spearing the ring (False)
• pbc (None, infrastructure.PBC, or list) - If periodic boundary conditions should be used, provide either an infrastructure.PBC object or the parameters to construct one. Allowed constructors:

     * a, b, c : box lengths
     * a, b, c, alpha, beta, gamma box : box lengths and angles
     * ax, ay, az, bx, by, bz, cx, cy, cz : box vectors
  

Returns: dict

If ring_based=True, keys are an atom index of one of the atoms in the speared ring, and values are the atom index of one of the atoms in the spearing bond. If ring_based=False, the keys/values are flipped.

Get only those clashes that are not ignored.

Parameters:

• all_clashes (dict) - All found clashes
• ignored_clashes (dict) - Clashes that should be ignored

Returns: dict

Those clashes in all_clashes that are not in ignored_clashes. Keys are atom indexes, values are all the atom indexes that clash with that atom

Get an infrastructure Structure object and an associated bitset struct.atom_total long

Parameters:

• struct (schrodinger.structure.Structure) - The python module Structure object

Returns: tuple

First item of the tuple is a schrodinger.infra.structure.Structure object. Second item is a bitset that is struct.atom_total long

Find clashes - either intrastructure if struct2 is None, or interstructure if struct2 is not None.

Parameters:

• struct (schrodinger.structure.Structure) - The structure for intrastructure clashes or the first structure for interstructure clashes
• cutoff (float) - The cutoff for finding clashes. This value is multipied times the sum of the VDW radii of the two atoms. If the distance is less than this scaled VDW radii sum, a clash exists
• struct2 (schrodinger.structure.Structure) - The second structure for interstructure clashes
• pbc (None, infrastructure.PBC, or list) - If periodic boundary conditions should be used, provide either an infrastructure.PBC object or the parameters to construct one. Allowed constructors:

     * a, b, c : box lengths
     * a, b, c, alpha, beta, gamma box : box lengths and angles
     * ax, ay, az, bx, by, bz, cx, cy, cz : box vectors
  

Returns: dict

keys are atom indexes in struct1 (or struct2 if defined), and values are all the atom indexes in struct1 that clash with that atom

Check for any intrastructure clashes

Parameters:

• struct (schrodinger.structure.Structure) - The structure for intrastructure clashes
• scale (float) - The cutoff for finding clashes. This value is multipied times the sum of the VDW radii of the two atoms. If the distance is less than this scaled VDW radii sum, a clash exists
• pbc (None, infrastructure.PBC, or list) - If periodic boundary conditions should be used, provide either an infrastructure.PBC object or the parameters to construct one. Allowed constructors:

     * a, b, c : box lengths
     * a, b, c, alpha, beta, gamma box : box lengths and angles
     * ax, ay, az, bx, by, bz, cx, cy, cz : box vectors
  

• rings (list) - The precalculated rings returned by findRings() on the structure. If not supplied, they will be calculated on the fly.
• ignore (dict) - A dictionary of clashes - any clash in this dictionary will be ignored. These are typically existing clashes that we have already tried and failed to remove. keys are atom indexes, values are lists of atom indexes that clash with the key atom.

Returns: dict

keys are atom indexes, and values are all the atom indexes that clash with that atom. A clash may come from two atoms too close together, or a ring that is speared by a bond.

Count the total number of clashes

Parameters:

• clashes (dict) - keys are atom indexes, values are all the atom indexes that clash with that atom

Color each molecule in struct a different color

Parameters:

• struct (schrodinger.structure.Structure) - The structure to color