From dd6b3ee576e3d9d712ea349686861ec52574272c Mon Sep 17 00:00:00 2001 From: Ralf Gommers Date: Wed, 28 Oct 2009 23:09:48 +0100 Subject: [PATCH 1/5] Add some docs for 'make coverage'. --- DEVELOPMENT.txt | 46 +++++++++++++++++++++++++++++++++++++++ doc/source/contribute.txt | 2 +- 2 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 DEVELOPMENT.txt diff --git a/DEVELOPMENT.txt b/DEVELOPMENT.txt new file mode 100644 index 00000000..61b6f7eb --- /dev/null +++ b/DEVELOPMENT.txt @@ -0,0 +1,46 @@ +Development process +------------------- + * Go to `http://github.com/stefanv/scikits.image + `_ and follow the instructions on + making your own fork/branch. + * Make changes to your branch, committing locally as you progress. + * Push your changes back to github. + * Ping stefan to request a merge into the main development branch. + +.. note:: + + Do *not* merge the main branch into yours. You may rebase, + as long as you are `aware of its dangers `_ + (also see `LWN article `_). + +All of this may be intimidating if you've never used git before, so we'd +happily accept plain old unified diffs (``git diff`` or ``diff -u a.txt +b.txt``) as well. + +Guidelines: +``````````` + * All code should have tests. + * All code should be documented, to the same + `standard `_ + as NumPy and SciPy. + * Follow the `Python PEPs `_ + where possible. + * All major changes should be `posted for review + `_ to the `mailing list + `_. + +Test coverage +------------- +Tests for a module should ideally cover all code in that module, i.e. statement +coverage should be at 100%. To measure the test coverage, install ``_ and then run:: + + $ make coverage + +This will print a report with one line for each file in `scikits.image`, +detailing the test coverage. + +Bugs +```` +Please `report bugs on Github `_. + diff --git a/doc/source/contribute.txt b/doc/source/contribute.txt index 8ed8e081..5e62b585 100644 --- a/doc/source/contribute.txt +++ b/doc/source/contribute.txt @@ -1,2 +1,2 @@ .. include:: ../../TASKS.txt - +.. include:: ../../DEVELOPMENT.txt From 00cf3a841b4a87d777a08968722e76a0539abcf4 Mon Sep 17 00:00:00 2001 From: Ralf Gommers Date: Mon, 2 Nov 2009 20:36:04 +0100 Subject: [PATCH 2/5] Fix the description of make coverage. --- DEVELOPMENT.txt | 12 ++++++--- TASKS.txt | 35 ------------------------- doc/source/api/api.txt | 1 - doc/source/api/scikits.image.color.txt | 36 ++++++++++++++++++++++++++ 4 files changed, 45 insertions(+), 39 deletions(-) diff --git a/DEVELOPMENT.txt b/DEVELOPMENT.txt index 61b6f7eb..7ce18d25 100644 --- a/DEVELOPMENT.txt +++ b/DEVELOPMENT.txt @@ -19,7 +19,7 @@ b.txt``) as well. Guidelines: ``````````` - * All code should have tests. + * All code should have tests (see "Test coverage" below for more details). * All code should be documented, to the same `standard `_ as NumPy and SciPy. @@ -30,7 +30,7 @@ Guidelines: `_. Test coverage -------------- +````````````` Tests for a module should ideally cover all code in that module, i.e. statement coverage should be at 100%. To measure the test coverage, install ``_ and then run:: @@ -38,7 +38,13 @@ http://nedbatchelder.com/code/coverage/>`_ and then run:: $ make coverage This will print a report with one line for each file in `scikits.image`, -detailing the test coverage. +detailing the test coverage:: + + Name Stmts Exec Cover Missing + ------------------------------------------------------------------------------ + scikits/image/color/colorconv 77 77 100% + scikits/image/filter/__init__ 1 1 100% + ... Bugs ```` diff --git a/TASKS.txt b/TASKS.txt index 1ec192c7..cd9c8e5e 100644 --- a/TASKS.txt +++ b/TASKS.txt @@ -96,38 +96,3 @@ checking in the API files into the repository (done) -- but the doc build process needs to be updated to use these distributed files if they cannot be generated from source. -Development process -------------------- - * Go to `http://github.com/stefanv/scikits.image - `_ and follow the instructions on - making your own fork/branch. - * Make changes to your branch, committing locally as you progress. - * Push your changes back to github. - * Ping stefan to request a merge into the main development branch. - -.. note:: - - Do *not* merge the main branch into yours. You may rebase, - as long as you are `aware of its dangers `_ - (also see `LWN article `_). - -All of this may be intimidating if you've never used git before, so we'd -happily accept plain old unified diffs (``git diff`` or ``diff -u a.txt -b.txt``) as well. - -Guidelines: -``````````` - * All code should have tests. - * All code should be documented, to the same - `standard `_ - as NumPy and SciPy. - * Follow the `Python PEPs `_ - where possible. - * All major changes should be `posted for review - `_ to the `mailing list - `_. - -Bugs -```` -Please `report bugs on Github `_. - diff --git a/doc/source/api/api.txt b/doc/source/api/api.txt index 3b5b4ba1..921a226d 100644 --- a/doc/source/api/api.txt +++ b/doc/source/api/api.txt @@ -8,5 +8,4 @@ API Reference scikits.image.color scikits.image.filter scikits.image.io - scikits.image.opencv scikits.image.transform diff --git a/doc/source/api/scikits.image.color.txt b/doc/source/api/scikits.image.color.txt index eb7a91c4..ee2bbe8f 100644 --- a/doc/source/api/scikits.image.color.txt +++ b/doc/source/api/scikits.image.color.txt @@ -7,10 +7,46 @@ Module: :mod:`color` .. currentmodule:: scikits.image.color .. autosummary:: + scikits.image.color.convert_colorspace + scikits.image.color.hsv2rgb scikits.image.color.rgb2hsv + scikits.image.color.rgb2rgbcie + scikits.image.color.rgb2xyz + scikits.image.color.rgbcie2rgb + scikits.image.color.xyz2rgb + +convert_colorspace +------------------ + +.. autofunction:: scikits.image.color.convert_colorspace + +hsv2rgb +------- + +.. autofunction:: scikits.image.color.hsv2rgb rgb2hsv ------- .. autofunction:: scikits.image.color.rgb2hsv +rgb2rgbcie +---------- + +.. autofunction:: scikits.image.color.rgb2rgbcie + +rgb2xyz +------- + +.. autofunction:: scikits.image.color.rgb2xyz + +rgbcie2rgb +---------- + +.. autofunction:: scikits.image.color.rgbcie2rgb + +xyz2rgb +------- + +.. autofunction:: scikits.image.color.xyz2rgb + From 25701aede31778fbd1f679301e80a22e0a35f537 Mon Sep 17 00:00:00 2001 From: Ralf Gommers Date: Mon, 2 Nov 2009 20:44:26 +0100 Subject: [PATCH 3/5] Fix link to issue tracker. --- DEVELOPMENT.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEVELOPMENT.txt b/DEVELOPMENT.txt index 7ce18d25..6aa43a68 100644 --- a/DEVELOPMENT.txt +++ b/DEVELOPMENT.txt @@ -48,5 +48,5 @@ detailing the test coverage:: Bugs ```` -Please `report bugs on Github `_. +Please `report bugs on Github `_. From 8f51081d9f0ccb6a9c37c329d280039e3d3358c9 Mon Sep 17 00:00:00 2001 From: Ralf Gommers Date: Mon, 2 Nov 2009 20:45:11 +0100 Subject: [PATCH 4/5] Remove note about patent issues with marching squares, was resolved on list. --- TASKS.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TASKS.txt b/TASKS.txt index cd9c8e5e..35594899 100644 --- a/TASKS.txt +++ b/TASKS.txt @@ -24,7 +24,7 @@ or tests. * `Hough transform `_ * `Shortest paths `_ * `Grey-level co-occurrence matrices `_ - * Marching squares (investigate patent issues) + * Marching squares * Nadav's bilateral filtering (first compare against CellProfile's code) * 2D iso-contour finding (sub-pixel precision) [ask Zach Pincus] * 2D image warping via thin-plate splines [ask Zach Pincus] From 8f7e3bcaaaf62866d4dad52e046dad4ee3dfb9c5 Mon Sep 17 00:00:00 2001 From: Ralf Gommers Date: Mon, 2 Nov 2009 21:07:26 +0100 Subject: [PATCH 5/5] Correct calling of coverage plugin, no spurious output anymore. --- Makefile | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 081e0d08..5a5dbc86 100644 --- a/Makefile +++ b/Makefile @@ -10,5 +10,4 @@ test: nosetests scikits/image coverage: - nosetests scikits/image --with-coverage - coverage -r -m scikits/image/*.py scikits/image/*/*.py + nosetests scikits/image --with-coverage --cover-package=scikits.image