vtkPlotHistogram2D.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 vtkPlotHistogram2D_h
#define vtkPlotHistogram2D_h

#include "vtkChartsCoreModule.h" // For export macro
#include "vtkNew.h"              // For vtkNew
#include "vtkPlot.h"
#include "vtkRect.h"          // Needed for vtkRectf
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

#include <string> // Needed for std::string

VTK_ABI_NAMESPACE_BEGIN

class vtkDoubleArray;
class vtkImageData;
class vtkScalarsToColors;

class VTKCHARTSCORE_EXPORT VTK_MARSHALAUTO vtkPlotHistogram2D : public vtkPlot
{
public:
  vtkTypeMacro(vtkPlotHistogram2D, vtkPlot);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkPlotHistogram2D* New();

  void Update() override;

  bool Paint(vtkContext2D* painter) override;

  virtual void SetInputData(vtkImageData* data, vtkIdType z = 0);
  void SetInputData(vtkTable*) override {}
  void SetInputData(vtkTable*, const vtkStdString&, const vtkStdString&) override {}

  vtkImageData* GetInputImageData();

  void SetTransferFunction(vtkScalarsToColors* transfer);

  vtkScalarsToColors* GetTransferFunction();

  void GetBounds(double bounds[4]) override;

  virtual void SetPosition(const vtkRectf& pos);
  virtual vtkRectf GetPosition();


  vtkSetMacro(ArrayName, std::string);
  vtkGetMacro(ArrayName, std::string);

  vtkStdString GetTooltipLabel(
    const vtkVector2d& plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex) override;

  vtkIdType GetNearestPoint(const vtkVector2f& point, const vtkVector2f& tolerance,
    vtkVector2f* location, vtkIdType* segmentId) override;
  using vtkPlot::GetNearestPoint;

  bool UpdateCache() override;

protected:
  vtkPlotHistogram2D();
  ~vtkPlotHistogram2D() override;

  vtkSmartPointer<vtkImageData> Input;
  vtkSmartPointer<vtkImageData> Output;
  vtkSmartPointer<vtkScalarsToColors> TransferFunction;
  vtkRectf Position;

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

  static vtkIdType GetLabelIndexFromValue(double value, vtkAxis* axis);
  static inline bool CanComputeMagnitude(vtkDataArray* array);

  inline vtkDataArray* GetSelectedArray();
  double GetInputArrayValue(int x, int y, int z);

  std::string ArrayName;
  vtkNew<vtkDoubleArray> MagnitudeArray;
};

VTK_ABI_NAMESPACE_END
#endif // vtkPlotHistogram2D_h