Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
pyrosetta.distributed.viewer.modules.setHydrogenBonds Class Reference

Public Member Functions

def __init__
 
def apply
 

Public Attributes

 color
 
 dashed
 
 radius
 

Detailed Description

Display hydrogen bonds according to `pyrosetta.rosetta.core.pose.Pose.get_hbonds()`
in each initialized `.pdb` file, `Pose` or `PackedPose` object.

Parameters
----------
first : optional
    `color`

    `str` indicating a standard color (e.g. "yellow").
    Default: "black"

second : optional
    `dashed`

    `True` or `False` to show hydrogen bonds as dashed lines.
    If `True`, then option `radius` must be `None`.
    If `False`, then option `radius` must be specified.
    Default: True

third : optional
    `radius`

    `float` or `int` indicating the radius of the solid (non-dashed) stick connecting the atoms participating
    in each hydrogen bond. If set, this automatically sets the option `dashed` to `False`.
    Default: None

Returns
-------
A Viewer instance.

Constructor & Destructor Documentation

def pyrosetta.distributed.viewer.modules.setHydrogenBonds.__init__ (   self,
  color = "black",
  dashed = True,
  radius = None 
)

Member Function Documentation

def pyrosetta.distributed.viewer.modules.setHydrogenBonds.apply (   self,
  viewer,
  pose,
  pdbstring 
)

Member Data Documentation

pyrosetta.distributed.viewer.modules.setHydrogenBonds.color
pyrosetta.distributed.viewer.modules.setHydrogenBonds.dashed
pyrosetta.distributed.viewer.modules.setHydrogenBonds.radius

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