#include <itkBinaryStatisticsKeepNObjectsImageFilter.h>

Detailed Description

template<typename TInputImage, typename TFeatureImage>
class itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >

keep N objects according to their statistics attributes

BinaryStatisticsKeepNObjectsImageFilter keep the N objects in a binary image with the highest (or lowest) attribute value. The attributes are the ones of the StatisticsLabelObject.

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

This implementation was taken from the Insight Journal paper: https://doi.org/10.54294/q6auw4

See also: StatisticsLabelObject, LabelStatisticsKeepNObjectsImageFilter, BinaryShapeKeepNObjectsImageFilter

Definition at line 46 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

Inheritance diagram for itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >:

Collaboration diagram for itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >:

Public Types
using	AttributeType = typename LabelObjectType::AttributeType

using	BinarizerType = LabelMapToBinaryImageFilter< LabelMapType, OutputImageType >

using	ConstPointer = SmartPointer< const Self >

using	FeatureImageConstPointer = typename FeatureImageType::ConstPointer

using	FeatureImagePixelType = typename FeatureImageType::PixelType

using	FeatureImagePointer = typename FeatureImageType::Pointer

using	FeatureImageType = TFeatureImage

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	KeepNObjectsType = StatisticsKeepNObjectsLabelMapFilter< LabelMapType >

using	LabelizerType = BinaryImageToLabelMapFilter< InputImageType, LabelMapType >

using	LabelMapType = LabelMap< LabelObjectType >

using	LabelObjectType = StatisticsLabelObject< LabelType, Self::ImageDimension >

using	LabelObjectValuatorType = StatisticsLabelMapFilter< LabelMapType, TFeatureImage >

using	LabelType = SizeValueType

using	OutputImageConstPointer = typename OutputImageType::ConstPointer

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = BinaryStatisticsKeepNObjectsImageFilter

using	Superclass = ImageToImageFilter< TInputImage, TInputImage >

Public Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TInputImage >

Public Types inherited from itk::ImageSource< TInputImage >
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

using	Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
const FeatureImageType *	GetFeatureImage ()

const char *	GetNameOfClass () const override

void	SetFeatureImage (const TFeatureImage *input)

void	SetInput1 (const InputImageType *input)

void	SetInput2 (const FeatureImageType *input)


virtual void	SetFullyConnected (bool _arg)

virtual const bool &	GetFullyConnected () const

virtual void	FullyConnectedOn ()


virtual void	SetBackgroundValue (OutputImagePixelType _arg)

virtual OutputImagePixelType	GetBackgroundValue () const


virtual void	SetForegroundValue (OutputImagePixelType _arg)

virtual OutputImagePixelType	GetForegroundValue () const


virtual SizeValueType	GetNumberOfObjects () const

virtual void	SetNumberOfObjects (SizeValueType _arg)


virtual bool	GetReverseOrdering () const

virtual void	SetReverseOrdering (bool _arg)

virtual void	ReverseOrderingOn ()


virtual AttributeType	GetAttribute () const

virtual void	SetAttribute (AttributeType _arg)

void	SetAttribute (const std::string &s)

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TInputImage >
OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

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

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TInputImage::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TInputImage >
static constexpr unsigned int	OutputImageDimension

Protected Member Functions
	BinaryStatisticsKeepNObjectsImageFilter ()

void	EnlargeOutputRequestedRegion (DataObject *) override

void	GenerateData () override

void	GenerateInputRequestedRegion () override

void	PrintSelf (std::ostream &os, Indent indent) const override

	~BinaryStatisticsKeepNObjectsImageFilter () override=default

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

void	PrintSelf (std::ostream &os, Indent indent) const override

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

Protected Member Functions inherited from itk::ImageSource< TInputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
AttributeType	m_Attribute {}

OutputImagePixelType	m_BackgroundValue {}

OutputImagePixelType	m_ForegroundValue {}

bool	m_FullyConnected { false }

SizeValueType	m_NumberOfObjects { 0 }

bool	m_ReverseOrdering { false }

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Static Protected Member Functions inherited from itk::ImageSource< TInputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ImageSource< TInputImage >
bool	m_DynamicMultiThreading

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ AttributeType

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::AttributeType = typename LabelObjectType::AttributeType

Definition at line 85 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ BinarizerType

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::BinarizerType = LabelMapToBinaryImageFilter<LabelMapType, OutputImageType>

Definition at line 87 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ ConstPointer

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::ConstPointer = SmartPointer<const Self>

Definition at line 55 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ FeatureImageConstPointer

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::FeatureImageConstPointer = typename FeatureImageType::ConstPointer

Definition at line 71 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ FeatureImagePixelType

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::FeatureImagePixelType = typename FeatureImageType::PixelType

Definition at line 72 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ FeatureImagePointer

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::FeatureImagePointer = typename FeatureImageType::Pointer

Definition at line 70 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ FeatureImageType

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::FeatureImageType = TFeatureImage

Definition at line 69 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 61 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 63 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 60 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 62 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 58 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ KeepNObjectsType

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::KeepNObjectsType = StatisticsKeepNObjectsLabelMapFilter<LabelMapType>

Definition at line 86 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ LabelizerType

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::LabelizerType = BinaryImageToLabelMapFilter<InputImageType, LabelMapType>

Definition at line 83 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ LabelMapType

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::LabelMapType = LabelMap<LabelObjectType>

Definition at line 82 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ LabelObjectType

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::LabelObjectType = StatisticsLabelObject<LabelType, Self::ImageDimension>

Definition at line 81 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ LabelObjectValuatorType

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::LabelObjectValuatorType = StatisticsLabelMapFilter<LabelMapType, TFeatureImage>

Definition at line 84 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ LabelType

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::LabelType = SizeValueType

Definition at line 79 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ OutputImageConstPointer

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::OutputImageConstPointer = typename OutputImageType::ConstPointer

Definition at line 65 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ OutputImagePixelType

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::OutputImagePixelType = typename OutputImageType::PixelType

Definition at line 67 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 64 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 66 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::OutputImageType = TInputImage

Definition at line 59 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::Pointer = SmartPointer<Self>

Definition at line 54 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ Self

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::Self = BinaryStatisticsKeepNObjectsImageFilter

Standard class type aliases.

Definition at line 52 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TFeatureImage >

using itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::Superclass = ImageToImageFilter<TInputImage, TInputImage>

Definition at line 53 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

Constructor & Destructor Documentation

◆ BinaryStatisticsKeepNObjectsImageFilter()

template<typename TInputImage , typename TFeatureImage >

itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::BinaryStatisticsKeepNObjectsImageFilter ( )

protected

◆ ~BinaryStatisticsKeepNObjectsImageFilter()

template<typename TInputImage , typename TFeatureImage >

itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::~BinaryStatisticsKeepNObjectsImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ EnlargeOutputRequestedRegion()

template<typename TInputImage , typename TFeatureImage >

void itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::EnlargeOutputRequestedRegion ( DataObject * )

overrideprotectedvirtual

BinaryStatisticsKeepNObjectsImageFilter will produce the entire output.

Reimplemented from itk::ProcessObject.

◆ FullyConnectedOn()

template<typename TInputImage , typename TFeatureImage >

virtual void itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::FullyConnectedOn ( )

virtual

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

◆ GenerateData()

template<typename TInputImage , typename TFeatureImage >

void itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::GenerateData ( )

overrideprotectedvirtual

Single-threaded version of GenerateData. This filter delegates to GrayscaleGeodesicErodeImageFilter.

Reimplemented from itk::ProcessObject.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TFeatureImage >

void itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

BinaryStatisticsKeepNObjectsImageFilter needs the entire input be available. Thus, it needs to provide an implementation of GenerateInputRequestedRegion().

Reimplemented from itk::ProcessObject.

◆ GetAttribute()

template<typename TInputImage , typename TFeatureImage >

virtual AttributeType itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::GetAttribute ( ) const

virtual

Set/Get the attribute to use to select the object to keep. The default is "Mean".

◆ GetBackgroundValue()

template<typename TInputImage , typename TFeatureImage >

virtual OutputImagePixelType itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::GetBackgroundValue ( ) const

virtual

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

◆ GetFeatureImage()

template<typename TInputImage , typename TFeatureImage >

const FeatureImageType* itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::GetFeatureImage ( )

inline

Get the feature image

Definition at line 170 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

References itk::ProcessObject::GetInput().

◆ GetForegroundValue()

template<typename TInputImage , typename TFeatureImage >

virtual OutputImagePixelType itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::GetForegroundValue ( ) const

virtual

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

◆ GetFullyConnected()

template<typename TInputImage , typename TFeatureImage >

virtual const bool& itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::GetFullyConnected ( ) const

virtual

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

◆ GetNameOfClass()

template<typename TInputImage , typename TFeatureImage >

const char* itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

◆ GetNumberOfObjects()

template<typename TInputImage , typename TFeatureImage >

virtual SizeValueType itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::GetNumberOfObjects ( ) const

virtual

Set/Get the number of objects to keep

◆ GetReverseOrdering()

template<typename TInputImage , typename TFeatureImage >

virtual bool itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::GetReverseOrdering ( ) const

virtual

Set/Get the ordering of the objects. By default, the ones with the highest value are kept. Turming ReverseOrdering to true make this filter keep the objects with the smallest values

◆ New()

template<typename TInputImage , typename TFeatureImage >

static Pointer itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::New ( )

static

Standard New method.

◆ PrintSelf()

template<typename TInputImage , typename TFeatureImage >

void itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ProcessObject.

◆ ReverseOrderingOn()

template<typename TInputImage , typename TFeatureImage >

virtual void itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::ReverseOrderingOn ( )

virtual

Set/Get the ordering of the objects. By default, the ones with the highest value are kept. Turming ReverseOrdering to true make this filter keep the objects with the smallest values

◆ SetAttribute() [1/2]

template<typename TInputImage , typename TFeatureImage >

virtual void itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::SetAttribute ( AttributeType _arg )

virtual

Set/Get the attribute to use to select the object to keep. The default is "Mean".

◆ SetAttribute() [2/2]

template<typename TInputImage , typename TFeatureImage >

void itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::SetAttribute ( const std::string & s )

inline

Set/Get the attribute to use to select the object to keep. The default is "Mean".

Definition at line 154 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ SetBackgroundValue()

template<typename TInputImage , typename TFeatureImage >

virtual void itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::SetBackgroundValue ( OutputImagePixelType _arg )

virtual

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

◆ SetFeatureImage()

template<typename TInputImage , typename TFeatureImage >

void itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::SetFeatureImage ( const TFeatureImage * input )

inline

Set the feature image

Definition at line 162 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ SetForegroundValue()

template<typename TInputImage , typename TFeatureImage >

virtual void itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::SetForegroundValue ( OutputImagePixelType _arg )

virtual

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

◆ SetFullyConnected()

template<typename TInputImage , typename TFeatureImage >

virtual void itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::SetFullyConnected ( bool _arg )

virtual

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

◆ SetInput1()

template<typename TInputImage , typename TFeatureImage >

void itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::SetInput1 ( const InputImageType * input )

inline

Set the input image

Definition at line 177 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ SetInput2()

template<typename TInputImage , typename TFeatureImage >

void itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::SetInput2 ( const FeatureImageType * input )

inline

Set the feature image

Definition at line 184 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ SetNumberOfObjects()

template<typename TInputImage , typename TFeatureImage >

virtual void itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::SetNumberOfObjects ( SizeValueType _arg )

virtual

Set/Get the number of objects to keep

◆ SetReverseOrdering()

template<typename TInputImage , typename TFeatureImage >

virtual void itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::SetReverseOrdering ( bool _arg )

virtual

Set/Get the ordering of the objects. By default, the ones with the highest value are kept. Turming ReverseOrdering to true make this filter keep the objects with the smallest values

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TFeatureImage >

constexpr unsigned int itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::ImageDimension = TInputImage::ImageDimension

staticconstexpr

Definition at line 77 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ InputImageDimension

template<typename TInputImage , typename TFeatureImage >

constexpr unsigned int itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::InputImageDimension = TInputImage::ImageDimension

staticconstexpr

ImageDimension constants

Definition at line 75 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ m_Attribute

template<typename TInputImage , typename TFeatureImage >

AttributeType itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::m_Attribute {}

private

Definition at line 216 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ m_BackgroundValue

template<typename TInputImage , typename TFeatureImage >

OutputImagePixelType itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::m_BackgroundValue {}

private

Definition at line 212 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ m_ForegroundValue

template<typename TInputImage , typename TFeatureImage >

OutputImagePixelType itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::m_ForegroundValue {}

private

Definition at line 213 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ m_FullyConnected

template<typename TInputImage , typename TFeatureImage >

bool itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::m_FullyConnected { false }

private

Definition at line 211 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ m_NumberOfObjects

template<typename TInputImage , typename TFeatureImage >

SizeValueType itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::m_NumberOfObjects { 0 }

private

Definition at line 214 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ m_ReverseOrdering

template<typename TInputImage , typename TFeatureImage >

bool itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::m_ReverseOrdering { false }

private

Definition at line 215 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

◆ OutputImageDimension

template<typename TInputImage , typename TFeatureImage >

constexpr unsigned int itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::OutputImageDimension = TInputImage::ImageDimension

staticconstexpr

Definition at line 76 of file itkBinaryStatisticsKeepNObjectsImageFilter.h.

The documentation for this class was generated from the following file:

itkBinaryStatisticsKeepNObjectsImageFilter.h

Detailed Description

template<typename TInputImage, typename TFeatureImage> class itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ AttributeType

◆ BinarizerType

◆ ConstPointer

◆ FeatureImageConstPointer

◆ FeatureImagePixelType

◆ FeatureImagePointer

◆ FeatureImageType

◆ InputImageConstPointer

◆ InputImagePixelType

◆ InputImagePointer

◆ InputImageRegionType

◆ InputImageType

◆ KeepNObjectsType

◆ LabelizerType

◆ LabelMapType

◆ LabelObjectType

◆ LabelObjectValuatorType

◆ LabelType

◆ OutputImageConstPointer

◆ OutputImagePixelType

◆ OutputImagePointer

◆ OutputImageRegionType

◆ OutputImageType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ BinaryStatisticsKeepNObjectsImageFilter()

◆ ~BinaryStatisticsKeepNObjectsImageFilter()

Member Function Documentation

◆ EnlargeOutputRequestedRegion()

◆ FullyConnectedOn()

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GetAttribute()

◆ GetBackgroundValue()

◆ GetFeatureImage()

◆ GetForegroundValue()

◆ GetFullyConnected()

◆ GetNameOfClass()

◆ GetNumberOfObjects()

◆ GetReverseOrdering()

◆ New()

◆ PrintSelf()

◆ ReverseOrderingOn()

◆ SetAttribute() [1/2]

◆ SetAttribute() [2/2]

◆ SetBackgroundValue()

◆ SetFeatureImage()

◆ SetForegroundValue()

◆ SetFullyConnected()

◆ SetInput1()

◆ SetInput2()

◆ SetNumberOfObjects()

◆ SetReverseOrdering()

Member Data Documentation

◆ ImageDimension

◆ InputImageDimension

◆ m_Attribute

◆ m_BackgroundValue

◆ m_ForegroundValue

◆ m_FullyConnected

◆ m_NumberOfObjects

◆ m_ReverseOrdering

◆ OutputImageDimension

template<typename TInputImage, typename TFeatureImage>
class itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >