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
	)

Referenced by pyrosetta.distributed.tasks.taskbase.TaskBase.__setstate__().

Member Function Documentation

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

References pyrosetta.distributed.viewer.modules._pdbstring_to_pose(), pyrosetta.distributed.viewer.modules.setBackgroundColor.color, pyrosetta.distributed.viewer.modules.setDisulfides.color, pyrosetta.distributed.viewer.modules.setHydrogenBonds.color, pyrosetta.distributed.viewer.modules.setHydrogenBonds.dashed, fmt.join(), ObjexxFCL.len(), pyrosetta.distributed.viewer.modules.setDisulfides.radius, pyrosetta.distributed.viewer.modules.setHydrogenBonds.radius, basic::sampling::orientations::QuatDBMetadata.radius, basic::options::OptionKeys::relax::range.range, binder.split(), and basic::options::OptionKeys::in::file.xyz.

Referenced by pyrosetta.distributed.tasks.rosetta_scripts.BaseRosettaScriptsTask.execute().

Member Data Documentation

pyrosetta.distributed.viewer.modules.setHydrogenBonds.color

Referenced by pyrosetta.distributed.viewer.modules.setHydrogenBonds.apply(), pyrosetta.distributed.viewer.modules.setHydrogens.apply(), and pyrosetta.distributed.viewer.modules.setSurface.apply().

pyrosetta.distributed.viewer.modules.setHydrogenBonds.dashed

Referenced by pyrosetta.distributed.viewer.modules.setHydrogenBonds.apply().

pyrosetta.distributed.viewer.modules.setHydrogenBonds.radius

Referenced by pyrosetta.distributed.viewer.modules.setHydrogenBonds.apply(), pyrosetta.distributed.viewer.modules.setHydrogens.apply(), pyrosetta.distributed.viewer.modules.setStyle.apply(), and test.Workshop9_my_shapes.MyCircle.area().

---

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

• src/python/PyRosetta/src/pyrosetta/distributed/viewer/modules.py