ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::StreamingImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkStreamingImageFilter.h>

+ Inheritance diagram for itk::StreamingImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::StreamingImageFilter< TInputImage, TOutputImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DataObjectPointer = typename Superclass::DataObjectPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using RegionSplitterPointer = typename SplitterType::Pointer
 
using Self = StreamingImageFilter
 
using SplitterType = ImageRegionSplitterBase
 
using Superclass = ImageToImageFilter< TInputImage, TOutputImage >
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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 OutputImagePixelType = typename Superclass::OutputImagePixelType
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TOutputImage >
 
- Public Types inherited from itk::ImageSource< TOutputImage >
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 = TOutputImage
 
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 ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
virtual const unsigned int & GetNumberOfStreamDivisions () const
 
virtual void SetNumberOfStreamDivisions (unsigned int _arg)
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
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 >
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
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 ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (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 SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () 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
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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
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::ImageToImageFilter< TInputImage, TOutputImage >
static void SetGlobalDefaultDirectionTolerance (double)
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static double GetGlobalDefaultCoordinateTolerance ()
 
- 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 ()
 

Static Public Attributes

static constexpr unsigned int InputImageDimension = InputImageType::ImageDimension
 
static constexpr unsigned int OutputImageDimension = OutputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
unsigned int m_NumberOfStreamDivisions
 
RegionSplitterPointer m_RegionSplitter
 
virtual void SetRegionSplitter (SplitterType *_arg)
 
virtual SplitterTypeGetModifiableRegionSplitter ()
 
virtual const SplitterTypeGetRegionSplitter () const
 
void UpdateOutputData (DataObject *output) override
 
void PropagateRequestedRegion (DataObject *output) override
 
 StreamingImageFilter ()
 
 ~StreamingImageFilter () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override=default
 
void VerifyInputInformation () ITKv5_CONST override
 
void GenerateInputRequestedRegion () override
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
 ImageSource ()
 
 ~ImageSource () override=default
 
void GenerateData () override
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void AfterThreadedGenerateData ()
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicMultiThreadingOff ()
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () 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)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () 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 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 &time)
 
- 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::ImageSource< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- 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::ImageSource< TOutputImage >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::StreamingImageFilter< TInputImage, TOutputImage >

Pipeline object to control data streaming for large data processing.

StreamingImageFilter is a pipeline object that allows the user to control how data is pulled through the pipeline. To generate its OutputRequestedRegion, this filter will divide the output into several pieces (controlled by SetNumberOfStreamDivisions), and call the upstream pipeline for each piece, tiling the individual outputs into one large output. This reduces the memory footprint for the application since each filter does not have to process the entire dataset at once. This filter will produce the entire output as one image, but the upstream filters will do their processing in pieces.

Examples
SphinxExamples/src/Core/Common/StreamAPipeline/Code.cxx.

Definition at line 44 of file itkStreamingImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >
using itk::StreamingImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 53 of file itkStreamingImageFilter.h.

◆ DataObjectPointer

template<typename TInputImage , typename TOutputImage >
using itk::StreamingImageFilter< TInputImage, TOutputImage >::DataObjectPointer = typename Superclass::DataObjectPointer

Definition at line 71 of file itkStreamingImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage , typename TOutputImage >
using itk::StreamingImageFilter< TInputImage, TOutputImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 65 of file itkStreamingImageFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TOutputImage >
using itk::StreamingImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 63 of file itkStreamingImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage , typename TOutputImage >
using itk::StreamingImageFilter< TInputImage, TOutputImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 64 of file itkStreamingImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage >
using itk::StreamingImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Some type alias for the input and output.

Definition at line 62 of file itkStreamingImageFilter.h.

◆ OutputImagePixelType

template<typename TInputImage , typename TOutputImage >
using itk::StreamingImageFilter< TInputImage, TOutputImage >::OutputImagePixelType = typename OutputImageType::PixelType

Definition at line 70 of file itkStreamingImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage , typename TOutputImage >
using itk::StreamingImageFilter< TInputImage, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 68 of file itkStreamingImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage >
using itk::StreamingImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 69 of file itkStreamingImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage >
using itk::StreamingImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 67 of file itkStreamingImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >
using itk::StreamingImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 52 of file itkStreamingImageFilter.h.

◆ RegionSplitterPointer

template<typename TInputImage , typename TOutputImage >
using itk::StreamingImageFilter< TInputImage, TOutputImage >::RegionSplitterPointer = typename SplitterType::Pointer

Definition at line 79 of file itkStreamingImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >
using itk::StreamingImageFilter< TInputImage, TOutputImage >::Self = StreamingImageFilter

Standard class type aliases.

Definition at line 50 of file itkStreamingImageFilter.h.

◆ SplitterType

template<typename TInputImage , typename TOutputImage >
using itk::StreamingImageFilter< TInputImage, TOutputImage >::SplitterType = ImageRegionSplitterBase

SmartPointer to a region splitting object

Definition at line 78 of file itkStreamingImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >
using itk::StreamingImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 51 of file itkStreamingImageFilter.h.

Constructor & Destructor Documentation

◆ StreamingImageFilter()

template<typename TInputImage , typename TOutputImage >
itk::StreamingImageFilter< TInputImage, TOutputImage >::StreamingImageFilter ( )
protected

Get/Set the helper class for dividing the input into chunks.

◆ ~StreamingImageFilter()

template<typename TInputImage , typename TOutputImage >
itk::StreamingImageFilter< TInputImage, TOutputImage >::~StreamingImageFilter ( )
overrideprotecteddefault

Get/Set the helper class for dividing the input into chunks.

Member Function Documentation

◆ CreateAnother()

template<typename TInputImage , typename TOutputImage >
virtual::itk::LightObject::Pointer itk::StreamingImageFilter< TInputImage, 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.

◆ GetModifiableRegionSplitter()

template<typename TInputImage , typename TOutputImage >
virtual SplitterType* itk::StreamingImageFilter< TInputImage, TOutputImage >::GetModifiableRegionSplitter ( )
virtual

Get/Set the helper class for dividing the input into chunks.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >
virtual const char* itk::StreamingImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

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

◆ GetNumberOfStreamDivisions()

template<typename TInputImage , typename TOutputImage >
virtual const unsigned int& itk::StreamingImageFilter< TInputImage, TOutputImage >::GetNumberOfStreamDivisions ( ) const
virtual

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

◆ GetRegionSplitter()

template<typename TInputImage , typename TOutputImage >
virtual const SplitterType* itk::StreamingImageFilter< TInputImage, TOutputImage >::GetRegionSplitter ( ) const
virtual

Get/Set the helper class for dividing the input into chunks.

◆ New()

template<typename TInputImage , typename TOutputImage >
static Pointer itk::StreamingImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >
void itk::StreamingImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Get/Set the helper class for dividing the input into chunks.

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

◆ PropagateRequestedRegion()

template<typename TInputImage , typename TOutputImage >
void itk::StreamingImageFilter< TInputImage, TOutputImage >::PropagateRequestedRegion ( DataObject output)
overridevirtual

Override PropagateRequestedRegion from ProcessObject Since inside UpdateOutputData we iterate over streaming pieces we don't need to proapage up the pipeline

Reimplemented from itk::ProcessObject.

◆ SetNumberOfStreamDivisions()

template<typename TInputImage , typename TOutputImage >
virtual void itk::StreamingImageFilter< TInputImage, TOutputImage >::SetNumberOfStreamDivisions ( unsigned int  _arg)
virtual

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

◆ SetRegionSplitter()

template<typename TInputImage , typename TOutputImage >
virtual void itk::StreamingImageFilter< TInputImage, TOutputImage >::SetRegionSplitter ( SplitterType _arg)
virtual

Get/Set the helper class for dividing the input into chunks.

◆ UpdateOutputData()

template<typename TInputImage , typename TOutputImage >
void itk::StreamingImageFilter< TInputImage, TOutputImage >::UpdateOutputData ( DataObject output)
overridevirtual

Override UpdateOutputData() from ProcessObject to divide upstream updates into pieces. This filter does not have a GenerateData() or ThreadedGenerateData() method. Instead, all the work is done in UpdateOutputData() since it must update a little, execute a little, update some more, execute some more, etc.

Reimplemented from itk::ProcessObject.

Member Data Documentation

◆ InputImageDimension

template<typename TInputImage , typename TOutputImage >
constexpr unsigned int itk::StreamingImageFilter< TInputImage, TOutputImage >::InputImageDimension = InputImageType::ImageDimension
staticconstexpr

Dimension of input image.

Definition at line 74 of file itkStreamingImageFilter.h.

◆ m_NumberOfStreamDivisions

template<typename TInputImage , typename TOutputImage >
unsigned int itk::StreamingImageFilter< TInputImage, TOutputImage >::m_NumberOfStreamDivisions
private

Get/Set the helper class for dividing the input into chunks.

Definition at line 123 of file itkStreamingImageFilter.h.

◆ m_RegionSplitter

template<typename TInputImage , typename TOutputImage >
RegionSplitterPointer itk::StreamingImageFilter< TInputImage, TOutputImage >::m_RegionSplitter
private

Get/Set the helper class for dividing the input into chunks.

Definition at line 124 of file itkStreamingImageFilter.h.

◆ OutputImageDimension

template<typename TInputImage , typename TOutputImage >
constexpr unsigned int itk::StreamingImageFilter< TInputImage, TOutputImage >::OutputImageDimension = OutputImageType::ImageDimension
staticconstexpr

Definition at line 75 of file itkStreamingImageFilter.h.


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