ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::InPlaceLabelMapFilter< TInputImage > Class Template Reference

#include <itkInPlaceLabelMapFilter.h>

+ Inheritance diagram for itk::InPlaceLabelMapFilter< TInputImage >:
+ Collaboration diagram for itk::InPlaceLabelMapFilter< TInputImage >:

Detailed Description

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

Base class for filters that takes an image as input and overwrites that image as the output.

InPlaceLabelMapFilter 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. InPlaceLabelMapFilters 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 InPlaceLabelMapFilter 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. In place operation can also be controlled (when the input and output image type match) via the methods InPlaceOn() and InPlaceOff().

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

This code was contributed in the Insight Journal paper: "Label object representation and manipulation with ITK" by Lehmann G. https://hdl.handle.net/1926/584 http://www.insight-journal.org/browse/publication/176

Author
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.
See Also
LabelMapToBinaryImageFilter, LabelMapToLabelImageFilter

Definition at line 83 of file itkInPlaceLabelMapFilter.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef InputImageType::IndexType IndexType
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
InputImageType::LabelObjectType 
LabelObjectType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImagePointer 
OutputImagePointer
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef Superclass::OutputImageType OutputImageType
 
typedef InputImageType::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef InputImageType::RegionType RegionType
 
typedef InPlaceLabelMapFilter Self
 
typedef LabelMapFilter
< TInputImage, TInputImage > 
Superclass
 
typedef TInputImage TOutputImage
 
- Public Types inherited from itk::LabelMapFilter< TInputImage, TInputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::InputImageConstPointer 
InputImageConstPointer
 
typedef
Superclass::InputImagePixelType 
InputImagePixelType
 
typedef
Superclass::InputImagePointer 
InputImagePointer
 
typedef
Superclass::InputImageRegionType 
InputImageRegionType
 
typedef Superclass::InputImageType InputImageType
 
typedef
InputImageType::LabelObjectType 
LabelObjectType
 
typedef
OutputImageType::ConstPointer 
OutputImageConstPointer
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TInputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef LabelMapFilter Self
 
typedef ImageToImageFilter
< TInputImage, TInputImage > 
Superclass
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource< TInputImage > Superclass
 
- Public Types inherited from itk::ImageSource< TInputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TInputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef MultiThreader MultiThreaderType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

bool CanRunInPlace () const
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace ()
 
virtual void InPlaceOn ()
 
virtual void InPlaceOff ()
 
- Public Member Functions inherited from itk::LabelMapFilter< TInputImage, TInputImage >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
void EnlargeOutputRequestedRegion (DataObject *) override
 
void GenerateInputRequestedRegion () override
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PopBackInput () override
 
virtual void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TInputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual 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 const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::LabelMapFilter< TInputImage, TInputImage >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::LabelMapFilter< TInputImage, TInputImage >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TInputImage >
static const unsigned int OutputImageDimension
 

Protected Member Functions

virtual void AllocateOutputs () override
 
virtual InputImageTypeGetLabelMap () override
 
 InPlaceLabelMapFilter ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~InPlaceLabelMapFilter () override
 
- Protected Member Functions inherited from itk::LabelMapFilter< TInputImage, TInputImage >
virtual void AfterThreadedGenerateData () override
 
virtual void BeforeThreadedGenerateData () override
 
 LabelMapFilter ()
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId) override
 
virtual void ThreadedProcessLabelObject (LabelObjectType *labelObject)
 
 ~LabelMapFilter () override
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
 ImageToImageFilter ()
 
virtual void VerifyInputInformation () override
 
 ~ImageToImageFilter () override
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TInputImage >
virtual void GenerateData () override
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual ~ImageSource () override
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

bool m_InPlace
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
 
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType
 
- Static Protected Member Functions inherited from itk::ImageSource< TInputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::LabelMapFilter< TInputImage, TInputImage >
FastMutexLock::Pointer m_LabelObjectContainerLock
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TInputImage>
typedef SmartPointer< const Self > itk::InPlaceLabelMapFilter< TInputImage >::ConstPointer

Definition at line 90 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
typedef InputImageType::IndexType itk::InPlaceLabelMapFilter< TInputImage >::IndexType

Definition at line 113 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
typedef InputImageType::ConstPointer itk::InPlaceLabelMapFilter< TInputImage >::InputImageConstPointer

Definition at line 107 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
typedef InputImageType::PixelType itk::InPlaceLabelMapFilter< TInputImage >::InputImagePixelType

Definition at line 109 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
typedef InputImageType::Pointer itk::InPlaceLabelMapFilter< TInputImage >::InputImagePointer

Definition at line 106 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
typedef InputImageType::RegionType itk::InPlaceLabelMapFilter< TInputImage >::InputImageRegionType

Definition at line 108 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
typedef TInputImage itk::InPlaceLabelMapFilter< TInputImage >::InputImageType

Some convenient typedefs.

Definition at line 105 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
typedef InputImageType::LabelObjectType itk::InPlaceLabelMapFilter< TInputImage >::LabelObjectType

Definition at line 110 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
typedef Superclass::OutputImagePixelType itk::InPlaceLabelMapFilter< TInputImage >::OutputImagePixelType

Definition at line 102 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
typedef Superclass::OutputImagePointer itk::InPlaceLabelMapFilter< TInputImage >::OutputImagePointer

Definition at line 100 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
typedef Superclass::OutputImageRegionType itk::InPlaceLabelMapFilter< TInputImage >::OutputImageRegionType

Definition at line 101 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
typedef Superclass::OutputImageType itk::InPlaceLabelMapFilter< TInputImage >::OutputImageType

Superclass typedefs.

Definition at line 96 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
typedef InputImageType::PixelType itk::InPlaceLabelMapFilter< TInputImage >::PixelType

Definition at line 112 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
typedef SmartPointer< Self > itk::InPlaceLabelMapFilter< TInputImage >::Pointer

Definition at line 89 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
typedef InputImageType::RegionType itk::InPlaceLabelMapFilter< TInputImage >::RegionType

Definition at line 114 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
typedef InPlaceLabelMapFilter itk::InPlaceLabelMapFilter< TInputImage >::Self

Standard class typedefs.

Definition at line 87 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
typedef LabelMapFilter< TInputImage, TInputImage > itk::InPlaceLabelMapFilter< TInputImage >::Superclass

Definition at line 88 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
typedef TInputImage itk::InPlaceLabelMapFilter< TInputImage >::TOutputImage

Definition at line 116 of file itkInPlaceLabelMapFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage>
itk::InPlaceLabelMapFilter< TInputImage >::InPlaceLabelMapFilter ( )
protected
template<typename TInputImage>
itk::InPlaceLabelMapFilter< TInputImage >::~InPlaceLabelMapFilter ( )
overrideprotected

Member Function Documentation

template<typename TInputImage>
virtual void itk::InPlaceLabelMapFilter< TInputImage >::AllocateOutputs ( )
overrideprotectedvirtual

The GenerateData method normally allocates the buffers for all of the outputs of a filter. Since InPlaceLabelMapFilter'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< TInputImage >.

template<typename TInputImage>
bool itk::InPlaceLabelMapFilter< TInputImage >::CanRunInPlace ( ) const
inline

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.

Definition at line 136 of file itkInPlaceLabelMapFilter.h.

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

Reimplemented in itk::ShapeLabelMapFilter< TImage, Image< TImage::PixelType, TImage::ImageDimension > >, itk::PadLabelMapFilter< TInputImage >, and itk::RegionFromReferenceLabelMapFilter< TInputImage >.

template<typename TInputImage>
virtual bool itk::InPlaceLabelMapFilter< TInputImage >::GetInPlace ( )
virtual

In place operation can be turned on and off. This only has an effect when the input and output image type match.

template<typename TInputImage>
virtual InputImageType* itk::InPlaceLabelMapFilter< TInputImage >::GetLabelMap ( )
inlineoverrideprotectedvirtual

Return the output label collection image, instead of the input as in the default implementation

Reimplemented from itk::LabelMapFilter< TInputImage, TInputImage >.

Definition at line 169 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
virtual const char* itk::InPlaceLabelMapFilter< TInputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::LabelMapFilter< TInputImage, TInputImage >.

Reimplemented in itk::ShapeLabelMapFilter< TImage, TLabelImage >, itk::ShapeLabelMapFilter< TImage, Image< TImage::PixelType, TImage::ImageDimension > >, itk::LabelSelectionLabelMapFilter< TImage >, itk::AttributeSelectionLabelMapFilter< TImage, TAttributeAccessor >, itk::AttributeSelectionLabelMapFilter< TImage, Functor::LabelLabelObjectAccessor< TImage::LabelObjectType > >, itk::AttributeUniqueLabelMapFilter< TImage, TAttributeAccessor >, itk::BinaryReconstructionLabelMapFilter< TImage, TMarkerImage, TAttributeAccessor >, itk::MergeLabelMapFilter< TImage >, itk::AttributeUniqueLabelMapFilter< TImage, Functor::LabelLabelObjectAccessor< TImage::LabelObjectType > >, itk::StatisticsLabelMapFilter< TImage, TFeatureImage >, itk::LabelUniqueLabelMapFilter< TImage >, itk::ShapeOpeningLabelMapFilter< TImage >, itk::AttributeOpeningLabelMapFilter< TImage, TAttributeAccessor >, itk::StatisticsKeepNObjectsLabelMapFilter< TImage >, itk::AttributePositionLabelMapFilter< TImage, TAttributeAccessor, VPhysicalPosition >, itk::AttributeRelabelLabelMapFilter< TImage, TAttributeAccessor >, itk::ChangeLabelLabelMapFilter< TImage >, itk::StatisticsOpeningLabelMapFilter< TImage >, itk::StatisticsRelabelLabelMapFilter< TImage >, itk::AttributeRelabelLabelMapFilter< TImage, Functor::LabelLabelObjectAccessor< TImage::LabelObjectType > >, itk::AttributeKeepNObjectsLabelMapFilter< TImage, TAttributeAccessor >, itk::RelabelLabelMapFilter< TImage >, itk::ShapeUniqueLabelMapFilter< TImage >, itk::ShapeRelabelLabelMapFilter< TImage >, itk::ShapeKeepNObjectsLabelMapFilter< TImage >, itk::StatisticsPositionLabelMapFilter< TImage >, itk::AggregateLabelMapFilter< TImage >, itk::StatisticsUniqueLabelMapFilter< TImage >, itk::ShiftScaleLabelMapFilter< TImage >, itk::AutoCropLabelMapFilter< TInputImage >, itk::ShapePositionLabelMapFilter< TImage >, itk::ChangeRegionLabelMapFilter< TInputImage >, itk::CropLabelMapFilter< TInputImage >, itk::PadLabelMapFilter< TInputImage >, and itk::RegionFromReferenceLabelMapFilter< TInputImage >.

template<typename TInputImage>
virtual void itk::InPlaceLabelMapFilter< TInputImage >::InPlaceOff ( )
virtual

In place operation can be turned on and off. This only has an effect when the input and output image type match.

template<typename TInputImage>
virtual void itk::InPlaceLabelMapFilter< TInputImage >::InPlaceOn ( )
virtual

In place operation can be turned on and off. This only has an effect when the input and output image type match.

template<typename TInputImage>
static Pointer itk::InPlaceLabelMapFilter< TInputImage >::New ( )
static

Standard New method.

template<typename TInputImage>
virtual void itk::InPlaceLabelMapFilter< TInputImage >::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, TInputImage >.

Reimplemented in itk::ShapeUniqueLabelMapFilter< TImage >, itk::ShapeKeepNObjectsLabelMapFilter< TImage >, itk::ShapeRelabelLabelMapFilter< TImage >, itk::ShapeOpeningLabelMapFilter< TImage >, itk::AttributeSelectionLabelMapFilter< TImage, TAttributeAccessor >, itk::AttributeSelectionLabelMapFilter< TImage, Functor::LabelLabelObjectAccessor< TImage::LabelObjectType > >, itk::ShapeLabelMapFilter< TImage, TLabelImage >, itk::ShapeLabelMapFilter< TImage, Image< TImage::PixelType, TImage::ImageDimension > >, itk::StatisticsLabelMapFilter< TImage, TFeatureImage >, itk::ShapePositionLabelMapFilter< TImage >, itk::BinaryReconstructionLabelMapFilter< TImage, TMarkerImage, TAttributeAccessor >, itk::RegionFromReferenceLabelMapFilter< TInputImage >, itk::CropLabelMapFilter< TInputImage >, itk::PadLabelMapFilter< TInputImage >, itk::MergeLabelMapFilter< TImage >, itk::AttributeOpeningLabelMapFilter< TImage, TAttributeAccessor >, itk::AttributeKeepNObjectsLabelMapFilter< TImage, TAttributeAccessor >, itk::AttributeUniqueLabelMapFilter< TImage, TAttributeAccessor >, itk::ChangeRegionLabelMapFilter< TInputImage >, itk::AttributeUniqueLabelMapFilter< TImage, Functor::LabelLabelObjectAccessor< TImage::LabelObjectType > >, itk::AutoCropLabelMapFilter< TInputImage >, itk::ChangeLabelLabelMapFilter< TImage >, itk::AttributeRelabelLabelMapFilter< TImage, TAttributeAccessor >, itk::AttributeRelabelLabelMapFilter< TImage, Functor::LabelLabelObjectAccessor< TImage::LabelObjectType > >, itk::ShiftScaleLabelMapFilter< TImage >, itk::AttributePositionLabelMapFilter< TImage, TAttributeAccessor, VPhysicalPosition >, and itk::AggregateLabelMapFilter< TImage >.

template<typename TInputImage>
virtual void itk::InPlaceLabelMapFilter< TInputImage >::SetInPlace ( bool  _arg)
virtual

In place operation can be turned on and off. This only has an effect when the input and output image type match.

Member Data Documentation

template<typename TInputImage>
const unsigned int itk::InPlaceLabelMapFilter< TInputImage >::InputImageDimension = TInputImage::ImageDimension
static

ImageDimension constants

Definition at line 119 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
bool itk::InPlaceLabelMapFilter< TInputImage >::m_InPlace
private

Definition at line 175 of file itkInPlaceLabelMapFilter.h.

template<typename TInputImage>
const unsigned int itk::InPlaceLabelMapFilter< TInputImage >::OutputImageDimension = TOutputImage::ImageDimension
static

ImageDimension constants

Definition at line 120 of file itkInPlaceLabelMapFilter.h.


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