[Insight-users] Is there detailed reference for Itk classes?

[Matt McCormick]

Hi flydps, John, ianl,

Thank you for your feedback regarding documentation.  More experienced
members of the community try to be empathetic to the needs of
newcomers, but your direct input is appreciated.  There is an
awareness of the need to update the current documentation to improve
the vitality of the project, recruit new blood, and improve the
usefulness of the toolkit.  To-be-determined are funding mechanisms
for collaborative documentation generation with community
participation that provides the right information.

Regarding how to obtain a more in-depth class reference:

1)  The Doxygen documentation is an excellent resource that is updated
nightly.  It is automatically generate from comments in the source
code.  If you find deficiencies, please consider examining the source
code to correct them and submit a patch with Gerrit:

  http://www.itk.org/Wiki/ITK/Git/Develop

Or, it may be convenient to use the browser-based editing and
submission facilities obtained with the "Edit comments" link on a
class's HTML page.

2)  How to use a class is often best demonstrated by example.  See

  http://www.itk.org/Wiki/ITK/Examples
  http://itk.org/ITKExamples/
  The "Examples" directory in the ITK repository source tree.

To find out where a specific class is used, download the Git
repository for the examples, either

  git clone https://gitorious.org/itkwikiexamples/itkwikiexamples
  git clone https://github.com/InsightSoftwareConsortium/ITKExamples
(the html also has a class based index, here, too)
  git clone http://itk.org/ITK.git

"cd" into the example directory, then

  git grep ClassName

For instance

  git grep ImageFileReader

3)  More in-depth guides like the Software Guide are very helpful,
although the Software Guide does have some out-of-date information.  A
good list of resources can be found here:

 http://www.itk.org/Wiki/ITK/Documentation

Hope this helps,
Matt


On Tue, Sep 18, 2012 at 3:39 AM, ianl <ilindsay at insigniamedical.co.uk> wrote:
> I too have found the existing documentation quite sparse and out of date in
> places, for example the user manual (PDF) seems to be related to ITK 2.4
> from 2005 - we are now on version 4.2 . While this does provide quite a good
> 'getting started' tutorial, there is a need for some more in depth class
> reference.
>
> I would like to know whether there is a plan within Kitware to get the
> printed software guide book updated. We would certainly buy it if so (we
> have already purchased the VTK book), and I'm sure others would too.
>
> Finally, the book Insight Into Images (Terry S Yoo, ISBN 1-56881-217-5) is
> quite good background reading material, if a little heavy going in places,
> and explains the principles and ideas behind the algorithms, but does not go
> into actual API descriptions.
>
>
>
> --
> View this message in context: http://itk-users.7.n7.nabble.com/Is-there-detailed-reference-for-Itk-classes-tp29486p29496.html
> Sent from the ITK - Users mailing list archive at Nabble.com.
> _____________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
>
> Kitware offers ITK Training Courses, for more information visit:
> http://www.kitware.com/products/protraining.php
>
> Please keep messages on-topic and check the ITK FAQ at:
> http://www.itk.org/Wiki/ITK_FAQ
>
> Follow this link to subscribe/unsubscribe:
> http://www.itk.org/mailman/listinfo/insight-users