ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::InPlaceImageFilter< TInputImage, TOutputImage > Class Template Reference
Data Processing Objects » Filters » Image FiltersGroup Core » | Module ITKCommon

#include <itkInPlaceImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage = TInputImage>
class itk::InPlaceImageFilter< TInputImage, TOutputImage >

Base class for filters that take an image as input and overwrite that image as the output.

InPlaceImageFilter is the base class for all process objects whose output image data is constructed by overwriting the input image data. In other words, the output bulk data is the same block of memory as the input bulk data. This filter provides the mechanisms for in place image processing while maintaining general pipeline mechanics. InPlaceImageFilters use less memory than standard ImageToImageFilters because the input buffer is reused as the output buffer. However, this benefit does not come without a cost. Since the filter overwrites its input, the ownership of the bulk data is transitioned from the input data object to the output data object. When a data object has multiple consumers with one of the consumers being an in place filter, the in place filter effectively destroys the bulk data for the data object. Upstream filters will then have to re-execute to regenerate the data object's bulk data for the remaining consumers.

Since an InPlaceImageFilter reuses the input bulk data memory for the output bulk data memory, the input image type must match the output image type. If the input and output image types are not identical, the filter reverts to a traditional ImageToImageFilter behaviour where an output image is allocated. Additionally, the requested region of the output must match that of the input. In place operation can also be controlled (when the input and output image type match) via the methods InPlaceOn() and InPlaceOff().

Subclasses of InPlaceImageFilter must take extra care in how they manage memory using (and perhaps overriding) the implementations of ReleaseInputs() and AllocateOutputs() provided here.

ITK Sphinx Examples:

Definition at line 77 of file itkInPlaceImageFilter.h.

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

Public Types

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 = InPlaceImageFilter
 
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

virtual bool CanRunInPlace () const
 
const char * GetNameOfClass () const override
 
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType * GetInput () const
 
const InputImageType * GetInput (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 >
OutputImageType * GetOutput (unsigned int idx)
 
OutputImageType * GetOutput ()
 
const OutputImageType * GetOutput () const
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderType * GetMultiThreader () const
 
const char * GetNameOfClass () const override
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdType & GetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Attributes

static constexpr unsigned int InputImageDimension = 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

virtual bool GetRunningInPlace () const
 
 InPlaceImageFilter ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void ReleaseInputs () override
 
 ~InPlaceImageFilter () override=default
 
void AllocateOutputs () 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)
 
void GenerateInputRequestedRegion () override
 
 ImageToImageFilter ()
 
void VerifyInputInformation () const override
 
 ~ImageToImageFilter () override=default
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const ImageRegionSplitterBase * GetImageRegionSplitter () 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 void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void 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 () const
 
 ~ProcessObject () override
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObject * GetOutput (const DataObjectIdentifierType &key)
 
const DataObject * GetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObject * GetOutput (DataObjectPointerArraySizeType i)
 
const DataObject * GetOutput (DataObjectPointerArraySizeType i) const
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
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 Member Functions

void InternalAllocateOutputs ()
 

Private Attributes

bool m_InPlace { true }
 
bool m_RunningInPlace { false }
 

Additional Inherited Members

- 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 ()
 
- 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 ImageRegionSplitterBase * GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading { true }
 
- 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

◆ ConstPointer

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

Definition at line 86 of file itkInPlaceImageFilter.h.

◆ InputImageConstPointer

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

Definition at line 100 of file itkInPlaceImageFilter.h.

◆ InputImagePixelType

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

Definition at line 102 of file itkInPlaceImageFilter.h.

◆ InputImagePointer

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

Definition at line 99 of file itkInPlaceImageFilter.h.

◆ InputImageRegionType

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

Definition at line 101 of file itkInPlaceImageFilter.h.

◆ InputImageType

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

Some convenient type alias.

Definition at line 98 of file itkInPlaceImageFilter.h.

◆ Pointer

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

Definition at line 85 of file itkInPlaceImageFilter.h.

◆ Self

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

Standard class type aliases.

Definition at line 83 of file itkInPlaceImageFilter.h.

◆ Superclass

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

Definition at line 84 of file itkInPlaceImageFilter.h.

Constructor & Destructor Documentation

◆ InPlaceImageFilter()

template<typename TInputImage, typename TOutputImage = TInputImage>
itk::InPlaceImageFilter< TInputImage, TOutputImage >::InPlaceImageFilter ( )
protecteddefault

◆ ~InPlaceImageFilter()

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

Member Function Documentation

◆ AllocateOutputs()

template<typename TInputImage, typename TOutputImage = TInputImage>
void itk::InPlaceImageFilter< TInputImage, TOutputImage >::AllocateOutputs ( )
inlineoverrideprotectedvirtual

The GenerateData method normally allocates the buffers for all of the outputs of a filter. Since InPlaceImageFilter's can use an overwritten version of the input for its output, the output buffer should not be allocated. When possible, we graft the input to the filter to the output. If an InPlaceFilter has multiple outputs, then it would need to override this method to graft one of its outputs and allocate the remaining. If a filter is threaded (i.e. it provides an implementation of ThreadedGenerateData()), this method is called automatically. If an InPlaceFilter is not threaded (i.e. it provides an implementation of GenerateData()), then this method (or equivalent) must be called in GenerateData().

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, BinaryThresholdImageFilter< TInputImage, TOutputImage > >, and itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, CastImageFilter< TInputImage, TOutputImage > >.

Definition at line 149 of file itkInPlaceImageFilter.h.

◆ CanRunInPlace()

template<typename TInputImage, typename TOutputImage = TInputImage>
virtual bool itk::InPlaceImageFilter< TInputImage, TOutputImage >::CanRunInPlace ( ) const
virtual

Can the filter run in place? To do so, the filter's first input and output must have the same dimension and pixel type. This method can be used in conjunction with the InPlace ivar to determine whether a particular use of the filter is really running in place. Some filters may be able to optimize their operation if the InPlace is true and CanRunInPlace is true. CanRunInPlace may also be overridden by InPlaceImageFilter subclasses to fine tune its behavior.

Reimplemented in itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >, and itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >.

◆ GetInPlace()

template<typename TInputImage, typename TOutputImage = TInputImage>
virtual bool itk::InPlaceImageFilter< TInputImage, TOutputImage >::GetInPlace ( ) const
virtual

In place operation can be turned on and off. Asking for in-place operation, i.e. calling SetInplace(true) or InplaceOn(), will be effective only if CanRunInPlace also returns true. By default CanRunInPlace checks whether the input and output image type match.

◆ GetNameOfClass()

template<typename TInputImage, typename TOutputImage = TInputImage>
const char* itk::InPlaceImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

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

Reimplemented in itk::SymmetricEigenAnalysisFixedDimensionImageFilter< TMatrixDimension, TInputImage, TOutputImage >, itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::SymmetricEigenAnalysisImageFilter< TInputImage, TOutputImage >, itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::SparseFieldLevelSetImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >, itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >, itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType, TInputImage::ImageDimension > >, itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >, itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, unsigned int >, itk::IntensityWindowingImageFilter< TInputImage, TOutputImage >, itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >, itk::SigmoidImageFilter< TInputImage, TOutputImage >, itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, itk::ClampImageFilter< TInputImage, TOutputImage >, itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >, itk::RescaleIntensityImageFilter< TInputImage, TOutputImage >, itk::AdaptImageFilter< TInputImage, TOutputImage, TAccessor >, itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >, itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >, itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >, itk::FiniteDifferenceImageFilter< TInputImage, TSparseOutputImage >, itk::FiniteDifferenceImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >, itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >, itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >, itk::AntiAliasBinaryImageFilter< TInputImage, TOutputImage >, itk::ChangeLabelImageFilter< TInputImage, TOutputImage >, itk::RelabelComponentImageFilter< TInputImage, TOutputImage >, itk::VectorRescaleIntensityImageFilter< TInputImage, TOutputImage >, itk::GPUBinaryThresholdImageFilter< TInputImage, TOutputImage >, itk::CastImageFilter< TInputImage, TOutputImage >, itk::CastImageFilter< FeatureImageType, ImageType >, itk::NaryMaximumImageFilter< TInputImage, TOutputImage >, itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >, itk::NaryAddImageFilter< TInputImage, TOutputImage >, itk::TransformGeometryImageFilter< TInputImage, TOutputImage >, itk::InvertIntensityImageFilter< TInputImage, TOutputImage >, itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction >, itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::ExpNegativeImageFilter< TInputImage, TOutputImage >, itk::GradientMagnitudeRecursiveGaussianImageFilter< TInputImage, TOutputImage >, itk::VectorIndexSelectionCastImageFilter< TInputImage, TOutputImage >, itk::ShotNoiseImageFilter< TInputImage, TOutputImage >, itk::MatrixIndexSelectionImageFilter< TInputImage, TOutputImage >, itk::MinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::BinaryMinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::AnisotropicFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, itk::GPUCastImageFilter< TInputImage, TOutputImage >, itk::AcosImageFilter< TInputImage, TOutputImage >, itk::AsinImageFilter< TInputImage, TOutputImage >, itk::TensorFractionalAnisotropyImageFilter< TInputImage, TOutputImage >, itk::TensorRelativeAnisotropyImageFilter< TInputImage, TOutputImage >, itk::CosImageFilter< TInputImage, TOutputImage >, itk::AtanImageFilter< TInputImage, TOutputImage >, itk::IsotropicFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, itk::AnisotropicDiffusionImageFilter< TInputImage, TOutputImage >, itk::VectorMagnitudeImageFilter< TInputImage, TOutputImage >, itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >, itk::VectorCurvatureAnisotropicDiffusionImageFilter< TInputImage, TOutputImage >, itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >, itk::BoundedReciprocalImageFilter< TInputImage, TOutputImage >, itk::SinImageFilter< TInputImage, TOutputImage >, itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >, itk::SaltAndPepperNoiseImageFilter< TInputImage, TOutputImage >, itk::AbsImageFilter< TInputImage, TOutputImage >, itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >, itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >, itk::ExpImageFilter< TInputImage, TOutputImage >, itk::UnsharpMaskLevelSetImageFilter< TInputImage, TOutputImage >, itk::Log10ImageFilter< TInputImage, TOutputImage >, itk::SqrtImageFilter< TInputImage, TOutputImage >, itk::TanImageFilter< TInputImage, TOutputImage >, itk::EdgePotentialImageFilter< TInputImage, TOutputImage >, itk::NotImageFilter< TInputImage, TOutputImage >, itk::RGBToLuminanceImageFilter< TInputImage, TOutputImage >, itk::RoundImageFilter< TInputImage, TOutputImage >, itk::LabelContourImageFilter< TInputImage, TOutputImage >, itk::LogImageFilter< TInputImage, TOutputImage >, itk::SquareImageFilter< TInputImage, TOutputImage >, itk::FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >, itk::VectorGradientAnisotropicDiffusionImageFilter< TInputImage, TOutputImage >, itk::CurvatureAnisotropicDiffusionImageFilter< TInputImage, TOutputImage >, itk::ComplexToImaginaryImageFilter< TInputImage, TOutputImage >, itk::BinaryContourImageFilter< TInputImage, TOutputImage >, itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >, itk::ComplexToPhaseImageFilter< TInputImage, TOutputImage >, itk::ComplexToRealImageFilter< TInputImage, TOutputImage >, itk::ComplexToModulusImageFilter< TInputImage, TOutputImage >, itk::BinaryGeneratorImageFilter< TInputImage, TMaskImage, TOutputImage >, itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType >, itk::BinaryGeneratorImageFilter< TInputImage, TLabelImage, TOutputImage >, itk::UnaryGeneratorImageFilter< TInputImage, TOutputImage >, itk::SpeckleNoiseImageFilter< TInputImage, TOutputImage >, itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >, itk::AdditiveGaussianNoiseImageFilter< TInputImage, TOutputImage >, itk::TernaryGeneratorImageFilter< TMask, TImage, TImage, TImage >, itk::GradientAnisotropicDiffusionImageFilter< TInputImage, TOutputImage >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::InvertIntensityTransform< TInputImage::PixelType, TOutputImage::PixelType > >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::ChangeLabel< TInputImage::PixelType, TOutputImage::PixelType > >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Clamp< TInputImage::PixelType, TOutputImage::PixelType > >, itk::UnaryFunctorImageFilter< TLabelImage, TOutputImage, Functor::LabelToRGBFunctor< TLabelImage::PixelType, TOutputImage::PixelType > >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::VectorMagnitudeLinearTransform< TInputImage::PixelType, TOutputImage::PixelType > >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::IntensityLinearTransform< TInputImage::PixelType, TOutputImage::PixelType > >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::SymmetricEigenAnalysisFixedDimensionFunction< TMatrixDimension, TInputImage::PixelType, TOutputImage::PixelType > >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::IntensityWindowingTransform< TInputImage::PixelType, TOutputImage::PixelType > >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::NOT< TInputImage::PixelType, TOutputImage::PixelType > >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::ThresholdLabeler< TInputImage::PixelType, TOutputImage::PixelType > >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::ExpNegative< TInputImage::PixelType, TOutputImage::PixelType > >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::SymmetricEigenAnalysisFunction< TInputImage::PixelType, TOutputImage::PixelType > >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::TensorRelativeAnisotropyFunction< TInputImage::PixelType > >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::MatrixIndexSelection< TInputImage::PixelType, TOutputImage::PixelType > >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::BinaryThreshold< TInputImage::PixelType, TOutputImage::PixelType > >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::AccessorFunctor< TInputImage::PixelType, TAccessor > >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Sigmoid< TInputImage::PixelType, TOutputImage::PixelType > >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::TensorFractionalAnisotropyFunction< TInputImage::PixelType > >, itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::VectorIndexSelectionCast< TInputImage::PixelType, TOutputImage::PixelType > >, itk::UnaryFunctorImageFilter< TImage, TImage, Functor::BinaryNot< TImage::PixelType > >, itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >, itk::CropImageFilter< TInputImage, TOutputImage >, itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >, itk::NaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Add1< TInputImage::PixelType, TInputImage::PixelType > >, itk::NaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Maximum1< TInputImage::PixelType, TInputImage::PixelType > >, itk::GPUUnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::GPUCast< TInputImage::PixelType, TOutputImage::PixelType >, CastImageFilter< TInputImage, TOutputImage > >, itk::GPUUnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::GPUBinaryThreshold< TInputImage::PixelType, TOutputImage::PixelType >, BinaryThresholdImageFilter< TInputImage, TOutputImage > >, itk::GPUImageToImageFilter< TInputImage, TOutputImage, BinaryThresholdImageFilter< TInputImage, TOutputImage > >, itk::GPUImageToImageFilter< TInputImage, TOutputImage, CastImageFilter< TInputImage, TOutputImage > >, itk::NoiseBaseImageFilter< TInputImage, TOutputImage >, itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, BinaryThresholdImageFilter< TInputImage, TOutputImage > >, and itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, CastImageFilter< TInputImage, TOutputImage > >.

◆ GetRunningInPlace()

template<typename TInputImage, typename TOutputImage = TInputImage>
virtual bool itk::InPlaceImageFilter< TInputImage, TOutputImage >::GetRunningInPlace ( ) const
protectedvirtual

This methods should only be called during the GenerateData phase of the pipeline. This method return true if the input image's bulk data is the same as the output image's data.

◆ InPlaceOn()

template<typename TInputImage, typename TOutputImage = TInputImage>
virtual void itk::InPlaceImageFilter< TInputImage, TOutputImage >::InPlaceOn ( )
virtual

In place operation can be turned on and off. Asking for in-place operation, i.e. calling SetInplace(true) or InplaceOn(), will be effective only if CanRunInPlace also returns true. By default CanRunInPlace checks whether the input and output image type match.

◆ InternalAllocateOutputs()

template<typename TInputImage, typename TOutputImage = TInputImage>
void itk::InPlaceImageFilter< TInputImage, TOutputImage >::InternalAllocateOutputs ( )
private

◆ PrintSelf()

template<typename TInputImage, typename TOutputImage = TInputImage>
void itk::InPlaceImageFilter< 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 >.

Reimplemented in itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >, itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, unsigned int >, itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >, itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType, TInputImage::ImageDimension > >, itk::SymmetricEigenAnalysisFixedDimensionImageFilter< TMatrixDimension, TInputImage, TOutputImage >, itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::SparseFieldLevelSetImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >, itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, itk::SymmetricEigenAnalysisImageFilter< TInputImage, TOutputImage >, itk::RelabelComponentImageFilter< TInputImage, TOutputImage >, itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >, itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >, itk::FiniteDifferenceImageFilter< TInputImage, TSparseOutputImage >, itk::FiniteDifferenceImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >, itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >, itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >, itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >, itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >, itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >, itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >, itk::IntensityWindowingImageFilter< TInputImage, TOutputImage >, itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >, itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >, itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >, itk::RescaleIntensityImageFilter< TInputImage, TOutputImage >, itk::ClampImageFilter< TInputImage, TOutputImage >, itk::AntiAliasBinaryImageFilter< TInputImage, TOutputImage >, itk::ChangeLabelImageFilter< TInputImage, TOutputImage >, itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >, itk::VectorRescaleIntensityImageFilter< TInputImage, TOutputImage >, itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >, itk::AnisotropicDiffusionImageFilter< TInputImage, TOutputImage >, itk::ShotNoiseImageFilter< TInputImage, TOutputImage >, itk::GradientMagnitudeRecursiveGaussianImageFilter< TInputImage, TOutputImage >, itk::MinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::BinaryContourImageFilter< TInputImage, TOutputImage >, itk::SaltAndPepperNoiseImageFilter< TInputImage, TOutputImage >, itk::BinaryMinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::LabelContourImageFilter< TInputImage, TOutputImage >, itk::InvertIntensityImageFilter< TInputImage, TOutputImage >, itk::AnisotropicFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, itk::FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >, itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >, itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >, itk::CropImageFilter< TInputImage, TOutputImage >, itk::IsotropicFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, itk::AdditiveGaussianNoiseImageFilter< TInputImage, TOutputImage >, itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >, itk::SpeckleNoiseImageFilter< TInputImage, TOutputImage >, itk::UnsharpMaskLevelSetImageFilter< TInputImage, TOutputImage >, itk::TensorFractionalAnisotropyImageFilter< TInputImage, TOutputImage >, itk::TensorRelativeAnisotropyImageFilter< TInputImage, TOutputImage >, itk::GPUImageToImageFilter< TInputImage, TOutputImage, BinaryThresholdImageFilter< TInputImage, TOutputImage > >, itk::GPUImageToImageFilter< TInputImage, TOutputImage, CastImageFilter< TInputImage, TOutputImage > >, itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, BinaryThresholdImageFilter< TInputImage, TOutputImage > >, itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, CastImageFilter< TInputImage, TOutputImage > >, itk::NoiseBaseImageFilter< TInputImage, TOutputImage >, and itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction >.

Referenced by itk::TensorFractionalAnisotropyImageFilter< TInputImage, TOutputImage >::PrintSelf(), itk::TensorRelativeAnisotropyImageFilter< TInputImage, TOutputImage >::PrintSelf(), itk::BinaryNotImageFilter< TImage >::PrintSelf(), itk::SymmetricEigenAnalysisImageFilter< TInputImage, TOutputImage >::PrintSelf(), and itk::SymmetricEigenAnalysisFixedDimensionImageFilter< TMatrixDimension, TInputImage, TOutputImage >::PrintSelf().

◆ ReleaseInputs()

template<typename TInputImage, typename TOutputImage = TInputImage>
void itk::InPlaceImageFilter< TInputImage, TOutputImage >::ReleaseInputs ( )
overrideprotectedvirtual

InPlaceImageFilter may transfer ownership of the input bulk data to the output object. Once the output object owns the bulk data (done in AllocateOutputs()), the input object must release its hold on the bulk data. ProcessObject::ReleaseInputs() only releases the input bulk data when the user has set the ReleaseDataFlag. InPlaceImageFilter::ReleaseInputs() also releases the input that it has overwritten.

See also
ProcessObject::ReleaseInputs()

Reimplemented from itk::ProcessObject.

Reimplemented in itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, BinaryThresholdImageFilter< TInputImage, TOutputImage > >, and itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, CastImageFilter< TInputImage, TOutputImage > >.

◆ SetInPlace()

template<typename TInputImage, typename TOutputImage = TInputImage>
virtual void itk::InPlaceImageFilter< TInputImage, TOutputImage >::SetInPlace ( bool  _arg)
virtual

In place operation can be turned on and off. Asking for in-place operation, i.e. calling SetInplace(true) or InplaceOn(), will be effective only if CanRunInPlace also returns true. By default CanRunInPlace checks whether the input and output image type match.

Member Data Documentation

◆ InputImageDimension

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

ImageDimension constants

Definition at line 105 of file itkInPlaceImageFilter.h.

◆ m_InPlace

template<typename TInputImage, typename TOutputImage = TInputImage>
bool itk::InPlaceImageFilter< TInputImage, TOutputImage >::m_InPlace { true }
private

Definition at line 185 of file itkInPlaceImageFilter.h.

◆ m_RunningInPlace

template<typename TInputImage, typename TOutputImage = TInputImage>
bool itk::InPlaceImageFilter< TInputImage, TOutputImage >::m_RunningInPlace { false }
private

Definition at line 186 of file itkInPlaceImageFilter.h.

◆ OutputImageDimension

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

Definition at line 106 of file itkInPlaceImageFilter.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16