vtk-m/vtkm/worklet/NDimsEntropy.h
Kenneth Moreland d879188de0 Make DispatcherBase invoke using a TryExecute
Rather than force all dispatchers to be templated on a device adapter,
instead use a TryExecute internally within the invoke to select a device
adapter.

Because this removes the need to declare a device when invoking a
worklet, this commit also removes the need to declare a device in
several other areas of the code.
2018-08-29 19:18:54 -07:00

104 lines
3.6 KiB
C++

//============================================================================
// 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.
//
// Copyright 2014 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
// Copyright 2014 UT-Battelle, LLC.
// Copyright 2014 Los Alamos National Security.
//
// Under the terms of Contract DE-NA0003525 with NTESS,
// 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_worklet_NDimsEntropy_h
#define vtk_m_worklet_NDimsEntropy_h
#include <vtkm/Math.h>
#include <vtkm/cont/ArrayHandle.h>
#include <vtkm/cont/ArrayHandleCounting.h>
#include <vtkm/cont/DeviceAdapter.h>
#include <vtkm/worklet/DispatcherMapField.h>
#include <vtkm/worklet/NDimsHistogram.h>
#include <vtkm/worklet/WorkletMapField.h>
#include <vtkm/worklet/histogram/ComputeNDEntropy.h>
#include <vtkm/cont/Field.h>
namespace vtkm
{
namespace worklet
{
class NDimsEntropy
{
public:
template <typename DeviceAdapter>
void SetNumOfDataPoints(vtkm::Id _numDataPoints, DeviceAdapter device)
{
NumDataPoints = _numDataPoints;
NdHistogram.SetNumOfDataPoints(_numDataPoints, device);
}
// Add a field and the bin for this field
// Return: rangeOfRange is min max value of this array
// binDelta is delta of a bin
template <typename HandleType, typename DeviceAdapter>
void AddField(const HandleType& fieldArray, vtkm::Id numberOfBins, DeviceAdapter device)
{
vtkm::Range range;
vtkm::Float64 delta;
NdHistogram.AddField(fieldArray, numberOfBins, range, delta, device);
}
// Execute the entropy computation filter given
// fields and number of bins of each fields
// Returns:
// Entropy (log2) of the field of the data
template <typename DeviceAdapter>
vtkm::Float64 Run(DeviceAdapter device)
{
using DeviceAlgorithms = typename vtkm::cont::DeviceAdapterAlgorithm<DeviceAdapter>;
std::vector<vtkm::cont::ArrayHandle<vtkm::Id>> binIds;
vtkm::cont::ArrayHandle<vtkm::Id> freqs;
NdHistogram.Run(binIds, freqs, device);
///// calculate sum of frequency of the histogram /////
vtkm::Id initFreqSumValue = 0;
vtkm::Id freqSum = DeviceAlgorithms::Reduce(freqs, initFreqSumValue, vtkm::Sum());
///// calculate information content of each bin using self-define worklet /////
vtkm::cont::ArrayHandle<vtkm::Float64> informationContent;
vtkm::worklet::histogram::SetBinInformationContent binWorklet(
static_cast<vtkm::Float64>(freqSum));
vtkm::worklet::DispatcherMapField<vtkm::worklet::histogram::SetBinInformationContent>
setBinInformationContentDispatcher(binWorklet);
setBinInformationContentDispatcher.SetDevice(DeviceAdapter());
setBinInformationContentDispatcher.Invoke(freqs, informationContent);
///// calculate entropy by summing up information conetent of all bins /////
vtkm::Float64 initEntropyValue = 0;
vtkm::Float64 entropy =
DeviceAlgorithms::Reduce(informationContent, initEntropyValue, vtkm::Sum());
return entropy;
}
private:
vtkm::worklet::NDimsHistogram NdHistogram;
vtkm::Id NumDataPoints;
};
}
} // namespace vtkm::worklet
#endif // vtk_m_worklet_NDimsEntropy_h