vtkHyperTreeGridThreshold.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 vtkHyperTreeGridThreshold_h
#define vtkHyperTreeGridThreshold_h
 
#include "vtkDeprecation.h"            // For deprecation macros
#include "vtkFiltersHyperTreeModule.h" // For export macro
#include "vtkHyperTreeGridAlgorithm.h"
 
#include <memory> // For std::unique_ptr
#include <mutex>
 
VTK_ABI_NAMESPACE_BEGIN
class vtkBitArray;
class vtkHyperTreeGrid;
 
class vtkHyperTreeGridNonOrientedCursor;
 
class VTKFILTERSHYPERTREE_EXPORT vtkHyperTreeGridThreshold : public vtkHyperTreeGridAlgorithm
{
public:
  static vtkHyperTreeGridThreshold* New();
  vtkTypeMacro(vtkHyperTreeGridThreshold, vtkHyperTreeGridAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  VTK_DEPRECATED_IN_9_3_0("JustCreateNewMask is deprecated in favor of MemoryStrategy")
  virtual void SetJustCreateNewMask(bool) {}
  VTK_DEPRECATED_IN_9_3_0("JustCreateNewMask is deprecated in favor of MemoryStrategy")
  virtual bool GetJustCreateNewMask() { return (this->GetMemoryStrategy() == MaskInput); }


  vtkSetMacro(LowerThreshold, double);
  vtkGetMacro(LowerThreshold, double);


  vtkSetMacro(UpperThreshold, double);
  vtkGetMacro(UpperThreshold, double);

  void ThresholdBetween(double, double);


  enum MemoryStrategyChoice
  {
    MaskInput = 0,
    CopyStructureAndIndexArrays = 1,
    DeepThreshold = 2
  };

  vtkGetMacro(MemoryStrategy, int);
  vtkSetClampMacro(MemoryStrategy, int, MaskInput, DeepThreshold);
 
protected:
  vtkHyperTreeGridThreshold();
  ~vtkHyperTreeGridThreshold() override;

  int FillOutputPortInformation(int, vtkInformation*) override;

  int ProcessTrees(vtkHyperTreeGrid*, vtkDataObject*) override;

  bool RecursivelyProcessTree(
    vtkHyperTreeGridNonOrientedCursor*, vtkHyperTreeGridNonOrientedCursor*);

  bool RecursivelyProcessTreeWithCreateNewMask(vtkHyperTreeGridNonOrientedCursor*);

  double LowerThreshold;

  double UpperThreshold;

  vtkBitArray* InMask;

  vtkBitArray* OutMask;

  vtkIdType CurrentId;

  vtkDataArray* InScalars;

  bool JustCreateNewMask;
 
private:
  vtkHyperTreeGridThreshold(const vtkHyperTreeGridThreshold&) = delete;
  void operator=(const vtkHyperTreeGridThreshold&) = delete;
  bool RecursivelyProcessChild(vtkHyperTreeGridNonOrientedCursor* outCursor, int ichild);

  void SafeInsertOutMask(vtkIdType tupleIdx, double value);
 
  int MemoryStrategy = MaskInput;
  std::vector<std::mutex> OutMaskMutexes;
  int ArrayMutexSize = 0; // Needs to be a multiple of 8
 
  struct Internals;
  std::unique_ptr<Internals> Internal;
};
 
VTK_ABI_NAMESPACE_END
#endif /* vtkHyperTreeGridThreshold */