#include <itkImageSink.h>

Inheritance diagram for itk::ImageSink< TInputImage >:

Collaboration diagram for itk::ImageSink< TInputImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = typename Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	RegionSplitterPointer = typename SplitterType::Pointer

using	Self = ImageSink

using	SplitterType = ImageRegionSplitterBase

using	Superclass = StreamingProcessObject

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

using	Pointer = SmartPointer< Self >

using	Self = StreamingProcessObject

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 const InputImageType *	GetInput () const

virtual const InputImageType *	GetInput (const DataObjectIdentifierType &key) const

virtual const InputImageType *	GetInput (unsigned int idx) const

virtual const char *	GetNameOfClass () const

virtual void	SetInput (const InputImageType *input)

void	Update () override

void	UpdateLargestPossibleRegion () override

Public Member Functions inherited from itk::StreamingProcessObject
void	GenerateData () override

virtual int	GetCurrentRequestNumber () const

void	PropagateRequestedRegion (DataObject *output) override

void	ResetPipeline () override

void	UpdateOutputData (DataObject *output) 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 ()

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	SetAbortGenerateData (bool _arg)

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

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

MultiThreaderType *	GetMultiThreader () const

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	PrepareOutputs ()

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

unsigned long	AddObserver (const EventObject &event, Command *) 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)

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 Attributes
static constexpr unsigned int	InputImageDimension = InputImageType::ImageDimension

unsigned int	m_NumberOfStreamDivisions { 1 }

RegionSplitterPointer	m_RegionSplitter

InputImageRegionType	m_CurrentInputRegion

double	m_CoordinateTolerance { Self::GetGlobalDefaultCoordinateTolerance() }

double	m_DirectionTolerance { Self::GetGlobalDefaultDirectionTolerance() }

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

	ImageSink ()

	~ImageSink () override=default

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

unsigned int	GetNumberOfInputRequestedRegions () override

void	GenerateNthInputRequestedRegion (unsigned int inputRequestedRegionNumber) override

virtual void	AllocateOutputs ()

void	VerifyInputInformation () ITKv5_CONST override

void	BeforeStreamedGenerateData () override

void	StreamedGenerateData (unsigned int inputRequestedRegionNumber) override

virtual void	ThreadedStreamedGenerateData (const InputImageRegionType &inputRegionForChunk)=0

virtual void	SetNumberOfStreamDivisions (unsigned int _arg)

virtual unsigned int	GetNumberOfStreamDivisions () const

virtual void	SetRegionSplitter (SplitterType *_arg)

virtual SplitterType *	GetModifiableRegionSplitter ()

virtual const SplitterType *	GetRegionSplitter () const

static void	SetGlobalDefaultDirectionTolerance (double)

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static double	GetGlobalDefaultCoordinateTolerance ()

Additional Inherited Members
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 Member Functions inherited from itk::StreamingProcessObject
virtual void	AfterStreamedGenerateData ()

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

	StreamingProcessObject ()

	~StreamingProcessObject () override

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

	~ProcessObject () override

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

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

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	AddInput (DataObject *input)

virtual void	PushBackInput (const DataObject *input)

virtual void	PopBackInput ()

virtual void	PushFrontInput (const DataObject *input)

virtual void	PopFrontInput ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

virtual void	SetPrimaryInput (DataObject *object)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

void	SetRequiredInputNames (const NameArray &)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

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

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

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual void	SetPrimaryOutput (DataObject *object)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

virtual void	AddOutput (DataObject *output)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

virtual void	VerifyPreconditions () ITKv5_CONST

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual void	GenerateOutputInformation ()

virtual void	PropagateResetPipeline ()

virtual void	ReleaseInputs ()

virtual void	CacheInputReleaseDataFlags ()

virtual void	RestoreInputReleaseDataFlags ()

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

	~Object () override

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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 Member Functions inherited from itk::ProcessObject
static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ProcessObject
bool	m_Updating

TimeStamp	m_OutputInformationMTime

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

Static Private Member Functions inherited from itk::ImageToImageFilterCommon
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Detailed Description

template<typename TInputImage>
class itk::ImageSink< TInputImage >

ImageSink is the base class for process objects which consume image data. This class defaults to having at least one input of the templated image type. The framework enables derived algorithms to stream the input image as it's being consumed by the algorithm.

The framework provides multi-threading of the streamed image regions. The input image's pipeline is updated multiple times with the streaming requested regions, then the fulfilled requested region are split again for multi-threading.

By default, the NumberOfStreamDivisions is 1 (no streaming). Derived implementations must change the access specification for this method to be public to expose the streaming feature.

Definition at line 53 of file itkImageSink.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage>

using itk::ImageSink< TInputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 64 of file itkImageSink.h.

◆ DataObjectIdentifierType

template<typename TInputImage>

using itk::ImageSink< TInputImage >::DataObjectIdentifierType = typename Superclass::DataObjectIdentifierType

Definition at line 82 of file itkImageSink.h.

◆ DataObjectPointer

template<typename TInputImage>

using itk::ImageSink< TInputImage >::DataObjectPointer = DataObject::Pointer

Smart Pointer type to a DataObject.

Definition at line 70 of file itkImageSink.h.

◆ InputImagePixelType

template<typename TInputImage>

using itk::ImageSink< TInputImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 76 of file itkImageSink.h.

◆ InputImagePointer

template<typename TInputImage>

using itk::ImageSink< TInputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 74 of file itkImageSink.h.

◆ InputImageRegionType

template<typename TInputImage>

using itk::ImageSink< TInputImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 75 of file itkImageSink.h.

◆ InputImageType

template<typename TInputImage>

using itk::ImageSink< TInputImage >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 73 of file itkImageSink.h.

◆ Pointer

template<typename TInputImage>

using itk::ImageSink< TInputImage >::Pointer = SmartPointer<Self>

Definition at line 63 of file itkImageSink.h.

◆ RegionSplitterPointer

template<typename TInputImage>

using itk::ImageSink< TInputImage >::RegionSplitterPointer = typename SplitterType::Pointer

Definition at line 80 of file itkImageSink.h.

◆ Self

template<typename TInputImage>

using itk::ImageSink< TInputImage >::Self = ImageSink

Standard class type aliases.

Definition at line 61 of file itkImageSink.h.

◆ SplitterType

template<typename TInputImage>

using itk::ImageSink< TInputImage >::SplitterType = ImageRegionSplitterBase

SmartPointer to a region splitting object

Definition at line 79 of file itkImageSink.h.

◆ Superclass

template<typename TInputImage>

using itk::ImageSink< TInputImage >::Superclass = StreamingProcessObject

Definition at line 62 of file itkImageSink.h.

Constructor & Destructor Documentation

◆ ImageSink()

template<typename TInputImage>

itk::ImageSink< TInputImage >::ImageSink ( )

protected

Tolerances for checking whether input images are defined to occupy the same physical space.

◆ ~ImageSink()

template<typename TInputImage>

itk::ImageSink< TInputImage >::~ImageSink ( )

overrideprotecteddefault

Tolerances for checking whether input images are defined to occupy the same physical space.

Member Function Documentation

◆ AllocateOutputs()

template<typename TInputImage>

virtual void itk::ImageSink< TInputImage >::AllocateOutputs ( )

inlineprotectedvirtual

Tolerances for checking whether input images are defined to occupy the same physical space.

Definition at line 159 of file itkImageSink.h.

Referenced by itk::ImageSink< TImage >::BeforeStreamedGenerateData().

◆ BeforeStreamedGenerateData()

template<typename TInputImage>

void itk::ImageSink< TInputImage >::BeforeStreamedGenerateData ( )

inlineoverrideprotectedvirtual

Tolerances for checking whether input images are defined to occupy the same physical space.

Reimplemented from itk::StreamingProcessObject.

Reimplemented in itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::StatisticsImageFilter< TInputImage >, and itk::MinimumMaximumImageFilter< TInputImage >.

Definition at line 166 of file itkImageSink.h.

◆ GenerateNthInputRequestedRegion()

template<typename TInputImage>

void itk::ImageSink< TInputImage >::GenerateNthInputRequestedRegion ( unsigned int inputRequestedRegionNumber )

overrideprotectedvirtual

Tolerances for checking whether input images are defined to occupy the same physical space.

Implements itk::StreamingProcessObject.

◆ GetCoordinateTolerance()

template<typename TInputImage>

virtual double itk::ImageSink< TInputImage >::GetCoordinateTolerance ( ) const

virtual

Tolerances for checking whether input images are defined to occupy the same physical space.

◆ GetDirectionTolerance()

template<typename TInputImage>

virtual double itk::ImageSink< TInputImage >::GetDirectionTolerance ( ) const

virtual

Tolerances for checking whether input images are defined to occupy the same physical space.

◆ GetGlobalDefaultCoordinateTolerance()

template<typename TInputImage>

static double itk::ImageToImageFilterCommon::GetGlobalDefaultCoordinateTolerance

static

Tolerances for checking whether input images are defined to occupy the same physical space.

◆ GetGlobalDefaultDirectionTolerance()

template<typename TInputImage>

static double itk::ImageToImageFilterCommon::GetGlobalDefaultDirectionTolerance

static

Tolerances for checking whether input images are defined to occupy the same physical space.

◆ GetInput() [1/3]

template<typename TInputImage>

virtual const InputImageType* itk::ImageSink< TInputImage >::GetInput ( ) const

virtual

◆ GetInput() [2/3]

template<typename TInputImage>

virtual const InputImageType* itk::ImageSink< TInputImage >::GetInput ( const DataObjectIdentifierType & key ) const

virtual

◆ GetInput() [3/3]

template<typename TInputImage>

virtual const InputImageType* itk::ImageSink< TInputImage >::GetInput ( unsigned int idx ) const

virtual

◆ GetModifiableRegionSplitter()

template<typename TInputImage>

virtual SplitterType* itk::ImageSink< TInputImage >::GetModifiableRegionSplitter ( )

protectedvirtual

Tolerances for checking whether input images are defined to occupy the same physical space.

◆ GetNameOfClass()

template<typename TInputImage>

virtual const char* itk::ImageSink< TInputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::StreamingProcessObject.

Reimplemented in itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::MinimumMaximumImageFilter< TInputImage >, itk::StatisticsImageFilter< TInputImage >, itk::Statistics::ImageToHistogramFilter< TImage >, and itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >.

◆ GetNumberOfInputRequestedRegions()

template<typename TInputImage>

unsigned int itk::ImageSink< TInputImage >::GetNumberOfInputRequestedRegions ( )

overrideprotectedvirtual

Tolerances for checking whether input images are defined to occupy the same physical space.

Implements itk::StreamingProcessObject.

◆ GetNumberOfStreamDivisions()

template<typename TInputImage>

virtual unsigned int itk::ImageSink< TInputImage >::GetNumberOfStreamDivisions ( ) const

protectedvirtual

Get the number of pieces to divide the input. The upstream pipeline will be executed this many times.

Reimplemented in itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::Statistics::ImageToHistogramFilter< TImage >, itk::StatisticsImageFilter< TInputImage >, and itk::MinimumMaximumImageFilter< TInputImage >.

◆ GetRegionSplitter()

template<typename TInputImage>

virtual const SplitterType* itk::ImageSink< TInputImage >::GetRegionSplitter ( ) const

protectedvirtual

Tolerances for checking whether input images are defined to occupy the same physical space.

◆ PrintSelf()

template<typename TInputImage>

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

overrideprotectedvirtual

Tolerances for checking whether input images are defined to occupy the same physical space.

Reimplemented from itk::LightObject.

Reimplemented in itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::StatisticsImageFilter< TInputImage >, and itk::MinimumMaximumImageFilter< TInputImage >.

◆ SetCoordinateTolerance()

template<typename TInputImage>

virtual void itk::ImageSink< TInputImage >::SetCoordinateTolerance ( double _arg )

virtual

get/set the Coordinate tolerance This tolerance is used when comparing the space defined by the input images. ITK has a requirement that multiple input images be congruent in space by default.

◆ SetDirectionTolerance()

template<typename TInputImage>

virtual void itk::ImageSink< TInputImage >::SetDirectionTolerance ( double _arg )

virtual

get/set the direction tolerance This tolerance is used to make sure that all input images are oriented the same before performing the filter's transformations.

◆ SetGlobalDefaultCoordinateTolerance()

template<typename TInputImage>

static void itk::ImageToImageFilterCommon::SetGlobalDefaultCoordinateTolerance

static

get/set the global default coordinate tolerance

This value is used to initialize the CoordinateTolerance upon class construction of any ImageToImage filter. This has no effect on currently constructed classes.

◆ SetGlobalDefaultDirectionTolerance()

template<typename TInputImage>

static void itk::ImageToImageFilterCommon::SetGlobalDefaultDirectionTolerance

static

get/set the global default direction tolerance

This value is used to initialize the DirectionTolerance upon class construction of any Image filters. This has no effect on currently constructed classes.

◆ SetInput()

template<typename TInputImage>

virtual void itk::ImageSink< TInputImage >::SetInput ( const InputImageType * input )

virtual

Set/Get the image input of this process object.

◆ SetNumberOfStreamDivisions()

template<typename TInputImage>

virtual void itk::ImageSink< TInputImage >::SetNumberOfStreamDivisions ( unsigned int _arg )

protectedvirtual

Set the number of pieces to divide the input. The upstream pipeline will be executed this many times.

Reimplemented in itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::Statistics::ImageToHistogramFilter< TImage >, itk::StatisticsImageFilter< TInputImage >, and itk::MinimumMaximumImageFilter< TInputImage >.

◆ SetRegionSplitter()

template<typename TInputImage>

virtual void itk::ImageSink< TInputImage >::SetRegionSplitter ( SplitterType * _arg )

protectedvirtual

Set/Get Helper class for dividing the input into regions for streaming

◆ StreamedGenerateData()

template<typename TInputImage>

void itk::ImageSink< TInputImage >::StreamedGenerateData ( unsigned int inputRequestedRegionNumber )

overrideprotectedvirtual

Tolerances for checking whether input images are defined to occupy the same physical space.

Implements itk::StreamingProcessObject.

◆ ThreadedStreamedGenerateData()

template<typename TInputImage>

virtual void itk::ImageSink< TInputImage >::ThreadedStreamedGenerateData ( const InputImageRegionType & inputRegionForChunk )

protectedpure virtual

Tolerances for checking whether input images are defined to occupy the same physical space.

◆ Update()

template<typename TInputImage>

void itk::ImageSink< TInputImage >::Update ( )

overridevirtual

Bring this filter up-to-date.

Update() checks modified times against last execution times, and re-executes objects if necessary. A side effect of this method is that the whole pipeline may execute in order to bring this filter up-to-date. This method updates the currently prescribed requested region. If no requested region has been set on the output, then the requested region will be set to the largest possible region. Once the requested region is set, Update() will make sure the specified requested region is up-to-date. This is a confusing side effect to users who are just calling Update() on a filter. A first call to Update() will cause the largest possible region to be updated. A second call to Update() will update that same region. If a modification to the upstream pipeline cause a filter to have a different largest possible region, this second call to Update() will not cause the output requested region to be reset to the new largest possible region. Instead, the output requested region will be the same as the last time Update() was called. To have a filter always to produce its largest possible region, users should call UpdateLargestPossibleRegion() instead.

Reimplemented from itk::ProcessObject.

◆ UpdateLargestPossibleRegion()

template<typename TInputImage>

void itk::ImageSink< TInputImage >::UpdateLargestPossibleRegion ( )

overridevirtual

Sets the output requested region to the largest possible region and updates.

This is the method users should call if they want the entire dataset to be processed. If a user wants to update the same output region as a previous call to Update() or a previous call to UpdateLargestPossibleRegion(), then they should call the method Update().

Reimplemented from itk::ProcessObject.

◆ VerifyInputInformation()

template<typename TInputImage>

void itk::ImageSink< TInputImage >::VerifyInputInformation ( )

overrideprotectedvirtual

Tolerances for checking whether input images are defined to occupy the same physical space.

Reimplemented from itk::ProcessObject.

Member Data Documentation

◆ InputImageDimension

template<typename TInputImage>

constexpr unsigned int itk::ImageSink< TInputImage >::InputImageDimension = InputImageType::ImageDimension

staticconstexpr

Dimension of input images.

Definition at line 85 of file itkImageSink.h.

◆ m_CoordinateTolerance

template<typename TInputImage>

double itk::ImageSink< TInputImage >::m_CoordinateTolerance { Self::GetGlobalDefaultCoordinateTolerance() }

private

Tolerances for checking whether input images are defined to occupy the same physical space.

Definition at line 202 of file itkImageSink.h.

◆ m_CurrentInputRegion

template<typename TInputImage>

InputImageRegionType itk::ImageSink< TInputImage >::m_CurrentInputRegion

private

Tolerances for checking whether input images are defined to occupy the same physical space.

Definition at line 196 of file itkImageSink.h.

◆ m_DirectionTolerance

template<typename TInputImage>

double itk::ImageSink< TInputImage >::m_DirectionTolerance { Self::GetGlobalDefaultDirectionTolerance() }

private

Tolerances for checking whether input images are defined to occupy the same physical space.

Definition at line 203 of file itkImageSink.h.

◆ m_NumberOfStreamDivisions

template<typename TInputImage>

unsigned int itk::ImageSink< TInputImage >::m_NumberOfStreamDivisions { 1 }

private

Tolerances for checking whether input images are defined to occupy the same physical space.

Definition at line 194 of file itkImageSink.h.

◆ m_RegionSplitter

template<typename TInputImage>

RegionSplitterPointer itk::ImageSink< TInputImage >::m_RegionSplitter

private

Tolerances for checking whether input images are defined to occupy the same physical space.

Definition at line 195 of file itkImageSink.h.

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

itkImageSink.h

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

template<typename TInputImage> class itk::ImageSink< TInputImage >

Member Typedef Documentation

◆ ConstPointer

◆ DataObjectIdentifierType

◆ DataObjectPointer

◆ InputImagePixelType

◆ InputImagePointer

◆ InputImageRegionType

◆ InputImageType

◆ Pointer

◆ RegionSplitterPointer

◆ Self

◆ SplitterType

◆ Superclass

Constructor & Destructor Documentation

◆ ImageSink()

◆ ~ImageSink()

Member Function Documentation

◆ AllocateOutputs()

◆ BeforeStreamedGenerateData()

◆ GenerateNthInputRequestedRegion()

◆ GetCoordinateTolerance()

◆ GetDirectionTolerance()

◆ GetGlobalDefaultCoordinateTolerance()

◆ GetGlobalDefaultDirectionTolerance()

◆ GetInput() [1/3]

◆ GetInput() [2/3]

◆ GetInput() [3/3]

◆ GetModifiableRegionSplitter()

◆ GetNameOfClass()

◆ GetNumberOfInputRequestedRegions()

◆ GetNumberOfStreamDivisions()

◆ GetRegionSplitter()

◆ PrintSelf()

◆ SetCoordinateTolerance()

◆ SetDirectionTolerance()

◆ SetGlobalDefaultCoordinateTolerance()

◆ SetGlobalDefaultDirectionTolerance()

◆ SetInput()

◆ SetNumberOfStreamDivisions()

◆ SetRegionSplitter()

◆ StreamedGenerateData()

◆ ThreadedStreamedGenerateData()

◆ Update()

◆ UpdateLargestPossibleRegion()

◆ VerifyInputInformation()

Member Data Documentation

◆ InputImageDimension

◆ m_CoordinateTolerance

◆ m_CurrentInputRegion

◆ m_DirectionTolerance

◆ m_NumberOfStreamDivisions

◆ m_RegionSplitter

template<typename TInputImage>
class itk::ImageSink< TInputImage >