ITK
6.0.0
Insight Toolkit
|
#include <itkFlatStructuringElement.h>
A class to support a variety of flat structuring elements, including versions created by decomposition of lines.
FlatStructuringElement provides several static methods, which can be used to create a structuring element with a particular shape, size, etc. Currently, those methods enable the creation of the following structuring elements: ball, box, cross, annulus, or polygon. Polygons are available as fast approximations of balls using line decompositions. Boxes also use line decompositions.
"Flat" refers to binary as opposed to grayscale structuring elements. Flat structuring elements can be used for both binary and grayscale images.
A Neighborhood has an N-dimensional radius. The radius is defined separately for each dimension as the number of pixels that the neighborhood extends outward from the center pixel. For example, a 2D Neighborhood object with a radius of 2x3 has sides of length 5x7. However, in the case of balls and annuli, this definition is slightly different from the parametric definition of those objects. For example, an ellipse of radius 2x3 has a diameter of 4x6, not 5x7. To have a diameter of 5x7, the radius would need to increase by 0.5 in each dimension. Thus, the "radius" of the neighborhood and the "radius" of the object should be distinguished.
To accomplish this, the "ball" and "annulus" structuring elements have an optional flag called "radiusIsParametric" (off by default). Setting this flag to true will use the parametric definition of the object and will generate structuring elements with more accurate areas, which can be especially important when morphological operations are intended to remove or retain objects of particular sizes. When the mode is turned off (default), the radius is the same, but the object diameter is set to (radius*2)+1, which is the size of the neighborhood region. Thus, the original ball and annulus structuring elements have a systematic bias in the radius of +0.5 voxels in each dimension relative to the parametric definition of the radius. Thus, we recommend turning this mode on for more accurate structuring elements, but this mode is turned off by default for backward compatibility.
As an example, a 3D ball of radius 5 should have an area of 523. With this mode turned on, the number of "on" pixels is 515 (error 1.6%), but with it turned off, the area is 739 (error 41%). For a 3D annulus of radius 5 and thickness 2, the area should be 410. With this mode turned on, the area is 392 (error 4.5%), but when turned off it is 560 (error 36%). This same trend holds for balls and annuli of any radius or dimension. For more detailed experiments with this mode, please refer to the results of the test itkFlatStructuringElementTest.cxx or the wiki example.
Definition at line 86 of file itkFlatStructuringElement.h.
Classes | |
struct | StructuringElementFacet |
Public Types | |
using | DecompType = std::vector< LType > |
using | ImageType = typename itk::Image< PixelType, VDimension > |
using | LType = Vector< float, VDimension > |
using | Self = FlatStructuringElement< VDimension > |
using | Superclass = Neighborhood< bool, VDimension > |
Public Types inherited from itk::Neighborhood< bool, VDimension > | |
using | AllocatorType = NeighborhoodAllocator< bool > |
using | ConstIterator = typename AllocatorType::const_iterator |
using | DimensionValueType = unsigned int |
using | Iterator = typename AllocatorType::iterator |
using | NeighborIndexType = SizeValueType |
using | OffsetType = Offset< VDimension > |
using | PixelType = bool |
using | RadiusType = itk::Size< VDimension > |
using | Self = Neighborhood |
using | SizeType = itk::Size< VDimension > |
using | SizeValueType = typename SizeType::SizeValueType |
using | SliceIteratorType = SliceIterator< bool, Self > |
Static Public Member Functions | |
static Self | Annulus (RadiusType radius, unsigned int thickness=1, bool includeCenter=false, bool radiusIsParametric=false) |
static Self | Ball (RadiusType radius, bool radiusIsParametric=false) |
static Self | Box (RadiusType radius) |
static Self | Cross (RadiusType radius) |
static Self | FromImage (const ImageType *image) |
static Self | Polygon (RadiusType radius, unsigned int lines) |
Static Public Attributes | |
static constexpr unsigned int | NeighborhoodDimension = VDimension |
Static Public Attributes inherited from itk::Neighborhood< bool, VDimension > | |
static constexpr unsigned int | NeighborhoodDimension |
Protected Member Functions | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
Protected Member Functions inherited from itk::Neighborhood< bool, VDimension > | |
virtual void | Allocate (NeighborIndexType i) |
virtual void | ComputeNeighborhoodOffsetTable () |
virtual void | ComputeNeighborhoodStrideTable () |
virtual void | PrintSelf (std::ostream &, Indent) const |
void | SetSize () |
Private Types | |
using | FacetType = StructuringElementFacet< VDimension > |
using | FacetType3 = StructuringElementFacet< 3 > |
using | LType2 = Vector< float, 2 > |
using | LType3 = Vector< float, 3 > |
Static Private Member Functions | |
static RadiusType | CheckImageSize (const ImageType *image) |
static void | GeneratePolygon (itk::FlatStructuringElement< 2 > &res, itk::Size< 2 > radius, unsigned int lines) |
static void | GeneratePolygon (itk::FlatStructuringElement< 3 > &res, itk::Size< 3 > radius, unsigned int lines) |
template<typename TStructuringElement , typename TRadius > | |
static void | GeneratePolygon (TStructuringElement &res, TRadius radius, unsigned int lines) |
Private Attributes | |
bool | m_Decomposable {} |
DecompType | m_Lines {} |
bool | m_RadiusIsParametric {} |
using itk::FlatStructuringElement< VDimension >::DecompType = std::vector<LType> |
Definition at line 116 of file itkFlatStructuringElement.h.
|
private |
Definition at line 237 of file itkFlatStructuringElement.h.
|
private |
Definition at line 248 of file itkFlatStructuringElement.h.
using itk::FlatStructuringElement< VDimension >::ImageType = typename itk::Image<PixelType, VDimension> |
ImageType used in constructors
Definition at line 119 of file itkFlatStructuringElement.h.
using itk::FlatStructuringElement< VDimension >::LType = Vector<float, VDimension> |
Definition at line 115 of file itkFlatStructuringElement.h.
|
private |
Definition at line 245 of file itkFlatStructuringElement.h.
|
private |
Definition at line 247 of file itkFlatStructuringElement.h.
using itk::FlatStructuringElement< VDimension >::Self = FlatStructuringElement<VDimension> |
Standard class type aliases.
Definition at line 90 of file itkFlatStructuringElement.h.
using itk::FlatStructuringElement< VDimension >::Superclass = Neighborhood<bool, VDimension> |
Definition at line 91 of file itkFlatStructuringElement.h.
|
overridedefault |
Default destructor.
|
inline |
Default constructor.
Definition at line 125 of file itkFlatStructuringElement.h.
|
inline |
Return the lines associated with the structuring element
Definition at line 184 of file itkFlatStructuringElement.h.
|
static |
Create an annulus structuring element
|
static |
Create a ball structuring element
|
static |
Various constructors Create a box structuring element. The structuring element is is decomposable.
|
staticprivate |
Check for correct odd size image. Return image size. Called in constructor FromImage.
bool itk::FlatStructuringElement< VDimension >::CheckParallel | ( | LType | NewVec | ) | const |
void itk::FlatStructuringElement< VDimension >::ComputeBufferFromLines | ( | ) |
Fill the buffer of the structuring element based on the lines associated to the structuring element
|
static |
Create a cross structuring element
|
static |
Create a FlatStructureElement from a bool image. Image must be odd in all dimensions.
|
staticprivate |
|
staticprivate |
|
staticprivate |
|
inline |
Returns whether the structuring element is decomposable or not. If the structuring is decomposable, the set of lines associated with the structuring may be used by an algorithm instead of the standard buffer.
Definition at line 166 of file itkFlatStructuringElement.h.
Referenced by itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >::MakeKernel().
|
inline |
Return the lines associated with the structuring element
Definition at line 179 of file itkFlatStructuringElement.h.
|
inline |
The RadiusIsParametric mode ensures that the area of the foreground corresponds to the radius that was specified. This defaults to "off" for backward compatibility.
Definition at line 206 of file itkFlatStructuringElement.h.
|
static |
Create a polygon structuring element. The structuring element is is decomposable. lines is the number of elements in the decomposition
|
overrideprotectedvirtual |
Standard itk object method.
Reimplemented from itk::Neighborhood< bool, VDimension >.
|
virtual |
The RadiusIsParametric mode ensures that the area of the foreground corresponds to the radius that was specified. This defaults to "off" for backward compatibility.
|
inline |
Returns whether the structuring element is decomposable or not. If the structuring is decomposable, the set of lines associated with the structuring may be used by an algorithm instead of the standard buffer.
Definition at line 171 of file itkFlatStructuringElement.h.
|
inline |
The RadiusIsParametric mode ensures that the area of the foreground corresponds to the radius that was specified. This defaults to "off" for backward compatibility.
Definition at line 211 of file itkFlatStructuringElement.h.
|
private |
Definition at line 228 of file itkFlatStructuringElement.h.
|
private |
Definition at line 230 of file itkFlatStructuringElement.h.
|
private |
Definition at line 250 of file itkFlatStructuringElement.h.
|
staticconstexpr |
External support for dimensionality.
Definition at line 113 of file itkFlatStructuringElement.h.