vtkRandomHyperTreeGridSource.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkRandomHyperTreeGridSource_h
#define vtkRandomHyperTreeGridSource_h
 
#include "vtkFiltersSourcesModule.h" // For export macro
#include "vtkHyperTreeGridAlgorithm.h"
 
#include <vector>
#include <vtkNew.h> // For vtkNew
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDoubleArray;
class vtkExtentTranslator;
class vtkHyperTreeGridNonOrientedCursor;
class vtkMinimalStandardRandomSequence;
 
class VTKFILTERSSOURCES_EXPORT vtkRandomHyperTreeGridSource : public vtkHyperTreeGridAlgorithm
{
public:
  static vtkRandomHyperTreeGridSource* New();
  vtkTypeMacro(vtkRandomHyperTreeGridSource, vtkHyperTreeGridAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  vtkGetVector3Macro(Dimensions, unsigned int);
  vtkSetVector3Macro(Dimensions, unsigned int);
  vtkGetVector6Macro(OutputBounds, double);
  vtkSetVector6Macro(OutputBounds, double);
 
  vtkGetMacro(Seed, vtkTypeUInt32);
  vtkSetMacro(Seed, vtkTypeUInt32);
  vtkGetMacro(MaxDepth, vtkIdType);
  vtkSetClampMacro(MaxDepth, vtkIdType, 1, VTK_ID_MAX);
  vtkGetMacro(SplitFraction, double);
  vtkSetClampMacro(SplitFraction, double, 0., 1.);
  vtkGetMacro(MaskedFraction, double);
  vtkSetClampMacro(MaskedFraction, double, 0., 1.);
  vtkGetMacro(ActualMaskedCellFraction, double);
protected:
  vtkRandomHyperTreeGridSource();
  ~vtkRandomHyperTreeGridSource() override;
 
  int RequestInformation(
    vtkInformation* req, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
 
  int RequestData(
    vtkInformation* req, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
 
  // We just do the work in RequestData.
  int ProcessTrees(vtkHyperTreeGrid*, vtkDataObject*) final { return 1; }
 
  int FillOutputPortInformation(int port, vtkInformation* info) override;
 
  void SubdivideLeaves(vtkHyperTreeGridNonOrientedCursor* cursor, vtkIdType treeId);
 
  bool ShouldRefine(vtkIdType level);
 
  unsigned int Dimensions[3];
  double OutputBounds[6];
  vtkTypeUInt32 Seed;
  vtkIdType MaxDepth;
  double SplitFraction;
 
private:
  vtkRandomHyperTreeGridSource(const vtkRandomHyperTreeGridSource&) = delete;
  void operator=(const vtkRandomHyperTreeGridSource&) = delete;
 
  vtkNew<vtkMinimalStandardRandomSequence> NodeRNG;
  // We have 2 different RNG for retrocompatibility, since the mask
  // has been added later on.
  vtkNew<vtkMinimalStandardRandomSequence> MaskRNG;
  vtkNew<vtkExtentTranslator> ExtentTranslator;
  vtkDoubleArray* Levels;
  double MaskedFraction = 0;
  double ActualMaskedCellFraction = 0;
  std::vector<double> MaskingCostPerLevel{ 1.0 };
 
  bool ShouldMask(double siblingsMasked = 0.0, int level = 0, double errorMargin = 0.0);
 
  double GenerateMask(vtkHyperTreeGridNonOrientedCursor* cursor, vtkIdType treeId,
    double unmaskedFraction = 1.0, bool isParentMasked = false, double siblingsMasked = 0.0);
 
  void InitializeMaskingNodeCostPerLevel();
 
  double GetMaskingNodeCost(int level);
 
  void ShuffleArray(std::vector<int>& array, int size, vtkMinimalStandardRandomSequence* rng);
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkRandomHyperTreeGridSource_h