Proposals:Refactoring Statistics Framework 2007 Class Manifesto: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
No edit summary
 
(30 intermediate revisions by 2 users not shown)
Line 47: Line 47:
=== Measurement Containers ===
=== Measurement Containers ===


* KdTree
* KdTree <font style="color: #006400;">'''Refactored'''</font> (same name)
* Histogram <font style="color: #006400;">'''Refactored'''</font> (same name)  
* Histogram <font style="color: #006400;">'''Refactored'''</font> (same name)  
* VariableDimensionHistogram <font style="color: #0000a0;">'''ToBeRefactored'''</font> (same name)
* VariableDimensionHistogram <font style="color: #006400;">'''Refactored'''</font> (now provided as Histrogram)  
* ListSampleBase <font style="color: #8b0000;">'''Deprecated!'''</font>
* ListSampleBase <font style="color: #8b0000;">'''Deprecated!'''</font>
* ListSample <font style="color: #006400;">'''Refactored'''</font> (same name)
* ListSample <font style="color: #006400;">'''Refactored'''</font> (same name)
Line 69: Line 69:
=== Process Objects ===
=== Process Objects ===


* SampleClassifier
* SampleClassifier <font style="color: #006400;">'''Refactored'''</font> (as SampleClassifierFilter )
* SampleClassifierWithMask
* SampleClassifierWithMask<font style="color: #006400;">'''Will be Refactored'''</font> (as SampleClassifierWithMaskFilter ) PENDING


[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Process Objects | Migration Instructions ]]
[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Process Objects | Migration Instructions ]]
Line 82: Line 82:
=== MeanShift ===
=== MeanShift ===


* HypersphereKernelMeanShiftModeSeeker
* HypersphereKernelMeanShiftModeSeeker PENDING
* MeanShiftModeCacheMethod
* MeanShiftModeCacheMethod PENDING
* MeanShiftModeSeekerBase
* MeanShiftModeSeekerBase PENDING


[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #MeanShift | Migration Instructions ]]
[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #MeanShift | Migration Instructions ]]
Line 100: Line 100:
=== Univariate Distributions ===
=== Univariate Distributions ===


* ChiSquareDistribution
* ChiSquareDistribution COPIED
* GaussianDistribution
* GaussianDistribution COPIED
* ProbabilityDistribution
* ProbabilityDistribution COPIED
* TDistribution
* TDistribution COPIED


[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Univariate Distributions | Migration Instructions ]]
[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Univariate Distributions | Migration Instructions ]]
Line 109: Line 109:
=== Algorithms ===
=== Algorithms ===


* SampleAlgorithmBase
* SampleAlgorithmBase <font style="color: #8b0000;">'''Deprecated!'''</font>
* StatisticsAlgorithm
* StatisticsAlgorithm COPIED
* NeighborhoodSampler
* NeighborhoodSampler Refactored (must be renamed as NeighborhoodExtractionSampleFilter?)


[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Algorithms | Migration Instructions ]]
[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Algorithms | Migration Instructions ]]
Line 117: Line 117:
=== Calculators ===
=== Calculators ===


* CovarianceCalculator <font style="color: #006400;">'''Refactored'''</font> (now CovarianceFilter : ProcessObject)
* CovarianceCalculator <font style="color: #006400;">'''Refactored'''</font> (now CovarianceSampleFilter : ProcessObject)
* GreyLevelCooccurrenceMatrixTextureCoefficientsCalculator <font style="color: #006400;">'''Refactored'''</font> (now HistogramToTextureFeaturesFilter : ProcessObject)
* GreyLevelCooccurrenceMatrixTextureCoefficientsCalculator <font style="color: #006400;">'''Refactored'''</font> (now HistogramToTextureFeaturesFilter : ProcessObject)
* MeanCalculator <font style="color: #006400;">'''Refactored'''</font> (now MeanFilter : ProcessObject)
* MeanCalculator <font style="color: #006400;">'''Refactored'''</font> (now MeanSampleFilter : ProcessObject)
* ScalarImageTextureCalculator <font style="color: #006400;">'''Refactored'''</font> (now ScalarImageToTextureFeaturesFilter : ProcessObject)
* ScalarImageTextureCalculator <font style="color: #006400;">'''Refactored'''</font> (now ScalarImageToTextureFeaturesFilter : ProcessObject)
* WeightedCovarianceCalculator <font style="color: #006400;">'''Refactored'''</font> (now WeightedCovarianceFilter : ProcessObject)
* WeightedCovarianceCalculator <font style="color: #006400;">'''Refactored'''</font> (now WeightedCovarianceSampleFilter : ProcessObject)


* WeightedMeanCalculator <font style="color: #006400;">'''Refactored'''</font> (now WeightedMeanFilter : ProcessObject)
* WeightedMeanCalculator <font style="color: #006400;">'''Refactored'''</font> (now WeightedMeanSampleFilter : ProcessObject)


[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Calculators | Migration Instructions ]]
[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Calculators | Migration Instructions ]]
Line 131: Line 131:
* ImageToHistogramGenerator <font style="color: #006400;">'''Refactored'''</font> (now ImageToHistogramFilter)
* ImageToHistogramGenerator <font style="color: #006400;">'''Refactored'''</font> (now ImageToHistogramFilter)
* ImageToListGenerator <font style="color: #006400;">'''Refactored'''</font> (now ImageToListSampleFilter)
* ImageToListGenerator <font style="color: #006400;">'''Refactored'''</font> (now ImageToListSampleFilter)
* KdTreeGenerator
* KdTreeGenerator COPIED
* ListSampleToHistogramGenerator <font style="color: #006400;">'''Refactored'''</font> (now SampleToHistogramFilter)
* ListSampleToHistogramGenerator <font style="color: #006400;">'''Refactored'''</font> (now SampleToHistogramFilter)
* MaskedScalarImageToGreyLevelCooccurrenceMatrixGenerator <font style="color: #8b0000;">'''Deprecated!'''</font> (now managed by the ScalarImageToCooccurrenceMatrixFilter )
* MaskedScalarImageToGreyLevelCooccurrenceMatrixGenerator <font style="color: #8b0000;">'''Deprecated!'''</font> (now managed by the ScalarImageToCooccurrenceMatrixFilter )
Line 140: Line 140:
* ScalarImageToHistogramGenerator <font style="color: #006400;">'''Refactored'''</font> (now ImageToHistogramFilter)
* ScalarImageToHistogramGenerator <font style="color: #006400;">'''Refactored'''</font> (now ImageToHistogramFilter)
* SelectiveSubsampleGenerator <font style="color: #006400;">'''Refactored'''</font> (to be implemented as a type of  SubsampleFilter)
* SelectiveSubsampleGenerator <font style="color: #006400;">'''Refactored'''</font> (to be implemented as a type of  SubsampleFilter)
* WeightedCentroidKdTreeGenerator
* WeightedCentroidKdTreeGenerator COPIED


[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Generators | Migration Instructions ]]
[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Generators | Migration Instructions ]]
Line 146: Line 146:
=== Filters ===
=== Filters ===


* HistogramToEntropyImageFilter
* HistogramToEntropyImageFilter PENDING
* HistogramToImageFilter
* HistogramToImageFilter PENDING
* HistogramToIntensityImageFilter
* HistogramToIntensityImageFilter PENDING
* HistogramToLogProbabilityImageFilter
* HistogramToLogProbabilityImageFilter PENDING
* HistogramToProbabilityImageFilter
* HistogramToProbabilityImageFilter PENDING
* ListSampleToHistogramFilter <font style="color: #006400;">'''Refactored'''</font> (now SampleToHistogramFilter)
* ListSampleToHistogramFilter <font style="color: #006400;">'''Refactored'''</font> (now SampleToHistogramFilter)
* SampleMeanShiftBlurringFilter
* SampleMeanShiftBlurringFilter PENDING
* SampleMeanShiftClusteringFilter
* SampleMeanShiftClusteringFilter   PENDING
* SampleSelectiveMeanShiftBlurringFilter
* SampleSelectiveMeanShiftBlurringFilter   PENDING
* SampleToHistogramProjectionFilter
* SampleToHistogramProjectionFilter PENDING


[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Filters | Migration Instructions ]]
[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Filters | Migration Instructions ]]
Line 161: Line 161:
=== Multivariate Density Functions ===
=== Multivariate Density Functions ===


* DensityFunction
* DensityFunction <font style="color: #8b0000;">'''Deprecated!'''</font>
* DistanceToCentroidMembershipFunction
* DistanceToCentroidMembershipFunction <font style="color: #006400;">'''Refactored'''</font>
* GaussianDensityFunction
* GaussianDensityFunction <font style="color: #006400;">'''Refactored'''</font> (and renamed as GaussianMembershipFunction)
* GoodnessOfFitFunctionBase <font style="color: #8b0000;">'''Deprecated!'''</font> (has never been used in the toolkit)
* GoodnessOfFitFunctionBase <font style="color: #8b0000;">'''Deprecated!'''</font> (has never been used in the toolkit) (to keep ?)
* GoodnessOfFitMixtureModelCostFunction  <font style="color: #8b0000;">'''Deprecated!'''</font> (has never been used in the toolkit)
* GoodnessOfFitMixtureModelCostFunction  <font style="color: #8b0000;">'''Deprecated!'''</font> (has never been used in the toolkit)(to keep ?)
* LogLikelihoodGoodnessOfFitFunction  <font style="color: #8b0000;">'''Deprecated!'''</font> (has never been used in the toolkit)
* LogLikelihoodGoodnessOfFitFunction  <font style="color: #8b0000;">'''Deprecated!'''</font> (has never been used in the toolkit)(to keep ?)
* MahalanobisDistanceMembershipFunction
* MahalanobisDistanceMembershipFunction <font style="color: #8b0000;">'''Deprecated!'''</font> (functionality provided by the MembershipFunction + MahalanobisDistance)
* MembershipFunctionBase
* MembershipFunctionBase <font style="color: #006400;">'''Refactored'''</font> (same name)


[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Multivariate Density Functions | Migration Instructions ]]
[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Multivariate Density Functions | Migration Instructions ]]
Line 174: Line 174:
=== Distance Metrics ===
=== Distance Metrics ===


* DistanceMetric
* DistanceMetric <font style="color: #006400;">'''Refactored'''</font>
* EuclideanDistance
* EuclideanDistance <font style="color: #006400;">'''Refactored'''</font> (now EuclideanDistanceMetric)


[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Distance Metrics | Migration Instructions ]]
[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Distance Metrics | Migration Instructions ]]
=== Decision rules===
* DecisionRuleBase  <font style="color: #006400;">'''Refactored'''</font> (now DecisionRule)
* MinimumDecisionRule <font style="color: #006400;">'''Refactored'''</font> (same name +2)
* MaximumDecisionRule <font style="color: #006400;">'''Refactored'''</font> (same name +2)
* MaximumRatioDecisionRule <font style="color: #006400;">'''Refactored'''</font> (same name +2)
[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Decision rules | Migration Instructions ]]


=== Components ===
=== Components ===


* GaussianGoodnessOfFitComponent
* GaussianGoodnessOfFitComponent   PENDING
* GaussianMixtureModelComponent
* GaussianMixtureModelComponent   Refactored (review comment at end of .txx)
* GoodnessOfFitComponentBase
* GoodnessOfFitComponentBase       PENDING
* MixtureModelComponentBase
* MixtureModelComponentBase       Refactored (same name)


[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Components | Migration Instructions ]]
[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Components | Migration Instructions ]]
Line 190: Line 199:
=== Estimators ===
=== Estimators ===


* ExpectationMaximizationMixtureModelEstimator
* ExpectationMaximizationMixtureModelEstimator Refactored
* KdTreeBasedKmeansEstimator
* KdTreeBasedKmeansEstimator Refactored


[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Estimators | Migration Instructions ]]
[[Proposals:Refactoring Statistics Framework 2007 Migration Users Guide #Estimators | Migration Instructions ]]


=== Mixture of Model related classes ===
 
* ExpectationMaximizationMixtureModelEstimator
* GaussianMixtureModelComponent
* GoodnessOfFitMixtureModelCostFunction
* MixtureModelComponentBase


= Class Diagrams =
= Class Diagrams =

Latest revision as of 15:55, 29 April 2009

Statistics Class Manifesto

Summary Table

They are categorized in the following table


Conceptual Class Number
Measurement Containers 8
Frequency Containers 2
Process Objects 2
Traits 1
Mean shift 3
Adaptors 5
Univariate Distributions 4
Algorithms 3
Calculators 6
Generators 12
Filters 10
Multivariate Density Functions 8
Distance Metrics 2
Components 4
Estimators 2
Total 72

List of Classes per Category

Measurement Containers



  • KdTree Refactored (same name)
  • Histogram Refactored (same name)
  • VariableDimensionHistogram Refactored (now provided as Histrogram)
  • ListSampleBase Deprecated!
  • ListSample Refactored (same name)
  • Sample Refactored (same name) (now derives from DataObject)
  • Subsample Refactored (same name)(identifiers do not refer to sample anymore)
  • MembershipSample Refactored In Progress (same name. does not derive from sample anymore)


Migration Instructions

Frequency Containers

  • DenseFrequencyContainer Refactored (DenseFrequencyContainer2)
  • SparseFrequencyContainer Refactored (SparseFrequencyContainer2)

Note: The names of the frequency containers were suffixed by 2 to make them different from the frequency containers in ITK CVS to avoid linking problem with the ITKStatistics library Migration Instructions

Process Objects

  • SampleClassifier Refactored (as SampleClassifierFilter )
  • SampleClassifierWithMaskWill be Refactored (as SampleClassifierWithMaskFilter ) PENDING

Migration Instructions

Traits

  • MeasurementVectorTraits Refactored (same name)

Migration Instructions

MeanShift

  • HypersphereKernelMeanShiftModeSeeker PENDING
  • MeanShiftModeCacheMethod PENDING
  • MeanShiftModeSeekerBase PENDING

Migration Instructions

Adaptors

  • ImageToCooccurrenceListAdaptor Refactored ( now ScalarImageToCoocurrenceListSampleFilter )
  • ImageToListAdaptor Refactored ( now ImageToListSampleAdaptor )
  • JointDomainImageToListAdaptor Refactored ( now JointDomainImageToListSampleAdaptor )
  • PointSetToListAdaptor Refactored ( now PointSetToListSampleAdaptor )
  • ScalarImageToListAdaptor Deprecated!

Migration Instructions

Univariate Distributions

  • ChiSquareDistribution COPIED
  • GaussianDistribution COPIED
  • ProbabilityDistribution COPIED
  • TDistribution COPIED

Migration Instructions

Algorithms

  • SampleAlgorithmBase Deprecated!
  • StatisticsAlgorithm COPIED
  • NeighborhoodSampler Refactored (must be renamed as NeighborhoodExtractionSampleFilter?)

Migration Instructions

Calculators

  • CovarianceCalculator Refactored (now CovarianceSampleFilter : ProcessObject)
  • GreyLevelCooccurrenceMatrixTextureCoefficientsCalculator Refactored (now HistogramToTextureFeaturesFilter : ProcessObject)
  • MeanCalculator Refactored (now MeanSampleFilter : ProcessObject)
  • ScalarImageTextureCalculator Refactored (now ScalarImageToTextureFeaturesFilter : ProcessObject)
  • WeightedCovarianceCalculator Refactored (now WeightedCovarianceSampleFilter : ProcessObject)
  • WeightedMeanCalculator Refactored (now WeightedMeanSampleFilter : ProcessObject)

Migration Instructions

Generators

  • ImageToHistogramGenerator Refactored (now ImageToHistogramFilter)
  • ImageToListGenerator Refactored (now ImageToListSampleFilter)
  • KdTreeGenerator COPIED
  • ListSampleToHistogramGenerator Refactored (now SampleToHistogramFilter)
  • MaskedScalarImageToGreyLevelCooccurrenceMatrixGenerator Deprecated! (now managed by the ScalarImageToCooccurrenceMatrixFilter )
  • MembershipSampleGenerator Deprecated! (it should have been a type of Classifier filter .. to be implemented, Low priority)
  • NormalVariateGenerator Will stay as the only Generators
  • RandomVariateGeneratorBase Will stay as the only Generators
  • ScalarImageToGreyLevelCooccurrenceMatrixGenerator Refactored (now ScalarImageToCooccurrenceMatrixFilter )
  • ScalarImageToHistogramGenerator Refactored (now ImageToHistogramFilter)
  • SelectiveSubsampleGenerator Refactored (to be implemented as a type of SubsampleFilter)
  • WeightedCentroidKdTreeGenerator COPIED

Migration Instructions

Filters

  • HistogramToEntropyImageFilter PENDING
  • HistogramToImageFilter PENDING
  • HistogramToIntensityImageFilter PENDING
  • HistogramToLogProbabilityImageFilter PENDING
  • HistogramToProbabilityImageFilter PENDING
  • ListSampleToHistogramFilter Refactored (now SampleToHistogramFilter)
  • SampleMeanShiftBlurringFilter PENDING
  • SampleMeanShiftClusteringFilter PENDING
  • SampleSelectiveMeanShiftBlurringFilter PENDING
  • SampleToHistogramProjectionFilter PENDING

Migration Instructions

Multivariate Density Functions

  • DensityFunction Deprecated!
  • DistanceToCentroidMembershipFunction Refactored
  • GaussianDensityFunction Refactored (and renamed as GaussianMembershipFunction)
  • GoodnessOfFitFunctionBase Deprecated! (has never been used in the toolkit) (to keep ?)
  • GoodnessOfFitMixtureModelCostFunction Deprecated! (has never been used in the toolkit)(to keep ?)
  • LogLikelihoodGoodnessOfFitFunction Deprecated! (has never been used in the toolkit)(to keep ?)
  • MahalanobisDistanceMembershipFunction Deprecated! (functionality provided by the MembershipFunction + MahalanobisDistance)
  • MembershipFunctionBase Refactored (same name)

Migration Instructions

Distance Metrics

  • DistanceMetric Refactored
  • EuclideanDistance Refactored (now EuclideanDistanceMetric)

Migration Instructions

Decision rules

  • DecisionRuleBase Refactored (now DecisionRule)
  • MinimumDecisionRule Refactored (same name +2)
  • MaximumDecisionRule Refactored (same name +2)
  • MaximumRatioDecisionRule Refactored (same name +2)

Migration Instructions

Components

  • GaussianGoodnessOfFitComponent PENDING
  • GaussianMixtureModelComponent Refactored (review comment at end of .txx)
  • GoodnessOfFitComponentBase PENDING
  • MixtureModelComponentBase Refactored (same name)

Migration Instructions

Estimators

  • ExpectationMaximizationMixtureModelEstimator Refactored
  • KdTreeBasedKmeansEstimator Refactored

Migration Instructions


Class Diagrams

Measurement Containers

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


Frequency Containers

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

Process Objects

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

Traits

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

MeanShift

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

Adaptors

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

Univariate Distributions

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

Algorithms

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

Calculators

API

  • SetInputSample()
  • GetInputSample()
  • GetMeasurementVectorSize()
  • SetMeasurementVectorSize()
  • Update()
  • GenerateData()
  • GetOutput()

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.

Generators

API

  • SetInput() / SetSample()
  • GetImput()
  • SetClassMask()
  • GetClassMask()
  • GenerateData()
  • GetOutput()

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.

Filters

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

Multivariate Density Functions

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

Distance Metrics

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

Components

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

Estimators

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

Retrieved from "https://public.kitware.com/Wiki/index.php?title=Proposals:Refactoring_Statistics_Framework_2007_Class_Manifesto&oldid=15262"