2016-08-10 20:34:21 +00:00
|
|
|
//============================================================================
|
|
|
|
// 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.
|
|
|
|
//
|
2017-09-20 21:33:44 +00:00
|
|
|
// Copyright 2014 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
|
2016-08-10 20:34:21 +00:00
|
|
|
// Copyright 2014 UT-Battelle, LLC.
|
|
|
|
// Copyright 2014 Los Alamos National Security.
|
|
|
|
//
|
2017-09-20 21:33:44 +00:00
|
|
|
// Under the terms of Contract DE-NA0003525 with NTESS,
|
2016-08-10 20:34:21 +00:00
|
|
|
// the U.S. Government retains certain rights in this software.
|
|
|
|
//
|
|
|
|
// Under the terms of Contract DE-AC52-06NA25396 with Los Alamos National
|
|
|
|
// Laboratory (LANL), the U.S. Government retains certain rights in
|
|
|
|
// this software.
|
|
|
|
//============================================================================
|
|
|
|
|
|
|
|
#ifndef vtk_m_filter_Histogram_h
|
|
|
|
#define vtk_m_filter_Histogram_h
|
|
|
|
|
|
|
|
#include <vtkm/filter/FilterField.h>
|
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
namespace vtkm
|
|
|
|
{
|
|
|
|
namespace filter
|
|
|
|
{
|
2017-07-06 17:51:45 +00:00
|
|
|
/// \brief Construct the histogram of a given Field
|
|
|
|
///
|
|
|
|
/// Construct a histogram with a default of 10 bins
|
|
|
|
///
|
2016-08-10 20:34:21 +00:00
|
|
|
class Histogram : public vtkm::filter::FilterField<Histogram>
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
//Construct a histogram with a default of 10 bins
|
2016-10-19 22:42:58 +00:00
|
|
|
VTKM_CONT
|
2016-08-10 20:34:21 +00:00
|
|
|
Histogram();
|
|
|
|
|
2016-10-19 22:42:58 +00:00
|
|
|
VTKM_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
void SetNumberOfBins(vtkm::Id count) { this->NumberOfBins = count; }
|
2016-08-10 20:34:21 +00:00
|
|
|
|
2016-10-19 22:42:58 +00:00
|
|
|
VTKM_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
vtkm::Id GetNumberOfBins() const { return this->NumberOfBins; }
|
2016-08-10 20:34:21 +00:00
|
|
|
|
|
|
|
//Returns the bin delta of the last computed field, be it from DoExecute
|
|
|
|
//or from MapField
|
2016-10-19 22:42:58 +00:00
|
|
|
VTKM_CONT
|
2016-08-10 20:34:21 +00:00
|
|
|
vtkm::Float64 GetBinDelta() const { return this->BinDelta; }
|
|
|
|
|
|
|
|
//Returns the the min and max values for that last computed field
|
2016-10-19 22:42:58 +00:00
|
|
|
VTKM_CONT
|
2016-08-10 20:34:21 +00:00
|
|
|
vtkm::Range GetDataRange() const { return this->DataRange; }
|
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
template <typename T, typename StorageType, typename DerivedPolicy, typename DeviceAdapter>
|
2018-04-02 21:58:21 +00:00
|
|
|
VTKM_CONT vtkm::cont::DataSet DoExecute(const vtkm::cont::DataSet& input,
|
|
|
|
const vtkm::cont::ArrayHandle<T, StorageType>& field,
|
|
|
|
const vtkm::filter::FieldMetadata& fieldMeta,
|
|
|
|
const vtkm::filter::PolicyBase<DerivedPolicy>& policy,
|
|
|
|
const DeviceAdapter& tag);
|
2016-08-10 20:34:21 +00:00
|
|
|
|
|
|
|
private:
|
2017-05-18 14:29:41 +00:00
|
|
|
vtkm::Id NumberOfBins;
|
2016-08-10 20:34:21 +00:00
|
|
|
vtkm::Float64 BinDelta;
|
|
|
|
vtkm::Range DataRange;
|
|
|
|
};
|
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
template <>
|
2016-08-10 20:34:21 +00:00
|
|
|
class FilterTraits<Histogram>
|
|
|
|
{ //currently the Histogram filter only works on scalar data.
|
|
|
|
//this mainly has to do with getting the ranges for each bin
|
|
|
|
//would require returning a more complex value type
|
|
|
|
public:
|
2018-02-22 13:29:13 +00:00
|
|
|
using InputFieldTypeList = TypeListTagScalarAll;
|
2016-08-10 20:34:21 +00:00
|
|
|
};
|
|
|
|
}
|
|
|
|
} // namespace vtkm::filter
|
|
|
|
|
|
|
|
#include <vtkm/filter/Histogram.hxx>
|
|
|
|
|
|
|
|
#endif // vtk_m_filter_Histogram_h
|