-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathboxkit.api._create.html
More file actions
179 lines (162 loc) · 8.5 KB
/
boxkit.api._create.html
File metadata and controls
179 lines (162 loc) · 8.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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>boxkit.api._create module — BoxKit 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/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.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="next" title="boxkit.api._mean module" href="boxkit.api._mean.html" />
<link rel="prev" title="boxkit.api package" href="boxkit.api.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"> BoxKit
</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" />
<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">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="README.html"> BoxKit</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="boxkit.html">boxkit package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="boxkit.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="boxkit.api.html">boxkit.api package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="boxkit.api.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="boxkit.library.html">boxkit.library package</a></li>
<li class="toctree-l3"><a class="reference internal" href="boxkit.resources.html">boxkit.resources package</a></li>
</ul>
</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">BoxKit</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"></a> »</li>
<li><a href="boxkit.html">boxkit package</a> »</li>
<li><a href="boxkit.api.html">boxkit.api package</a> »</li>
<li>boxkit.api._create module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/boxkit.api._create.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">
<div class="section" id="module-boxkit.api._create">
<span id="boxkit-api-create-module"></span><h1>boxkit.api._create module<a class="headerlink" href="#module-boxkit.api._create" title="Permalink to this headline"></a></h1>
<p>Module with implemenetation of api methods</p>
<dl class="py function">
<dt class="sig sig-object py" id="boxkit.api._create.create_dataset">
<span class="sig-prename descclassname"><span class="pre">boxkit.api._create.</span></span><span class="sig-name descname"><span class="pre">create_dataset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">storage</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="o"><span class="pre">**</span></span><span class="n"><span class="pre">attributes</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#boxkit.api._create.create_dataset" title="Permalink to this definition"></a></dt>
<dd><p>Create a dataset from a file</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>Dataset object</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="boxkit.api._create.create_region">
<span class="sig-prename descclassname"><span class="pre">boxkit.api._create.</span></span><span class="sig-name descname"><span class="pre">create_region</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">attributes</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#boxkit.api._create.create_region" title="Permalink to this definition"></a></dt>
<dd><p>Create a region from a dataset</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dataset</strong> (<em>Dataset object</em>) – </p></li>
<li><p><strong>attributes</strong> (<em>dictionary of attributes</em>) – <dl class="simple">
<dt>{ ‘xmin’<span class="classifier">low x bound</span></dt><dd><p>’ymin’ : low y bound
‘zmin’ : low z bound
‘xmax’ : high x bound
‘ymax’ : high y bound
‘zmax’ : high z bound }</p>
</dd>
</dl>
</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Region object</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="boxkit.api._create.create_slice">
<span class="sig-prename descclassname"><span class="pre">boxkit.api._create.</span></span><span class="sig-name descname"><span class="pre">create_slice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">attributes</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#boxkit.api._create.create_slice" title="Permalink to this definition"></a></dt>
<dd><p>Create a slice from a dataset</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dataset</strong> (<em>Dataset object</em>) – </p></li>
<li><p><strong>attributes</strong> (<em>dictionary of attributes</em>) – <dl class="simple">
<dt>{ ‘xmin’<span class="classifier">low x bound</span></dt><dd><p>’ymin’ : low y bound
‘zmin’ : low z bound
‘xmax’ : high x bound
‘ymax’ : high y bound
‘zmax’ : high z bound }</p>
</dd>
</dl>
</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Slice object</p>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="boxkit.api.html" class="btn btn-neutral float-left" title="boxkit.api package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="boxkit.api._mean.html" class="btn btn-neutral float-right" title="boxkit.api._mean module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2022, Akash Dhruv.</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>