itkRelabelComponentImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkRelabelComponentImageFilter_h
#define itkRelabelComponentImageFilter_h
 
#include "itkInPlaceImageFilter.h"
#include "itkImage.h"
#include <vector>
#include <mutex>
 
namespace itk
{
 
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT RelabelComponentImageFilter : public InPlaceImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(RelabelComponentImageFilter);

  using Self = RelabelComponentImageFilter;
  using Superclass = InPlaceImageFilter<TInputImage, TOutputImage>;

  using typename Superclass::InputImagePointer;

  using OutputPixelType = typename TOutputImage::PixelType;
  using OutputInternalPixelType = typename TOutputImage::InternalPixelType;
  using InputPixelType = typename TInputImage::PixelType;
  using InputInternalPixelType = typename TInputImage::InternalPixelType;
  static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension;
  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;
  using IndexType = typename TInputImage::IndexType;
  using SizeType = typename TInputImage::SizeType;
  using RegionType = typename TOutputImage::RegionType;

  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(RelabelComponentImageFilter);

  itkNewMacro(Self);

  using LabelType = InputPixelType;

  using ObjectSizeType = SizeValueType;

  itkGetConstMacro(NumberOfObjects, SizeValueType);
 
  using ObjectSizeInPixelsContainerType = std::vector<ObjectSizeType>;
  using ObjectSizeInPhysicalUnitsContainerType = std::vector<float>;

  itkGetConstMacro(OriginalNumberOfObjects, SizeValueType);

  itkSetMacro(NumberOfObjectsToPrint, SizeValueType);
  itkGetConstReferenceMacro(NumberOfObjectsToPrint, SizeValueType);

  itkSetMacro(MinimumObjectSize, ObjectSizeType);

  itkGetConstMacro(MinimumObjectSize, ObjectSizeType);

  itkSetMacro(SortByObjectSize, bool);
  itkGetConstMacro(SortByObjectSize, bool);
  itkBooleanMacro(SortByObjectSize);

  const ObjectSizeInPixelsContainerType &
  GetSizeOfObjectsInPixels() const
  {
    // The GetConstReferenceMacro can't be used here because this container
    // doesn't have an ostream<< operator overloaded.
    return this->m_SizeOfObjectsInPixels;
  }

  const ObjectSizeInPhysicalUnitsContainerType &
  GetSizeOfObjectsInPhysicalUnits() const
  {
    // The GetConstReferenceMacro can't be used here because this container
    // doesn't have an ostream<< operator overloaded.
    return this->m_SizeOfObjectsInPhysicalUnits;
  }

  ObjectSizeType
  GetSizeOfObjectInPixels(LabelType obj) const
  {
    if (obj > 0 && static_cast<SizeValueType>(obj) <= m_NumberOfObjects)
    {
      return m_SizeOfObjectsInPixels[obj - 1];
    }
 
    return 0;
  }

  float
  GetSizeOfObjectInPhysicalUnits(LabelType obj) const
  {
    if (obj > 0 && static_cast<SizeValueType>(obj) <= m_NumberOfObjects)
    {
      return m_SizeOfObjectsInPhysicalUnits[obj - 1];
    }
 
    return 0;
  }
 
  itkConceptMacro(InputEqualityComparableCheck, (Concept::EqualityComparable<InputPixelType>));
  itkConceptMacro(UnsignedLongConvertibleToInputCheck, (Concept::Convertible<LabelType, InputPixelType>));
  itkConceptMacro(OutputLongConvertibleToUnsignedLongCheck, (Concept::Convertible<OutputPixelType, LabelType>));
  itkConceptMacro(InputConvertibleToOutputCheck, (Concept::Convertible<InputPixelType, OutputPixelType>));
  itkConceptMacro(SameDimensionCheck, (Concept::SameDimension<InputImageDimension, ImageDimension>));
 
protected:
  RelabelComponentImageFilter();
  ~RelabelComponentImageFilter() override = default;

  void
  GenerateData() override;
 
  void
  ParallelComputeLabels(const RegionType & inputRegionForThread);

  void
  GenerateInputRequestedRegion() override;

  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  struct RelabelComponentObjectType
  {
    ObjectSizeType m_SizeInPixels;
 
    RelabelComponentObjectType &
    operator+=(const RelabelComponentObjectType & other)
    {
      this->m_SizeInPixels += other.m_SizeInPixels;
      return *this;
    }
  };
 
private:
  SizeValueType  m_NumberOfObjects{ 0 };
  SizeValueType  m_NumberOfObjectsToPrint{ 10 };
  SizeValueType  m_OriginalNumberOfObjects{ 0 };
  ObjectSizeType m_MinimumObjectSize{ 0 };
  bool           m_SortByObjectSize{ true };
 
  std::mutex m_Mutex{};
 
  using MapType = std::map<LabelType, RelabelComponentObjectType>;
  MapType m_SizeMap{};
 
  ObjectSizeInPixelsContainerType        m_SizeOfObjectsInPixels{};
  ObjectSizeInPhysicalUnitsContainerType m_SizeOfObjectsInPhysicalUnits{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkRelabelComponentImageFilter.hxx"
#endif
 
#endif