vtkExtractHistogram2D.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkExtractHistogram2D.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm 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.
 
=========================================================================*/
/*-------------------------------------------------------------------------
  Copyright 2011 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
#ifndef vtkExtractHistogram2D_h
#define vtkExtractHistogram2D_h
 
#include "vtkFiltersImagingModule.h" // For export macro
#include "vtkStatisticsAlgorithm.h"
 
class vtkImageData;
class vtkIdTypeArray;
class vtkMultiBlockDataSet;
 
class VTKFILTERSIMAGING_EXPORT vtkExtractHistogram2D : public vtkStatisticsAlgorithm
{
public:
  static vtkExtractHistogram2D* New();
  vtkTypeMacro(vtkExtractHistogram2D, vtkStatisticsAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  enum OutputIndices
  {
    HISTOGRAM_IMAGE = 3
  };
 
 
  vtkSetVector2Macro(NumberOfBins, int);
  vtkGetVector2Macro(NumberOfBins, int);
 
 
  vtkSetVector2Macro(ComponentsToProcess, int);
  vtkGetVector2Macro(ComponentsToProcess, int);
 
 
  vtkSetVector4Macro(CustomHistogramExtents, double);
  vtkGetVector4Macro(CustomHistogramExtents, double);
 
 
  vtkSetMacro(UseCustomHistogramExtents, vtkTypeBool);
  vtkGetMacro(UseCustomHistogramExtents, vtkTypeBool);
  vtkBooleanMacro(UseCustomHistogramExtents, vtkTypeBool);
 
 
  vtkSetMacro(ScalarType, int);
  void SetScalarTypeToUnsignedInt() { this->SetScalarType(VTK_UNSIGNED_INT); }
  void SetScalarTypeToUnsignedLong() { this->SetScalarType(VTK_UNSIGNED_LONG); }
  void SetScalarTypeToUnsignedShort() { this->SetScalarType(VTK_UNSIGNED_SHORT); }
  void SetScalarTypeToUnsignedChar() { this->SetScalarType(VTK_UNSIGNED_CHAR); }
  void SetScalarTypeToFloat() { this->SetScalarType(VTK_FLOAT); }
  void SetScalarTypeToDouble() { this->SetScalarType(VTK_DOUBLE); }
  vtkGetMacro(ScalarType, int);
 
 
  vtkGetMacro(MaximumBinCount, double);
 
  int GetBinRange(vtkIdType binX, vtkIdType binY, double range[4]);
 
  int GetBinRange(vtkIdType bin, double range[4]);
 
  void GetBinWidth(double bw[2]);
 
  vtkImageData* GetOutputHistogramImage();
 
  double* GetHistogramExtents();
 
  vtkSetMacro(SwapColumns, vtkTypeBool);
  vtkGetMacro(SwapColumns, vtkTypeBool);
  vtkBooleanMacro(SwapColumns, vtkTypeBool);
 
 
  virtual void SetRowMask(vtkDataArray*);
  vtkGetObjectMacro(RowMask, vtkDataArray);
 
  void Aggregate(vtkDataObjectCollection*, vtkMultiBlockDataSet*) override {}
 
protected:
  vtkExtractHistogram2D();
  ~vtkExtractHistogram2D() override;
 
  vtkTypeBool SwapColumns;
  int NumberOfBins[2];
  double HistogramExtents[4];
  double CustomHistogramExtents[4];
  vtkTypeBool UseCustomHistogramExtents;
  int ComponentsToProcess[2];
  double MaximumBinCount;
  int ScalarType;
  vtkDataArray* RowMask;
 
  virtual int ComputeBinExtents(vtkDataArray* col1, vtkDataArray* col2);
 
  void Learn(vtkTable* inData, vtkTable* inParameters, vtkMultiBlockDataSet* outMeta) override;
 
  void Derive(vtkMultiBlockDataSet*) override {}
 
  void Test(vtkTable*, vtkMultiBlockDataSet*, vtkTable*) override { return; }
 
  void Assess(vtkTable*, vtkMultiBlockDataSet*, vtkTable*) override { return; }
 
  void SelectAssessFunctor(vtkTable* vtkNotUsed(outData), vtkDataObject* vtkNotUsed(inMeta),
    vtkStringArray* vtkNotUsed(rowNames), AssessFunctor*& vtkNotUsed(dfunc)) override
  {
  }
 
  int FillOutputPortInformation(int port, vtkInformation* info) override;
 
  int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
 
  int GetInputArrays(vtkDataArray*& col1, vtkDataArray*& col2);
 
private:
  vtkExtractHistogram2D(const vtkExtractHistogram2D&) = delete;
  void operator=(const vtkExtractHistogram2D&) = delete;
};
 
#endif