itkKdTreeGenerator.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 itkKdTreeGenerator_h
#define itkKdTreeGenerator_h

#include <vector>

#include "itkKdTree.h"
#include "itkStatisticsAlgorithm.h"

namespace itk
{
namespace Statistics
{
template< typename TSample >
class ITK_TEMPLATE_EXPORT KdTreeGenerator:public Object
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(KdTreeGenerator);

  using Self = KdTreeGenerator;
  using Superclass = Object;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(KdTreeGenerator, Object);

  itkNewMacro(Self);

  using MeasurementVectorType = typename TSample::MeasurementVectorType;
  using MeasurementType = typename TSample::MeasurementType;

  using MeasurementVectorSizeType = unsigned int;

  using KdTreeType = KdTree< TSample >;

  using OutputType = KdTreeType;

  using OutputPointer = typename KdTreeType::Pointer;

  using KdTreeNodeType = typename KdTreeType::KdTreeNodeType;

  using SubsampleType = Subsample< TSample >;

  using SubsamplePointer = typename SubsampleType::Pointer;

  void SetSample(TSample *sample);

  void SetBucketSize(unsigned int size);

  OutputPointer GetOutput()
  {
    return m_Tree;
  }

  void Update()
  {
    this->GenerateData();
  }

  void GenerateData();

  itkGetConstMacro(MeasurementVectorSize, unsigned int);

protected:
  KdTreeGenerator();

  ~KdTreeGenerator() override = default;

  void PrintSelf(std::ostream & os, Indent indent) const override;

  SubsamplePointer GetSubsample()
  {
    return m_Subsample;
  }

  virtual KdTreeNodeType * GenerateNonterminalNode(unsigned int beginIndex,
                                                   unsigned int endIndex,
                                                   MeasurementVectorType
                                                   & lowerBound,
                                                   MeasurementVectorType
                                                   & upperBound,
                                                   unsigned int level);

  KdTreeNodeType * GenerateTreeLoop(unsigned int beginIndex, unsigned int endIndex,
                                    MeasurementVectorType & lowerBound,
                                    MeasurementVectorType & upperBound,
                                    unsigned int level);

private:
  TSample *m_SourceSample;

  SubsamplePointer m_Subsample;

  unsigned int m_BucketSize;

  OutputPointer m_Tree;

  MeasurementVectorType m_TempLowerBound;

  MeasurementVectorType m_TempUpperBound;

  MeasurementVectorType m_TempMean;

  MeasurementVectorSizeType m_MeasurementVectorSize;
};  // end of class
} // end of namespace Statistics
} // end of namespace itk

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

#endif