-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathhist_tools.html
More file actions
265 lines (181 loc) · 15.5 KB
/
Copy pathhist_tools.html
File metadata and controls
265 lines (181 loc) · 15.5 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
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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>astroML.plotting.hist_tools — astroML 1.0 documentation</title>
<link href="../../../_static/css/theme.css" rel="stylesheet" />
<link href="../../../_static/css/index.c5995385ac14fb8791e8eb36b4908be2.css" rel="stylesheet" />
<link rel="stylesheet"
href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/basic.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../../_static/togglebutton.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/mystnb.css" />
<link rel="preload" as="script" href="../../../_static/js/index.1c5a1a01449ed65a7b51.js">
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/togglebutton.js"></script>
<script >var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
<link rel="shortcut icon" href="../../../_static/favicon.ico"/>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en" />
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
<div class="container-fluid" id="banner"></div>
<nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main"><div class="container-xl">
<div id="navbar-start">
<a class="navbar-brand" href="../../../index.html">
<img src="../../../_static/Logo.gif" class="logo" alt="logo">
</a>
</div>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-collapsible" aria-controls="navbar-collapsible" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar-collapsible" class="col-lg-9 collapse navbar-collapse">
<div id="navbar-center" class="mr-auto">
<div class="navbar-center-item">
<ul id="navbar-main-elements" class="navbar-nav">
<li class="toctree-l1 nav-item">
<a class="reference internal nav-link" href="../../../user_guide/index.html">
User Guide
</a>
</li>
<li class="toctree-l1 nav-item">
<a class="reference internal nav-link" href="../../../examples/index.html">
General astroML Examples
</a>
</li>
<li class="toctree-l1 nav-item">
<a class="reference internal nav-link" href="../../../development/index.html">
Development
</a>
</li>
<li class="nav-item">
<a class="nav-link nav-external" href="https://astroml.org/astroML-notebooks">Notebooks<i class="fas fa-external-link-alt"></i></a>
</li>
<li class="nav-item">
<a class="nav-link nav-external" href="http://www.astroml.org/book_figures/index.html">Book Figures<i class="fas fa-external-link-alt"></i></a>
</li>
</ul>
</div>
</div>
<div id="navbar-end">
<div class="navbar-end-item">
<ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
</ul>
</div>
</div>
</div>
</div>
</nav>
<div class="container-xl">
<div class="row">
<!-- Only show if we have sidebars configured, else just a small margin -->
<div class="col-12 col-md-3 bd-sidebar"><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
</form><nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
<div class="bd-toc-item active">
</div>
</nav>
</div>
<div class="d-none d-xl-block col-xl-2 bd-toc">
</div>
<main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
<div>
<h1>Source code for astroML.plotting.hist_tools</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">warnings</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">from</span> <span class="nn">astropy.stats</span> <span class="kn">import</span> <span class="p">(</span><span class="n">scott_bin_width</span><span class="p">,</span> <span class="n">freedman_bin_width</span><span class="p">,</span>
<span class="n">knuth_bin_width</span><span class="p">,</span> <span class="n">bayesian_blocks</span><span class="p">)</span>
<span class="kn">from</span> <span class="nn">astroML.utils</span> <span class="kn">import</span> <span class="n">deprecated</span>
<span class="kn">from</span> <span class="nn">astroML.utils.exceptions</span> <span class="kn">import</span> <span class="n">AstroMLDeprecationWarning</span>
<div class="viewcode-block" id="hist"><a class="viewcode-back" href="../../../modules/generated/astroML.plotting.hist.html#astroML.plotting.hist">[docs]</a><span class="nd">@deprecated</span><span class="p">(</span><span class="s1">'0.4'</span><span class="p">,</span> <span class="n">alternative</span><span class="o">=</span><span class="s1">'astropy.visualization.hist'</span><span class="p">,</span>
<span class="n">warning_type</span><span class="o">=</span><span class="n">AstroMLDeprecationWarning</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">hist</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">bins</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="nb">range</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""Enhanced histogram</span>
<span class="sd"> This is a histogram function that enables the use of more sophisticated</span>
<span class="sd"> algorithms for determining bins. Aside from the `bins` argument allowing</span>
<span class="sd"> a string specified how bins are computed, the parameters are the same</span>
<span class="sd"> as pylab.hist().</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> x : array_like</span>
<span class="sd"> array of data to be histogrammed</span>
<span class="sd"> bins : int or list or str (optional)</span>
<span class="sd"> If bins is a string, then it must be one of:</span>
<span class="sd"> 'blocks' : use bayesian blocks for dynamic bin widths</span>
<span class="sd"> 'knuth' : use Knuth's rule to determine bins</span>
<span class="sd"> 'scott' : use Scott's rule to determine bins</span>
<span class="sd"> 'freedman' : use the Freedman-diaconis rule to determine bins</span>
<span class="sd"> range : tuple or None (optional)</span>
<span class="sd"> the minimum and maximum range for the histogram. If not specified,</span>
<span class="sd"> it will be (x.min(), x.max())</span>
<span class="sd"> ax : Axes instance (optional)</span>
<span class="sd"> specify the Axes on which to draw the histogram. If not specified,</span>
<span class="sd"> then the current active axes will be used.</span>
<span class="sd"> **kwargs :</span>
<span class="sd"> other keyword arguments are described in pylab.hist().</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">bins</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="s2">"weights"</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">"weights argument is not supported: it will be ignored."</span><span class="p">)</span>
<span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'weights'</span><span class="p">)</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
<span class="k">if</span> <span class="s1">'ax'</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">:</span>
<span class="n">ax</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'ax'</span><span class="p">]</span>
<span class="k">del</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'ax'</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># import here so that testing with Agg will work</span>
<span class="kn">from</span> <span class="nn">matplotlib</span> <span class="kn">import</span> <span class="n">pyplot</span> <span class="k">as</span> <span class="n">plt</span>
<span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">gca</span><span class="p">()</span>
<span class="c1"># if range is specified, we need to truncate the data for</span>
<span class="c1"># the bin-finding routines</span>
<span class="k">if</span> <span class="p">(</span><span class="nb">range</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="p">(</span><span class="n">bins</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'blocks'</span><span class="p">,</span>
<span class="s1">'knuth'</span><span class="p">,</span> <span class="s1">'knuths'</span><span class="p">,</span>
<span class="s1">'scott'</span><span class="p">,</span> <span class="s1">'scotts'</span><span class="p">,</span>
<span class="s1">'freedman'</span><span class="p">,</span> <span class="s1">'freedmans'</span><span class="p">])):</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">x</span><span class="p">[(</span><span class="n">x</span> <span class="o">>=</span> <span class="nb">range</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">&</span> <span class="p">(</span><span class="n">x</span> <span class="o"><=</span> <span class="nb">range</span><span class="p">[</span><span class="mi">1</span><span class="p">])]</span>
<span class="k">if</span> <span class="n">bins</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'blocks'</span><span class="p">]:</span>
<span class="n">bins</span> <span class="o">=</span> <span class="n">bayesian_blocks</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">bins</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'knuth'</span><span class="p">,</span> <span class="s1">'knuths'</span><span class="p">]:</span>
<span class="n">dx</span><span class="p">,</span> <span class="n">bins</span> <span class="o">=</span> <span class="n">knuth_bin_width</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">bins</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'scott'</span><span class="p">,</span> <span class="s1">'scotts'</span><span class="p">]:</span>
<span class="n">dx</span><span class="p">,</span> <span class="n">bins</span> <span class="o">=</span> <span class="n">scott_bin_width</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">bins</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'freedman'</span><span class="p">,</span> <span class="s1">'freedmans'</span><span class="p">]:</span>
<span class="n">dx</span><span class="p">,</span> <span class="n">bins</span> <span class="o">=</span> <span class="n">freedman_bin_width</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">bins</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"unrecognized bin code: '</span><span class="si">{}</span><span class="s2">'"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">bins</span><span class="p">))</span>
<span class="k">return</span> <span class="n">ax</span><span class="o">.</span><span class="n">hist</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">bins</span><span class="p">,</span> <span class="nb">range</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
</pre></div>
</div>
<div class='prev-next-bottom'>
</div>
</main>
</div>
</div>
<script src="../../../_static/js/index.1c5a1a01449ed65a7b51.js"></script>
<footer class="footer mt-5 mt-md-0">
<div class="container">
<div class="footer-item">
<p class="copyright">
© Copyright 2012-2021, Jake Vanderplas & AstroML Developers.<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.<br/>
</p>
</div>
</div>
</footer>
</body>
</html>