// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
 * @class   vtkImageAccumulate
 * @brief   Generalized histograms up to 3 dimensions.
 *
 * vtkImageAccumulate - This filter divides component space into
 * discrete bins.  It then counts the number of pixels associated
 * with each bin.
 * The dimensionality of the output depends on how many components the
 * input pixels have. An input images with N components per pixels will
 * result in an N-dimensional histogram, where N can be 1, 2, or 3.
 * The input can be any type, but the output is always int.
 * Some statistics are computed on the pixel values at the same time.
 * The SetStencil and ReverseStencil functions allow the statistics to be
 * computed on an arbitrary portion of the input data.
 * See the documentation for vtkImageStencilData for more information.
 *
 * This filter also supports ignoring pixels with value equal to 0. Using this
 * option with vtkImageMask may result in results being slightly off since 0
 * could be a valid value from your input.
 *
 */

#ifndef vtkImageAccumulate_h
#define vtkImageAccumulate_h

#include "vtkImageAlgorithm.h"
#include "vtkImagingStatisticsModule.h" // For export macro

VTK_ABI_NAMESPACE_BEGIN
class vtkImageStencilData;

class VTKIMAGINGSTATISTICS_EXPORT vtkImageAccumulate : public vtkImageAlgorithm
{
public:
  static vtkImageAccumulate* New();
  vtkTypeMacro(vtkImageAccumulate, vtkImageAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  ///@{
  /**
   * Set/Get - The component spacing is the dimension of each bin.
   * This ends up being the spacing of the output "image".
   * If the number of input scalar components are less than three,
   * then some of these spacing values are ignored.
   * For a 1D histogram with 10 bins spanning the values 1000 to 2000,
   * this spacing should be set to 100, 0, 0.
   * Initial value is (1.0,1.0,1.0).
   */
  vtkSetVector3Macro(ComponentSpacing, double);
  vtkGetVector3Macro(ComponentSpacing, double);
  ///@}

  ///@{
  /**
   * Set/Get - The component origin is the location of bin (0, 0, 0).
   * Note that if the Component extent does not include the value (0,0,0),
   * then this origin bin will not actually be in the output.
   * The origin of the output ends up being the same as the component origin.
   * For a 1D histogram with 10 bins spanning the values 1000 to 2000,
   * this origin should be set to 1000, 0, 0.
   * Initial value is (0.0,0.0,0.0).
   */
  vtkSetVector3Macro(ComponentOrigin, double);
  vtkGetVector3Macro(ComponentOrigin, double);
  ///@}

  ///@{
  /**
   * Set/Get - The component extent sets the number/extent of the bins.
   * For a 1D histogram with 10 bins spanning the values 1000 to 2000,
   * this extent should be set to 0, 9, 0, 0, 0, 0.
   * The extent specifies inclusive min/max values.
   * This implies that the top extent should be set to the number of bins - 1.
   * Initial value is (0,255,0,0,0,0)
   */
  void SetComponentExtent(int extent[6]);
  void SetComponentExtent(int minX, int maxX, int minY, int maxY, int minZ, int maxZ);
  void GetComponentExtent(int extent[6]);
  int* GetComponentExtent() VTK_SIZEHINT(6) { return this->ComponentExtent; }
  ///@}

  ///@{
  /**
   * Use a stencil to specify which voxels to accumulate.
   * Backcompatible methods.
   * It set and get the stencil on input port 1.
   * Initial value is nullptr.
   */
  void SetStencilData(vtkImageStencilData* stencil);
  vtkImageStencilData* GetStencil();
  ///@}

  ///@{
  /**
   * Reverse the stencil. Initial value is false.
   */
  vtkSetClampMacro(ReverseStencil, vtkTypeBool, 0, 1);
  vtkBooleanMacro(ReverseStencil, vtkTypeBool);
  vtkGetMacro(ReverseStencil, vtkTypeBool);
  ///@}

  ///@{
  /**
   * Get the statistics information for the data.
   * The values only make sense after the execution of the filter.
   * Initial values are 0.
   */
  vtkGetVector3Macro(Min, double);
  vtkGetVector3Macro(Max, double);
  vtkGetVector3Macro(Mean, double);
  vtkGetVector3Macro(StandardDeviation, double);
  vtkGetMacro(VoxelCount, vtkIdType);
  ///@}

  ///@{
  /**
   * Should the data with value 0 be ignored? Initial value is false.
   */
  vtkSetClampMacro(IgnoreZero, vtkTypeBool, 0, 1);
  vtkGetMacro(IgnoreZero, vtkTypeBool);
  vtkBooleanMacro(IgnoreZero, vtkTypeBool);
  ///@}

protected:
  vtkImageAccumulate();
  ~vtkImageAccumulate() override;

  double ComponentSpacing[3];
  double ComponentOrigin[3];
  int ComponentExtent[6];

  int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  vtkTypeBool IgnoreZero;
  double Min[3];
  double Max[3];
  double Mean[3];
  double StandardDeviation[3];
  vtkIdType VoxelCount;

  vtkTypeBool ReverseStencil;

  int FillInputPortInformation(int port, vtkInformation* info) override;

private:
  vtkImageAccumulate(const vtkImageAccumulate&) = delete;
  void operator=(const vtkImageAccumulate&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif
