Proposals:Refactoring Statistics Framework 2007

From KitwarePublic
Jump to navigationJump to search

ITK: Statistical Framework Refactoring

Summary

Motivation

Recently it has been found that certain characteristics of the Statistical Framework API could be improved in order to provide a more consistent inteface.

In particular, issues have been pointed out regarding the following topics

  • Iterators
  • Samples versus Subsamples
  • Statistical calculator integrated into the pipeline


Tasks

The proposed refactoring will include the following specific tasks

  • Review all iterators used in the Statistics framework and add tests for their functionalities until bringing their code coverage to 100%
  • Restructure the implementation of the Subsample class, to make sure that
    • It can be used in any place where a sample can be used.
    • Sub-sampling can be nested without breaking the consistency of the statistical operation.

Schedule

The refactoring tasks will be initiated on March 23rd and will be completed before April 15th 2007

Specific Program

Tasks

Class Manifesto

There are 72 header files in the Statistics directory.

They are subdivided in

  • 4 Distributions
  • 6 Calculators
  • 12 Generators
Conceptual Class Number
Containers
Distributions 4
Calculators 6
Generators 12
Adaptors
Total 72

Iterators Review

The goal of this task is to ensure that the set of iterators is consistent with the set of data containers and that all the iterators are tested to a 100% code coverage.

List of Data Containers

  • itk::Sample
  • itk::Histogram
  • itk::ListSampleBase
  • itk::ListSample
  • itk::MembershipSample
  • itk::VariableDimensionHistogram
  • itk::DenseFrequencyContainer
  • itk::SparseFrequencyContainer
  • itk::ImageToCooccurrenceListAdaptor
  • itk::ImageToListAdaptor
  • itk::JointDomainImageToListAdaptor
  • itk::PointSetToListAdaptor
  • itk::ScalarImageToListAdaptor


List of Iterators

Class Diagram

This is a graph with borders and nodes. Maybe there is an Imagemap used so the nodes may be linking to some Pages.