ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
#include <itkInPlaceLabelMapFilter.h>
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. http://hdl.handle.net/1926/584 http://www.insight-journal.org/browse/publication/176
Definition at line 83 of file itkInPlaceLabelMapFilter.h.
Public Types | |
typedef SmartPointer< const Self > | ConstPointer |
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< Self > | Pointer |
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 Self > | ConstPointer |
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< Self > | Pointer |
typedef LabelMapFilter | Self |
typedef ImageToImageFilter < TInputImage, TInputImage > | Superclass |
Public Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage > | |
typedef SmartPointer< const Self > | ConstPointer |
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< Self > | Pointer |
typedef ImageToImageFilter | Self |
typedef ImageSource< TInputImage > | Superclass |
Public Types inherited from itk::ImageSource< TInputImage > | |
typedef SmartPointer< const Self > | ConstPointer |
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< Self > | Pointer |
typedef ImageSource | Self |
typedef ProcessObject | Superclass |
Public Types inherited from itk::ProcessObject | |
typedef SmartPointer< const Self > | ConstPointer |
typedef DataObject::DataObjectIdentifierType | DataObjectIdentifierType |
typedef DataObject::Pointer | DataObjectPointer |
typedef std::vector < DataObjectPointer > | DataObjectPointerArray |
typedef DataObjectPointerArray::size_type | DataObjectPointerArraySizeType |
typedef std::vector < DataObjectIdentifierType > | NameArray |
typedef SmartPointer< Self > | Pointer |
typedef ProcessObject | Self |
typedef Object | Superclass |
Public Types inherited from itk::Object | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef Object | Self |
typedef LightObject | Superclass |
Public Types inherited from itk::LightObject | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightObject | Self |
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 |
Private Member Functions | |
InPlaceLabelMapFilter (const Self &) | |
void | operator= (const Self &) |
Private Attributes | |
bool | m_InPlace |
typedef SmartPointer< const Self > itk::InPlaceLabelMapFilter< TInputImage >::ConstPointer |
Definition at line 90 of file itkInPlaceLabelMapFilter.h.
typedef InputImageType::IndexType itk::InPlaceLabelMapFilter< TInputImage >::IndexType |
Definition at line 113 of file itkInPlaceLabelMapFilter.h.
typedef InputImageType::ConstPointer itk::InPlaceLabelMapFilter< TInputImage >::InputImageConstPointer |
Definition at line 107 of file itkInPlaceLabelMapFilter.h.
typedef InputImageType::PixelType itk::InPlaceLabelMapFilter< TInputImage >::InputImagePixelType |
Definition at line 109 of file itkInPlaceLabelMapFilter.h.
typedef InputImageType::Pointer itk::InPlaceLabelMapFilter< TInputImage >::InputImagePointer |
Definition at line 106 of file itkInPlaceLabelMapFilter.h.
typedef InputImageType::RegionType itk::InPlaceLabelMapFilter< TInputImage >::InputImageRegionType |
Definition at line 108 of file itkInPlaceLabelMapFilter.h.
typedef TInputImage itk::InPlaceLabelMapFilter< TInputImage >::InputImageType |
Some convenient typedefs.
Definition at line 105 of file itkInPlaceLabelMapFilter.h.
typedef InputImageType::LabelObjectType itk::InPlaceLabelMapFilter< TInputImage >::LabelObjectType |
Definition at line 110 of file itkInPlaceLabelMapFilter.h.
typedef Superclass::OutputImagePixelType itk::InPlaceLabelMapFilter< TInputImage >::OutputImagePixelType |
Definition at line 102 of file itkInPlaceLabelMapFilter.h.
typedef Superclass::OutputImagePointer itk::InPlaceLabelMapFilter< TInputImage >::OutputImagePointer |
Definition at line 100 of file itkInPlaceLabelMapFilter.h.
typedef Superclass::OutputImageRegionType itk::InPlaceLabelMapFilter< TInputImage >::OutputImageRegionType |
Definition at line 101 of file itkInPlaceLabelMapFilter.h.
typedef Superclass::OutputImageType itk::InPlaceLabelMapFilter< TInputImage >::OutputImageType |
Superclass typedefs.
Definition at line 96 of file itkInPlaceLabelMapFilter.h.
typedef InputImageType::PixelType itk::InPlaceLabelMapFilter< TInputImage >::PixelType |
Definition at line 112 of file itkInPlaceLabelMapFilter.h.
typedef SmartPointer< Self > itk::InPlaceLabelMapFilter< TInputImage >::Pointer |
Definition at line 89 of file itkInPlaceLabelMapFilter.h.
typedef InputImageType::RegionType itk::InPlaceLabelMapFilter< TInputImage >::RegionType |
Definition at line 114 of file itkInPlaceLabelMapFilter.h.
typedef InPlaceLabelMapFilter itk::InPlaceLabelMapFilter< TInputImage >::Self |
Standard class typedefs.
Definition at line 87 of file itkInPlaceLabelMapFilter.h.
typedef LabelMapFilter< TInputImage, TInputImage > itk::InPlaceLabelMapFilter< TInputImage >::Superclass |
Definition at line 88 of file itkInPlaceLabelMapFilter.h.
typedef TInputImage itk::InPlaceLabelMapFilter< TInputImage >::TOutputImage |
Definition at line 116 of file itkInPlaceLabelMapFilter.h.
|
protected |
|
protected |
|
private |
|
protectedvirtual |
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 >.
|
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.
|
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 >.
|
virtual |
In place operation can be turned on and off. This only has an effect when the input and output image type match.
|
inlineprotectedvirtual |
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.
|
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::StatisticsOpeningLabelMapFilter< TImage >, itk::StatisticsRelabelLabelMapFilter< TImage >, itk::AttributeRelabelLabelMapFilter< TImage, Functor::LabelLabelObjectAccessor< TImage::LabelObjectType > >, itk::AttributeKeepNObjectsLabelMapFilter< TImage, TAttributeAccessor >, itk::RelabelLabelMapFilter< TImage >, itk::ShapeRelabelLabelMapFilter< TImage >, itk::ShapeUniqueLabelMapFilter< TImage >, itk::ShapeKeepNObjectsLabelMapFilter< TImage >, itk::StatisticsPositionLabelMapFilter< TImage >, itk::AggregateLabelMapFilter< TImage >, itk::ChangeLabelLabelMapFilter< 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 >.
|
virtual |
In place operation can be turned on and off. This only has an effect when the input and output image type match.
|
virtual |
In place operation can be turned on and off. This only has an effect when the input and output image type match.
|
static |
Standard New method.
|
private |
|
protectedvirtual |
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::StatisticsLabelMapFilter< TImage, TFeatureImage >, itk::ShapeLabelMapFilter< TImage, TLabelImage >, itk::ShapeLabelMapFilter< TImage, Image< TImage::PixelType, TImage::ImageDimension > >, 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::AttributeRelabelLabelMapFilter< TImage, TAttributeAccessor >, itk::AttributeRelabelLabelMapFilter< TImage, Functor::LabelLabelObjectAccessor< TImage::LabelObjectType > >, itk::ChangeLabelLabelMapFilter< TImage >, itk::ShiftScaleLabelMapFilter< TImage >, itk::AttributePositionLabelMapFilter< TImage, TAttributeAccessor, VPhysicalPosition >, and itk::AggregateLabelMapFilter< TImage >.
|
virtual |
In place operation can be turned on and off. This only has an effect when the input and output image type match.
|
static |
ImageDimension constants
Definition at line 119 of file itkInPlaceLabelMapFilter.h.
|
private |
Definition at line 178 of file itkInPlaceLabelMapFilter.h.
|
static |
ImageDimension constants
Definition at line 120 of file itkInPlaceLabelMapFilter.h.