Package specific_analyses :: Package model_free :: Module uf
[hide private]
[frames] | no frames]

Module uf

source code

The model-free analysis user functions.

Functions [hide private]
 
create_model(model=None, equation=None, params=None, spin_id=None)
Function for creating a custom model-free model.
source code
 
delete()
Delete all the model-free data.
source code
 
model_setup(model=None, equation=None, params=None, spin_id=None)
Function for updating various data structures depending on the model selected.
source code
 
remove_tm(spin_id=None)
Remove local tm from the set of model-free parameters for the given spins.
source code
 
select_model(model=None, spin_id=None)
Function for the selection of a preset model-free model.
source code
Variables [hide private]
  uf_tables = Uf_tables()
  api_model_free = Model_free()
hash(x)
  classic_style_doc = Desc_container("Model-free classic style")
  table = uf_tables.add_table(label= "table: model-free macro cl...
  eliminate_doc = []
  __package__ = 'specific_analyses.model_free'

Imports: match, RelaxError, RelaxFuncSetupError, RelaxNoSequenceError, RelaxTensorError, pipes, exists_mol_res_spin_data, spin_loop, check_pipe, specific_analyses, Model_free, model_map, Uf_tables, Desc_container


Function Details [hide private]

create_model(model=None, equation=None, params=None, spin_id=None)

source code 

Function for creating a custom model-free model.

Parameters:
  • model (str) - The name of the model.
  • equation (str) - The equation type to use. The 3 allowed types are: 'mf_orig' for the original model-free equations with parameters {s2, te}; 'mf_ext' for the extended model-free equations with parameters {s2f, tf, s2, ts}; and 'mf_ext2' for the extended model-free equations with parameters {s2f, tf, s2s, ts}.
  • params (list of str) - A list of the parameters to include in the model. The allowed parameter names includes those for the equation type as well as chemical exchange 'rex', the bond length 'r', and the chemical shift anisotropy 'csa'.
  • spin_id (str) - The spin identification string.

model_setup(model=None, equation=None, params=None, spin_id=None)

source code 

Function for updating various data structures depending on the model selected.

Parameters:
  • model (str) - The name of the model.
  • equation (str) - The equation type to use. The 3 allowed types are: 'mf_orig' for the original model-free equations with parameters {s2, te}; 'mf_ext' for the extended model-free equations with parameters {s2f, tf, s2, ts}; and 'mf_ext2' for the extended model-free equations with parameters {s2f, tf, s2s, ts}.
  • params (list of str) - A list of the parameters to include in the model. The allowed parameter names includes those for the equation type as well as chemical exchange 'rex', the bond length 'r', and the chemical shift anisotropy 'csa'.
  • spin_id (str) - The spin identification string.

remove_tm(spin_id=None)

source code 

Remove local tm from the set of model-free parameters for the given spins.

Parameters:
  • spin_id (str or None) - The spin identification string.

select_model(model=None, spin_id=None)

source code 

Function for the selection of a preset model-free model.

Parameters:
  • model (str) - The name of the model.
  • spin_id (str) - The spin identification string.

Variables 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.")