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

#include <itkSliceImageFilter.h>

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::SliceImageFilter< TInputImage, TOutputImage >

Slices an image based on a starting index and a stopping index, and a step size.

This class is designed to facilitate the implementation of extended sliced based indexing into images.

The input and output image must be of the same dimension.

The input parameters are a starting and stopping index as well as a stepping size. The starting index indicates the first pixels to be used and for each dimension the index is incremented by the step until the index is equal to or "beyond" the stopping index. If the step is negative then the image will be reversed in the dimension, and the stopping index is expected to be less then the starting index. If the stopping index is already beyond the starting index then an image of size zero will be returned.

The output image's starting index is always zero. The origin is the physical location of the starting index. The output directions cosine matrix is that of the input but with sign changes matching that of the step's sign.

Note
In certain combinations such as with start=1, and step>1 while the physical location of the center of the pixel remains the same, the extent (edge to edge space) of the output image will be beyond the extent of the original image.

Definition at line 56 of file itkSliceImageFilter.h.

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

Public Types

using ArrayType = FixedArray< int, ImageDimension >
 
using ConstPointer = SmartPointer< const Self >
 
using IndexType = typename InputImageType::IndexType
 
using IndexValueType = typename InputIndexType::IndexValueType
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageType = TInputImage
 
using InputIndexType = typename TInputImage::IndexType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename TOutputImage::RegionType
 
using OutputImageType = TOutputImage
 
using OutputIndexType = typename TOutputImage::IndexType
 
using OutputOffsetType = typename TOutputImage::OffsetType
 
using Pointer = SmartPointer< Self >
 
using Self = SliceImageFilter
 
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 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

const char * GetNameOfClass () const override
 
virtual void SetStart (IndexType _arg)
 
virtual const IndexTypeGetStart () const
 
void SetStart (IndexValueType start)
 
virtual void SetStop (IndexType _arg)
 
virtual const IndexTypeGetStop () const
 
void SetStop (IndexValueType stop)
 
virtual void SetStep (ArrayType _arg)
 
virtual const ArrayTypeGetStep () const
 
void SetStep (int step)
 
- 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 *input)
 
virtual void PushFrontInput (const InputImageType *input)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *input)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- 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
 
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) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double GetGlobalDefaultCoordinateTolerance ()
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static void SetGlobalDefaultDirectionTolerance (double)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::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
 

Protected Member Functions

void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputInformation () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 SliceImageFilter ()
 
void VerifyInputInformation () ITKv5_CONST override
 
 ~SliceImageFilter () override=default
 
- 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 ()
 
 ~ImageToImageFilter () override=default
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

IndexType m_Start {}
 
ArrayType m_Step {}
 
IndexType m_Stop {}
 

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 >
 
- 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
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ArrayType

template<class TInputImage , class TOutputImage >
using itk::SliceImageFilter< TInputImage, TOutputImage >::ArrayType = FixedArray<int, ImageDimension>

Definition at line 94 of file itkSliceImageFilter.h.

◆ ConstPointer

template<class TInputImage , class TOutputImage >
using itk::SliceImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 65 of file itkSliceImageFilter.h.

◆ IndexType

template<class TInputImage , class TOutputImage >
using itk::SliceImageFilter< TInputImage, TOutputImage >::IndexType = typename InputImageType::IndexType

Definition at line 92 of file itkSliceImageFilter.h.

◆ IndexValueType

template<class TInputImage , class TOutputImage >
using itk::SliceImageFilter< TInputImage, TOutputImage >::IndexValueType = typename InputIndexType::IndexValueType

Definition at line 93 of file itkSliceImageFilter.h.

◆ InputImageConstPointer

template<class TInputImage , class TOutputImage >
using itk::SliceImageFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 78 of file itkSliceImageFilter.h.

◆ InputImagePointer

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

Definition at line 77 of file itkSliceImageFilter.h.

◆ InputImageType

template<class TInputImage , class TOutputImage >
using itk::SliceImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Definition at line 75 of file itkSliceImageFilter.h.

◆ InputIndexType

template<class TInputImage , class TOutputImage >
using itk::SliceImageFilter< TInputImage, TOutputImage >::InputIndexType = typename TInputImage::IndexType

Definition at line 81 of file itkSliceImageFilter.h.

◆ OutputImagePointer

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

Definition at line 76 of file itkSliceImageFilter.h.

◆ OutputImageRegionType

template<class TInputImage , class TOutputImage >
using itk::SliceImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename TOutputImage::RegionType

Typedef to describe the output image region type.

Definition at line 85 of file itkSliceImageFilter.h.

◆ OutputImageType

template<class TInputImage , class TOutputImage >
using itk::SliceImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Typedef to images

Definition at line 74 of file itkSliceImageFilter.h.

◆ OutputIndexType

template<class TInputImage , class TOutputImage >
using itk::SliceImageFilter< TInputImage, TOutputImage >::OutputIndexType = typename TOutputImage::IndexType

Definition at line 80 of file itkSliceImageFilter.h.

◆ OutputOffsetType

template<class TInputImage , class TOutputImage >
using itk::SliceImageFilter< TInputImage, TOutputImage >::OutputOffsetType = typename TOutputImage::OffsetType

Definition at line 82 of file itkSliceImageFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage >
using itk::SliceImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 64 of file itkSliceImageFilter.h.

◆ Self

template<class TInputImage , class TOutputImage >
using itk::SliceImageFilter< TInputImage, TOutputImage >::Self = SliceImageFilter

Standard class type aliases.

Definition at line 62 of file itkSliceImageFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage >
using itk::SliceImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 63 of file itkSliceImageFilter.h.

Constructor & Destructor Documentation

◆ SliceImageFilter()

template<class TInputImage , class TOutputImage >
itk::SliceImageFilter< TInputImage, TOutputImage >::SliceImageFilter ( )
protected

Begin concept checking End concept checking

◆ ~SliceImageFilter()

template<class TInputImage , class TOutputImage >
itk::SliceImageFilter< TInputImage, TOutputImage >::~SliceImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ DynamicThreadedGenerateData()

template<class TInputImage , class TOutputImage >
void itk::SliceImageFilter< TInputImage, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType outputRegionForThread)
overrideprotectedvirtual

SliceImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a DynamicThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling DynamicThreadedGenerateData(). DynamicThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

template<class TInputImage , class TOutputImage >
void itk::SliceImageFilter< TInputImage, 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 >.

◆ GenerateOutputInformation()

template<class TInputImage , class TOutputImage >
void itk::SliceImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( )
overrideprotectedvirtual

SliceImageFilter produces an image which is a different resolution and with a different pixel spacing than its input image.

See also
ProcessObject::GenerateOutputInformaton()

Reimplemented from itk::ProcessObject.

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage >
const char* itk::SliceImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
overridevirtual

◆ GetStart()

template<class TInputImage , class TOutputImage >
virtual const IndexType& itk::SliceImageFilter< TInputImage, TOutputImage >::GetStart ( ) const
virtual

Set/Get the first index extracted from the input image

◆ GetStep()

template<class TInputImage , class TOutputImage >
virtual const ArrayType& itk::SliceImageFilter< TInputImage, TOutputImage >::GetStep ( ) const
virtual

Set/Get the stride of indexes extracted

An exception will be generated if 0.

◆ GetStop()

template<class TInputImage , class TOutputImage >
virtual const IndexType& itk::SliceImageFilter< TInputImage, TOutputImage >::GetStop ( ) const
virtual

Set/Get the excluded end of the range

◆ New()

template<class TInputImage , class TOutputImage >
static Pointer itk::SliceImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<class TInputImage , class TOutputImage >
void itk::SliceImageFilter< TInputImage, 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 >.

◆ SetStart() [1/2]

template<class TInputImage , class TOutputImage >
virtual void itk::SliceImageFilter< TInputImage, TOutputImage >::SetStart ( IndexType  _arg)
virtual

Set/Get the first index extracted from the input image

◆ SetStart() [2/2]

template<class TInputImage , class TOutputImage >
void itk::SliceImageFilter< TInputImage, TOutputImage >::SetStart ( IndexValueType  start)

Set/Get the first index extracted from the input image

◆ SetStep() [1/2]

template<class TInputImage , class TOutputImage >
virtual void itk::SliceImageFilter< TInputImage, TOutputImage >::SetStep ( ArrayType  _arg)
virtual

Set/Get the stride of indexes extracted

An exception will be generated if 0.

◆ SetStep() [2/2]

template<class TInputImage , class TOutputImage >
void itk::SliceImageFilter< TInputImage, TOutputImage >::SetStep ( int  step)

Set/Get the stride of indexes extracted

An exception will be generated if 0.

◆ SetStop() [1/2]

template<class TInputImage , class TOutputImage >
virtual void itk::SliceImageFilter< TInputImage, TOutputImage >::SetStop ( IndexType  _arg)
virtual

Set/Get the excluded end of the range

◆ SetStop() [2/2]

template<class TInputImage , class TOutputImage >
void itk::SliceImageFilter< TInputImage, TOutputImage >::SetStop ( IndexValueType  stop)

Set/Get the excluded end of the range

◆ VerifyInputInformation()

template<class TInputImage , class TOutputImage >
void itk::SliceImageFilter< TInputImage, TOutputImage >::VerifyInputInformation ( )
overrideprotectedvirtual

Verifies that the input images occupy the same physical space and the each index is at the same physical location.

The default implementation of the PropagateRequestedRegion() methods copies the index and size from the output to the input. This makes an implicit assumption that the images occupy the same physical location at each voxel. This method enforces that they are the same.

This implementation verifies that all input images of InputImageDimensions have the same origin, spacing and direction.

Filters which do not expect all input images to be at the same physical location should over-ride this method. Also filters whose inputs are different dimensions may need to override this method.

See also
ProcessObject::VerifyInputInformation

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

Member Data Documentation

◆ ImageDimension

template<class TInputImage , class TOutputImage >
constexpr unsigned int itk::SliceImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension
staticconstexpr

ImageDimension enumeration.

Definition at line 88 of file itkSliceImageFilter.h.

◆ m_Start

template<class TInputImage , class TOutputImage >
IndexType itk::SliceImageFilter< TInputImage, TOutputImage >::m_Start {}
private

Definition at line 164 of file itkSliceImageFilter.h.

◆ m_Step

template<class TInputImage , class TOutputImage >
ArrayType itk::SliceImageFilter< TInputImage, TOutputImage >::m_Step {}
private

Definition at line 166 of file itkSliceImageFilter.h.

◆ m_Stop

template<class TInputImage , class TOutputImage >
IndexType itk::SliceImageFilter< TInputImage, TOutputImage >::m_Stop {}
private

Definition at line 165 of file itkSliceImageFilter.h.

◆ OutputImageDimension

template<class TInputImage , class TOutputImage >
constexpr unsigned int itk::SliceImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension
staticconstexpr

Definition at line 89 of file itkSliceImageFilter.h.


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