-
Notifications
You must be signed in to change notification settings - Fork 0
/
SLC_8h_source.html
183 lines (181 loc) · 17.5 KB
/
SLC_8h_source.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>isce3: isce/cxx/isce3/matchtemplate/ampcor/dom/SLC.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">isce3
 <span id="projectnumber">0.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="sphinx/html/index.html"><span>Python classes</span></a></li>
<li><a href="https://github-fn.jpl.nasa.gov/isce-3/isce/issues/"><span>Issue Tracker</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_404e96cc334514cbeb4d3a6830fc20a4.html">isce</a></li><li class="navelem"><a class="el" href="dir_242328b4dda42afcab822a3a2c9e5d23.html">cxx</a></li><li class="navelem"><a class="el" href="dir_25ad1bde3345b7504bdf331e9ef506fd.html">isce3</a></li><li class="navelem"><a class="el" href="dir_3a7ced93bc3f391c73fcfc96dbf225b8.html">matchtemplate</a></li><li class="navelem"><a class="el" href="dir_6b1d7afc217261ee8610b73936a681d7.html">ampcor</a></li><li class="navelem"><a class="el" href="dir_a819ea436fe4e9172c51ba0634f4d246.html">dom</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">SLC.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// -*- C++ -*-</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// -*- coding: utf-8 -*-</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// michael a.g. aïvázis <michael.aivazis@para-sim.com></span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// parasim</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// (c) 1998-2019 all rights reserved</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// externals</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <complex></span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// encapsulation of SLC raster images</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classampcor_1_1dom_1_1SLC.html"> 14</a></span> <span class="keyword">class </span><a class="code" href="classampcor_1_1dom_1_1SLC.html">ampcor::dom::SLC</a> : <span class="keyword">public</span> <a class="code" href="classampcor_1_1dom_1_1Raster.html">ampcor::dom::Raster</a> {</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  <span class="comment">// types</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="comment">// for sizing things</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keyword">using</span> size_type = size_t; <span class="comment">// from ampcor::dom</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="comment">// filenames</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keyword">using</span> uri_type = uri_t;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="comment">// my cell type</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">using</span> cell_type = std::complex<float>;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="comment">// my pixel</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keyword">using</span> pixel_type = cell_type;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="comment">// my grid</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">using</span> grid_type = constmmap_t<2, pixel_type>;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="comment">// my layout type</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">using</span> layout_type = grid_type::layout_type;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="comment">// my slice type</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">using</span> slice_type = grid_type::slice_type;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="comment">// my index type</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">using</span> index_type = grid_type::index_type;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// my shape type</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">using</span> shape_type = grid_type::shape_type;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="comment">// my view type</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">using</span> view_type = grid_type::view_type;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// my constview type</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">using</span> constview_type = grid_type::constview_type;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">// interface</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// access to my layout</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">inline</span> <span class="keyword">auto</span> layout() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// the number of pixels</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">inline</span> <span class="keyword">auto</span> pixels() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// my memory footprint</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">inline</span> <span class="keyword">auto</span> size() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// the size of my pixel</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">inline</span> <span class="keyword">static</span> constexpr <span class="keyword">auto</span> pixelSize();</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// the location of the data buffer</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">inline</span> <span class="keyword">auto</span> data() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// data access</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keyword">auto</span> & operator[](size_type offset) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keyword">auto</span> & operator[](<span class="keyword">const</span> index_type & index) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// support for iterating over my data</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">inline</span> <span class="keyword">auto</span> view();</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">inline</span> <span class="keyword">auto</span> view(<span class="keyword">const</span> slice_type & slice);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">inline</span> <span class="keyword">auto</span> view() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">inline</span> <span class="keyword">auto</span> view(<span class="keyword">const</span> slice_type & slice) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">inline</span> <span class="keyword">auto</span> constview(<span class="keyword">const</span> slice_type & slice) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// meta-methods</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">virtual</span> ~<a class="code" href="classampcor_1_1dom_1_1SLC.html">SLC</a>();</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">inline</span> <a class="code" href="classampcor_1_1dom_1_1SLC.html">SLC</a>(uri_type filename, shape_type shape);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// implementation details: data</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  grid_type _grid;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> };</div>
<div class="ttc" id="classampcor_1_1dom_1_1SLC_html"><div class="ttname"><a href="classampcor_1_1dom_1_1SLC.html">ampcor::dom::SLC</a></div><div class="ttdef"><b>Definition:</b> SLC.h:14</div></div>
<div class="ttc" id="classampcor_1_1dom_1_1Raster_html"><div class="ttname"><a href="classampcor_1_1dom_1_1Raster.html">ampcor::dom::Raster</a></div><div class="ttdef"><b>Definition:</b> Raster.h:11</div></div>
</div><!-- fragment --></div><!-- contents -->
<hr>
Generated for ISCE3.0 by
<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.8.5.
</body>
</html>