itkOctree.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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.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"

namespace itk
{
enum {
  B2_MASKFILE_BLACK = 0,
  B2_MASKFILE_WHITE = 1,
  B2_MASKFILE_GRAY = 2
  };

enum OctreePlaneType {
  UNKNOWN_PLANE,   
  SAGITAL_PLANE,   
  CORONAL_PLANE,   
  TRANSVERSE_PLANE 
  };

class ITKCommon_EXPORT OctreeBase:public Object
{
public:

  using Self = OctreeBase;
  using Pointer = SmartPointer< Self >;

  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_ASSIGN(Octree);

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

  itkNewMacro(Self);

  itkTypeMacro(Octree, Superclass);

  ImageTypePointer GetImage();

  void BuildFromBuffer(const void *buffer, 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;

  OctreeNode * GetTree() override;

  const OctreeNodeBranch * GetColorTable() const override;

  int GetColorTableSize() const override;

private:
  OctreeNodeBranch * maskToOctree(const TPixel *Mask, unsigned width, unsigned x,
                                  unsigned y, unsigned z, unsigned xsize,
                                  unsigned ysize, unsigned zsize);

  OctreePlaneType m_Plane{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;
};
}

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkOctree.hxx"
#endif

#endif // itkOctree_h