-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmembrane_normal.html
More file actions
148 lines (126 loc) · 8.16 KB
/
membrane_normal.html
File metadata and controls
148 lines (126 loc) · 8.16 KB
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Specifying membrane normal — gorder "1.2.0" documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=784e175d"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Accessing the results" href="results.html" />
<link rel="prev" title="Order parameters for specific membrane region" href="geometry.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
gorder
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="gorder.html">Performing the analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="analysis_types.html">Analysis types</a></li>
<li class="toctree-l1"><a class="reference internal" href="leaflets.html">Order parameters for individual leaflets</a></li>
<li class="toctree-l1"><a class="reference internal" href="ordermap.html">Maps of order parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="estimate_error.html">Estimating error</a></li>
<li class="toctree-l1"><a class="reference internal" href="geometry.html">Order parameters for specific membrane region</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Specifying membrane normal</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#gorder.membrane_normal.DynamicNormal"><code class="docutils literal notranslate"><span class="pre">DynamicNormal</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="results.html">Accessing the results</a></li>
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">Errors you can encounter</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">gorder</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Specifying membrane normal</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/membrane_normal.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-gorder.membrane_normal">
<span id="specifying-membrane-normal"></span><h1>Specifying membrane normal<a class="headerlink" href="#module-gorder.membrane_normal" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="gorder.membrane_normal.DynamicNormal">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gorder.membrane_normal.</span></span><span class="sig-name descname"><span class="pre">DynamicNormal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">heads</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">radius</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">collect</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gorder.membrane_normal.DynamicNormal" title="Link to this definition"></a></dt>
<dd><p>Request a dynamic local membrane normal calculation.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>heads</strong> (<em>str</em>) – Selection query specifying reference atoms representing lipid headgroups
(typically phosphorus atoms or phosphate beads). Must be exactly one
atom/bead per lipid molecule.</p></li>
<li><p><strong>radius</strong> (<em>float</em>) – Radius of the sphere used to select nearby lipids for membrane normal
estimation in nm. Recommended value is half the membrane thickness.
Must be greater than 0. The default value is 2.0 (nm).</p></li>
<li><p><strong>collect</strong> (<em>Optional</em><em>[</em><em>Union</em><em>[</em><em>bool</em><em>, </em><em>str</em><em>]</em><em>]</em><em>, </em><em>default=False</em>) – Determines whether dynamic membrane normals are saved and exported.
By default (<cite>False</cite>), normals are not saved.
If <cite>True</cite>, normals are saved internally and accessible via the Python API, but not written to a file.
If a string is provided, normals are saved and written to the specified output file.</p></li>
</ul>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="exceptions.html#gorder.exceptions.ConfigError" title="gorder.exceptions.ConfigError"><strong>ConfigError</strong></a> – If <cite>radius</cite> is not positive.</p>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="geometry.html" class="btn btn-neutral float-left" title="Order parameters for specific membrane region" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="results.html" class="btn btn-neutral float-right" title="Accessing the results" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2025, Ladislav Bartos.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>