vtkHierarchicalBinningFilter.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkHierarchicalBinningFilter.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See LICENSE file for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkHierarchicalBinningFilter_h
#define vtkHierarchicalBinningFilter_h

#include "vtkFiltersPointsModule.h" // For export macro
#include "vtkPolyDataAlgorithm.h"

#define VTK_MAX_LEVEL 12

struct vtkBinTree;

class VTKFILTERSPOINTS_EXPORT vtkHierarchicalBinningFilter : public vtkPolyDataAlgorithm
{
public:

  static vtkHierarchicalBinningFilter *New();
  vtkTypeMacro(vtkHierarchicalBinningFilter,vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetClampMacro(NumberOfLevels,int,1,VTK_MAX_LEVEL);
  vtkGetMacro(NumberOfLevels,int);


  vtkSetMacro(Automatic,bool);
  vtkGetMacro(Automatic,bool);
  vtkBooleanMacro(Automatic,bool);


  vtkSetVector3Macro(Divisions,int);
  vtkGetVectorMacro(Divisions,int,3);


  vtkSetVector6Macro(Bounds,double);
  vtkGetVectorMacro(Bounds,double,6);

  int GetNumberOfGlobalBins();

  int GetNumberOfBins(int level);

  vtkIdType GetLevelOffset(int level, vtkIdType& npts);

  vtkIdType GetBinOffset(int globalBin, vtkIdType& npts);

  vtkIdType GetLocalBinOffset(int level, int localBin, vtkIdType& npts);

  void GetBinBounds(int globalBin, double bounds[6]);

  void GetLocalBinBounds(int level, int localBin, double bounds[6]);

protected:
  vtkHierarchicalBinningFilter();
  ~vtkHierarchicalBinningFilter() override;

  // IVars
  int NumberOfLevels;
  bool Automatic;
  int Divisions[3];
  double Bounds[6];

  // Handle to the underlying implementation. The representation is maintained so
  // that the convenience functions can be invoked on the bin tree.
  vtkBinTree *Tree;

  int RequestData(vtkInformation *, vtkInformationVector **,
    vtkInformationVector *) override;
  int FillInputPortInformation(int port, vtkInformation *info) override;

private:
  vtkHierarchicalBinningFilter(const vtkHierarchicalBinningFilter&) = delete;
  void operator=(const vtkHierarchicalBinningFilter&) = delete;

};

#endif