HappyDoc Generated Documentation .\PBReader\base.py

. / PBReader / base.py 

Functions   
  readPBinfo 
readPBinfo (
        fileName,
        category=None,
        clearCategory=1,
        lineWidth=None,
        drawMode=None,
        leftModel=None,
        rightModel=None,
        defColor=None,
        )

read a file containing pseudobond info and display those bonds

category defaults to fileName. clearCategory controls whether the pseudobond group should be cleared of pre-existing pseudobonds before reading the file. lineWidth is a floating- point number and controls the width of lines used to draw the pseudobonds. This only is relevant if drawMode is Wire. drawMode controls the depiction style of the pseudobonds. Possible modes are:

Wire (aka chimera.Bond_Wire)
wireframe Stick (aka chimera.Bond_Stick) -- sticks

leftModel and rightModel control what models the endpoints of the pseudobond lie in, if none are specified in the input file. defColor is the color assigned to the pseudobond group as a whole, which can be overridden by specific pseudobonds.

Classes   

This document was automatically generated Thu Nov 09 13:33:30 2006 by HappyDoc version 3.0.a1