#include <itkLabelMapOverlayImageFilter.h>
Apply a colormap to a label map and superimpose it on an image.
Apply a colormap to a label map and put it on top of the feature image. The feature image is typically the image from which the labeling was produced. Use the SetInput function to set the LabelMap, and the SetFeatureImage function to set the feature image.
The set of colors is a good selection of distinct colors. The opacity of the label map can be defined by the user. A background label produce a gray pixel with the same intensity than the input one.
This implementation was taken from the Insight Journal paper: https://doi.org/10.54294/q6auw4
Definition at line 59 of file itkLabelMapOverlayImageFilter.h.
Public Types | |
using | ConstPointer = SmartPointer<const Self> |
using | FeatureImageConstPointer = typename FeatureImageType::ConstPointer |
using | FeatureImagePixelType = typename FeatureImageType::PixelType |
using | FeatureImagePointer = typename FeatureImageType::Pointer |
using | FeatureImageRegionType = typename FeatureImageType::RegionType |
using | FeatureImageType = TFeatureImage |
using | FunctorType |
using | IndexType = typename OutputImageType::IndexType |
using | LabelMapConstPointer = typename LabelMapType::ConstPointer |
using | LabelMapPixelType = typename LabelMapType::PixelType |
using | LabelMapPointer = typename LabelMapType::Pointer |
using | LabelMapRegionType = typename LabelMapType::RegionType |
using | LabelMapType = TLabelMap |
using | LabelObjectType = typename LabelMapType::LabelObjectType |
using | LabelType = typename LabelObjectType::LabelType |
using | LengthType = typename LabelObjectType::LengthType |
using | OutputImageConstPointer = typename OutputImageType::ConstPointer |
using | OutputImagePixelType = typename OutputImageType::PixelType |
using | OutputImagePointer = typename OutputImageType::Pointer |
using | OutputImageRegionType = typename OutputImageType::RegionType |
using | OutputImageType = TOutputImage |
using | Pointer = SmartPointer<Self> |
using | RegionType = typename OutputImageType::RegionType |
using | Self = LabelMapOverlayImageFilter |
using | SizeType = typename OutputImageType::SizeType |
using | Superclass = LabelMapFilter<TLabelMap, TOutputImage> |
![]() | |
using | ConstPointer = SmartPointer<const Self> |
using | InputImageConstPointer |
using | InputImagePixelType |
using | InputImagePointer |
using | InputImageRegionType |
using | InputImageType |
using | LabelObjectType = typename InputImageType::LabelObjectType |
using | OutputImageConstPointer = typename OutputImageType::ConstPointer |
using | OutputImagePixelType = typename OutputImageType::PixelType |
using | OutputImagePointer = typename OutputImageType::Pointer |
using | OutputImageRegionType = typename OutputImageType::RegionType |
using | OutputImageType = TOutputImage |
using | Pointer = SmartPointer<Self> |
using | Self = LabelMapFilter |
using | Superclass = ImageToImageFilter<TInputImage, TOutputImage> |
![]() | |
using | ConstPointer = SmartPointer<const Self> |
using | InputImageConstPointer = typename InputImageType::ConstPointer |
using | InputImagePixelType = typename InputImageType::PixelType |
using | InputImagePointer = typename InputImageType::Pointer |
using | InputImageRegionType = typename InputImageType::RegionType |
using | InputImageType = TInputImage |
using | OutputImagePixelType |
using | OutputImageRegionType |
using | Pointer = SmartPointer<Self> |
using | Self = ImageToImageFilter |
using | Superclass = 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 |
![]() | |
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 |
![]() | |
using | ConstPointer = SmartPointer<const Self> |
using | Pointer = SmartPointer<Self> |
using | Self = Object |
using | Superclass = LightObject |
![]() | |
using | ConstPointer = SmartPointer<const Self> |
using | Pointer = SmartPointer<Self> |
using | Self = LightObject |
Static Public Member Functions | |
static Pointer | New () |
![]() | |
static Pointer | New () |
![]() | |
static double | GetGlobalDefaultCoordinateTolerance () |
static double | GetGlobalDefaultDirectionTolerance () |
static void | SetGlobalDefaultCoordinateTolerance (double) |
static void | SetGlobalDefaultDirectionTolerance (double) |
![]() | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool val) |
![]() | |
static void | BreakOnError () |
static Pointer | New () |
Static Public Attributes | |
static constexpr unsigned int | ImageDimension = TOutputImage::ImageDimension |
static constexpr unsigned int | InputImageDimension = TLabelMap::ImageDimension |
static constexpr unsigned int | OutputImageDimension = TOutputImage::ImageDimension |
![]() | |
static constexpr unsigned int | InputImageDimension = TInputImage::ImageDimension |
static constexpr unsigned int | OutputImageDimension = TOutputImage::ImageDimension |
![]() | |
static constexpr unsigned int | InputImageDimension = TInputImage::ImageDimension |
static constexpr unsigned int | OutputImageDimension = TOutputImage::ImageDimension |
![]() | |
static constexpr unsigned int | OutputImageDimension = TOutputImage::ImageDimension |
Private Attributes | |
FunctorType | m_Functor {} |
double | m_Opacity {} |
Additional Inherited Members | |
![]() | |
using | InputToOutputRegionCopierType |
using | OutputToInputRegionCopierType |
![]() | |
static const ImageRegionSplitterBase * | GetGlobalDefaultSplitter () |
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION | ThreaderCallback (void *arg) |
![]() | |
template<typename TSourceObject> | |
static void | MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs) |
static constexpr float | progressFixedToFloat (uint32_t fixed) |
static uint32_t | progressFloatToFixed (float f) |
![]() | |
std::mutex | m_LabelObjectContainerLock {} |
![]() | |
bool | m_DynamicMultiThreading { true } |
![]() | |
TimeStamp | m_OutputInformationMTime {} |
bool | m_Updating {} |
![]() | |
std::atomic< int > | m_ReferenceCount {} |
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::ConstPointer = SmartPointer<const Self> |
Definition at line 68 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::FeatureImageConstPointer = typename FeatureImageType::ConstPointer |
Definition at line 82 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::FeatureImagePixelType = typename FeatureImageType::PixelType |
Definition at line 84 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::FeatureImagePointer = typename FeatureImageType::Pointer |
Definition at line 81 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::FeatureImageRegionType = typename FeatureImageType::RegionType |
Definition at line 83 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::FeatureImageType = TFeatureImage |
Definition at line 80 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::FunctorType |
Definition at line 95 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::IndexType = typename OutputImageType::IndexType |
Definition at line 91 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::LabelMapConstPointer = typename LabelMapType::ConstPointer |
Definition at line 73 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::LabelMapPixelType = typename LabelMapType::PixelType |
Definition at line 75 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::LabelMapPointer = typename LabelMapType::Pointer |
Definition at line 72 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::LabelMapRegionType = typename LabelMapType::RegionType |
Definition at line 74 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::LabelMapType = TLabelMap |
Some convenient type alias.
Definition at line 71 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::LabelObjectType = typename LabelMapType::LabelObjectType |
Definition at line 76 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::LabelType = typename LabelObjectType::LabelType |
Definition at line 77 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::LengthType = typename LabelObjectType::LengthType |
Definition at line 78 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::OutputImageConstPointer = typename OutputImageType::ConstPointer |
Definition at line 88 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::OutputImagePixelType = typename OutputImageType::PixelType |
Definition at line 90 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer |
Definition at line 87 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType |
Definition at line 89 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::OutputImageType = TOutputImage |
Definition at line 86 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::Pointer = SmartPointer<Self> |
Definition at line 67 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::RegionType = typename OutputImageType::RegionType |
Definition at line 93 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::Self = LabelMapOverlayImageFilter |
Standard class type aliases.
Definition at line 65 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::SizeType = typename OutputImageType::SizeType |
Definition at line 92 of file itkLabelMapOverlayImageFilter.h.
using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::Superclass = LabelMapFilter<TLabelMap, TOutputImage> |
Definition at line 66 of file itkLabelMapOverlayImageFilter.h.
|
protected |
Referenced by GetNameOfClass().
|
overrideprotecteddefault |
|
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::LabelMapFilter< TInputImage, TOutputImage >.
|
overrideprotectedvirtual |
If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData() or DynamicThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call (Dynamic)ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of (Dynamic)ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a (Dynamic)ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The (Dynamic)ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. (Dynamic)ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).
DynamicThreadedGenerateData() is the newer variant without threadId, and is the preferred signature, which is called by default. This variant can split the requested region into different number of pieces depending on current multi-processing load, which allows better load balancing. The non-dynamic (also known as classic) ThreadedGenerateData() signature has threadId, and number of pieces to be split into is known in advance. It is activated by calling this->DynamicMultiThreadingOff(); in derived class constructor. It should be used when the multi-threaded algorithm needs to pre-allocate some data structure with size dependent on the number of pieces (also known as chunks, work units, and sometimes also incorrectly as threads). Only PlatformMultiThreader guarantees that each piece will be processed in its own specific thread. Pool and TBB multi-threaders maintain a pool of threads (normally equal to number of processing cores) which they use to process the pieces. This normally results in a single thread being reused to process multiple work units.
Reimplemented from itk::LabelMapFilter< TInputImage, TOutputImage >.
|
overrideprotectedvirtual |
LabelMapOverlayImageFilter will produce the entire output.
Reimplemented from itk::LabelMapFilter< TInputImage, TOutputImage >.
|
overrideprotectedvirtual |
A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling DynamicThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter can be threaded, it should NOT provide a GenerateData() method but should provide a DynamicThreadedGenerateData() instead.
Reimplemented from itk::ImageSource< TOutputImage >.
|
overrideprotectedvirtual |
LabelMapOverlayImageFilter needs the entire input be available. Thus, it needs to provide an implementation of GenerateInputRequestedRegion().
Reimplemented from itk::LabelMapFilter< TInputImage, TOutputImage >.
|
overrideprotectedvirtual |
Generate the information describing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.
Reimplemented from itk::ProcessObject.
|
inline |
Get the feature image
Definition at line 119 of file itkLabelMapOverlayImageFilter.h.
References itk::ProcessObject::GetInput().
|
inline |
Set/Get the overlay functor - defaults to a reasonable set of colors. This can be used to apply a different colormap.
Definition at line 158 of file itkLabelMapOverlayImageFilter.h.
References m_Functor.
|
inline |
Set/Get the overlay functor - defaults to a reasonable set of colors. This can be used to apply a different colormap.
Definition at line 163 of file itkLabelMapOverlayImageFilter.h.
References m_Functor.
|
overridevirtual |
Reimplemented from itk::LabelMapFilter< TInputImage, TOutputImage >.
References LabelMapOverlayImageFilter().
|
virtual |
Set/Get the opacity of the colored label image. The value must be between 0 and 1
|
static |
Standard New method.
|
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 >.
|
inline |
Set the feature image
Definition at line 111 of file itkLabelMapOverlayImageFilter.h.
References itk::ProcessObject::SetNthInput().
Referenced by SetInput2().
|
inlinevirtual |
Set/Get the overlay functor - defaults to a reasonable set of colors. This can be used to apply a different colormap.
Definition at line 149 of file itkLabelMapOverlayImageFilter.h.
References m_Functor, and itk::Object::Modified().
|
inline |
Set the input image
Definition at line 126 of file itkLabelMapOverlayImageFilter.h.
References itk::ImageToImageFilter< TInputImage, TOutputImage >::SetInput().
|
inline |
Set the feature image
Definition at line 133 of file itkLabelMapOverlayImageFilter.h.
References SetFeatureImage().
|
virtual |
Set/Get the opacity of the colored label image. The value must be between 0 and 1
|
inlineprotected |
Definition at line 191 of file itkLabelMapOverlayImageFilter.h.
References itk::LabelMapFilter< TLabelMap, TOutputImage >::DynamicThreadedGenerateData().
|
overrideprotected |
|
staticconstexpr |
Definition at line 101 of file itkLabelMapOverlayImageFilter.h.
|
staticconstexpr |
ImageDimension constants
Definition at line 99 of file itkLabelMapOverlayImageFilter.h.
|
private |
Definition at line 207 of file itkLabelMapOverlayImageFilter.h.
Referenced by GetFunctor(), GetFunctor(), and SetFunctor().
|
private |
Definition at line 206 of file itkLabelMapOverlayImageFilter.h.
|
staticconstexpr |
Definition at line 100 of file itkLabelMapOverlayImageFilter.h.