Histogram.h

Go to the documentation of this file.

//============================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt 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.
//============================================================================
 
#ifndef vtk_m_filter_density_estimate_Histogram_h
#define vtk_m_filter_density_estimate_Histogram_h
 
#include <vtkm/filter/FilterField.h>
#include <vtkm/filter/density_estimate/vtkm_filter_density_estimate_export.h>
 
namespace vtkm
{
namespace filter
{
namespace density_estimate
{
class VTKM_FILTER_DENSITY_ESTIMATE_EXPORT Histogram : public vtkm::filter::FilterField
{
public:
  //Construct a histogram with a default of 10 bins
  VTKM_CONT
  Histogram();
 
  VTKM_CONT
  void SetNumberOfBins(vtkm::Id count) { this->NumberOfBins = count; }
 
  VTKM_CONT
  vtkm::Id GetNumberOfBins() const { return this->NumberOfBins; }
 
  VTKM_CONT
  void SetRange(const vtkm::Range& range) { this->Range = range; }
 
  VTKM_CONT
  const vtkm::Range& GetRange() const { return this->Range; }
 
  VTKM_CONT
  vtkm::Float64 GetBinDelta() const { return this->BinDelta; }
 
  VTKM_CONT
  vtkm::Range GetComputedRange() const { return this->ComputedRange; }
 
private:
  VTKM_CONT vtkm::cont::DataSet DoExecute(const vtkm::cont::DataSet& input) override;
  VTKM_CONT vtkm::cont::PartitionedDataSet DoExecutePartitions(
    const vtkm::cont::PartitionedDataSet& inData) override;
 
  VTKM_CONT void PreExecute(const vtkm::cont::PartitionedDataSet& input);
  VTKM_CONT void PostExecute(const vtkm::cont::PartitionedDataSet& input,
                             vtkm::cont::PartitionedDataSet& output);
 
  vtkm::Id NumberOfBins = 10;
  vtkm::Float64 BinDelta = 0;
  vtkm::Range ComputedRange;
  vtkm::Range Range;
  bool InExecutePartitions = false;
};
} // namespace density_estimate
} // namespace filter
} // namespace vtkm
 
#endif // vtk_m_filter_density_estimate_Histogram_h