-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathstep class.html
189 lines (163 loc) · 19.5 KB
/
step class.html
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Step class — skypiea 1.28 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></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="prev" title="Installation" href="installation.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">
skypiea
</a>
<div class="version">
1.28
</div>
<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="installation.html">Installation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Step class</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#skypiea.Step"><code class="docutils literal notranslate"><span class="pre">Step()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#skypiea.Step.hist1D"><code class="docutils literal notranslate"><span class="pre">hist1D()</span></code></a></li>
</ul>
</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">skypiea</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">Step class</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/step class.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="step-class">
<h1>Step class<a class="headerlink" href="#step-class" title="Permalink to this heading">¶</a></h1>
<p>The main class is the <code class="docutils literal notranslate"><span class="pre">skypiea.Step</span></code> class.</p>
<dl class="py function">
<dt class="sig sig-object py" id="skypiea.Step">
<span class="sig-prename descclassname"><span class="pre">skypiea.</span></span><span class="sig-name descname"><span class="pre">Step</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/skypiea/step.html#Step"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skypiea.Step" title="Permalink to this definition">¶</a></dt>
<dd><p>Main Class for simulation parameters. Include beam, laser and plasma parameters at a given timestep</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="skypiea.Step.hist1D">
<span class="sig-prename descclassname"><span class="pre">skypiea.Step.</span></span><span class="sig-name descname"><span class="pre">hist1D</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xconv</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xrange</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[None,</span> <span class="pre">None]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plot</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ax</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yaxis</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'charge'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#skypiea.Step.hist1D" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot/get 1D histogram data from the weighted beam.</p>
<p class="rubric">Example</p>
<div class="literal-block-wrapper docutils container" id="id1">
<div class="code-block-caption"><span class="caption-text">Simple plot of the x distribution (dQ/dx).</span><a class="headerlink" href="#id1" title="Permalink to this code">¶</a></div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Note that x axis is convert in um with xconv. step.sigma_x is the standard deviation (bunch length) in x.</span>
<span class="n">H</span><span class="p">,</span> <span class="n">xedges</span> <span class="o">=</span> <span class="n">step</span><span class="o">.</span><span class="n">hist1D</span><span class="p">(</span><span class="s1">'x'</span><span class="p">,</span>
<span class="n">xconv</span><span class="o">=</span><span class="s1">'um'</span><span class="p">,</span>
<span class="n">xrange</span><span class="o">=</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="o">*</span><span class="n">step</span><span class="o">.</span><span class="n">sigma_x</span><span class="o">*</span><span class="mf">1e6</span><span class="p">,</span><span class="mi">3</span><span class="o">*</span><span class="n">step</span><span class="o">.</span><span class="n">sigma_x</span><span class="o">*</span><span class="mf">1e6</span><span class="p">],</span>
<span class="n">bins</span><span class="o">=</span><span class="mi">150</span><span class="p">,</span>
<span class="n">plot</span><span class="o">=</span><span class="s1">'plot'</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<div class="literal-block-wrapper docutils container" id="id2">
<div class="code-block-caption"><span class="caption-text">Multiple plots.</span><a class="headerlink" href="#id2" title="Permalink to this code">¶</a></div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">fig</span><span class="p">,</span> <span class="n">axs</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplots</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">,</span> <span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mi">4</span><span class="o">*</span><span class="mi">3</span><span class="p">,</span><span class="mi">4</span><span class="o">*</span><span class="mi">2</span><span class="p">),</span> <span class="n">dpi</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">tight_layout</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">fig</span><span class="o">.</span><span class="n">suptitle</span><span class="p">(</span><span class="sa">f</span><span class="s2">"dQ/dE with various options"</span><span class="p">)</span>
<span class="n">H</span><span class="p">,</span> <span class="n">xedges</span> <span class="o">=</span> <span class="n">step</span><span class="o">.</span><span class="n">hist1D</span><span class="p">(</span><span class="s1">'energy_part'</span><span class="p">,</span><span class="n">dx</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span><span class="n">plot</span><span class="o">=</span><span class="s1">'plot'</span><span class="p">,</span><span class="n">ax</span><span class="o">=</span><span class="n">axs</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">])</span>
<span class="n">_</span> <span class="o">=</span> <span class="n">axs</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="sa">f</span><span class="s2">"plot: dx = 1 ($\Delta$E = </span><span class="si">{</span><span class="w"> </span><span class="n">xedges</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="n">xedges</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="w"> </span><span class="si">:</span><span class="s2">.2f</span><span class="si">}</span><span class="s2">)"</span><span class="p">)</span>
<span class="n">H</span><span class="p">,</span> <span class="n">xedges</span> <span class="o">=</span> <span class="n">step</span><span class="o">.</span><span class="n">hist1D</span><span class="p">(</span><span class="s1">'energy_part'</span><span class="p">,</span><span class="n">bins</span><span class="o">=</span><span class="mi">50</span><span class="p">,</span><span class="n">plot</span><span class="o">=</span><span class="s1">'plot'</span><span class="p">,</span><span class="n">ax</span><span class="o">=</span><span class="n">axs</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span><span class="mi">1</span><span class="p">])</span>
<span class="n">_</span> <span class="o">=</span> <span class="n">axs</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="sa">f</span><span class="s2">"plot: bins=50 ($\Delta$E = </span><span class="si">{</span><span class="w"> </span><span class="n">xedges</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="n">xedges</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="w"> </span><span class="si">:</span><span class="s2">.2f</span><span class="si">}</span><span class="s2">)"</span><span class="p">)</span>
<span class="n">H</span><span class="p">,</span> <span class="n">xedges</span> <span class="o">=</span> <span class="n">step</span><span class="o">.</span><span class="n">hist1D</span><span class="p">(</span><span class="s1">'energy_part'</span><span class="p">,</span><span class="n">bins</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span><span class="n">plot</span><span class="o">=</span><span class="s1">'hist'</span><span class="p">,</span><span class="n">ax</span><span class="o">=</span><span class="n">axs</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span><span class="mi">2</span><span class="p">])</span>
<span class="n">_</span> <span class="o">=</span> <span class="n">axs</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span><span class="mi">2</span><span class="p">]</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="sa">f</span><span class="s2">"hist: bins=20 ($\Delta$E = </span><span class="si">{</span><span class="w"> </span><span class="n">xedges</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="n">xedges</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="w"> </span><span class="si">:</span><span class="s2">.2f</span><span class="si">}</span><span class="s2">)"</span><span class="p">)</span>
<span class="n">H</span><span class="p">,</span> <span class="n">xedges</span> <span class="o">=</span> <span class="n">step</span><span class="o">.</span><span class="n">hist1D</span><span class="p">(</span><span class="s1">'energy_part'</span><span class="p">,</span><span class="n">bins</span><span class="o">=</span><span class="mi">50</span><span class="p">,</span><span class="n">plot</span><span class="o">=</span><span class="s1">'lineplot'</span><span class="p">,</span><span class="n">ax</span><span class="o">=</span><span class="n">axs</span><span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">0</span><span class="p">])</span>
<span class="n">_</span> <span class="o">=</span> <span class="n">axs</span><span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="sa">f</span><span class="s2">"lineplot: bins=50"</span><span class="p">)</span>
<span class="n">H</span><span class="p">,</span> <span class="n">xedges</span> <span class="o">=</span> <span class="n">step</span><span class="o">.</span><span class="n">hist1D</span><span class="p">(</span><span class="s1">'energy_part'</span><span class="p">,</span><span class="n">bins</span><span class="o">=</span><span class="mi">40</span><span class="p">,</span><span class="n">plot</span><span class="o">=</span><span class="s1">'histplot'</span><span class="p">,</span><span class="n">ax</span><span class="o">=</span><span class="n">axs</span><span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">])</span>
<span class="n">_</span> <span class="o">=</span> <span class="n">axs</span><span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="sa">f</span><span class="s2">"histplot: bins=50"</span><span class="p">)</span>
<span class="n">H</span><span class="p">,</span> <span class="n">xedges</span> <span class="o">=</span> <span class="n">step</span><span class="o">.</span><span class="n">hist1D</span><span class="p">(</span><span class="s1">'energy_part'</span><span class="p">,</span><span class="n">dx</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span><span class="n">plot</span><span class="o">=</span><span class="s1">'histplot'</span><span class="p">,</span><span class="n">ax</span><span class="o">=</span><span class="n">axs</span><span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">])</span>
<span class="n">_</span> <span class="o">=</span> <span class="n">axs</span><span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">]</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="sa">f</span><span class="s2">"histplot: dx=1"</span><span class="p">)</span>
</pre></div>
</div>
</div>
<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>xname</strong> (<em>str</em>) – Name of the beam value for the x axis (e.g. “x”,”uy”,”energy_part”,…)</p></li>
<li><p><strong>xconv</strong> (<em>str</em><em>, </em><em>optional</em>) – Unit wanted for the x axis. Defaults to None.</p></li>
<li><p><strong>xrange</strong> (<em>list</em><em>, </em><em>optional</em>) – Range [min, max] of the data. Defaults to [None,None].</p></li>
<li><p><strong>bins</strong> (<em>int</em><em>, </em><em>optional</em>) – Number of bins used. Defaults to 100.</p></li>
<li><p><strong>dx</strong> (<em>float</em><em>, </em><em>optional</em>) – Step in x wanted. <strong>Modify bins</strong>. Defaults to None.</p></li>
<li><p><strong>plot</strong> (<em>str</em><em>, </em><em>optional</em>) – Type of plot wanted. Defaults to None.</p></li>
<li><p><strong>ax</strong> (<em>matplotlib.pyplot.axes</em><em>, </em><em>optional</em>) – matplotlib.pyplot.axes object for plots. Defaults to None.
If None, but plot != None, will create a new figure with its own ax.</p></li>
<li><p><strong>yaxis</strong> (<em>str</em><em>, </em><em>optional</em>) – Set the y axis. Defaults to ‘charge’.</p></li>
<li><p><strong>**kwargs</strong> (<em>List</em><em> of </em><em>properties</em>) – <ul>
<li><p>linestyle (str): Defaults to “-“.</p></li>
</ul>
</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><ul class="simple">
<li><p><strong>hist (float)</strong> (<em>array</em>) – The values of the histogram. See density and weights for a description of the possible semantics.</p></li>
<li><p><strong>bin_edges (float)</strong> (<em>array of dtype float</em>) – Return the bin edges (length(hist)+1).</p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="installation.html" class="btn btn-neutral float-left" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2023, Damien Minenna.</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>