itkMergeLabelMapFilter.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 itkMergeLabelMapFilter_h
#define itkMergeLabelMapFilter_h
 
#include "itkInPlaceLabelMapFilter.h"
#include "ITKLabelMapExport.h"
 
namespace itk
{
// See https://docs.microsoft.com/en-us/cpp/error-messages/compiler-errors-1/compiler-error-c2059?view=vs-2019
#ifdef STRICT
#  define TEMPINPLACELABELMAPSTRICT STRICT
#  undef STRICT
#endif
 
class MergeLabelMapFilterEnums
{
public:
  enum class ChoiceMethod : uint8_t
  {
    KEEP = 0,
    AGGREGATE = 1,
    PACK = 2,
    STRICT = 3
  };
};
// Define how to print enumeration
extern ITKLabelMap_EXPORT std::ostream &
                          operator<<(std::ostream & out, const MergeLabelMapFilterEnums::ChoiceMethod value);
 
using ChoiceMethodEnum = MergeLabelMapFilterEnums::ChoiceMethod;
#if !defined(ITK_LEGACY_REMOVE)
 
using ChoiceMethod = ChoiceMethodEnum;
// We need to expose the enum values at the class level
// for backwards compatibility
static constexpr ChoiceMethodEnum KEEP = ChoiceMethodEnum::KEEP;
static constexpr ChoiceMethodEnum AGGREGATE = ChoiceMethodEnum::AGGREGATE;
static constexpr ChoiceMethodEnum PACK = ChoiceMethodEnum::PACK;
static constexpr ChoiceMethodEnum STRICT = ChoiceMethodEnum::STRICT;
#endif
 
#ifdef TEMPINPLACELABELMAPSTRICT
#  define STRICT TEMPINPLACELABELMAPSTRICT
#  undef TEMPINPLACELABELMAPSTRICT
#endif
 
template <typename TImage>
class ITK_TEMPLATE_EXPORT MergeLabelMapFilter : public InPlaceLabelMapFilter<TImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MergeLabelMapFilter);
 
  using Self = MergeLabelMapFilter;
  using Superclass = InPlaceLabelMapFilter<TImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using ImageType = TImage;
  using ImagePointer = typename ImageType::Pointer;
  using ImageConstPointer = typename ImageType::ConstPointer;
  using PixelType = typename ImageType::PixelType;
  using IndexType = typename ImageType::IndexType;
  using LabelObjectType = typename ImageType::LabelObjectType;
  using LabelObjectPointer = typename LabelObjectType::Pointer;
 
  static constexpr unsigned int ImageDimension = TImage::ImageDimension;
 
  itkNewMacro(Self);
 
  itkOverrideGetNameOfClassMacro(MergeLabelMapFilter);
 
#if !defined(ITK_LEGACY_REMOVE)
 
  using MethodChoice = ChoiceMethodEnum;
#endif
 
#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
/*  itkConceptMacro(InputEqualityComparableCheck,
    (Concept::EqualityComparable<InputImagePixelType>));
  itkConceptMacro(IntConvertibleToInputCheck,
    (Concept::Convertible<int, InputImagePixelType>));
  itkConceptMacro(InputOStreamWritableCheck,
    (Concept::OStreamWritable<InputImagePixelType>));*/
// End concept checking
#endif
 
#ifdef STRICT
#  undef STRICT
#endif
 
  itkSetMacro(Method, ChoiceMethodEnum);
  itkGetConstReferenceMacro(Method, ChoiceMethodEnum);
protected:
  MergeLabelMapFilter();
  ~MergeLabelMapFilter() override = default;
 
  void
  GenerateData() override;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  ChoiceMethodEnum m_Method{};
 
private:
  void
  MergeWithKeep();
 
  void
  MergeWithAggregate();
 
  void
  MergeWithPack();
 
  void
  MergeWithStrict();
}; // end of class
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMergeLabelMapFilter.hxx"
#endif
 
#endif