otbAttributesMapLabelObjectWithClassLabel.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * 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
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 otbAttributesMapLabelObjectWithClassLabel_h
#define otbAttributesMapLabelObjectWithClassLabel_h
 
#include "otbAttributesMapLabelObject.h"
 
namespace otb
{
 
template <class TLabel, unsigned int VImageDimension, class TAttributesValue, class TClassLabel>
class ITK_EXPORT AttributesMapLabelObjectWithClassLabel : public AttributesMapLabelObject<TLabel, VImageDimension, TAttributesValue>
{
public:
  typedef AttributesMapLabelObjectWithClassLabel Self;
  typedef AttributesMapLabelObject<TLabel, VImageDimension, TAttributesValue> Superclass;
  typedef itk::LabelObject<TLabel, VImageDimension> LabelObjectType;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
  typedef itk::WeakPointer<const Self>  ConstWeakPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(AttributesMapLabelObjectWithClassLabel, AttributesMapLabelObject);
 
  itkStaticConstMacro(ImageDimension, unsigned int, VImageDimension);
 
  typedef TClassLabel ClassLabelType;
 
  void SetClassLabel(const ClassLabelType& label)
  {
    m_ClassLabel    = label;
    m_HasClassLabel = true;
  }
 
  const ClassLabelType& GetClassLabel() const
  {
    if (!m_HasClassLabel)
    {
      itkExceptionMacro(<< "LabelObject has no class label!");
    }
    return m_ClassLabel;
  }
 
  bool HasClassLabel() const
  {
    return m_HasClassLabel;
  }
 
  void RemoveClassLabel()
  {
    m_ClassLabel    = itk::NumericTraits<ClassLabelType>::Zero;
    m_HasClassLabel = false;
  }
 
  void CopyAttributesFrom(const LabelObjectType* lo) override
  {
    Superclass::CopyAttributesFrom(lo);
 
    // copy the data of the current type if possible
    const Self* src = dynamic_cast<const Self*>(lo);
    if (src == nullptr)
    {
      return;
    }
 
    m_ClassLabel    = src->m_ClassLabel;
    m_HasClassLabel = src->m_HasClassLabel;
  }
 
protected:
  AttributesMapLabelObjectWithClassLabel() : m_ClassLabel(itk::NumericTraits<ClassLabelType>::Zero), m_HasClassLabel(false)
  {
  }
 
  ~AttributesMapLabelObjectWithClassLabel() override
  {
  }
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override
  {
    Superclass::PrintSelf(os, indent);
    if (m_HasClassLabel)
    {
      os << indent << "Class Label: " << m_ClassLabel << std::endl;
    }
    else
    {
      os << indent << "No class label available." << std::endl;
    }
  }
 
private:
  AttributesMapLabelObjectWithClassLabel(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  ClassLabelType m_ClassLabel;
 
  bool m_HasClassLabel;
};
 
} // end namespace otb
#endif