Skip to content

Commit 4acead8

Browse files
authored
Merge pull request #21 from thewtex/readme
DOC: Add README content
2 parents e1e653a + 577a290 commit 4acead8

File tree

1 file changed

+75
-0
lines changed

1 file changed

+75
-0
lines changed

README.rst

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
ITKTextureFeatures
2+
==================
3+
4+
.. image:: https://circleci.com/gh/InsightSoftwareConsortium/ITKTextureFeatures.svg?style=shield
5+
:target: https://circleci.com/gh/InsightSoftwareConsortium/ITKTextureFeatures
6+
7+
.. image:: https://travis-ci.org/InsightSoftwareConsortium/ITKTextureFeatures.svg?branch=master
8+
:target: https://travis-ci.org/InsightSoftwareConsortium/ITKTextureFeatures
9+
10+
.. image:: https://img.shields.io/appveyor/ci/jbvimort/itktexturefeatures.svg
11+
:target: https://ci.appveyor.com/project/jbvimort/itktexturefeatures
12+
13+
14+
Overview
15+
--------
16+
17+
This repository contains `ITK <https://itk.org>`_ filters to estimate
18+
texture feature maps from N-dimensional images.
19+
20+
For more information, see the `Insight Journal article <http://hdl.handle.net/10380/3574>`_::
21+
22+
Vimort J., McCormick M., Budin F., Paniagua B.
23+
Computing Textural Feature Maps for N-Dimensional images
24+
McCormick M.
25+
The Insight Journal. January-December. 2017.
26+
http://hdl.handle.net/10380/3574
27+
http://insight-journal.org/browse/publication/985
28+
29+
Installation
30+
------------
31+
32+
Python
33+
^^^^^^
34+
35+
Binary `Python packages <https://pypi.python.org/pypi/itk-texturefeatures>`_
36+
are available for macOS, Linux, and Windows. They can be installed with::
37+
38+
python -m pip install --upgrade pip
39+
python -m pip install itk-texturefeatures
40+
41+
3D Slicer Extension
42+
^^^^^^^^^^^^^^^^^^^
43+
44+
The module functionality is also available in the `3D Slicer
45+
<https://slicer.org>`_ desktop application. Install the *BoneTextureExtension*
46+
in the `3D Slicer extension manager
47+
<https://www.slicer.org/wiki/Documentation/Nightly/SlicerApplication/ExtensionsManager>`_.
48+
`Additional documentation
49+
<https://raw.githubusercontent.com/Kitware/BoneTextureExtension/master/Docs/BoneTextureExtensionTutorial_2017.pdf>`_
50+
is available for `the extension
51+
<https://github.com/Kitware/BoneTextureExtension>`_.
52+
53+
C++
54+
^^^
55+
56+
Since ITK 4.13.0, this module is available in the ITK source tree as a Remote
57+
module. To enable it, set::
58+
59+
Module_TextureFeatures:BOOL=ON
60+
61+
in ITK's CMake build configuration.
62+
63+
License
64+
-------
65+
66+
The source code is distributed under the Apache 2.0 License. Please see LICENSE file for details.
67+
68+
Acknowledgements
69+
----------------
70+
71+
This work was supported by the National Institute of Health (NIH) National
72+
Institute for Dental and Craniofacial Research (NIDCR) grant R21DE025306
73+
(Textural Biomarkers of Arthritis for the Subchondral Bone in the
74+
Temporomandibular Joint) and NIDCR grant R01DE024450 (Quantification of 3D
75+
bony Changes in Temporomandibular Joint Osteoarthritis).

0 commit comments

Comments
 (0)