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

Remove coverage table. Add document with release notes and download instructions.

Browse Source
This commit is contained in:
Stefan van der Walt committed 2015-03-27 00:26:15 -07:00
1 parent 1da2446a1d
commit 5aa9c5d12e
9 files changed
+25 -416
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

.gitignore
+3
View File
@@ -26,3 +26,6 @@ doc/source/auto_examples/applications/
doc/source/_static/random.js
.idea/
*.log
doc/release/_release_notes_for_docs.txt
doc/gh-pages
wheels
TASKS.txt
-1
View File
@@ -11,7 +11,6 @@ How to contribute to ``skimage``
gitwash/index
gsoc2011
coverage_table
cell_profiler
doc/.gitignore
-3
View File
@@ -1,3 +0,0 @@
gh-pages
source/coverage_table.txt
doc/Makefile
+5 -4
View File
@@ -12,7 +12,7 @@ PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
DEST = build
.PHONY: all help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest gitwash gh-pages coveragetable random_gallery
.PHONY: all help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest gitwash gh-pages release_notes random_gallery
all: html
@@ -43,10 +43,11 @@ api:
random_gallery:
@cd source && $(PYTHON) random_gallery.py
coveragetable:
@cd source && $(PYTHON) coverage_generator.py
release_notes:
@echo "Copying release notes"
@tail -n +4 `ls release/*.txt | sort -k 2 -t . -n | tail -n 1` > release/_release_notes_for_docs.txt
html: api coveragetable random_gallery
html: api release_notes random_gallery
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(DEST)/html
cp -r source/plots $(DEST)/html
@echo
doc/make.bat
-129
View File
@@ -1,129 +0,0 @@
@ECHO OFF
REM Command file for Sphinx documentation
set SPHINXBUILD=sphinx-build
set ALLSPHINXOPTS=-d build/doctrees %SPHINXOPTS% source
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
)
if "%1" == "" goto help
if "%1" == "help" (
:help
echo.Please use `make ^<target^>` where ^<target^> is one of
echo. html to make standalone HTML files
echo. dirhtml to make HTML files named index.html in directories
echo. pickle to make pickle files
echo. json to make JSON files
echo. htmlhelp to make HTML files and a HTML help project
echo. qthelp to make HTML files and a qthelp project
echo. devhelp to make HTML files and a Devhelp project
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
echo. changes to make an overview over all changed/added/deprecated items
echo. linkcheck to check all external links for integrity
echo. doctest to run all doctests embedded in the documentation if enabled
goto end
)
for %%x in (html htmlhelp latex qthelp) do (
if "%1" == "%%x" (
md source\api 2>NUL
python tools/build_modref_templates.py
)
)
if "%1" == "clean" (
for /d %%i in (build\*) do rmdir /q /s %%i
del /q /s build\*
goto end
)
if "%1" == "html" (
cd source && python random_gallery.py && python coverage_generator.py && cd ..
%SPHINXBUILD% -b html %ALLSPHINXOPTS% build/html
echo.
echo.Build finished. The HTML pages are in build/html.
goto end
)
if "%1" == "dirhtml" (
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% build/dirhtml
echo.
echo.Build finished. The HTML pages are in build/dirhtml.
goto end
)
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% build/pickle
echo.
echo.Build finished; now you can process the pickle files.
goto end
)
if "%1" == "json" (
%SPHINXBUILD% -b json %ALLSPHINXOPTS% build/json
echo.
echo.Build finished; now you can process the JSON files.
goto end
)
if "%1" == "htmlhelp" (
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% build/htmlhelp
echo.
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in build/htmlhelp.
goto end
)
if "%1" == "qthelp" (
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% build/qthelp
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in build/qthelp, like this:
echo.^> qcollectiongenerator build\qthelp\scikitimage.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile build\qthelp\scikitimage.ghc
goto end
)
if "%1" == "devhelp" (
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% build/devhelp
echo.
echo.Build finished.
goto end
)
if "%1" == "latex" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% build/latex
echo.
echo.Build finished; the LaTeX files are in build/latex.
goto end
)
if "%1" == "changes" (
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% build/changes
echo.
echo.The overview file is in build/changes.
goto end
)
if "%1" == "linkcheck" (
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% build/linkcheck
echo.
echo.Link check complete; look for any errors in the above output ^
or in build/linkcheck/output.txt.
goto end
)
if "%1" == "doctest" (
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% build/doctest
echo.
echo.Testing of doctests in the sources finished, look at the ^
results in build/doctest/output.txt.
goto end
)
:end
doc/source/coverage.csv
-1
View File
@@ -1 +0,0 @@
Image Display and Exploration,Image Display and Exploration,Image File I/O,Image Types and Type Conversions GUI Tools,Modular Interactive Tools,Navigational Tools for Image Scroll Panel,Utilities for Interactive Tools Spatial Transformations and Image Registration,Spatial Transformations,Image Registration, Image Analysis and Statistics,Image Analysis,Texture Analysis,Pixel Values and Statistics Image Arithmetic,,, Image Enhancement and Restoration,Image Enhancement,Image Restoration (Deblurring), Linear Filtering and Transforms,Linear Filtering,Linear 2-D Filter Design,Image Transforms Morphological Operations,Intensity and Binary Images,Binary Images,Structuring Element Creation and Manipulation "ROI-Based, Neighborhood, and Block Processing",ROI-Based Processing,Neighborhood and Block Processing, Colormaps and Color Space,Color Space Conversions,, Utilities,Validation,Array Operations,Performance ,,, Make movie from multiframe image ,immovie ,:done:`immovie`,:partial:`immovie` "Play movies, videos, or image sequences ",implay ,:na:`n/a`, Display image ,imshow ,, Image Tool ,imtool ,, Display multiple image frames as rectangular montage,montage ,, Display multiple images in single figure ,subimage,, Display image as texture-mapped surface ,warp ,, , ,, Read metadata from header file of Analyze 7.5 data set ,analyze75info,, Read image data from image file of Analyze 7.5 data set ,analyze75read,, Anonymize DICOM file ,dicomanon ,, Get or set active DICOM data dictionary ,dicomdict ,, Read metadata from DICOM message ,dicominfo ,, Find attribute in DICOM data dictionary ,dicomlookup ,, Read DICOM image ,dicomread ,, Generate DICOM unique identifier ,dicomuid ,, Write images as DICOM files ,dicomwrite ,, Read high dynamic range (HDR) image ,hdrread ,, Write Radiance high dynamic range (HDR) image file ,hdrwrite ,, Read metadata from Interfile file ,interfileinfo,, Read images in Interfile format ,interfileread,, Check if file is R-Set ,isrset ,, Create high dynamic range image ,makehdr ,, Read metadata from National Imagery Transmission Format (NITF) file,nitfinfo ,, Read image from NITF file ,nitfread ,, Open R-Set file ,openrset ,, Create reduced resolution data set from image file ,rsetwrite ,, Render high dynamic range image for viewing ,tonemap ,, ,,, Convert Bayer pattern encoded image to truecolor image,demosaic,, Convert grayscale or binary image to indexed image,gray2ind,, Convert grayscale image to indexed image using multilevel thresholding,grayslice,, Global image threshold using Otsu's method,graythresh,, "Convert image to binary image, based on threshold",im2bw,, Convert image to double precision,im2double,, Convert image to 16-bit signed integers,im2int16,, Convert image to Java buffered image,im2java2d,, Convert image to single precision,im2single,, Convert image to 16-bit unsigned integers,im2uint16,, Convert image to 8-bit unsigned integers,im2uint8,, Convert indexed image to grayscale image,ind2gray,, Convert indexed image to RGB image,ind2rgb,, Convert label matrix into RGB image,label2rgb,, Convert matrix to grayscale image,mat2gray,, Convert RGB image or colormap to grayscale,rgb2gray,, ,,, Image Information tool,imageinfo,, Adjust Contrast tool,imcontrast,, Display Range tool,imdisplayrange,, Distance tool,imdistline,, Pixel Information tool,impixelinfo,, Pixel Information tool without text label,impixelinfoval,, Pixel Region tool,impixelregion,, Pixel Region tool panel,impixelregionpanel,, ,,, Magnification box for scroll panel,immagbox,, Overview tool for image displayed in scroll panel,imoverview,, Overview tool panel for image displayed in scroll panel,imoverviewpanel,, Scroll panel for interactive image navigation,imscrollpanel,, ,,, Convert axes coordinates to pixel coordinates,axes2pix,, Image data from axes,getimage,, Image model object from image object,getimagemodel,, Information about image attributes,imattributes,, Create draggable ellipse,imellipse,, Create draggable freehand region,imfreehand,, Get handle to current axes containing image,imgca,, Get handle to current figure containing image,imgcf,, Open Image dialog box,imLine truncated
doc/source/coverage_generator.py
-276
View File
@@ -1,276 +0,0 @@
#!/usr/bin/env python
from __future__ import division
import sys
import os
import csv
# Import StringIO module
try:
import cStringIO as StringIO
except ImportError:
try:
import StringIO
except:
import io as StringIO
# Missing item value
MISSING_STRING=":missing:`Not Implemented`"
def calculate_coverage(reader):
"""Calculate portions of code that are in one of the coverage categories
Returns a tuple representing the weighted items. The order is
(done, partial, missing, not applicable)
"""
# Coverage counters
total_items = 0
partial_items = 0
done_items = 0
na_items = 0
# Skip table names
for row in reader:
if len(row[0]) == 0:
break
# Count items
for row in reader:
if len(row[0]) > 0:
total_items += 1
if ":done:" in row[2] or ":done:" in row[3]:
done_items += 1
if ":partial:" in row[2] or ":partial:" in row[3]:
partial_items += 1
if ":na:" in row[2] or ":na:" in row[3]:
na_items += 1
counts = (done_items,
partial_items,
total_items - (partial_items + done_items + na_items),
na_items)
return list(i / total_items for i in counts)
def read_table_titles(reader):
r"""Create a dictionary with keys as section names and values as a list of
table names
return (dict)
"""
section_titles = []
table_names = {}
try:
for row in reader:
names = []
# End of names table
if len(row[0]) == 0:
break
# Extract names of the tables
for name in row[1:]:
if len(name) > 0:
names.append(name)
else:
break
section_titles.append(row[0])
table_names[row[0]] = names
except csv.Error as e:
sys.exit('line %d: %s' % (reader.line_num, e))
return section_titles,table_names
def table_seperator(stream,lengths,character="-"):
r"""Write out table row seperator
:Input:
- *stream* (io/stream) Stream where output is put
- *lengths* (list) A list of the lengths of the columns
- *character* (string) Character to be filled between +, defaults to "-".
"""
stream.write("+")
stream.write('+'.join([character*(length+2) for length in lengths]))
stream.write("+")
def table_row(stream,data,lengths,num_columns=None):
r"""Write out table row data
:Input:
- *stream* (io/stream) Stream where output is put
- *data* (list) List of strings containing data
- *lengths* (list) A list of the lengths of the columns
- *num_columns* (string) Number of columns, defaults to the length of the
data array
"""
if num_columns is None:
num_columns = len(data)
stream.write("|")
for i in range(num_columns):
if len(data)-1 >= i:
if len(data[i]) == 0:
entry = MISSING_STRING
else:
entry = data[i]
else:
entry = MISSING_STRING
stream.write(" " + entry + " "*(lengths[i] - len(entry)) + " |")
def generate_table(reader,stream,table_name=None,
column_titles=["Functionality","Matlab","Scipy","Scipy"]):
r"""Generate a reST grid table based on the CSV data in reader
Reads CSV data from *reader* until an empty line is found and generates a
reST table based on the data into *stream*. A table name can be given for
a section and table label. All rows are read in and checked for maximum
number of columns (defaults to the size of column_titles) and column
widths so that the table can be constructed. If a row contains less than
the maximum number of columns a string is inserted that defaults to the
string *MISSING_STRING* which is a global parameter.
:Input:
- reader (csv.reader) The CSV reader to read in from
- stream (iostream) Output target
- table_name (string) Optional name of table, defaults to *None*
- column_titles (list) List of column titles
"""
# Find number of columns and column widths, base number of columns is
# determined by the headers
num_columns = len(column_titles)
data = [column_titles]
try:
for row in reader:
if len(row[0]) == 0:
break
data.append([entry.expandtabs() for entry in row])
num_columns = max(num_columns,len(row))
except csv.Error as e:
sys.exit('line %d: %s' % (reader.line_num, e))
column_lengths = [len(MISSING_STRING)]*num_columns
for row in data:
for i in range(len(row)):
column_lengths[i] = max(column_lengths[i],len(row[i]))
# Output table header
stream.write(table_name + "\n")
if table_name is not None:
stream.write("~"*len(table_name)+"\n\n")
stream.write(".. tabularcolumns:: |p{40%}|p{20%}|p{20%}|p{20%}|\n\n")
if table_name is not None:
stream.write(".. table::%s\n\n" % table_name)
table_seperator(stream,column_lengths,character="-")
stream.write("\n")
table_row(stream,data[0],column_lengths,num_columns)
stream.write("\n")
table_seperator(stream,column_lengths,character="=")
stream.write("\n")
# Output table data
for row in data[1:]:
table_row(stream,row,column_lengths,num_columns)
stream.write("\n")
table_seperator(stream,column_lengths,character='-')
stream.write("\n")
stream.write("\n\n")
def generate_page(csv_path,stream,page_title="Coverage Tables"):
r"""Generate coverage table page
Generates all reST for all tables contained in the CSV file at *csv_path*
and output it to *stream*.
:Input:
- *csv_path* (path) Path to CSV file
- *stream* (iostream) Output stream
- *page_title* (string) Optional page title, defaults to
``Coverage Tables``.
"""
# Open reader
csv_file = open(csv_path,'U')
# Sniffer does not seem to work all the time even when an Excel
# spread sheet is being used
# dialect = csv.Sniffer().sniff(csv_file.read(1024))
# csv_file.seek(0)
# reader = csv.reader(csv_file, dialect)
reader = csv.reader(csv_file)
item_counts = calculate_coverage(reader)
csv_file.seek(0)
# Write out header
stream.write("%s\n" % page_title)
stream.write("="*len(page_title) + "\n\n")
stream.write("""
.. role:: missing
.. role:: partial
.. role:: done
.. role:: na
.. role:: missing-bar
.. role:: partial-bar
.. role:: done-bar
.. role:: na-bar
.. warning::
This table has not yet been updated. We've just finished
setting up its structure.
Color Key
---------
:done:`Complete` :partial:`Partial` :missing:`Missing` :na:`Not Applicable`
Coverage Bar
------------
.. raw:: html
<table width="100%" class="coverage"><tr>
""")
for item, style in enumerate(('done-bar', 'partial-bar',
'missing-bar', 'na-bar')):
stream.write('<td width="%s%%" class="%s">&nbsp</td>' % \
(item_counts[item] * 100, style))
stream.write("</tr></table>\n\n")
sections,table_names = read_table_titles(reader)
for section_name in sections:
stream.write(section_name + "\n")
stream.write("-"*len(section_name) + "\n\n")
for table_name in table_names[section_name]:
generate_table(reader,stream,table_name)
csv_file.close()
if __name__ == "__main__":
csv_path = './coverage.csv'
output_path = './coverage_table.txt'
if len(sys.argv) > 1:
if sys.argv[1][:5].lower() == "help":
print("Coverage Table Generator: coverage_generator.py")
print(" Usage: coverage_generator.py [csv] [output]")
print(" csv - Path to csv file, defaults to ./coverage.csv")
print(" output - Ouput path, defaults to ./coverage_table.txt")
print('')
sys.exit(0)
if len(sys.argv) == 2:
csv_path = os.path.abspath(sys.argv[1])
if len(sys.argv) == 3:
output_path = os.path.abspath(sys.argv[2])
output = open(output_path,'w')
generate_page(csv_path,output)
output.close()
print("Generated %s from %s." % (output_path,csv_path))
doc/source/index.txt
+3 -2
View File
@@ -2,9 +2,9 @@
skimage |version| docs
****************************
This SciKit_ is an image processing toolbox for SciPy_.
Scikit-image is an image processing toolbox for SciPy_. `View the |version|
release notes here <download.txt>`_.
.. _SciKit: http://scikits.appspot.com
.. _SciPy: http://www.scipy.org
@@ -22,6 +22,7 @@ Sections
contribute
license
auto_examples/index
release_notes_and_installation
.. list-table::
doc/source/release_notes_and_installation.txt
+14
View File
@@ -0,0 +1,14 @@
.. |nbsp| unicode:: 0xA0
:trim:
.. contents:: |nbsp|
Release notes
=============
.. include:: ../release/_release_notes_for_docs.txt
Installation
============
.. include:: install.txt