wassname/scikit-image
1
0
Fork 0
mirror of https://github.com/wassname/scikit-image.git synced 2026-07-22 13:00:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge Tony's documentation enhancements.

Browse Source
This commit is contained in:
Stefan van der Walt
2011-07-18 18:29:00 -07:00
parent 16e5456def 1f31141837
commit 93744fcdec
5 changed files with 69 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/source/_templates/index.html
-88
View File
@@ -1,88 +0,0 @@
{% extends "layout.html" %}
{% set title = 'Home' %}
{% block body %}
<h1>{{ docstitle }}</h1>
<p>This <a href="http://scikits.appsport.com">SciKit</a> is an
image processing toolbox for <a href="http://www.scipy.org">SciPy</a>.</p>
<h2>Sections</h2>
<table class="contentstable" align="center">
<tr valign="top"><td width="50%">
<p class="biglink">
<a class="biglink" href="{{ pathto('overview') }}">
Overview</a><br/>
<span class="linkdescr">
Introduction to {{project}}.
</span></p>
<p class="biglink">
<a class="biglink" href="{{ pathto('install') }}">
Installation Steps</a><br/>
<span class="linkdescr">
How to install {{project}}.
</span></p>
<p class="biglink">
<a class="biglink" href="{{ pathto('contribute') }}">
Contribute</a><br/>
<span class="linkdescr">
Take part in development.
</span></p>
</td><td width="50%">
<p class="biglink">
<a class="biglink" href="{{ pathto('api/api') }}">
API Reference</a> (<a href="{{ pathto('api_changes')
}}">changes</a>)<br/>
<span class="linkdescr">
Documentation for the functions included in {{project}}.
</span></p>
<p class="biglink">
<a class="biglink" href="{{ pathto('user_guide') }}">
User Guide</a><br/>
<span class="linkdescr">
Usage guidelines.
</span></p>
<p class="biglink">
<a class="biglink" href="{{ pathto('license') }}">
License Info</a><br/>
<span class="linkdescr">
Conditions on the use and redistribution of this package.
</span></p>
</td></tr></table>
<h2>Indices and Tables</h2>
<table class="contentstable" align="center">
<tr valign="top"><td width="50%">
<p class="biglink">
<a class="biglink" href="{{ pathto('contents') }}">
Table of Contents</a><br/>
<span class="linkdescr">
Lists all sections and subsections.
</span></p>
<p class="biglink">
<a class="biglink" href="{{ pathto('search') }}">
Search Page</a><br/>
<span class="linkdescr">
Search this documentation.
</span></p>
</td><td width="50%">
<p class="biglink">
<a class="biglink" href="{{ pathto('genindex') }}">
Index</a><br/>
<span class="linkdescr">
All functions, classes, terms.
</span></p>
</td></tr></table>
{% endblock %}
doc/source/conf.py
+1 -1
View File
@@ -148,7 +148,7 @@ html_static_path = ['_static']
# Additional templates that should be rendered to pages, maps page names to
# template names.
html_additional_pages = {'index': 'index.html'}
# html_additional_pages = {}
# If false, no module index is generated.
#html_use_modindex = True
doc/source/index.txt
+51 -2
View File
@@ -1,3 +1,52 @@
.. toctree::
****************************
scikits.image |version| docs
****************************
/api/api
This SciKit_ is an image processing toolbox for SciPy_.
.. _SciKit: http://scikits.appspot.com
.. _SciPy: http://www.scipy.org
Sections
========
.. list-table::
:class: contentstable
* - `Overview <overview.html>`_
Introduction to scikits.image.
- `API Reference <api/api.html>`_ (`changes <api_changes.html>`_)
Documentation for the functions included in scikits.image.
* - `Installation Steps <install.html>`_
How to install scikits.image.
- `User Guide <user_guide.html>`_
Usage guidelines.
* - `Contribute <contribute.html>`_
Take part in development.
- `License Info <license.html>`_
Conditions on the use and redistribution of this package.
Indices and Tables
==================
`Table of Contents <contents.html>`_
Lists all sections and subsections.
:ref:`search`
Search this documentation.
:ref:`genindex`
All functions, classes, terms.
doc/source/themes/agogo/static/agogo.css_t
+8
View File
@@ -426,6 +426,14 @@ table.contentstable p.biglink {
line-height: 150%;
}
table.contentstable {
border-style: none;
}
table.contentstable td, table.contentstable th {
border-style: none;
}
a.biglink {
font-size: 1.3em;
}
scikits/image/filter/tv_denoise.py
+9 -6
View File
@@ -15,8 +15,9 @@ def _tv_denoise_3d(im, weight=100, eps=2.e-4, keep_type=False, n_iter_max=200):
eps: float, optional
relative difference of the value of the cost function that determines
the stop criterion. The algorithm stops when
(E_(n-1) - E_n) < eps * E_0
the stop criterion. The algorithm stops when:
(E_(n-1) - E_n) < eps * E_0
keep_type: bool, optional (False)
whether the output has the same dtype as the input array.
@@ -107,8 +108,9 @@ def _tv_denoise_2d(im, weight=50, eps=2.e-4, keep_type=False, n_iter_max=200):
eps: float, optional
relative difference of the value of the cost function that determines
the stop criterion. The algorithm stops when
(E_(n-1) - E_n) < eps * E_0
the stop criterion. The algorithm stops when:
(E_(n-1) - E_n) < eps * E_0
keep_type: bool, optional (False)
whether the output has the same dtype as the input array.
@@ -205,8 +207,9 @@ def tv_denoise(im, weight=50, eps=2.e-4, keep_type=False, n_iter_max=200):
eps: float, optional
relative difference of the value of the cost function that
determines the stop criterion. The algorithm stops when
(E_(n-1) - E_n) < eps * E_0
determines the stop criterion. The algorithm stops when:
(E_(n-1) - E_n) < eps * E_0
keep_type: bool, optional (False)
whether the output has the same dtype as the input array.