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.setSurface Class Reference

Public Member Functions

def __init__
 
def apply
 

Public Attributes

 residue_selector
 
 surface_type
 
 opacity
 
 color
 
 colorscheme
 

Detailed Description

Show the specified surface for each initialized `.pdb` file, `Pose` or `PackedPose` object.

Parameters
----------
first : optional
    `residue_selector`
    
    An instance of `pyrosetta.rosetta.core.select.residue_selector.ResidueSelector` to select residues
    on which to apply the surface.
    Default: None

second : optional
    `surface_type`

    `str` indicating surface type to be displayed. py3Dmol supports the following options:
        "VDW": Van der Waals surface
        "MS": Molecular surface
        "SES": Solvent excluded surface
        "SAS": Solvent accessible surface
    Default: "VDW"

third : optional
    `opacity`

    `float` or `int` between 0 and 1 for opacity of the displayed surface.
    Default: 0.5

fourth : optional
    `color`

    `str` indicating a standard color (e.g. "grey") of the surface to be displayed. 
    Either `color` or `colorscheme` may be specified, where `colorscheme` overrides `color`.
    Default: None

fifth : optional
    `colorscheme`

    `str` indicating the color scheme of the surface to be displayed.
    Either `color` or `colorscheme` may be specified, where `colorscheme` overrides `color`.
    Options include:
        A lower-case standard color followed by "Carbon" (e.g. "yellowCarbon")
        "ssPyMOL": PyMol secondary colorscheme
        "ssJmol": Jmol secondary colorscheme
        "Jmol": Jmol primary colorscheme
        "default": default colorscheme
        "amino": amino acid colorscheme
        "shapely": shapely protien colorscheme
        "nucleic": nucleic acid colorscheme
        "chain": standard chain colorscheme
        "chainHetatm": chain Hetatm colorscheme
    Default: None
    Reference: https://3dmol.csb.pitt.edu/doc/types.html#ColorschemeSpec
    
Returns
-------
A Viewer instance.

Constructor & Destructor Documentation

def pyrosetta.distributed.viewer.modules.setSurface.__init__ (   self,
  residue_selector = None,
  surface_type = "VDW",
  opacity = 0.5,
  color = None,
  colorscheme = None 
)

Member Function Documentation

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

Member Data Documentation

pyrosetta.distributed.viewer.modules.setSurface.color
pyrosetta.distributed.viewer.modules.setSurface.colorscheme
pyrosetta.distributed.viewer.modules.setSurface.opacity
pyrosetta.distributed.viewer.modules.setSurface.residue_selector
pyrosetta.distributed.viewer.modules.setSurface.surface_type

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