-
Notifications
You must be signed in to change notification settings - Fork 28
/
Copy pathmask.html
182 lines (157 loc) · 12.8 KB
/
mask.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
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Mask an object, typically to produce a copy with some values zeroed out — mask • nat</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Mask an object, typically to produce a copy with some values zeroed out — mask"><meta property="og:description" content="Mask an object, typically to produce a copy with some values zeroed out"><meta property="og:image" content="/logo.svg"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]--></head><body data-spy="scroll" data-target="#toc">
<div class="container template-reference-topic">
<header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">nat</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">1.10.4</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav"><li>
<a href="../index.html">
<span class="fa fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
Articles
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu"><li>
<a href="../articles/neurons-intro.html">Introduction to neurons and neuronlists</a>
</li>
<li>
<a href="../articles/neurons-as-graph.html">Working with individual neurons as graph structures</a>
</li>
<li>
<a href="../articles/plotly.html">3D graphics</a>
</li>
<li>
<a href="../articles/NeuroGeometry.html">NeuroGeometry: Analysing 3D morphology of neurons</a>
</li>
</ul></li>
<li>
<a href="../articles/Installation.html">Installation</a>
</li>
<li>
<a href="../index.html#learn">Learn</a>
</li>
<li>
<a href="../index.html#help">Help</a>
</li>
<li>
<a href="../news/index.html">Changelog</a>
</li>
</ul><ul class="nav navbar-nav navbar-right"><li>
<a href="https://natverse.github.io" class="external-link">natverse</a>
</li>
<li>
<a href="https://github.com/natverse/nat" class="external-link">
<span class="fa fa-github fa-lg"></span>
</a>
</li>
</ul></div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header><div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Mask an object, typically to produce a copy with some values zeroed out</h1>
<small class="dont-index">Source: <a href="https://github.com/natverse/nat/blob/HEAD/R/im3d.R" class="external-link"><code>R/im3d.R</code></a></small>
<div class="hidden name"><code>mask.Rd</code></div>
</div>
<div class="ref-description">
<p>Mask an object, typically to produce a copy with some values zeroed out</p>
</div>
<div id="ref-usage">
<div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">mask</span><span class="op">(</span><span class="va">x</span>, <span class="va">...</span><span class="op">)</span>
<span class="co"># S3 method for im3d</span>
<span class="fu">mask</span><span class="op">(</span><span class="va">x</span>, <span class="va">mask</span>, levels <span class="op">=</span> <span class="cn">NULL</span>, rval <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"im3d"</span>, <span class="st">"values"</span><span class="op">)</span>, invert <span class="op">=</span> <span class="cn">FALSE</span>, <span class="va">...</span><span class="op">)</span></code></pre></div>
</div>
<div id="arguments">
<h2>Arguments</h2>
<dl><dt>x</dt>
<dd><p>Object to be masked</p></dd>
<dt>...</dt>
<dd><p>Additional arguments passed to methods</p></dd>
<dt>mask</dt>
<dd><p>An im3d object, an array or a vector with dimensions compatible
with x.</p></dd>
<dt>levels</dt>
<dd><p>Optional numeric vector of pixel values or character vector
defining named <code><a href="materials.html">materials</a></code>.</p></dd>
<dt>rval</dt>
<dd><p>Whether to return an im3d object based on <code>x</code> or just the
values from <code>x</code> matching the mask.</p></dd>
<dt>invert</dt>
<dd><p>Whether to invert the voxel selection (default <code>FALSE</code>)</p></dd>
</dl></div>
<div id="value">
<h2>Value</h2>
<p>an object with attributes matching <code>x</code> and elements with value
<code>as.vector(TRUE, mode=mode)</code> i.e. <code>TRUE, 1, 0x01</code> and
<code>as.vector(FALSE, mode=mode)</code> i.e. <code>FALSE, 0, 0x00</code> as
appropriate.
A copy of x with</p>
</div>
<div id="details">
<h2>Details</h2>
<p>Note that <code>mask.im3d</code> passes ... arguments on to <code>im3d</code></p>
</div>
<div id="see-also">
<h2>See also</h2>
<div class="dont-index"><p>Other im3d:
<code><a href="as.im3d.html">as.im3d</a>()</code>,
<code><a href="boundingbox.html">boundingbox</a>()</code>,
<code><a href="im3d-coords.html">im3d-coords</a></code>,
<code><a href="im3d-io.html">im3d-io</a></code>,
<code><a href="im3d.html">im3d</a>()</code>,
<code><a href="imexpand.grid.html">imexpand.grid</a>()</code>,
<code><a href="imslice.html">imslice</a>()</code>,
<code><a href="is.im3d.html">is.im3d</a>()</code>,
<code><a href="origin.html">origin</a>()</code>,
<code><a href="projection.html">projection</a>()</code>,
<code><a href="threshold.html">threshold</a>()</code>,
<code><a href="unmask.html">unmask</a>()</code>,
<code><a href="voxdims.html">voxdims</a>()</code></p></div>
</div>
<div id="ref-examples">
<h2>Examples</h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="va">x</span><span class="op">=</span><span class="fu"><a href="im3d.html">im3d</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/array.html" class="external-link">array</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/stats/Normal.html" class="external-link">rnorm</a></span><span class="op">(</span><span class="fl">1000</span><span class="op">)</span>,dim<span class="op">=</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">10</span>,<span class="fl">10</span>,<span class="fl">10</span><span class="op">)</span><span class="op">)</span>, BoundingBox<span class="op">=</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">20</span>,<span class="fl">200</span>,<span class="fl">100</span>,<span class="fl">200</span>,<span class="fl">200</span>,<span class="fl">300</span><span class="op">)</span><span class="op">)</span></span>
<span class="r-in"><span class="va">m</span><span class="op">=</span><span class="fu"><a href="https://rdrr.io/r/base/array.html" class="external-link">array</a></span><span class="op">(</span><span class="fl">1</span><span class="op">:</span><span class="fl">5</span>,dim<span class="op">=</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">10</span>,<span class="fl">10</span>,<span class="fl">10</span><span class="op">)</span><span class="op">)</span></span>
<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/graphics/image.html" class="external-link">image</a></span><span class="op">(</span><span class="va">x</span><span class="op">[</span>,,<span class="fl">1</span><span class="op">]</span><span class="op">)</span></span>
<span class="r-plt img"><img src="mask-1.png" alt="" width="700" height="433"></span>
<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/graphics/image.html" class="external-link">image</a></span><span class="op">(</span><span class="fu">mask</span><span class="op">(</span><span class="va">x</span>, mask<span class="op">=</span><span class="va">m</span>, levels<span class="op">=</span><span class="fl">1</span><span class="op">)</span><span class="op">[</span>,,<span class="fl">1</span><span class="op">]</span><span class="op">)</span></span>
<span class="r-plt img"><img src="mask-2.png" alt="" width="700" height="433"></span>
<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/graphics/image.html" class="external-link">image</a></span><span class="op">(</span><span class="fu">mask</span><span class="op">(</span><span class="va">x</span>, mask<span class="op">=</span><span class="va">m</span>, levels<span class="op">=</span><span class="fl">1</span><span class="op">:</span><span class="fl">2</span><span class="op">)</span><span class="op">[</span>,,<span class="fl">1</span><span class="op">]</span><span class="op">)</span></span>
<span class="r-plt img"><img src="mask-3.png" alt="" width="700" height="433"></span>
</code></pre></div>
</div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
<nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
</nav></div>
</div>
<footer><div class="copyright">
<p></p><p>Developed by Gregory Jefferis, James Manton, Sridhar Jagannathan.</p>
</div>
<div class="pkgdown">
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.1.</p>
</div>
</footer></div>
</body></html>