itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage > Class Template Reference

#include <itkKappaSigmaThresholdImageFilter.h>

Detailed Description

template<typename TInputImage, typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>
class itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >

Threshold an image using Kappa-Sigma-Clipping.

This filter creates a binary thresholded image which separates background and foreground modes by iteratively rejecting pixels that do not belong to the dominant mode. The filter computes the threshold using the KappaSigmaThre- sholdImageCalculator and applies that threshold to the input image using the BinaryThresholdImageFilter.

Author

Gaetan Lehmann

Note

This class was taken from the Insight Journal paper: https://doi.org/10.54294/39qekn

See also

KappaSigmaThresholdImageCalculator

Definition at line 49 of file itkKappaSigmaThresholdImageFilter.h.

Inheritance diagram for itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >:

Collaboration diagram for itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >
using	InputImagePointer = typename TInputImage::Pointer
using	InputImageType = TInputImage
using	InputPixelType = typename TInputImage::PixelType
using	MaskImagePointer = typename TMaskImage::Pointer
using	MaskImageType = TMaskImage
using	MaskPixelType = typename TMaskImage::PixelType
using	OutputImagePointer = typename TOutputImage::Pointer
using	OutputPixelType = typename TOutputImage::PixelType
using	Pointer = SmartPointer< Self >
using	Self = KappaSigmaThresholdImageFilter
using	Superclass = ImageToImageFilter< TInputImage, TOutputImage >
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
virtual OutputPixelType	GetInsideValue () const
const MaskImageType *	GetMaskImage () const
const char *	GetNameOfClass () const override
virtual OutputPixelType	GetOutsideValue () const
virtual InputPixelType	GetThreshold () const
void	SetInput1 (const TInputImage *input)
void	SetInput2 (const MaskImageType *input)
virtual void	SetInsideValue (OutputPixelType _arg)
void	SetMaskImage (const MaskImageType *input)
virtual void	SetOutsideValue (OutputPixelType _arg)
virtual void	SetMaskValue (MaskPixelType _arg)
virtual MaskPixelType	GetMaskValue () const
virtual void	SetSigmaFactor (double _arg)
virtual double	GetSigmaFactor () const
virtual void	SetNumberOfIterations (unsigned int _arg)
virtual unsigned int	GetNumberOfIterations () const
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 >
const char *	GetNameOfClass () const override
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 void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData () const
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
NameArray	GetInputNames () const
DataObjectPointerArray	GetInputs ()
MultiThreaderType *	GetMultiThreader () const
const char *	GetNameOfClass () const override
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 DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)
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
const char *	GetNameOfClass () const override
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 Pointer	CreateAnother () const
virtual void	Delete ()
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const noexcept

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 ()

Protected Types
using	CalculatorType = KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage >
using	InputImageRegionType = typename TInputImage::RegionType
using	InputIndexType = typename TInputImage::IndexType
using	InputSizeType = typename TInputImage::SizeType
using	OutputImageRegionType = typename TOutputImage::RegionType
using	OutputIndexType = typename TOutputImage::IndexType
using	OutputSizeType = typename TOutputImage::SizeType
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Protected Member Functions
void	GenerateData () override
void	GenerateInputRequestedRegion () override
	KappaSigmaThresholdImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~KappaSigmaThresholdImageFilter () 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 ()
void	PrintSelf (std::ostream &os, Indent indent) const override
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	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
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
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	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	VerifyInputInformation () const
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
void	PrintSelf (std::ostream &os, Indent indent) const override
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	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Static Protected Attributes
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Private Attributes
OutputPixelType	m_InsideValue {}
MaskPixelType	m_MaskValue {}
unsigned int	m_NumberOfIterations { 2 }
OutputPixelType	m_OutsideValue {}
double	m_SigmaFactor { 2 }
InputPixelType	m_Threshold {}

Additional Inherited Members
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
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

CalculatorType

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::CalculatorType = KappaSigmaThresholdImageCalculator<TInputImage, TMaskImage>

protected

Definition at line 168 of file itkKappaSigmaThresholdImageFilter.h.

ConstPointer

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 58 of file itkKappaSigmaThresholdImageFilter.h.

InputImagePointer

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::InputImagePointer = typename TInputImage::Pointer

Image related type alias.

Definition at line 76 of file itkKappaSigmaThresholdImageFilter.h.

InputImageRegionType

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::InputImageRegionType = typename TInputImage::RegionType

protected

Definition at line 163 of file itkKappaSigmaThresholdImageFilter.h.

InputImageType

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::InputImageType = TInputImage

Standard image type within this class.

Definition at line 67 of file itkKappaSigmaThresholdImageFilter.h.

InputIndexType

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::InputIndexType = typename TInputImage::IndexType

protected

Definition at line 162 of file itkKappaSigmaThresholdImageFilter.h.

InputPixelType

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::InputPixelType = typename TInputImage::PixelType

Image pixel value type alias.

Definition at line 71 of file itkKappaSigmaThresholdImageFilter.h.

InputSizeType

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::InputSizeType = typename TInputImage::SizeType

protected

Definition at line 161 of file itkKappaSigmaThresholdImageFilter.h.

MaskImagePointer

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::MaskImagePointer = typename TMaskImage::Pointer

Definition at line 78 of file itkKappaSigmaThresholdImageFilter.h.

MaskImageType

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::MaskImageType = TMaskImage

Definition at line 68 of file itkKappaSigmaThresholdImageFilter.h.

MaskPixelType

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::MaskPixelType = typename TMaskImage::PixelType

Definition at line 73 of file itkKappaSigmaThresholdImageFilter.h.

OutputImagePointer

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::OutputImagePointer = typename TOutputImage::Pointer

Definition at line 77 of file itkKappaSigmaThresholdImageFilter.h.

OutputImageRegionType

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::OutputImageRegionType = typename TOutputImage::RegionType

protected

Definition at line 166 of file itkKappaSigmaThresholdImageFilter.h.

OutputIndexType

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::OutputIndexType = typename TOutputImage::IndexType

protected

Definition at line 165 of file itkKappaSigmaThresholdImageFilter.h.

OutputPixelType

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::OutputPixelType = typename TOutputImage::PixelType

Definition at line 72 of file itkKappaSigmaThresholdImageFilter.h.

OutputSizeType

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::OutputSizeType = typename TOutputImage::SizeType

protected

Definition at line 164 of file itkKappaSigmaThresholdImageFilter.h.

Pointer

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 57 of file itkKappaSigmaThresholdImageFilter.h.

Self

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::Self = KappaSigmaThresholdImageFilter

Standard Self type alias

Definition at line 55 of file itkKappaSigmaThresholdImageFilter.h.

Superclass

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

using itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 56 of file itkKappaSigmaThresholdImageFilter.h.

Constructor & Destructor Documentation

KappaSigmaThresholdImageFilter()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::KappaSigmaThresholdImageFilter ( )

protected

~KappaSigmaThresholdImageFilter()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::~KappaSigmaThresholdImageFilter ( )

overrideprotecteddefault

Member Function Documentation

GenerateData()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

void itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::GenerateData ( )

overrideprotectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

GenerateInputRequestedRegion()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

void itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

What is the input requested region that is required to produce the output requested region? By default, the largest possible region is always required but this is overridden in many subclasses. For instance, for an image processing filter where an output pixel is a simple function of an input pixel, the input requested region will be set to the output requested region. For an image processing filter where an output pixel is a function of the pixels in a neighborhood of an input pixel, then the input requested region will need to be larger than the output requested region (to avoid introducing artificial boundary conditions). This function should never request an input region that is outside the the input largest possible region (i.e. implementations of this method should crop the input requested region at the boundaries of the input largest possible region).

Reimplemented from itk::ProcessObject.

GetInsideValue()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

virtual OutputPixelType itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::GetInsideValue ( ) const

virtual

Get the "inside" pixel value.

GetMaskImage()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

const MaskImageType * itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::GetMaskImage ( ) const

inline

Get the mask image

Definition at line 130 of file itkKappaSigmaThresholdImageFilter.h.

References itk::ProcessObject::GetInput().

GetMaskValue()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

virtual MaskPixelType itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::GetMaskValue ( ) const

virtual

Set the mask value used to select which pixels will be considered in the threshold computation (optional, only in case a MaskImage is set).

GetNameOfClass()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

const char * itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

GetNumberOfIterations()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

virtual unsigned int itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::GetNumberOfIterations ( ) const

virtual

Set the number of rejection passes.

GetOutsideValue()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

virtual OutputPixelType itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::GetOutsideValue ( ) const

virtual

Get the "outside" pixel value.

GetSigmaFactor()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

virtual double itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::GetSigmaFactor ( ) const

virtual

Set the Sigma multiplier (Kappa) to adjust the pixel rejection rate.

GetThreshold()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

virtual InputPixelType itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::GetThreshold ( ) const

virtual

Get the computed threshold.

New()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

static Pointer itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

PrintSelf()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

void itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::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.

SetInput1()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

void itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::SetInput1 ( const TInputImage *  input )

inline

Set the input image

Definition at line 137 of file itkKappaSigmaThresholdImageFilter.h.

SetInput2()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

void itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::SetInput2 ( const MaskImageType *  input )

inline

Set the marker image

Definition at line 144 of file itkKappaSigmaThresholdImageFilter.h.

SetInsideValue()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

virtual void itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::SetInsideValue ( OutputPixelType  _arg )

virtual

Set the "inside" pixel value. The default value NumericTraits<OutputPixelType>::max()

SetMaskImage()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

void itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::SetMaskImage ( const MaskImageType *  input )

inline

Set the mask image

Definition at line 122 of file itkKappaSigmaThresholdImageFilter.h.

SetMaskValue()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

virtual void itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::SetMaskValue ( MaskPixelType  _arg )

virtual

Set the mask value used to select which pixels will be considered in the threshold computation (optional, only in case a MaskImage is set).

SetNumberOfIterations()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

virtual void itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::SetNumberOfIterations ( unsigned int  _arg )

virtual

Set the number of rejection passes.

SetOutsideValue()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

virtual void itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::SetOutsideValue ( OutputPixelType  _arg )

virtual

Set the "outside" pixel value. The default value OutputPixelType{}.

SetSigmaFactor()

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

virtual void itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::SetSigmaFactor ( double  _arg )

virtual

Set the Sigma multiplier (Kappa) to adjust the pixel rejection rate.

Member Data Documentation

InputImageDimension

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

constexpr unsigned int itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension

staticconstexprprotected

Image related type alias.

Definition at line 171 of file itkKappaSigmaThresholdImageFilter.h.

m_InsideValue

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

OutputPixelType itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::m_InsideValue {}

private

Definition at line 179 of file itkKappaSigmaThresholdImageFilter.h.

m_MaskValue

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

MaskPixelType itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::m_MaskValue {}

private

Definition at line 175 of file itkKappaSigmaThresholdImageFilter.h.

m_NumberOfIterations

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

unsigned int itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::m_NumberOfIterations { 2 }

private

Definition at line 177 of file itkKappaSigmaThresholdImageFilter.h.

m_OutsideValue

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

OutputPixelType itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::m_OutsideValue {}

private

Definition at line 180 of file itkKappaSigmaThresholdImageFilter.h.

m_SigmaFactor

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

double itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::m_SigmaFactor { 2 }

private

Definition at line 176 of file itkKappaSigmaThresholdImageFilter.h.

m_Threshold

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

InputPixelType itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::m_Threshold {}

private

Definition at line 178 of file itkKappaSigmaThresholdImageFilter.h.

OutputImageDimension

template<typename TInputImage , typename TMaskImage = Image<unsigned char, TInputImage::ImageDimension>, class TOutputImage = TInputImage>

constexpr unsigned int itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

staticconstexprprotected

Definition at line 172 of file itkKappaSigmaThresholdImageFilter.h.

---

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

• itkKappaSigmaThresholdImageFilter.h