Converts a label image to a label map and valuates the shape attributes. More...

#include <sitkLabelShapeStatisticsImageFilter.h>

Inheritance diagram for itk::simple::LabelShapeStatisticsImageFilter:

Collaboration diagram for itk::simple::LabelShapeStatisticsImageFilter:

Public Types
typedef IntegerPixelIDTypeList	PixelIDTypeList

typedef LabelShapeStatisticsImageFilter	Self

Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter	Self

Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
Self &	ComputeFeretDiameterOff ()

Self &	ComputeFeretDiameterOn ()

Self &	ComputeOrientedBoundingBoxOff ()

Self &	ComputeOrientedBoundingBoxOn ()

Self &	ComputePerimeterOff ()

Self &	ComputePerimeterOn ()

void	Execute (const Image &image1)

void	Execute (const Image &image1, double backgroundValue, bool computeFeretDiameter, bool computePerimeter, bool computeOrientedBoundingBox)

double	GetBackgroundValue () const

std::vector< unsigned int >	GetBoundingBox (int64_t label) const

std::vector< double >	GetCentroid (int64_t label) const

bool	GetComputeFeretDiameter () const

bool	GetComputeOrientedBoundingBox () const

bool	GetComputePerimeter () const

double	GetElongation (int64_t label) const

std::vector< double >	GetEquivalentEllipsoidDiameter (int64_t label) const

double	GetEquivalentSphericalPerimeter (int64_t label) const

double	GetEquivalentSphericalRadius (int64_t label) const

double	GetFeretDiameter (int64_t label) const

double	GetFlatness (int64_t label) const

std::vector< int64_t >	GetLabels () const

std::string	GetName () const

uint64_t	GetNumberOfLabels ()

uint64_t	GetNumberOfPixels (int64_t label) const

uint64_t	GetNumberOfPixelsOnBorder (int64_t label) const

std::vector< double >	GetOrientedBoundingBoxDirection (int64_t label) const

std::vector< double >	GetOrientedBoundingBoxOrigin (int64_t label) const

std::vector< double >	GetOrientedBoundingBoxSize (int64_t label) const

std::vector< double >	GetOrientedBoundingBoxVertices (int64_t label) const

double	GetPerimeter (int64_t label) const

double	GetPerimeterOnBorder (int64_t label) const

double	GetPerimeterOnBorderRatio (int64_t label) const

double	GetPhysicalSize (int64_t label) const

std::vector< double >	GetPrincipalAxes (int64_t label) const

std::vector< double >	GetPrincipalMoments (int64_t label) const

double	GetRoundness (int64_t label) const

bool	HasLabel (int64_t label)

	LabelShapeStatisticsImageFilter ()

Self &	SetBackgroundValue (double BackgroundValue)

Self &	SetComputeFeretDiameter (bool ComputeFeretDiameter)

Self &	SetComputeOrientedBoundingBox (bool ComputeOrientedBoundingBox)

Self &	SetComputePerimeter (bool ComputePerimeter)

std::string	ToString () const

virtual	~LabelShapeStatisticsImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter< 1 >
	ImageFilter ()

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...

virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands. More...

virtual	~ProcessObject ()

virtual void	DebugOn ()

virtual void	DebugOff ()

virtual bool	GetDebug () const

virtual void	SetDebug (bool debugFlag)

virtual void	SetNumberOfThreads (unsigned int n)

virtual unsigned int	GetNumberOfThreads () const

Private Types
typedef void(Self::*	MemberFunctionType) (const Image &image1)

Private Member Functions
template<class TImageType >
void	ExecuteInternal (const Image &image1)

Private Attributes
double	m_BackgroundValue

bool	m_ComputeFeretDiameter

bool	m_ComputeOrientedBoundingBox

bool	m_ComputePerimeter

itk::ProcessObject *	m_Filter

std::vector< int64_t >	m_Labels

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

nsstd::function< std::vector< unsigned int >int64_t)>	m_pfGetBoundingBox

nsstd::function< std::vector< double >int64_t)>	m_pfGetCentroid

nsstd::function< double(int64_t)>	m_pfGetElongation

nsstd::function< std::vector< double >int64_t)>	m_pfGetEquivalentEllipsoidDiameter

nsstd::function< double(int64_t)>	m_pfGetEquivalentSphericalPerimeter

nsstd::function< double(int64_t)>	m_pfGetEquivalentSphericalRadius

nsstd::function< double(int64_t)>	m_pfGetFeretDiameter

nsstd::function< double(int64_t)>	m_pfGetFlatness

nsstd::function< uint64_t(int64_t)>	m_pfGetNumberOfPixels

nsstd::function< uint64_t(int64_t)>	m_pfGetNumberOfPixelsOnBorder

nsstd::function< std::vector< double >int64_t)>	m_pfGetOrientedBoundingBoxDirection

nsstd::function< std::vector< double >int64_t)>	m_pfGetOrientedBoundingBoxOrigin

nsstd::function< std::vector< double >int64_t)>	m_pfGetOrientedBoundingBoxSize

nsstd::function< std::vector< double >int64_t)>	m_pfGetOrientedBoundingBoxVertices

nsstd::function< double(int64_t)>	m_pfGetPerimeter

nsstd::function< double(int64_t)>	m_pfGetPerimeterOnBorder

nsstd::function< double(int64_t)>	m_pfGetPerimeterOnBorderRatio

nsstd::function< double(int64_t)>	m_pfGetPhysicalSize

nsstd::function< std::vector< double >int64_t)>	m_pfGetPrincipalAxes

nsstd::function< std::vector< double >int64_t)>	m_pfGetPrincipalMoments

nsstd::function< double(int64_t)>	m_pfGetRoundness

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()

static void	GlobalDefaultDebugOff ()

static void	GlobalDefaultDebugOn ()

static void	SetGlobalDefaultDebug (bool debugFlag)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static void	SetGlobalWarningDisplay (bool flag)

static bool	GetGlobalWarningDisplay ()

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()

static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)

virtual itk::ProcessObject *	GetActiveProcess ()

virtual void	OnActiveProcessDelete ()

virtual void	onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()

Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
static void	FixNonZeroIndex (TImageType *img)

Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer	CastImageToITK (const Image &img)

template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

template<class TImageType >
static Image	CastITKToImage (TImageType *img)

static const itk::EventObject &	GetITKEventObject (EventEnum e)

template<typename T >
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)

static std::ostream &	ToStringHelper (std::ostream &os, const char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Detailed Description

Converts a label image to a label map and valuates the shape attributes.

A convenient class that converts a label image to a label map and valuates the shape attribute at once.

This implementation was taken from the Insight Journal paper:

https://hdl.handle.net/1926/584 or http://www.insight-journal.org/browse/publication/176

Author: Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

See also: ShapeLabelObject , LabelShapeOpeningImageFilter , LabelStatisticsOpeningImageFilter

Wiki Examples:

All Examples

Convert an itk::Image consisting of labeled regions to a ShapeLabelMap

See also: itk::LabelImageToShapeLabelMapFilter for the Doxygen on the original ITK class.

Definition at line 56 of file sitkLabelShapeStatisticsImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

typedef void(Self::* itk::simple::LabelShapeStatisticsImageFilter::MemberFunctionType) (const Image &image1)

private

Setup for member function dispatching

Definition at line 345 of file sitkLabelShapeStatisticsImageFilter.h.

◆ PixelIDTypeList

typedef IntegerPixelIDTypeList itk::simple::LabelShapeStatisticsImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 68 of file sitkLabelShapeStatisticsImageFilter.h.

◆ Self

typedef LabelShapeStatisticsImageFilter itk::simple::LabelShapeStatisticsImageFilter::Self

Definition at line 58 of file sitkLabelShapeStatisticsImageFilter.h.

Constructor & Destructor Documentation

◆ ~LabelShapeStatisticsImageFilter()

virtual itk::simple::LabelShapeStatisticsImageFilter::~LabelShapeStatisticsImageFilter ( )

virtual

Destructor

◆ LabelShapeStatisticsImageFilter()

itk::simple::LabelShapeStatisticsImageFilter::LabelShapeStatisticsImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ ComputeFeretDiameterOff()

Self& itk::simple::LabelShapeStatisticsImageFilter::ComputeFeretDiameterOff ( )

inline

Definition at line 89 of file sitkLabelShapeStatisticsImageFilter.h.

◆ ComputeFeretDiameterOn()

Self& itk::simple::LabelShapeStatisticsImageFilter::ComputeFeretDiameterOn ( )

inline

Set the value of ComputeFeretDiameter to true or false respectfully.

Definition at line 88 of file sitkLabelShapeStatisticsImageFilter.h.

◆ ComputeOrientedBoundingBoxOff()

Self& itk::simple::LabelShapeStatisticsImageFilter::ComputeOrientedBoundingBoxOff ( )

inline

Definition at line 117 of file sitkLabelShapeStatisticsImageFilter.h.

◆ ComputeOrientedBoundingBoxOn()

Self& itk::simple::LabelShapeStatisticsImageFilter::ComputeOrientedBoundingBoxOn ( )

inline

Set the value of ComputeOrientedBoundingBox to true or false respectfully.

Definition at line 116 of file sitkLabelShapeStatisticsImageFilter.h.

◆ ComputePerimeterOff()

Self& itk::simple::LabelShapeStatisticsImageFilter::ComputePerimeterOff ( )

inline

Definition at line 103 of file sitkLabelShapeStatisticsImageFilter.h.

◆ ComputePerimeterOn()

Self& itk::simple::LabelShapeStatisticsImageFilter::ComputePerimeterOn ( )

inline

Set the value of ComputePerimeter to true or false respectfully.

Definition at line 102 of file sitkLabelShapeStatisticsImageFilter.h.

◆ Execute() [1/2]

void itk::simple::LabelShapeStatisticsImageFilter::Execute ( const Image & image1 )

Execute the filter on the input image

◆ Execute() [2/2]

void itk::simple::LabelShapeStatisticsImageFilter::Execute	(	const Image &	image1,
		double	backgroundValue,
		bool	computeFeretDiameter,
		bool	computePerimeter,
		bool	computeOrientedBoundingBox
	)

Execute the filter on the input image with the given parameters

◆ ExecuteInternal()

template<class TImageType >

void itk::simple::LabelShapeStatisticsImageFilter::ExecuteInternal ( const Image & image1 )

private

◆ GetBackgroundValue()

double itk::simple::LabelShapeStatisticsImageFilter::GetBackgroundValue ( ) const

inline

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::NonpositiveMin() .

Definition at line 80 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetBoundingBox()

std::vector<unsigned int> itk::simple::LabelShapeStatisticsImageFilter::GetBoundingBox ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 130 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetCentroid()

std::vector<double> itk::simple::LabelShapeStatisticsImageFilter::GetCentroid ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 139 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetComputeFeretDiameter()

bool itk::simple::LabelShapeStatisticsImageFilter::GetComputeFeretDiameter ( ) const

inline

Set/Get whether the maximum Feret diameter should be computed or not. Default value is false, because of the high computation time required.

Definition at line 94 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetComputeOrientedBoundingBox()

bool itk::simple::LabelShapeStatisticsImageFilter::GetComputeOrientedBoundingBox ( ) const

inline

Set/Get whether the oriented bounding box should be computed or not. Default value is false because of potential memory consumption issues with sparse labels.

Definition at line 122 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetComputePerimeter()

bool itk::simple::LabelShapeStatisticsImageFilter::GetComputePerimeter ( ) const

inline

Set/Get whether the perimeter should be computed or not. Default value is false, because of the high computation time required.

Definition at line 108 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetElongation()

double itk::simple::LabelShapeStatisticsImageFilter::GetElongation ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 148 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetEquivalentEllipsoidDiameter()

std::vector<double> itk::simple::LabelShapeStatisticsImageFilter::GetEquivalentEllipsoidDiameter ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 157 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetEquivalentSphericalPerimeter()

double itk::simple::LabelShapeStatisticsImageFilter::GetEquivalentSphericalPerimeter ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 166 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetEquivalentSphericalRadius()

double itk::simple::LabelShapeStatisticsImageFilter::GetEquivalentSphericalRadius ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 175 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetFeretDiameter()

double itk::simple::LabelShapeStatisticsImageFilter::GetFeretDiameter ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 184 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetFlatness()

double itk::simple::LabelShapeStatisticsImageFilter::GetFlatness ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 193 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetLabels()

std::vector<int64_t> itk::simple::LabelShapeStatisticsImageFilter::GetLabels ( ) const

inline

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Definition at line 201 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetName()

std::string itk::simple::LabelShapeStatisticsImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 321 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetNumberOfLabels()

uint64_t itk::simple::LabelShapeStatisticsImageFilter::GetNumberOfLabels ( )

Return the number of labels after execution.

◆ GetNumberOfPixels()

uint64_t itk::simple::LabelShapeStatisticsImageFilter::GetNumberOfPixels ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 210 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetNumberOfPixelsOnBorder()

uint64_t itk::simple::LabelShapeStatisticsImageFilter::GetNumberOfPixelsOnBorder ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 219 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetOrientedBoundingBoxDirection()

std::vector<double> itk::simple::LabelShapeStatisticsImageFilter::GetOrientedBoundingBoxDirection ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 309 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetOrientedBoundingBoxOrigin()

std::vector<double> itk::simple::LabelShapeStatisticsImageFilter::GetOrientedBoundingBoxOrigin ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 300 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetOrientedBoundingBoxSize()

std::vector<double> itk::simple::LabelShapeStatisticsImageFilter::GetOrientedBoundingBoxSize ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 291 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetOrientedBoundingBoxVertices()

std::vector<double> itk::simple::LabelShapeStatisticsImageFilter::GetOrientedBoundingBoxVertices ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 318 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetPerimeter()

double itk::simple::LabelShapeStatisticsImageFilter::GetPerimeter ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 228 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetPerimeterOnBorder()

double itk::simple::LabelShapeStatisticsImageFilter::GetPerimeterOnBorder ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 237 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetPerimeterOnBorderRatio()

double itk::simple::LabelShapeStatisticsImageFilter::GetPerimeterOnBorderRatio ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 246 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetPhysicalSize()

double itk::simple::LabelShapeStatisticsImageFilter::GetPhysicalSize ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 255 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetPrincipalAxes()

std::vector<double> itk::simple::LabelShapeStatisticsImageFilter::GetPrincipalAxes ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 264 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetPrincipalMoments()

std::vector<double> itk::simple::LabelShapeStatisticsImageFilter::GetPrincipalMoments ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 273 of file sitkLabelShapeStatisticsImageFilter.h.

◆ GetRoundness()

double itk::simple::LabelShapeStatisticsImageFilter::GetRoundness ( int64_t label ) const

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 282 of file sitkLabelShapeStatisticsImageFilter.h.

◆ HasLabel()

bool itk::simple::LabelShapeStatisticsImageFilter::HasLabel ( int64_t label )

Does the specified label exist? Can only be called after a call a call to Update().

◆ SetBackgroundValue()

Self& itk::simple::LabelShapeStatisticsImageFilter::SetBackgroundValue ( double BackgroundValue )

inline

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::NonpositiveMin() .

Definition at line 75 of file sitkLabelShapeStatisticsImageFilter.h.

◆ SetComputeFeretDiameter()

Self& itk::simple::LabelShapeStatisticsImageFilter::SetComputeFeretDiameter ( bool ComputeFeretDiameter )

inline

Set/Get whether the maximum Feret diameter should be computed or not. Default value is false, because of the high computation time required.

Definition at line 85 of file sitkLabelShapeStatisticsImageFilter.h.

◆ SetComputeOrientedBoundingBox()

Self& itk::simple::LabelShapeStatisticsImageFilter::SetComputeOrientedBoundingBox ( bool ComputeOrientedBoundingBox )

inline

Set/Get whether the oriented bounding box should be computed or not. Default value is false because of potential memory consumption issues with sparse labels.

Definition at line 113 of file sitkLabelShapeStatisticsImageFilter.h.