scikit-image.github.com/search.html at main · scikit-image/scikit-image.github.com · GitHub

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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300


<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Search &mdash; scikit-image</title>


    <!-- Ubuntu font for logo -->
    <link rel="preconnect" href="https://fonts.googleapis.com">
    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
    <link href="https://fonts.googleapis.com/css2?family=Ubuntu:wght@300;400&display=swap" rel="stylesheet">

    <!-- Bootstrap 5.3.3 CSS -->
    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css"
          rel="stylesheet"
          integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH"
          crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=b72b686c" />
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=658c1930" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=658c1930" />
    <link rel="search" title="Search" href="#" />
    <link rel="top" title="scikit-image" href="index.html" />
    <link rel="shortcut icon" href="_static/favicon.ico">
</head>
<body>
    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT: './',
            VERSION: '',
            COLLAPSE_INDEX: false,
            FILE_SUFFIX: '.html',
            HAS_SOURCE: true
              };
    </script>

    <!-- Skip to main content link for accessibility -->
    <a href="#main-content" class="visually-hidden-focusable skip-link">Skip to main content</a>

    <div class="container">
        <header>
            <a href="https://scikit-image.org" class="logo" aria-label="scikit-image home">
                <img src="_static/img/logo.png" alt="">
                <span class="logo-text">
                    <span class="logo-title">scikit-image</span>
                    <span class="logo-tagline">Image processing in Python</span>
                </span>
            </a>

            <!-- Navigation -->
            <nav class="navbar navbar-expand-lg" aria-label="Main navigation">
                <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNav"
                        aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
                    <span class="navbar-toggler-icon"></span>
                </button>
                <div class="collapse navbar-collapse" id="navbarNav">
                    <ul class="navbar-nav me-auto mb-2 mb-lg-0">
                        <li class="nav-item"><a class="nav-link" href="/docs/stable/user_guide/install.html">Installation</a></li>
<li class="nav-item"><a class="nav-link" href="/docs/stable/auto_examples">Gallery</a></li>
<li class="nav-item"><a class="nav-link" href="/docs/stable">Documentation</a></li>
<li class="nav-item"><a class="nav-link" href="community_guidelines.html">Community</a></li>
<li class="nav-item">
    <a class="nav-link" href="https://github.com/scikit-image/scikit-image">
        <img src="_static/GitHub-Mark-32px.png" alt="GitHub" class="github-icon" loading="lazy">
        Source
    </a>
</li>

                    </ul>
                    <form class="d-flex search-form" action="/docs/stable/search.html" method="get" role="search">
                        <input class="form-control me-2" type="search" name="q" placeholder="Search documentation..."
                               aria-label="Search documentation">
                        <input type="hidden" name="check_keywords" value="yes">
                        <input type="hidden" name="area" value="default">
                        <button class="btn btn-outline-primary" type="submit">Search</button>
                    </form>
                </div>
            </nav>
        </header>

        <!-- Main content area -->
        <div class="row g-4">
            <aside class="col-lg-3 sidebar order-2 order-lg-1" aria-label="Sidebar navigation"><script type="module">
 import { Octokit } from "https://esm.sh/octokit";

 const octokit = new Octokit();
 const month_names = ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"];

 function notRc(release) {
   return !release.tag_name.includes('rc');
 }

 try {
   const releases = await octokit.rest.repos.listReleases({
     owner: 'scikit-image',
     repo: 'scikit-image',
     per_page: 5,
     page: 1
   });

   const release = releases.data.find(r => !r.draft && !r.prerelease && notRc(r));
   if (release && release.published_at) {
     const tag = release.tag_name;
     const stable_version = tag.slice(1);

     const date = release.published_at;
     const year = date.substring(0, 4);
     const month = date.substring(5, 7);

     document.getElementById('stable-version').textContent =
       stable_version + " - " + month_names[parseInt(month)-1] + " " + year;

     const stable_version_majmin = stable_version.split(".").slice(0,2).join(".");
     const releaseNotesLink = document.getElementById('release-notes');
     const release_notes_url = releaseNotesLink.getAttribute('href') + "/release_" + stable_version_majmin + ".rst";
     releaseNotesLink.setAttribute('href', release_notes_url);

     let dev_version = stable_version.split(".").map(Number);
     dev_version[1] += 1;
     dev_version = dev_version.slice(0, 2).join(".");

     document.getElementById('dev-version').textContent = "pre-" + dev_version;
   } else {
     console.warn('No eligible non-RC releases found');
   }
 } catch (error) {
   console.error('Failed to fetch release information:', error);
 }
</script>


<div class="card sidebar-box">
    <div class="card-body">
        <strong>Stable</strong>
        (<a href="https://github.com/scikit-image/scikit-image/tree/main/doc/source/release_notes" id="release-notes">release notes</a>)
        <p id="stable-version">x.y.z</p>

        <a class="btn btn-sm btn-primary" href="https://scikit-image.org/docs/stable/user_guide/install.html#installation-via-pip-and-conda">
            <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-download" viewBox="0 0 16 16" aria-hidden="true">
                <path d="M.5 9.9a.5.5 0 0 1 .5.5v2.5a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1v-2.5a.5.5 0 0 1 1 0v2.5a2 2 0 0 1-2 2H2a2 2 0 0 1-2-2v-2.5a.5.5 0 0 1 .5-.5z"/>
                <path d="M7.646 11.854a.5.5 0 0 0 .708 0l3-3a.5.5 0 0 0-.708-.708L8.5 10.293V1.5a.5.5 0 0 0-1 0v8.793L5.354 8.146a.5.5 0 1 0-.708.708l3 3z"/>
            </svg>
            Download
        </a>

        <br/><br/>
        <strong>Development</strong>
        <p id="dev-version">pre-x.y.z</p>
        <a class="btn btn-sm btn-outline-primary" href="https://scikit-image.org/docs/stable/user_guide/install.html#installing-scikit-image-for-contributors">
            <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-download" viewBox="0 0 16 16" aria-hidden="true">
                <path d="M.5 9.9a.5.5 0 0 1 .5.5v2.5a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1v-2.5a.5.5 0 0 1 1 0v2.5a2 2 0 0 1-2 2H2a2 2 0 0 1-2-2v-2.5a.5.5 0 0 1 .5-.5z"/>
                <path d="M7.646 11.854a.5.5 0 0 0 .708 0l3-3a.5.5 0 0 0-.708-.708L8.5 10.293V1.5a.5.5 0 0 0-1 0v8.793L5.354 8.146a.5.5 0 1 0-.708.708l3 3z"/>
            </svg>
            Download
        </a>
    </div>
</div><div class="card sidebar-box">
    <ul class="nav flex-column">
      <li class="nav-item">
        <a class="nav-link"
           href="https://github.com/scikit-image/scikit-image"
           aria-label="GitHub repository">
          <strong>GitHub</strong>
          <span class="sidebar-subtitle">source &amp; bug reports</span>
        </a>
      </li>
      <li class="nav-item">
        <a class="nav-link"
           href="https://scikit-image.org/docs/stable/development/contribute.html"
           aria-label="Contribution guide">
          <strong>Contribute</strong>
          <span class="sidebar-subtitle">get involved</span>
        </a>
      </li>
      <li class="nav-item">
        <a class="nav-link"
           href="https://forum.image.sc/tags/scikit-image"
           aria-label="Community forum">
          <strong>Get Help</strong>
          <span class="sidebar-subtitle">advice &amp; community</span>
        </a>
      </li>
      <li class="nav-item">
        <a class="nav-link"
           href="https://discuss.scientific-python.org/c/contributor/skimage"
           aria-label="Contributor discussions">
          <strong>Discuss</strong>
          <span class="sidebar-subtitle">contributor talk</span>
        </a>
      </li>
      <li class="nav-item">
        <a class="nav-link"
           href="https://stackoverflow.com/questions/tagged/scikit-image"
           aria-label="Stack Overflow questions">
          <strong>StackOverflow</strong>
          <span class="sidebar-subtitle">coding help</span>
        </a>
      </li>
    </ul>
</div>

<div class="text-center py-3">
  <a href="https://opencollective.com/scikit-image"
     target="_blank"
     rel="noopener noreferrer"
     aria-label="Donate via Open Collective">
    <img src="https://opencollective.com/scikit-image/donate/button@2x.png?color=white"
         alt="Donate button"
         width="300"
         loading="lazy">
  </a>
</div>

<div class="text-center py-2">
  <a href="https://github.com/scikit-image/scikit-image"
     target="_blank"
     rel="noopener noreferrer"
     aria-label="Star scikit-image on GitHub">
    <img src="https://img.shields.io/github/stars/scikit-image/scikit-image?style=for-the-badge&logo=github&color=CE5C00&labelColor=CE5C00&logoColor=white"
         alt="GitHub stars"
         height="35"
         loading="lazy">
  </a>
</div>
            </aside>
            <main class="col-lg-9 order-1 order-lg-2" id="main-content" tabindex="-1">

  <h1 id="search-documentation">Search</h1>
  <div id="fallback" class="admonition warning">
  <script type="text/javascript">
    $('#fallback').hide();
    $("input.search").focus();
  </script>
  <p>
    Please activate JavaScript to enable the search
    functionality.
  </p>
  </div>
  <p>
    From here you can search these documents. Enter your search
    words into the box in the navigation bar and press "Enter". Note that the
    search function will automatically search for all of the words. Pages
    containing fewer words won't appear in the result list.
  </p>

  <div id="search-results">

  </div>

            </main>
        </div>

        <!-- Footer -->
        <footer class="footer mt-5">
            <div class="footer-content">
                <div class="footer-brand">
                    <a href="https://scikit-image.org" class="footer-logo" aria-label="scikit-image home">
                        <img src="_static/img/logo.png" alt="" width="40" height="40">
                        <span>scikit-image</span>
                    </a>
                    <p class="footer-tagline">Image processing in Python</p>
                </div>

                <div class="footer-meta">
                    <small>&copy; scikit-image development team. Built with <a href="https://sphinx.pocoo.org/">Sphinx</a>.</small>
                </div>

                <div class="footer-social">
                    <span class="footer-social-text">This project is part of the<br>scientific Python ecosystem</span>
                    <a href="https://scientific-python.org" aria-label="Scientific Python" title="Scientific Python">
                        <img src="https://cdn.jsdelivr.net/gh/scientific-python/scientific-python.org@main/static/images/logo.svg"
                             alt="Scientific Python" height="45">
                    </a>
                </div>
            </div>
        </footer>
    </div>

    <!-- Chat button -->
    <div class="chatbutton">
        <a href="https://skimage.zulipchat.com" aria-label="Open Zulip chat">
            <svg xmlns="http://www.w3.org/2000/svg" viewBox="206.45 186.81 360.21 400.49" class="chatbutton-logo" aria-hidden="true">
                <path d="M566.66 527.25c0 33.03-24.23 60.05-53.84 60.05H260.29c-29.61 0-53.84-27.02-53.84-60.05 0-20.22 9.09-38.2 22.93-49.09l134.37-120c2.5-2.14 5.74 1.31 3.94 4.19l-49.29 98.69c-1.38 2.76.41 6.16 3.25 6.16h191.18c29.61 0 53.83 27.03 53.83 60.05zm0-281.39c0 20.22-9.09 38.2-22.93 49.09l-134.37 120c-2.5 2.14-5.74-1.31-3.94-4.19l49.29-98.69c1.38-2.76-.41-6.16-3.25-6.16H260.29c-29.61 0-53.84-27.02-53.84-60.05s24.23-60.05 53.84-60.05h252.54c29.61 0 53.83 27.02 53.83 60.05z" fill="currentColor"/>
            </svg>
            Open Chat
        </a>
    </div>

    <!-- Bootstrap 5.3.3 JS Bundle (includes Popper) -->
    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js"
            integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz"
            crossorigin="anonymous"></script>
</body>
</html>