Skip to content

Commit

Permalink
DOC: Consolidated documentation between parent and child classes
Browse files Browse the repository at this point in the history
  • Loading branch information
richardbeare authored and hjmjohnson committed Sep 6, 2022
1 parent 7211d4a commit 0210da1
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 46 deletions.
22 changes: 5 additions & 17 deletions Modules/Nonunit/Review/include/itkAreaClosingImageFilter.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,23 +26,11 @@ namespace itk
* \class AreaClosingImageFilter
* \brief Morphological closing by attributes
*
* This is the base class for morphology attribute
* operations. Attribute openings remove blobs according to criteria
* such as area. When applied to grayscale images it has the effect of
* trimming peaks based on area while leaving the rest of the image
* unchanged. It is possible to use attributes besides area, but no
* others are implemented yet. This filter uses some dodgy coding
* practices - most notably copying the image data to a linear buffer
* to allow direct implementation of the published algorithm. It
* should therefore be quite a good candidate to carry out tests of
* itk iterator performance with randomish access patterns.
*
* This filter is implemented using the method of Wilkinson, "A
* comparison of algorithms for Connected set openings and Closings",
* A. Meijster and M. H. Wilkinson, PAMI, vol 24, no. 4, April 2002.
* Attempts at implementing the method from ISMM 2000 are also
* included, but operation appears incorrect. Check the ifdefs if you
* are interested.
* Attribute closing remove blobs according to criteria
* such as area. When applied to grayscale images they have the effect of
* filling valleys (regions darker than their surroundings)
* based on area while leaving the rest of the image
* unchanged.
*
* This code was contributed in the Insight Journal paper
*
Expand Down
22 changes: 5 additions & 17 deletions Modules/Nonunit/Review/include/itkAreaOpeningImageFilter.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,11 @@ namespace itk
* \class AreaOpeningImageFilter
* \brief Morphological opening by attributes
*
* This is the base class for morphology attribute
* operations. Attribute openings remove blobs according to criteria
* such as area. When applied to grayscale images it has the effect of
* trimming peaks based on area while leaving the rest of the image
* unchanged. It is possible to use attributes besides area, but no
* others are implemented yet. This filter uses some dodgy coding
* practices - most notably copying the image data to a linear buffer
* to allow direct implementation of the published algorithm. It
* should therefore be quite a good candidate to carry out tests of
* itk iterator performance with randomish access patterns.
*
* This filter is implemented using the method of Wilkinson, "A
* comparison of algorithms for Connected set openings and Closings",
* A. Meijster and M. H. Wilkinson, PAMI, vol 24, no. 4, April 2002.
* Attempts at implementing the method from ISMM 2000 are also
* included, but operation appears incorrect. Check the ifdefs if you
* are interested.
* Attribute openings remove blobs according to criteria
* such as area. When applied to grayscale images they have the effect of
* trimming peaks (regions brighter than their surrounings)
* based on area while leaving the rest of the image
* unchanged.
*
* This code was contributed in the Insight Journal paper
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,22 +30,15 @@ namespace itk
* \brief Morphological opening by attributes
*
* This is the base class for morphology attribute
* operations. Attribute openings remove blobs according to criteria
* such as area. When applied to grayscale images it has the effect of
* trimming peaks based on area while leaving the rest of the image
* unchanged. It is possible to use attributes besides area, but no
* others are implemented yet. This filter uses some dodgy coding
* practices - most notably copying the image data to a linear buffer
* to allow direct implementation of the published algorithm. It
* should therefore be quite a good candidate to carry out tests of
* itk iterator performance with randomish access patterns.
* operations. Attribute operations remove blobs according to criteria
* such as area. Attribute openings remove bright regions that meet the
* attribute criteria (i.e. regions less than a user specified area or
* volume) while attribute closings fill dark regions that meet the
* attribute criteria.
*
* This filter is implemented using the method of Wilkinson, "A
* comparison of algorithms for Connected set openings and Closings",
* A. Meijster and M. H. Wilkinson, PAMI, vol 24, no. 4, April 2002.
* Attempts at implementing the method from ISMM 2000 are also
* included, but operation appears incorrect. Check the ifdefs if you
* are interested.
*
* This code was contributed in the Insight Journal paper
*
Expand Down

0 comments on commit 0210da1

Please sign in to comment.