Package gromacs :: Package analysis :: Package plugins :: Module helixbundle :: Class HelixBundle
[hide private]
[frames] | no frames]

Class HelixBundle

source code

 object --+    
          |    
core.Plugin --+
              |
             HelixBundle

*HelixBundle* plugin.

:func:`gromacs.g_bundle` helix analysis

.. class:: HelixBundle([helixtable, offset, with_kinks, [name[, simulation]]])

:Arguments:
   *helixtable*
       reST table with columns "name", "top", "bottom",
       "kink"; see :mod:`gromacs.analysis.plugins.helixbundle`
       for details
   *offset*
       add the *offset* to the residue numbers in *helixtable* [0]
   *helixndx*
       provide a index file with the appropriate groups
       instead of the table; also requires *na*
   *na*
       number of helices
   *with_kinks*
       take kinks into account [True]
   *name*
       plugin name [HelixBundle]
   *simulation*
       The :class:`gromacs.analysis.Simulation` instance that owns
       the plugin. [None]

Nested Classes [hide private]
  worker_class
actual plugin :class:`gromacs.analysis.core.Worker` class (name with leading underscore)
Instance Methods [hide private]

Inherited from core.Plugin: __init__, register

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Instance Variables [hide private]

Inherited from core.Plugin: plugin_name, simulation, worker

Properties [hide private]

Inherited from object: __class__