File: load_loop_objects.rst

package info (click to toggle)
promod3 3.6.0%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 966,592 kB
  • sloc: cpp: 55,817; python: 18,058; makefile: 85; sh: 51
file content (100 lines) | stat: -rw-r--r-- 3,256 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
..  Copyright (c) 2013-2020, SIB - Swiss Institute of Bioinformatics and
..                           Biozentrum - University of Basel
..  
..  Licensed under the Apache License, Version 2.0 (the "License");
..  you may not use this file except in compliance with the License.
..  You may obtain a copy of the License at
..  
..    http://www.apache.org/licenses/LICENSE-2.0
..  
..  Unless required by applicable law or agreed to in writing, software
..  distributed under the License is distributed on an "AS IS" BASIS,
..  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
..  See the License for the specific language governing permissions and
..  limitations under the License.


Loading Precomputed Objects
================================================================================

.. currentmodule:: promod3.loop


Several data objects are used throughout the loop module.
|project| offers to load precomputed instances for direct usage.

.. method:: LoadTorsionSampler(seed=0)

  Loads and returns a torsion sampler with an amino acid grouping
  as defined by [solis2006]_ that has been trained on 
  non-redundant protein structures.

  :param seed:          Seed for internal random number generator
  :type seed:           :class:`int`

  :returns:             The torsion sampler

  :rtype:               :class:`TorsionSampler`


.. method:: LoadTorsionSamplerCoil(seed=0)

  Loads and returns a torsion sampler with an amino acid grouping
  as defined by [solis2006]_ that has been trained on coil
  residues of  non-redundant protein structures.

  :param seed:          Seed for internal random number generator
  :type seed:           :class:`int`

  :returns:             The torsion sampler

  :rtype:               :class:`TorsionSampler`


.. method:: LoadTorsionSamplerHelical(seed=0)

  Loads and returns a torsion sampler with an amino acid grouping
  as defined by [solis2006]_ that has been trained on helical
  residues of  non-redundant protein structures.

  :param seed:          Seed for internal random number generator
  :type seed:           :class:`int`

  :returns:             The torsion sampler

  :rtype:               :class:`TorsionSampler`


.. method:: LoadTorsionSamplerExtended(seed=0)

  Loads and returns a torsion sampler with an amino acid grouping
  as defined by [solis2006]_ that has been trained on extended
  residues of  non-redundant protein structures.

  :param seed:          Seed for internal random number generator
  :type seed:           :class:`int`

  :returns:             The torsion sampler

  :rtype:               :class:`TorsionSampler`


.. method:: LoadStructureDB()

  Loads and returns a structure db containing roughly 21000 chains form the
  PDB with seqid redundancy cutoff of 60%

  :returns:             The structure db
  :rtype:               :class:`StructureDB`


.. method:: LoadFragDB()

  Loads and returns a FragDB containing fragments up to the length of 14,
  therefore capable of bridging gaps up to the length of 12. The returned
  databases contains the location of fragments in the :class:`StructureDB`
  returned by :meth:`LoadStructureDB`.

  :returns:             The Fragment database
  :rtype:               :class:`FragDB`