Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions latex/development_practices.tex
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ \section*{Development practices}

The library is licensed under the \emph{Modified BSD license}, which allows unrestricted redistribution for any purpose as long as copyright notices and disclaimers of warranty are maintained \citep{BSD}. It is compatible with GPL licenses, so users of scikit-image can choose to make their code available under the GPL. However, unlike the GPL, it does not require users to open-source derivative work (BSD is not a so-called copyleft license). Thus, scikit-image can also be used in closed-source, commercial environments.

The development team of scikit-image is an open community that collaborates on the \emph{GitHub} platform for issue tracking, code review, and release management\footnote{\url{https://github.com/scikit-image}}. \emph{Google Groups} is used as a public discussion forum for user support, community development, and announcements\footnote{\url{https://groups.google.com/forum/?&fromgroups\#!forum/scikit-image}}.
The development team of scikit-image is an open community that collaborates on the \emph{GitHub} platform for issue tracking, code review, and release management\footnote{\url{https://github.com/scikit-image}}. \emph{Google Groups} is used as a public discussion forum for user support, community development, and announcements\footnote{\url{https://groups.google.com/group/scikit-image}}.

scikit-image complies with the PEP8 coding style standard \citep{PEP8} and the NumPy documentation format \citep{NumpyDoc} in order to provide a consistent, familiar user experience across the library similar to other scientific Python packages. As mentioned earlier, the data representation used is \emph{n}-dimensional NumPy arrays, which ensures broad interoperability within the scientific Python ecosystem. The majority of the scikit-image API is intentionally designed as a functional interface which allows one to simply apply one function to the output of another. This modular approach also lowers the barrier of entry for new contributors, since one only needs to master a small part of the entire library in order to make an addition.

Expand All @@ -23,4 +23,4 @@ \section*{Development practices}

The source code is mainly written in Python, although certain performance critical sections are implemented in Cython, an optimising static compiler for Python \citep{Cython}. scikit-image aims to achieve full unit test coverage, which is above 87\% as of release 0.10 and continues to rise. A continuous integration system\footnote{\url{https://travis-ci.org}, \url{https://coveralls.io}, Accessed 2014-03-30} automatically checks each commit for unit test coverage and failures on both Python 2 and Python 3. Additionally, the code is analyzed by flake8 \citep{flake8} to ensure compliance with the PEP8 coding style standards \citep{PEP8}. Finally, the properties of each public function are documented thoroughly in an API reference guide, embedded as Python docstrings and accessible through the official project homepage or an interactive Python console. Short usage examples are typically included inside the docstrings, and new features are accompanied by longer, self-contained example scripts added to the narrative documentation and compiled to a gallery on the project website. We use Sphinx \citep{Sphinx} to automatically generate both library documentation and the website.

The development master branch is fully functional at all times and can be obtained from GitHub\footnote{\url{https://github.com/scikit-image/scikit-image}}. The community releases major updates as stable versions approximately every six months. Major releases include new features, while minor releases typically contain only bug fixes. Going forward, users will be notified about API-breaking changes through deprecation warnings for two full major releases before the changes are applied.
The development master branch is fully functional at all times and can be obtained from GitHub. The community releases major updates as stable versions approximately every six months. Major releases include new features, while minor releases typically contain only bug fixes. Going forward, users will be notified about API-breaking changes through deprecation warnings for two full major releases before the changes are applied.
5 changes: 2 additions & 3 deletions latex/panorama_example.tex
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,7 @@ \section*{Example: image registration and stitching}
corner_max = np.max(all_corners, axis=0)

output_shape = (corner_max - corner_min)
output_shape += np.abs(corner_min)
output_shape = output_shape[::-1]
output_shape = np.ceil(output_shape[::-1])
\end{pyverbatim}

The images are now warped according to the estimated transformation model. Values outside the input images are set to -1 to distinguish the ``background''.
Expand All @@ -118,7 +117,7 @@ \section*{Example: image registration and stitching}
image0_ = warp(image0, offset.inverse,
output_shape=output_shape, cval=-1)

image1_ = warp(image1, (offset + model_robust).inverse,
image1_ = warp(image1, (model_robust + offset).inverse,
output_shape=output_shape, cval=-1)
\end{pyverbatim}

Expand Down
50 changes: 30 additions & 20 deletions latex/skimage.bib
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,12 @@ @article{ipython
}

@article{Mahotas,
author={Coelho, LP},
year={2013},
title={{Mahotas}: Open source software for scriptable computer vision.},
journal={Journal of Open Research Software},
volume={1},
number={1},
doi={doi:10.5334/4}
author = {Luis Coelho},
title = {Mahotas: Open source software for scriptable computer vision},
journal = {Journal of Open Research Software},
volume = {1},
number = {1},
year = {2013}
}

@article{scikit-learn,
Expand All @@ -43,14 +42,15 @@ @article{scikit-learn
}

@article{neurodebian,
title={Open is not enough. Let's take the next step: an integrated, community-driven computing platform for neuroscience.},
url={\url{http://neuro.debian.net/pkgs/python-skimage.html}},
author={Halchenko, YO and Hanke, M},
year={2012},
journal={Front. Neuroinf.},
volume={6},
pages={22},
note={\url{http://neuro.debian.net/pkgs/python-skimage.html} Accessed: 2014-03-30}
AUTHOR={Halchenko, Yaroslav O. and Hanke, Michael},
TITLE={Open is not enough. Let's take the next step: An integrated, community-driven computing platform for neuroscience},
JOURNAL={Frontiers in Neuroinformatics},
VOLUME={6},
YEAR={2012},
NUMBER={22},
URL={http://www.frontiersin.org/neuroinformatics/10.3389/fninf.2012.00022/full},
DOI={10.3389/fninf.2012.00022},
ISSN={1662-5196}
}

@misc{ubuntu,
Expand Down Expand Up @@ -80,7 +80,7 @@ @misc{BSD
@article{Cython,
author={Behnel, S and Bradshaw, R and Citro, C and Dalcin, L and Seljebotn, DS and Smith, K},
year={2011},
title={{Cython}: The best of both worlds.},
title={{Cython}: {T}he best of both worlds.},
journal={Computing in Science and Engineering},
volume={13},
number={2},
Expand Down Expand Up @@ -203,7 +203,7 @@ @misc{cc-by

@inproceedings{ORB,
author={Rublee, E and Rabaud, V and Konolige, K and Bradski G.},
title={{ORB}: An efficient alternative to {SIFT} and {SURF}},
title={{ORB}: An efficient alternative to {SIFT} or {SURF}},
booktitle={Proceedings of the 2011 International Conference on Computer Vision {(ICCV)}},
pages={2564-2571},
year={2011},
Expand Down Expand Up @@ -232,10 +232,17 @@ @article{burt_adelson_0
}

@article{burt_adelson_1,
author={Burt, P and Adelson, E.},
author={Burt, P.J. and Adelson, E.H.},
journal={Communications, IEEE Transactions on},
title={The Laplacian Pyramid as a Compact Image Code},
journal={{IEEE} Transactions on Communications},
year={1983}
year={1983},
month={Apr},
volume={31},
number={4},
pages={532-540},
keywords={Image coding;Data compression;Data structures;Entropy;Frequency;Image coding;Image sampling;Laplace equations;Low pass filters;Pixel;Shape},
doi={10.1109/TCOM.1983.1095851},
ISSN={0090-6778},
}

@misc{Enblend,
Expand Down Expand Up @@ -276,6 +283,9 @@ @article{opencv
posted-at = {2008-01-15 19:21:54},
priority = {4},
title = {The {O}pen{CV} library.},
pages = {120-126},
volume = {25},
issue = {11},
year = {2000}
}

Expand Down
2 changes: 1 addition & 1 deletion latex/skimage.tex
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
\author[9]{Tony Yu}
\affil[9]{Enthought Inc.,
Austin, TX, USA}
\author[10]{the scikit-image contributors}
\author[10]{and the scikit-image contributors}
\affil[10]{\url{https://github.com/scikit-image/scikit-image/graphs/contributors}}

% Key words to associate with the article
Expand Down