vtkExtractHistogram.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 vtkExtractHistogram_h
#define vtkExtractHistogram_h
 
#include <memory> // for std::unique_ptr
 
#include "vtkFiltersStatisticsModule.h" // For export macro
#include "vtkTableAlgorithm.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDoubleArray;
class vtkFieldData;
class vtkIntArray;
class vtkExtractHistogramInternal;
 
class VTKFILTERSSTATISTICS_EXPORT vtkExtractHistogram : public vtkTableAlgorithm
{
public:
  static vtkExtractHistogram* New();
  vtkTypeMacro(vtkExtractHistogram, vtkTableAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetClampMacro(Component, int, 0, VTK_INT_MAX);
  vtkGetMacro(Component, int);


  vtkSetClampMacro(BinCount, int, 1, VTK_INT_MAX);
  vtkGetMacro(BinCount, int);


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


  vtkSetVector2Macro(CustomBinRanges, double);
  vtkGetVector2Macro(CustomBinRanges, double);


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


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


  vtkSetStringMacro(BinExtentsArrayName);
  vtkGetStringMacro(BinExtentsArrayName);


  vtkSetStringMacro(BinValuesArrayName);
  vtkGetStringMacro(BinValuesArrayName);


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


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


  vtkSetStringMacro(BinAccumulationArrayName);
  vtkGetStringMacro(BinAccumulationArrayName);


  vtkGetVector2Macro(BinRange, double);
 
protected:
  vtkExtractHistogram();
  ~vtkExtractHistogram() override;

  virtual bool GetInputArrayRange(vtkInformationVector** inputVector, double range[2]);
 
  int FillInputPortInformation(int port, vtkInformation* info) override;
 
  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
 
  // Initialize the bin_extents using the data range for the selected
  // array.
  virtual bool InitializeBinExtents(vtkInformationVector** inputVector, vtkDoubleArray* binExtents);
 
  void BinAnArray(
    vtkDataArray* dataArray, vtkIntArray* binValues, double min, double max, vtkFieldData* field);
 
  void FillBinExtents(vtkDoubleArray* binExtents);
 
  void NormalizeBins(vtkTable* outputData);
 
  void AccumulateBins(vtkTable* outputData);
 
  double CustomBinRanges[2] = { 0, 100 };
  double BinRange[2] = { VTK_DOUBLE_MAX, -VTK_DOUBLE_MAX };
  bool CenterBinsAroundMinAndMax = false;
  bool UseCustomBinRanges = false;
  int Component = 0;
  int BinCount = 10;
  bool CalculateAverages = false;
  char* BinExtentsArrayName = nullptr;
  char* BinValuesArrayName = nullptr;
  char* BinAccumulationArrayName = nullptr;
  bool Normalize = false;
  bool Accumulation = false;
 
  std::unique_ptr<vtkExtractHistogramInternal> Internal;
 
private:
  void operator=(const vtkExtractHistogram&) = delete;
  vtkExtractHistogram(const vtkExtractHistogram&) = delete;
 
  int GetInputFieldAssociation();
  vtkFieldData* GetInputFieldData(vtkDataObject* input);
};
 
VTK_ABI_NAMESPACE_END
#endif