[Insight-users] Doxygen reading

[Matt McCormick]

Antonin Perrot-Audet <antonin07130 at ...> writes:
> 
> itk::BinaryMorphologicalClosingImageFilter< TInputImage, TOutputImage, 
> TKernel >
> 
> Thanks to the pdf documentation, I now exactly what can be a 
> TInputeImage, ToutputImage, but I have been trying very hard, with no 
> success to find *what could be a TKernel*???
> 
> Thanks to the pdf documentation as well I can say that the "structuring 
> element" classes would work here. Where can I find a quick description 
> of the templates in the Doxygen documentation ? because I am quite sure 
> that if I use a string for a TKernel, that wouldn't work.
> 

Side note: itk::FlatStructuringElement is more flexible and works well too.  
You can read more about it here:
http://insight-journal.org/browse/publication/124

> This is an example, but it happenned with several different classes, and 
> thanks to the examples, I could figure out what I needed.
> 
> I have had quite a similar problem while looking for the 
> numericaltraits, a google search gives :
> 
> 
http://www.itk.org/Doxygen314/html/classitk_1_1NumericTraits_3_01FixedArray_3_01
unsigned_01long_00_011_01_4_01_4.html
> from that, I could go to the source, and come back to a more general 
> documentation.
> 
> I could not figure out how to use Doxygen to access this class' definition.

The VXL library has its own Doxygen documentation:

http://public.kitware.com/vxl/doc/development/core/vnl/html/index.html


> In the A-Z list, numericaltraits doesn't appear.
> 
> If someone could give me some advises and hints for using this 
> documentation? Otherwise, the pdf manual, and the examples are helping a 
> lot.
> 
> Thanks,
> 
> Antonin

The Doxygen documentation for ITK is fantastic and the ITK software guide is a 
beautiful thing.  As you mention, the examples are also nice.  If there are 
still missing pieces, try the Insight Journal: http://insight-journal.org/.  
There are often background, examples, and usage directions for contributed code.

After a while, I have learned it is much more efficient to just read the code 
instead of searching on google for an answer.  And The Goog might not have the 
answer anyway.  The source has all the answers, and it is very readable.  You 
can learn a lot quickly by looking at the code.  I start with the header, then 
move on the the implementation.