From 804b426787869932a1d5dbb1977045321acb9684 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= Date: Sat, 10 Nov 2012 08:35:23 +0100 Subject: [PATCH] Clean Readme --- skimage/filter/rank/README.rst | 41 ++++++++++++++++------------------ 1 file changed, 19 insertions(+), 22 deletions(-) diff --git a/skimage/filter/rank/README.rst b/skimage/filter/rank/README.rst index aae62162..29a68edb 100644 --- a/skimage/filter/rank/README.rst +++ b/skimage/filter/rank/README.rst @@ -1,35 +1,32 @@ -To use this to build your Cython file use the commandline options: - -.. sourcecode:: text - - $ python setup.py build_ext --inplace - - -**To do** +To do +----- * add simple examples, adapt documentation on existing examples - * add/check existing doc - * adapting tests for each type of filter -**General remarks** +General remarks +--------------- -Basically these filters compute local histogram for each pixel. Histogram is build using a moving window in -order to limit redundant computation. The path followed by the moving window is given hereunder +Basically these filters compute local histogram for each pixel. Histogram is +build using a moving window in order to limit redundant computation. The path +followed by the moving window is given hereunder ...-----------------------\ /--------------------------/ \-------------------------- ... -A comparison is proposed with cmorph.dilate algorithm to show how computation costs evolve with respect to image size or -structuring element size. This implementation gives better results for large structuring elements. +A comparison is proposed with cmorph.dilate algorithm to show how computation +costs evolve with respect to image size or structuring element size. This +implementation gives better results for large structuring elements. -A local histogram is update at each pixel by introducing pixel entering the structuring element border and -by removing those leaving it. The histogram size is 8bit (256 bins) for 8 bit images and 2 to 12 bit (up to 4096 bins) -for 16bit image depending on the image maximum value. Image with pixels higher than 4095 raise a ValueError. - -The filter is applied up to the image border, the neighboorhood used is adjusted accordingly. The user may provide -a mask image (same size as input image) where non zero value are the part of the image participating the the -histogram computation. By default all the image is filtered. +A local histogram is update at each pixel by introducing pixel entering the +structuring element border and by removing those leaving it. The histogram size +is 8bit (256 bins) for 8 bit images and 2 to 12 bit (up to 4096 bins) for 16bit +image depending on the image maximum value. Image with pixels higher than 4095 +raise a ValueError. +The filter is applied up to the image border, the neighboorhood used is adjusted +accordingly. The user may provide a mask image (same size as input image) where +non zero value are the part of the image participating the the histogram +computation. By default all the image is filtered.