ITK/Procedure for Contributing New Classes and Algorithms

From KitwarePublic
Revision as of 16:03, 2 December 2005 by Ibanez (talk | contribs)
Jump to navigationJump to search


This page describes the procedure for contributing new algorithms and classes to the Insight Toolkit.

The Rationale

The rationale behind this procedure is to pursue the following goals

  1. Technical correctness of new contributions
  2. Avoid duplication of functionalities
  3. Maximize reuse of existing code
  4. Maximize generalization of the algorithm implementations
  5. Enforce validation, testing and code coverage
  6. Maximize maintainability
  7. Ensure that new algorithms are properly documented
  8. Gather feedback from the community
  9. Hold a continuously open forum where algorithmic, and performance issues are discussed.

Since some of these goals may be conflicting, it will be the prerrogative of the Oversight Committee to rule on whether one criteria should be given more importance over another one.

Technical Correctness

The community should pounder whether the technical concepts behind a new algorithm are acceptable. Technical correctness requires the contributor to provide a background on the proposed algorithm. Some algorithms may be so widely known that a simple citation to a major paper describing the algorithm may be enough for satisfying the requirement of technical correctness. Less known algorithms would require more detailed descriptions in order to make the case for their technical correctness. There are no hard rules on how deep this description should be. The only clear cut criteria is that it should be clear enough for not raising major objections from the community.

The Procedure

The procedure for contributing new classes and algorithms is the following.

  1. An Author will propose an algorithm to the developers list or to the weekly tcon.
    This will be an initial check to make sure that the algorithm is not already available in ITK, or that it can not be constructed with components already existing on the toolkit.
  2. The Author will prepare a working prototype of source code and will tested with realistic data.
  3. The Author will submit a paper to the Insight Journal.
    The paper must include the following
    1. The source code of the prototype
    2. The source code of the test
    3. The realistic input data required by the test
    4. The full list of parameters required by the test
    5. The output data produced by the test
    6. A document (preferably a hyperlinked PDF) describing the algorithm and how to use the new classes
  4. The source code of the prototype and it test will be automatically compiled an executed by the testing system of the Insight Journal.