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

#include <itkKappaSigmaThresholdImageFilter.h>

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

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

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://hdl.handle.net/1926/367

See Also

KappaSigmaThresholdImageCalculator

Definition at line 48 of file itkKappaSigmaThresholdImageFilter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage::Pointer	InputImagePointer
typedef TInputImage	InputImageType
typedef TInputImage::PixelType	InputPixelType
typedef TMaskImage::Pointer	MaskImagePointer
typedef TMaskImage	MaskImageType
typedef TMaskImage::PixelType	MaskPixelType
typedef TOutputImage::Pointer	OutputImagePointer
typedef TOutputImage::PixelType	OutputPixelType
typedef SmartPointer< Self >	Pointer
typedef KappaSigmaThresholdImageFilter	Self
typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass
Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef SmartPointer< Self >	Pointer
typedef ImageToImageFilter	Self
typedef ImageSource< TOutputImage >	Superclass
Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef ImageSource	Self
typedef ProcessObject	Superclass
Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef MultiThreader	MultiThreaderType
typedef std::vector < DataObjectIdentifierType >	NameArray
typedef SmartPointer< Self >	Pointer
typedef ProcessObject	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual OutputPixelType	GetInsideValue () const
const MaskImageType *	GetMaskImage () const
virtual const char *	GetNameOfClass () const
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, TOutputImage >
const InputImageType *	GetInput () const
const InputImageType *	GetInput (unsigned int idx) const
virtual void	PopBackInput () override
virtual void	PopFrontInput () override
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	SetInput (const InputImageType *image)
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< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
virtual void	GraftOutput (DataObject *output)
virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
virtual ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
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 const float &	GetProgress () const
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float progress)
void	SetProgress (float progress)
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag () const
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
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
virtual void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) override
virtual void	UnRegister () const noexceptoverride
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Protected Types
typedef KappaSigmaThresholdImageCalculator < TInputImage, TMaskImage >	CalculatorType
typedef TInputImage::RegionType	InputImageRegionType
typedef TInputImage::IndexType	InputIndexType
typedef TInputImage::SizeType	InputSizeType
typedef TOutputImage::RegionType	OutputImageRegionType
typedef TOutputImage::IndexType	OutputIndexType
typedef TOutputImage::SizeType	OutputSizeType
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType

Protected Member Functions
virtual void	GenerateData () override
virtual void	GenerateInputRequestedRegion () override
	KappaSigmaThresholdImageFilter ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const override
	~KappaSigmaThresholdImageFilter () override
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
	ImageToImageFilter ()
virtual void	VerifyInputInformation () override
	~ImageToImageFilter () override
void	PushBackInput (const DataObject *input) override
void	PushFrontInput (const DataObject *input) override
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~ImageSource () override
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
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
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	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 num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyPreconditions ()
	~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 (void) const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName (void) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~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 ()

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

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

Additional Inherited Members
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime
bool	m_Updating
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

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

typedef KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage > itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::CalculatorType

protected

Definition at line 161 of file itkKappaSigmaThresholdImageFilter.h.

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

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

Definition at line 56 of file itkKappaSigmaThresholdImageFilter.h.

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

typedef TInputImage::Pointer itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::InputImagePointer

Image related typedefs.

Definition at line 74 of file itkKappaSigmaThresholdImageFilter.h.

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

typedef TInputImage::RegionType itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::InputImageRegionType

protected

Definition at line 156 of file itkKappaSigmaThresholdImageFilter.h.

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

typedef TInputImage itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::InputImageType

Standard image type within this class.

Definition at line 62 of file itkKappaSigmaThresholdImageFilter.h.

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

typedef TInputImage::IndexType itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::InputIndexType

protected

Definition at line 155 of file itkKappaSigmaThresholdImageFilter.h.

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

typedef TInputImage::PixelType itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::InputPixelType

Image pixel value typedef.

Definition at line 69 of file itkKappaSigmaThresholdImageFilter.h.

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

typedef TInputImage::SizeType itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::InputSizeType

protected

Definition at line 154 of file itkKappaSigmaThresholdImageFilter.h.

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

typedef TMaskImage::Pointer itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::MaskImagePointer

Definition at line 76 of file itkKappaSigmaThresholdImageFilter.h.

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

typedef TMaskImage itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::MaskImageType

Definition at line 66 of file itkKappaSigmaThresholdImageFilter.h.

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

typedef TMaskImage::PixelType itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::MaskPixelType

Definition at line 71 of file itkKappaSigmaThresholdImageFilter.h.

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

typedef TOutputImage::Pointer itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::OutputImagePointer

Definition at line 75 of file itkKappaSigmaThresholdImageFilter.h.

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

typedef TOutputImage::RegionType itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::OutputImageRegionType

protected

Definition at line 159 of file itkKappaSigmaThresholdImageFilter.h.

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

typedef TOutputImage::IndexType itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::OutputIndexType

protected

Definition at line 158 of file itkKappaSigmaThresholdImageFilter.h.

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

typedef TOutputImage::PixelType itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::OutputPixelType

Definition at line 70 of file itkKappaSigmaThresholdImageFilter.h.

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

typedef TOutputImage::SizeType itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::OutputSizeType

protected

Definition at line 157 of file itkKappaSigmaThresholdImageFilter.h.

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

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

Definition at line 55 of file itkKappaSigmaThresholdImageFilter.h.

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

typedef KappaSigmaThresholdImageFilter itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::Self

Standard Self typedef

Definition at line 53 of file itkKappaSigmaThresholdImageFilter.h.

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

typedef ImageToImageFilter< TInputImage, TOutputImage > itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::Superclass

Definition at line 54 of file itkKappaSigmaThresholdImageFilter.h.

Constructor & Destructor Documentation

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

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

protected

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

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

inlineoverrideprotected

Definition at line 147 of file itkKappaSigmaThresholdImageFilter.h.

Member Function Documentation

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

virtual::itk::LightObject::Pointer itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

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

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

overrideprotectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See Also

ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

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

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

overrideprotectedvirtual

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierarchy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See Also

ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

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.

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 128 of file itkKappaSigmaThresholdImageFilter.h.

References itk::ProcessObject::GetInput().

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

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

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

virtual

Runtime information support.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

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.

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.

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.

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.

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.

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

virtual 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::ImageToImageFilter< TInputImage, TOutputImage >.

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 134 of file itkKappaSigmaThresholdImageFilter.h.

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 140 of file itkKappaSigmaThresholdImageFilter.h.

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

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 121 of file itkKappaSigmaThresholdImageFilter.h.

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

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.

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 NumericTraits<OutputPixelType>::ZeroValue().

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

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

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

staticprotected

Image related typedefs.

Definition at line 165 of file itkKappaSigmaThresholdImageFilter.h.

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 177 of file itkKappaSigmaThresholdImageFilter.h.

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 171 of file itkKappaSigmaThresholdImageFilter.h.

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

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

private

Definition at line 175 of file itkKappaSigmaThresholdImageFilter.h.

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 178 of file itkKappaSigmaThresholdImageFilter.h.

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

double itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::m_SigmaFactor

private

Definition at line 174 of file itkKappaSigmaThresholdImageFilter.h.

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 176 of file itkKappaSigmaThresholdImageFilter.h.

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

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

staticprotected

Image related typedefs.

Definition at line 167 of file itkKappaSigmaThresholdImageFilter.h.

---

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

• itkKappaSigmaThresholdImageFilter.h