[Insight-users] How to know what parameters of a filter need to be set?

[Luis Ibanez]

Hi Roman,

Thanks for your comments,

You are pointing out to an important weakness of ITK as a toolkit.

As you mentioned, the level of documentation that you are looking for
is above the level that the typical Doxygen documentation provides.

We were hoping that the ITK Software Guide would provide that
extra information that fully describes how to use a filter. However
as you indicate, the Software Guide does not cover all the filters
in ITK.

Despite its 830 pages, it probably covers less than 20%
of the toolkit.



The "InsightClopedia"

              http://www.itk.org/Wiki/ITK_InsightClopedia

has been suggested as an alternative solution to this problem.

The idea, is that, collecting the information that you are asking
for requires a lot of work, and that, therefore we should distribute
the load of that work among many members of the ITK community.

Think of a Wikipedia where every page is one filter of ITK. The
page will be written by both developers and users, and will include
practical examples (even with input images and output images)
describing how to use the class.

This won't be done overnight...
but may be an option for gathering the collective intelligence
of the community.


Please let us know what you think of this alternative,


        Thanks


             Luis


---------------------------------------------------------------
On Fri, Oct 30, 2009 at 5:43 AM, Roman Grothausmann
<roman.grothausmann at helmholtz-berlin.de> wrote:
> Dear mailing list members,
>
>
> Although I like and value ITK very much there's a problem I've encountered a
> few times now: How do I find out what parameters of a filter have to be set?
> An example: I need some kind of closing filter. So I search in
> http://www.itk.org/Doxygen/html/classes.html for close/closing and find
> quite a few filters.
> Not knowing which one's the right for my case I try to find more information
> than the "Detailed Description" of each filter. If there's no description in
> the  ItkSoftwareGuide and/or the insight-journal I've no clue where to look
> else except the source which is very hard to understand quickly.
> Looking at the Detailed Description of ClosingByReconstructionImageFilter
> only PreserveIntensities is mentioned.
> Although mentioned there I couldn't find any filter called
> ErosionByReconstruction, only ReconstructionByErosionImageFilter. Is that
> the same?
> I know Dilation needs a structuring element. So I have to choose its shape
> and its size, but the list of "Public Member Functions" of
> ClosingByReconstructionImageFilter is huge.
> How do I know which are the important ones that need to be specified?
>
> Any help is very much appreciated
> Roman
>
> --
> Roman Grothausmann
>
> Helmholtz-Zentrum Berlin für Materialien und Energie GmbH
> Bereich Funktionale Materialien
> Institut für angewandte Materialforschung
> Hahn-Meitner-Platz 1
> D-14109 Berlin
>
> Tel.: +49-(0)30-8062-2816
> Fax.: +49-(0)30-8062-3059
>
> Mitglied der Hermann von Helmholtz-Gemeinschaft Deutscher Forschungszentren
> e.V.
> Vorsitzende des Aufsichtsrates: Dr. Beatrix Vierkorn-Rudolph,
> Stellvertretende Vorsitzende: Dr. Jutta Koch-Unterseher, Geschäftsführer:
> Prof. Dr. Anke Kaysser-Pyzalla, Prof. Dr. h.c. Wolfgang Eberhardt, Dr.
> Ulrich Breuer  Sitz Berlin, AG Charlottenburg, 89 HRB 5583
>
>
>
> _____________________________________
> 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.html
>
> 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
>