Package specific_fns :: Package model_free :: Module macro_base :: Class Macro
[hide private]
[frames] | no frames]

Class Macro

source code


The base class for the model-free analysis Molmol and PyMOL macro creation.

Instance Methods [hide private]
 
classic_style(self, data_type=None, colour_start=None, colour_end=None, colour_list=None, spin_id=None)
The classic macro style.
source code
 
classic_correlation_time(self, res_num, te, colour_start, colour_end, colour_list)
Function for generating the bond width and colours for correlation times.
source code
 
classic_order_param(self, res_num, s2, colour_start, colour_end, colour_list)
Function for generating the bond width and colours for order parameters.
source code
 
classic_rex(self, res_num, rex, colour_start, colour_end, colour_list)
Function for generating the bond width and colours for correlation times.
source code
 
create_macro(self, data_type, style=None, colour_start=None, colour_end=None, colour_list=None, spin_id=None)
Create and return an array of macros of the model-free parameters.
source code
Class Variables [hide private]
  classic_style_doc = Desc_container("Model-free classic style")
  table = uf_tables.add_table(label= "table: model-free macro cl...
Method Details [hide private]

classic_style(self, data_type=None, colour_start=None, colour_end=None, colour_list=None, spin_id=None)

source code 

The classic macro style.

Parameters:
  • data_type (str) - The parameter name or data type.
  • colour_start (str) - The starting colour (must be a MOLMOL or X11 name).
  • colour_end (str) - The ending colour (must be a MOLMOL or X11 name).
  • colour_list (str) - The colour list used, either 'molmol' or 'x11'.
  • spin_id (str) - The spin identification string.

create_macro(self, data_type, style=None, colour_start=None, colour_end=None, colour_list=None, spin_id=None)

source code 

Create and return an array of macros of the model-free parameters.

Parameters:
  • data_type (str) - The parameter name or data type.
  • style (None or str) - The Molmol style.
  • colour_start (str) - The starting colour (must be a MOLMOL or X11 name).
  • colour_end (str) - The ending colour (must be a MOLMOL or X11 name).
  • colour_list (str) - The colour list used, either 'molmol' or 'x11'.
  • spin_id (str) - The spin identification string.

Class Variable Details [hide private]

table

Value:
uf_tables.add_table(label= "table: model-free macro classic style", ca\
ption= "The model-free classic style for mapping model spin specific d\
ata onto 3D molecular structures using either PyMOL or Molmol.", capti\
on_short= "The model-free classic style for PyMOL and Molmol data mapp\
ing.")