ITK Release 4/Users Migration Guide/Migration Guide XML Samples: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
Line 222: Line 222:
<!--***************************************************************************
<!--***************************************************************************
**
**
** LabelObjectImproveAttributes.xml
** MoveGetSetLengthMeasurementVectorTraits.xml
**
**
** This is the second sample Migration Guide XML document. For full details,
** This is the second sample Migration Guide XML document. For full details,
Line 270: Line 270:
   <SampleCode>
   <SampleCode>
     <OldCode>
     <OldCode>
     typedef typename itk::ShapeOpeningLabelMapFilter&lt; LabelMapType &gt; OpeningType;
     typedef ShapeLabelObject LabelObjectType;
     typename OpeningType::Pointer opening = OpeningType::New();
     LabelObjectType::Pointer labelObject;
     opening->SetAttribute( "SizeOnBorder" );
     LabelObjectType::RegionType region = labelObject->GetRegion();
     </OldCode>
     </OldCode>


     <NewCode>
     <NewCode>
     typedef typename itk::ShapeOpeningLabelMapFilter&lt; LabelMapType &gt; OpeningType;
     typedef TLabelObject LabelObjectType;
     typename OpeningType::Pointer opening = OpeningType::New();
     LabelObjectType::Pointer labelObject;
     opening->SetAttribute( itk::LabelObject::NUMBER_OF_PIXELS_ON_BORDER );
     LabelObjectType::RegionType region = labelObject->GetBoundingBox();
     </NewCode>
     </NewCode>
   </SampleCode>
   </SampleCode>
Line 308: Line 308:
   Testing/Code/Review/itkAttributeUniqueLabelMapFilterTest1.cxx
   Testing/Code/Review/itkAttributeUniqueLabelMapFilterTest1.cxx
   Testing/Code/Review/itkLabelMapToAttributeImageFilterTest1.cxx
   Testing/Code/Review/itkLabelMapToAttributeImageFilterTest1.cxx
   Testing/Code/Review/itkShapeLabelObjectAccessorsTest1.cxx
   Testing/Code/Review/itkShapeLabelObjectAccessorsTest1.cxx
   </FileList>
   </FileList>


Line 320: Line 320:


   <!--
   <!--
   ** Migration guide rules
   ** Migration tool rules
   **-->
   **-->
   <MigrationFix-Automatic type="AttributeRename">
   <MigrationFix-Manual>
    <Old>
  BinaryElongation
    LabelObjectType::SIZE
   </MigrationFix-Manual>
    </Old>
    <New>
    LabelObjectType::NUMBER_OF_PIXELS
    </New>
   </MigrationFix-Automatic>


   <MigrationFix-Automatic type="AttributeRename">
   <MigrationFix-Manual>
    <Old>
  BINARY_ELONGATION
    LabelObjectType::BINARY_ELONGATION
   </MigrationFix-Manual>
    </Old>
    <New>
    LabelObjectType::ELONGATION
    </New>
   </MigrationFix-Automatic>


   <MigrationFix-Automatic type="AttributeRename">
   <MigrationFix-Manual>
    <Old>
  BinaryFlatness
    LabelObjectType::BINARY_FLATNESS
   </MigrationFix-Manual>
    </Old>
    <New>
    LabelObjectType::FLATNESS
    </New>
   </MigrationFix-Automatic>


   <MigrationFix-Automatic type="AttributeRename">
   <MigrationFix-Manual>
    <Old>
  BINARY_FLATNESS
    LabelObjectType::BINARY_PRINCIPAL_MOMENTS
   </MigrationFix-Manual>
    </Old>
    <New>
    LabelObjectType::PRINCIPAL_MOMENTS
    </New>
   </MigrationFix-Automatic>


   <MigrationFix-Automatic type="AttributeRename">
   <MigrationFix-Manual>
    <Old>
  BinaryPrincipalMoments
    LabelObjectType::BINARY_PRINCIPAL_AXES
   </MigrationFix-Manual>
    </Old>
    <New>
    LabelObjectType::PRINCIPAL_AXES
    </New>
   </MigrationFix-Automatic>


   <MigrationFix-Automatic type="AttributeRename">
   <MigrationFix-Manual>
    <Old>
  BINARY_PRINCIPAL_MOMENTS
    LabelObjectType::ELONGATION
   </MigrationFix-Manual>
    </Old>
    <New>
    LabelObjectType::WEIGHTED_ELONGATION
    </New>
   </MigrationFix-Automatic>


   <MigrationFix-Automatic type="AttributeRename">
   <MigrationFix-Manual>
    <Old>
  BinaryPrincipalAxes
    LabelObjectType::EQUIVALENT_ELLIPSOID_SIZE
   </MigrationFix-Manual>
    </Old>
    <New>
    LabelObjectType::EQUIVALENT_ELLIPSOID_DIAMETER
    </New>
   </MigrationFix-Automatic>


   <MigrationFix-Automatic type="AttributeRename">
   <MigrationFix-Manual>
    <Old>
  BINARY_PRINCIPAL_AXES
    LabelObjectType::EQUIVALENT_PARIMETER
   </MigrationFix-Manual>
    </Old>
    <New>
    LabelObjectType::EQUIVALENT_SPHERICAL_PERIMETER
    </New>
   </MigrationFix-Automatic>


   <MigrationFix-Automatic type="AttributeRename">
   <MigrationFix-Manual>
    <Old>
  Elongation
    LabelObjectType::EQUIVALENT_RADIUS
   </MigrationFix-Manual>
    </Old>
    <New>
    LabelObjectType::EQUIVALENT_SPHERICAL_RADIUS
    </New>
   </MigrationFix-Automatic>


   <MigrationFix-Automatic type="AttributeRename">
   <MigrationFix-Manual>
    <Old>
  ELONGATION
    LabelObjectType::FLATNESS
   </MigrationFix-Manual>
    </Old>
    <New>
    LabelObjectType::WEIGHTED_FLATNESS
    </New>
   </MigrationFix-Automatic>


   <MigrationFix-Automatic type="AttributeRename">
   <MigrationFix-Manual>
    <Old>
  EquivalentEllipsoidSize
    LabelObjectType::PHYSICAL_SIZE_ON_BORDER
   </MigrationFix-Manual>
    </Old>
    <New>
    LabelObjectType::PERIMETER_ON_BORDER
    </New>
   </MigrationFix-Automatic>


   <MigrationFix-Automatic type="AttributeRename">
   <MigrationFix-Manual>
    <Old>
  EQUIVALENT_ELLIPSOID_SIZE
    LabelObjectType::REGION
   </MigrationFix-Manual>
    </Old>
    <New>
    LabelObjectType::BOUNDING_BOX
    </New>
   </MigrationFix-Automatic>


   <MigrationFix-Automatic type="AttributeRename">
   <MigrationFix-Manual>
    <Old>
  EquivalentPerimeter
    LabelObjectType::PRINCIPAL_AXES
   </MigrationFix-Manual>
    </Old>
    <New>
    LabelObjectType::WEIGHTED_PRINCIPAL_AXES
    </New>
   </MigrationFix-Automatic>


   <MigrationFix-Automatic type="AttributeRename">
   <MigrationFix-Manual>
    <Old>
  EQUIVALENT_PERIMETER
    LabelObjectType::PRINCIPAL_MOMENTS
   </MigrationFix-Manual>
    </Old>
    <New>
    LabelObjectType::WEIGHTED_PRINCIPAL_MOMENTS
    </New>
   </MigrationFix-Automatic>


   <MigrationFix-Automatic type="AttributeRename">
   <MigrationFix-Manual>
    <Old>
  EquivalentRadius
    LabelObjectType::SIGMA
   </MigrationFix-Manual>
    </Old>
    <New>
    LabelObjectType::STANDARD_DEVIATION
    </New>
   </MigrationFix-Automatic>


   <MigrationFix-Automatic type="AttributeRename">
   <MigrationFix-Manual>
    <Old>
  EQUIVALENT_RADIUS
    LabelObjectType::SIZE_ON_BORDER
  </MigrationFix-Manual>
    </Old>
 
    <New>
  <MigrationFix-Manual>
    LabelObjectType::NUMBER_OF_PIXELS_ON_BORDER
  Flatness
    </New>
  </MigrationFix-Manual>
   </MigrationFix-Automatic>
 
  <MigrationFix-Manual>
  FLATNESS
  </MigrationFix-Manual>
 
  <MigrationFix-Manual>
  PhysicalSizeOnBorder
  </MigrationFix-Manual>
 
  <MigrationFix-Manual>
  PHYSICAL_SIZE_ON_BORDER
  </MigrationFix-Manual>
 
  <MigrationFix-Manual>
  Region
  </MigrationFix-Manual>
 
  <MigrationFix-Manual>
  REGION
  </MigrationFix-Manual>
 
  <MigrationFix-Manual>
  PrincipalAxes
  </MigrationFix-Manual>
 
  <MigrationFix-Manual>
  PRINCIPAL_AXES
  </MigrationFix-Manual>
 
  <MigrationFix-Manual>
  PrincipalMoments
  </MigrationFix-Manual>
 
  <MigrationFix-Manual>
  PRINCIPAL_MOMENTS
  </MigrationFix-Manual>
 
  <MigrationFix-Manual>
  Sigma
  </MigrationFix-Manual>
 
  <MigrationFix-Manual>
  SIGMA
  </MigrationFix-Manual>
 
  <MigrationFix-Manual>
  Size
  </MigrationFix-Manual>
 
  <MigrationFix-Manual>
  SIZE
  </MigrationFix-Manual>
 
  <MigrationFix-Manual>
  SizeOnBorder
  </MigrationFix-Manual>
 
  <MigrationFix-Manual>
  SIZE_ON_BORDER
   </MigrationFix-Manual>


</Change>
</Change>
</source>
</source>

Revision as of 18:19, 5 November 2010

Sample Files

The wiki is not particularly friendly about uploading xml documents (security issue I think), so the following page shows two examples directly.

Example 1 - Move GetLength and SetLength from MeasurementVectorTraits to NumericTraits

<source lang="xml"> <?xml version="1.0" encoding="UTF-8"?>


<Change> 

 <Title>
 Move GetLength and SetLength Functions from MeasurementVectorTraits to NumericTraits
 </Title>

 <Description>
 In an attempt to consolidate the numeric traits api, we are moving all
 functionality from Code/Numerics/Statistics/itkMeasurementVectorTraits.h into
 the individual NumericTraits files in Code/Common.
 </Description>

 <SampleCode>
   <OldCode>
   MeasurementVectorType mv;
   MeasurementVectorTraits::SetLength( mv, 3 );
   unsigned int length = MeasurementVectorTraits::GetLength( mv );
   </OldCode>

   <NewCode>
   MeasurementVectorType mv;
   NumericTraits<MeasurementVectorType>::SetLength( mv, 3 );
   unsigned int length = NumericTraits<MeasurementVectorType>::GetLength( mv );
   </NewCode>
 </SampleCode>

 <FileList>
 Code/Common/itkNumericTraitsArrayPixel.h
 Code/Common/itkNumericTraitsCovariantVectorPixel.h
 Code/Common/itkNumericTraitsDiffusionTensor3DPixel.h
 Code/Common/itkNumericTraitsFixedArrayPixel.h
 Code/Common/itkNumericTraitsPointPixel.h
 Code/Common/itkNumericTraitsRGBAPixel.h
 Code/Common/itkNumericTraitsRGBPixel.h
 Code/Common/itkNumericTraitsStdVector.h
 Code/Common/itkNumericTraitsTensorPixel.h
 Code/Common/itkNumericTraitsVariableLengthVectorPixel.h
 Code/Common/itkNumericTraitsVectorPixel.h
 Code/Numerics/Statistics/itkCovarianceSampleFilter.txx
 Code/Numerics/Statistics/itkDistanceMetric.h
 Code/Numerics/Statistics/itkDistanceMetric.txx
 Code/Numerics/Statistics/itkEuclideanDistanceMetric.txx
 Code/Numerics/Statistics/itkEuclideanSquareDistanceMetric.txx
 Code/Numerics/Statistics/itkExpectationMaximizationMixtureModelEstimator.txx
 Code/Numerics/Statistics/itkGaussianMembershipFunction.txx
 Code/Numerics/Statistics/itkGaussianMixtureModelComponent.txx
 Code/Numerics/Statistics/itkImageToListSampleFilter.txx
 Code/Numerics/Statistics/itkKdTree.txx
 Code/Numerics/Statistics/itkKdTreeBasedKmeansEstimator.h
 Code/Numerics/Statistics/itkKdTreeBasedKmeansEstimator.txx
 Code/Numerics/Statistics/itkKdTreeGenerator.txx
 Code/Numerics/Statistics/itkListSample.txx
 Code/Numerics/Statistics/itkMahalanobisDistanceMetric.txx
 Code/Numerics/Statistics/itkManhattanDistanceMetric.txx
 Code/Numerics/Statistics/itkMeasurementVectorTraits.h
 Code/Numerics/Statistics/itkMembershipFunctionBase.h
 Code/Numerics/Statistics/itkSample.h
 Code/Numerics/Statistics/itkSampleToHistogramFilter.txx
 Code/Numerics/Statistics/itkScalarImageToHistogramGenerator.txx
 Code/Numerics/Statistics/itkStandardDeviationPerComponentSampleFilter.txx
 Code/Numerics/Statistics/itkStatisticsAlgorithm.txx
 Code/Numerics/Statistics/itkWeightedCentroidKdTreeGenerator.txx
 Code/Numerics/Statistics/itkWeightedCovarianceSampleFilter.txx
 Testing/Code/Numerics/Statistics/CMakeLists.txt
 Testing/Code/Numerics/Statistics/itkDistanceToCentroidMembershipFunctionTest.cxx
 Testing/Code/Numerics/Statistics/itkEuclideanDistanceMetricTest.cxx
 Testing/Code/Numerics/Statistics/itkEuclideanSquareDistanceMetricTest.cxx
 Testing/Code/Numerics/Statistics/itkGaussianMembershipFunctionTest.cxx
 Testing/Code/Numerics/Statistics/itkListSampleTest.cxx
 Testing/Code/Numerics/Statistics/itkMahalanobisDistanceMetricTest.cxx
 Testing/Code/Numerics/Statistics/itkManhattanDistanceMetricTest.cxx
 Testing/Code/Numerics/Statistics/itkMembershipSampleTest1.cxx
 Testing/Code/Numerics/Statistics/itkMembershipSampleTest2.cxx
 Testing/Code/Numerics/Statistics/itkMembershipSampleTest3.cxx
 Testing/Code/Numerics/Statistics/itkMembershipSampleTest4.cxx
 Testing/Code/Numerics/Statistics/itkSampleClassifierFilterTest1.cxx
 Testing/Code/Numerics/Statistics/itkSampleClassifierFilterTest2.cxx
 Testing/Code/Numerics/Statistics/itkSampleClassifierFilterTest3.cxx
 Testing/Code/Numerics/Statistics/itkSampleClassifierFilterTest4.cxx
 Testing/Code/Numerics/Statistics/itkSampleClassifierFilterTest5.cxx
 Testing/Code/Numerics/Statistics/itkSampleClassifierFilterTest6.cxx
 Testing/Code/Numerics/Statistics/itkStatisticsTests.cxx
 Testing/Code/Numerics/Statistics/itkWeightedCentroidKdTreeGeneratorTest8.cxx
 Testing/Code/Numerics/Statistics/itkWeightedCentroidKdTreeGeneratorTest9.cxx
 Testing/Code/Numerics/Statistics/itkWeightedCovarianceSampleFilterTest2.cxx
 </FileList>

 <Gerrit-ChangeId>
 Ie78170c85c29a5d030e5ab605610878fe67d75c2
 </Gerrit-ChangeId>



 <MigrationFix-Manual type="MethodRefactor">
   <Old>
   MeasurementVectorTraits::GetLength
   </Old>
 </MigrationFix-Manual>

 <MigrationFix-Manual type="MethodRefactor">
   <Old>
   MeasurementVectorTraits::SetLength
   </Old>
 </MigrationFix-Manual>


</Change> </source>

Example 2 - Improve Attribute Names for Label Objects

<source lang="xml"> <?xml version="1.0" encoding="UTF-8"?>


<Change> 

 <Title>
 Improve Attribute Names for Labels
 </Title>

 <Description>
 This change updates the attribute names for the LabelObject system.  The
 changes are:

 BinaryElongation        -> Elongation
 BinaryFlatness          -> Flatness
 BinaryPrincipalMoments  -> PrincipalMoments
 BinaryPrincipalAxes     -> PrincipalAxes
 Elongation              -> WeightedElongation
 EquivalentEllipsoidSize -> EquivalentEllipsoidDiameter
 EquivalentPerimeter     -> EquivalentSphericalPerimeter
 EquivalentRadius        -> EquivalentSphericalRadius
 Flatness                -> WeightedFlatness
 PhysicalSizeOnBorder    -> PerimeterOnBorder
 Region                  -> BoundingBox
 PrincipalAxes           -> WeightedPrincipalAxes
 PrincipalMoments        -> WeightedPrincipalMoments
 Sigma                   -> StandardDeviation
 Size                    -> NumberOfPixels
 SizeOnBorder            -> NumberOfPixelsOnBorder
 </Description>

 <SampleCode>
   <OldCode>
   typedef ShapeLabelObject LabelObjectType;
   LabelObjectType::Pointer labelObject;
   LabelObjectType::RegionType region = labelObject->GetRegion();
   </OldCode>

   <NewCode>
   typedef TLabelObject LabelObjectType;
   LabelObjectType::Pointer labelObject;
   LabelObjectType::RegionType region = labelObject->GetBoundingBox();
   </NewCode>
 </SampleCode>

 <FileList>
 Code/Review/itkBinaryFillholeImageFilter.txx
 Code/Review/itkBinaryGrindPeakImageFilter.txx
 Code/Review/itkBinaryShapeKeepNObjectsImageFilter.txx
 Code/Review/itkBinaryShapeOpeningImageFilter.txx
 Code/Review/itkLabelMapUtilities.h
 Code/Review/itkLabelShapeKeepNObjectsImageFilter.txx
 Code/Review/itkLabelShapeOpeningImageFilter.txx
 Code/Review/itkShapeKeepNObjectsLabelMapFilter.txx
 Code/Review/itkShapeLabelMapFilter.txx
 Code/Review/itkShapeLabelObject.h
 Code/Review/itkShapeLabelObjectAccessors.h
 Code/Review/itkShapeOpeningLabelMapFilter.txx
 Code/Review/itkShapeRelabelImageFilter.txx
 Code/Review/itkShapeRelabelLabelMapFilter.txx
 Code/Review/itkShapeUniqueLabelMapFilter.txx
 Code/Review/itkStatisticsLabelMapFilter.txx
 Code/Review/itkStatisticsLabelObject.h
 Code/Review/itkStatisticsLabelObjectAccessors.h
 Testing/Code/Review/itkAttributePositionLabelMapFilterTest1.cxx
 Testing/Code/Review/itkAttributeUniqueLabelMapFilterTest1.cxx
 Testing/Code/Review/itkLabelMapToAttributeImageFilterTest1.cxx
 Testing/Code/Review/itkShapeLabelObjectAccessorsTest1.cxx
 </FileList>

 <Gerrit-ChangeId>
 Ib5bdca1cd1809490f1c5a0f991c7cc2714d33c70
 </Gerrit-ChangeId>



 <MigrationFix-Manual>
 BinaryElongation
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 BINARY_ELONGATION
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 BinaryFlatness
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 BINARY_FLATNESS
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 BinaryPrincipalMoments
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 BINARY_PRINCIPAL_MOMENTS
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 BinaryPrincipalAxes
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 BINARY_PRINCIPAL_AXES
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 Elongation
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 ELONGATION
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 EquivalentEllipsoidSize
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 EQUIVALENT_ELLIPSOID_SIZE
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 EquivalentPerimeter
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 EQUIVALENT_PERIMETER
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 EquivalentRadius
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 EQUIVALENT_RADIUS
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 Flatness
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 FLATNESS
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 PhysicalSizeOnBorder
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 PHYSICAL_SIZE_ON_BORDER
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 Region
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 REGION
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 PrincipalAxes
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 PRINCIPAL_AXES
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 PrincipalMoments
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 PRINCIPAL_MOMENTS
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 Sigma
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 SIGMA
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 Size
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 SIZE
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 SizeOnBorder
 </MigrationFix-Manual>

 <MigrationFix-Manual>
 SIZE_ON_BORDER
 </MigrationFix-Manual>

</Change> </source>

Retrieved from "https://public.kitware.com/Wiki/index.php?title=ITK_Release_4/Users_Migration_Guide/Migration_Guide_XML_Samples&oldid=33800"