itkWatershedBoundary.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 itkWatershedBoundary_h
#define itkWatershedBoundary_h
 
 
#include <list>
#include <vector>
#include "itkImage.h"
#include "itkProcessObject.h"
#include <unordered_map>
 
namespace itk
{
namespace watershed
{
template <typename TScalar, unsigned int TDimension>
class ITK_TEMPLATE_EXPORT Boundary : public DataObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(Boundary);

  static constexpr unsigned int Dimension = TDimension;

  using IndexType = std::pair<unsigned int, unsigned int>;
  using ImageType = Image<IdentifierType, TDimension>;
  using ImageIndexType = typename ImageType::IndexType;
  using ScalarType = TScalar;

  struct face_pixel_t
  {

    short flow;

    IdentifierType label;
  };

  struct flat_region_t
  {

    std::list<IdentifierType> offset_list;

    ScalarType bounds_min;

    IdentifierType min_label;

    ScalarType value;
  };

  using face_t = Image<face_pixel_t, TDimension>;

  using flat_hash_t = std::unordered_map<IdentifierType, flat_region_t>;
  using FlatHashValueType = typename flat_hash_t::value_type;

  using Self = Boundary;
  using Superclass = DataObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  itkNewMacro(Self);
  itkOverrideGetNameOfClassMacro(Boundary);
  using FacePointer = typename face_t::Pointer;

  FacePointer
  GetFace(const IndexType & idx)
  {
    return this->GetFace(idx.first, idx.second);
  }

  FacePointer
  GetFace(unsigned int dimension, unsigned int highlow)
  {
    if (highlow == 0)
    {
      return m_Faces[dimension].first;
    }
 
    return m_Faces[dimension].second;
  }
 
  void
  SetFace(FacePointer f, const IndexType & idx)
  {
    this->SetFace(f, idx.first, idx.second);
  }
 
  void
  SetFace(FacePointer f, unsigned int dimension, unsigned int highlow)
  {
    if (highlow == 0)
    {
      m_Faces[dimension].first = f;
    }
    else
    {
      m_Faces[dimension].second = f;
    }
    this->Modified();
  }

  flat_hash_t *
  GetFlatHash(const IndexType & idx)
  {
    return this->GetFlatHash(idx.first, idx.second);
  }
  flat_hash_t *
  GetFlatHash(unsigned int dimension, unsigned int highlow)
  {
    if (highlow == 0)
    {
      return &(m_FlatHashes[dimension].first);
    }
 
    return &(m_FlatHashes[dimension].second);
  }
 
  void
  SetFlatHash(flat_hash_t & l, const IndexType & idx)
  {
    this->SetFlatHash(l, idx.first, idx.second);
  }
  void
  SetFlatHash(flat_hash_t & l, unsigned int dimension, unsigned int highlow)
  {
    if (highlow == 0)
    {
      m_FlatHashes[dimension].first = l;
    }
    else
    {
      m_FlatHashes[dimension].second = l;
    }
    this->Modified();
  }


  void
  SetValid(bool & l, const IndexType & idx)
  {
    this->SetValid(l, idx.first, idx.second);
  }
  void
  SetValid(bool b, unsigned int dimension, unsigned int highlow)
  {
    if (highlow == 0)
    {
      m_Valid[dimension].first = b;
    }
    else
    {
      m_Valid[dimension].second = b;
    }
    this->Modified();
  }
 
  bool
  GetValid(const IndexType & idx) const
  {
    return this->GetValid(idx.first, idx.second);
  }
  bool
  GetValid(unsigned int dimension, unsigned int highlow) const
  {
    if (highlow == 0)
    {
      return m_Valid[dimension].first;
    }
 
    return m_Valid[dimension].second;
  }

 
protected:
  Boundary();
  ~Boundary() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  std::vector<std::pair<FacePointer, FacePointer>> m_Faces{};

  std::vector<std::pair<flat_hash_t, flat_hash_t>> m_FlatHashes{};

  std::vector<std::pair<bool, bool>> m_Valid{};
};
} // end namespace watershed
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkWatershedBoundary.hxx"
#endif
 
#endif