itkOctree.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 itkOctree_h
#define itkOctree_h
 
#include "itkOctreeNode.h"
#include "itkImage.h"
#include "itkCommonEnums.h"
 
namespace itk
{
enum
{
  B2_MASKFILE_BLACK = 0,
  B2_MASKFILE_WHITE = 1,
  B2_MASKFILE_GRAY = 2
};

class ITKCommon_EXPORT OctreeBase : public Object
{
public:
  using Self = OctreeBase;
  using Pointer = SmartPointer<Self>;
 
  using OctreeEnum = OctreeEnums::Octree;
 
#if !defined(ITK_LEGACY_REMOVE)
  // We need to expose the enum values at the class level
  // for backwards compatibility
  static constexpr OctreeEnum                                              UNKNOWN_PLANE = OctreeEnum::UNKNOWN_PLANE;
  static constexpr OctreeEnum                                              SAGITTAL_PLANE = OctreeEnum::SAGITTAL_PLANE;
  [[deprecated("Use SAGITTAL_PLANE instead")]] static constexpr OctreeEnum SAGITAL_PLANE = OctreeEnum::SAGITTAL_PLANE;
  static constexpr OctreeEnum                                              CORONAL_PLANE = OctreeEnum::CORONAL_PLANE;
  static constexpr OctreeEnum TRANSVERSE_PLANE = OctreeEnum::TRANSVERSE_PLANE;
#endif

  virtual OctreeNode *
  GetTree() = 0;

  virtual unsigned int
  GetDepth() = 0;

  virtual unsigned int
  GetWidth() = 0;

  virtual void
  SetDepth(unsigned int depth) = 0;

  virtual void
  SetWidth(unsigned int width) = 0;

  virtual void
  BuildFromBuffer(const void *       buffer,
                  const unsigned int xsize,
                  const unsigned int ysize,
                  const unsigned int zsize) = 0;

  virtual const OctreeNodeBranch *
  GetColorTable() const = 0;

  virtual int
  GetColorTableSize() const = 0;
};

template <typename TPixel, unsigned int ColorTableSize, typename MappingFunctionType>
class ITK_TEMPLATE_EXPORT Octree : public OctreeBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(Octree);

  using Self = Octree;
  using Superclass = OctreeBase;
  using Pointer = SmartPointer<Self>;
  using ImageType = Image<TPixel, 3>;
  using ImageTypePointer = typename ImageType::Pointer;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(Octree);
 
  ImageTypePointer
  GetImage();
 
  void
  BuildFromBuffer(const void *       frombuffer,
                  const unsigned int xsize,
                  const unsigned int ysize,
                  const unsigned int zsize) override;
 
  void
  BuildFromImage(Image<TPixel, 3> * fromImage);
 
  Octree();
  ~Octree() override;
  void
  SetColor(unsigned int color)
  {
    m_Tree.SetColor(color);
  }
  void
  SetTree(OctreeNodeBranch * branch)
  {
    m_Tree.SetBranch(branch);
  }
  void
  SetTrueDims(const unsigned int Dim0, const unsigned int Dim1, const unsigned int Dim2);
 
  int
  GetValue(const unsigned int Dim0, const unsigned int Dim1, const unsigned int Dim2);
 
  void
  SetWidth(unsigned int width) override;
 
  void
  SetDepth(unsigned int depth) override;
 
  unsigned int
  GetWidth() override;
 
  unsigned int
  GetDepth() override;
 
#if !defined(ITK_LEGACY_REMOVE)
  /***
   * Exposes enum values for backwards compatibility
   * */
  static constexpr OctreeEnum                                              UNKNOWN_PLANE = OctreeEnum::UNKNOWN_PLANE;
  static constexpr OctreeEnum                                              SAGITTAL_PLANE = OctreeEnum::SAGITTAL_PLANE;
  [[deprecated("Use SAGITTAL_PLANE instead")]] static constexpr OctreeEnum SAGITAL_PLANE = OctreeEnum::SAGITTAL_PLANE;
  static constexpr OctreeEnum                                              CORONAL_PLANE = OctreeEnum::CORONAL_PLANE;
  static constexpr OctreeEnum TRANSVERSE_PLANE = OctreeEnum::TRANSVERSE_PLANE;
#endif
 
  OctreeNode *
  GetTree() override;
 
  const OctreeNodeBranch *
  GetColorTable() const override;
 
  int
  GetColorTableSize() const override;
 
private:
  OctreeNodeBranch *
  maskToOctree(const TPixel * Mask,
               unsigned int   width,
               unsigned int   x,
               unsigned int   y,
               unsigned int   z,
               unsigned int   xsize,
               unsigned int   ysize,
               unsigned int   zsize);
 
  OctreeEnum m_Plane{ OctreeEnum::UNKNOWN_PLANE }; // The orientation of the plane for this octree
 
  // The width of the Octree. This is always a power of 2,
  // and large enough to contain MAX(DIMS[1,2,3])
  unsigned int m_Width{ 0 };
 
  unsigned int        m_Depth{ 0 };    // The depth of the Octree
  unsigned int        m_TrueDims[3]{}; // The true dimensions of the image
  OctreeNodeBranch    m_ColorTable[ColorTableSize];
  OctreeNode          m_Tree{};
  MappingFunctionType m_MappingFunction{};
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkOctree.hxx"
#endif
 
#endif // itkOctree_h