vtk-m/vtkm/worklet/KernelSplatter.h

594 lines
24 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.
//============================================================================
#ifndef vtk_m_worklet_KernelSplatter_h
#define vtk_m_worklet_KernelSplatter_h
#include <vtkm/Math.h>
#include <vtkm/cont/ArrayHandle.h>
#include <vtkm/cont/ArrayHandleCounting.h>
#include <vtkm/cont/ArrayHandlePermutation.h>
#include <vtkm/cont/ArrayHandleTransform.h>
#include <vtkm/cont/ArrayHandleUniformPointCoordinates.h>
#include <vtkm/cont/DataSet.h>
#include <vtkm/cont/DeviceAdapterAlgorithm.h>
#include <vtkm/cont/Timer.h>
#include <vtkm/cont/internal/ArrayPortalFromIterators.h>
#include <vtkm/worklet/DispatcherMapField.h>
#include <vtkm/worklet/WorkletMapField.h>
#include <vtkm/worklet/splatkernels/Gaussian.h>
#include <vtkm/worklet/splatkernels/KernelBase.h>
#include <vtkm/worklet/splatkernels/Spline3rdOrder.h>
//#define __VTKM_GAUSSIAN_SPLATTER_BENCHMARK
//----------------------------------------------------------------------------
// Macros for timing
//----------------------------------------------------------------------------
#if defined(__VTKM_GAUSSIAN_SPLATTER_BENCHMARK) && !defined(START_TIMER_BLOCK)
// start timer
#define START_TIMER_BLOCK(name) \
vtkm::cont::Timer timer_##name{ DeviceAdapter() }; \
timer_##name.Start();
// stop timer
#define END_TIMER_BLOCK(name) \
std::cout << #name " : elapsed : " << timer_##name.GetElapsedTime() << "\n";
#endif
#if !defined(START_TIMER_BLOCK)
#define START_TIMER_BLOCK(name)
#define END_TIMER_BLOCK(name)
#endif
//----------------------------------------------------------------------------
// Kernel splatter worklet/filter
//----------------------------------------------------------------------------
namespace vtkm
{
namespace worklet
{
namespace debug
{
#ifdef DEBUG_PRINT
//----------------------------------------------------------------------------
template <typename T, typename S = VTKM_DEFAULT_STORAGE_TAG>
void OutputArrayDebug(const vtkm::cont::ArrayHandle<T, S>& outputArray, const std::string& name)
{
using ValueType = T;
using StorageType = vtkm::cont::internal::Storage<T, S>;
using PortalConstType = typename StorageType::PortalConstType;
PortalConstType readPortal = outputArray.ReadPortal();
vtkm::cont::ArrayPortalToIterators<PortalConstType> iterators(readPortal);
std::vector<ValueType> result(readPortal.GetNumberOfValues());
std::copy(iterators.GetBegin(), iterators.GetEnd(), result.begin());
std::cout << name.c_str() << " " << outputArray.GetNumberOfValues() << "\n";
std::copy(result.begin(), result.end(), std::ostream_iterator<ValueType>(std::cout, " "));
std::cout << std::endl;
}
//----------------------------------------------------------------------------
template <typename T, int S>
void OutputArrayDebug(const vtkm::cont::ArrayHandle<vtkm::Vec<T, S>>& outputArray,
const std::string& name)
{
using ValueType = T;
using PortalConstType = typename vtkm::cont::ArrayHandle<vtkm::Vec<T, S>>::ReadPortalType;
PortalConstType readPortal = outputArray.ReadPortal();
vtkm::cont::ArrayPortalToIterators<PortalConstType> iterators(readPortal);
std::cout << name.c_str() << " " << outputArray.GetNumberOfValues() << "\n";
auto portal = outputArray.ReadPortal();
for (int i = 0; i < outputArray.GetNumberOfValues(); ++i)
{
std::cout << portal.Get(i);
}
std::cout << std::endl;
}
//----------------------------------------------------------------------------
template <typename I, typename T, int S>
void OutputArrayDebug(
const vtkm::cont::ArrayHandlePermutation<I, vtkm::cont::ArrayHandle<vtkm::Vec<T, S>>>&
outputArray,
const std::string& name)
{
using PortalConstType = typename vtkm::cont::
ArrayHandlePermutation<I, vtkm::cont::ArrayHandle<vtkm::Vec<T, S>>>::ReadPortalType;
PortalConstType readPortal = outputArray.ReadPortal();
vtkm::cont::ArrayPortalToIterators<PortalConstType> iterators(readPortal);
std::cout << name.c_str() << " " << outputArray.GetNumberOfValues() << "\n";
auto outputPortal = outputArray.ReadPortal();
for (int i = 0; i < outputArray.GetNumberOfValues(); ++i)
{
std::cout << outputPortal.Get(i);
}
std::cout << std::endl;
}
#else
template <typename T, typename S>
void OutputArrayDebug(const vtkm::cont::ArrayHandle<T, S>& vtkmNotUsed(outputArray),
const std::string& vtkmNotUsed(name))
{
}
//----------------------------------------------------------------------------
template <typename T, int S>
void OutputArrayDebug(const vtkm::cont::ArrayHandle<vtkm::Vec<T, S>>& vtkmNotUsed(outputArray),
const std::string& vtkmNotUsed(name))
{
}
//----------------------------------------------------------------------------
template <typename I, typename T, int S>
void OutputArrayDebug(
const vtkm::cont::ArrayHandlePermutation<I, vtkm::cont::ArrayHandle<vtkm::Vec<T, S>>>&
vtkmNotUsed(outputArray),
const std::string& vtkmNotUsed(name))
{
}
#endif
} // namespace debug
template <typename Kernel, typename DeviceAdapter>
struct KernelSplatterFilterUniformGrid
{
using DoubleHandleType = vtkm::cont::ArrayHandle<vtkm::Float64>;
using FloatHandleType = vtkm::cont::ArrayHandle<vtkm::Float32>;
using VecHandleType = vtkm::cont::ArrayHandle<vtkm::Id3>;
using IdHandleType = vtkm::cont::ArrayHandle<vtkm::Id>;
//
using FloatVec = vtkm::Vec3f_32;
using PointType = vtkm::Vec3f_64;
using PointHandleType = vtkm::cont::ArrayHandle<PointType>;
//
using VecPermType = vtkm::cont::ArrayHandlePermutation<IdHandleType, VecHandleType>;
using PointVecPermType = vtkm::cont::ArrayHandlePermutation<IdHandleType, PointHandleType>;
using IdPermType = vtkm::cont::ArrayHandlePermutation<IdHandleType, IdHandleType>;
using FloatPermType = vtkm::cont::ArrayHandlePermutation<IdHandleType, FloatHandleType>;
//
using IdCountingType = vtkm::cont::ArrayHandleCounting<vtkm::Id>;
//-----------------------------------------------------------------------
// zero an array,
// @TODO, get rid of this
//-----------------------------------------------------------------------
struct zero_voxel : public vtkm::worklet::WorkletMapField
{
using ControlSignature = void(FieldIn, FieldOut);
using ExecutionSignature = void(_1, WorkIndex, _2);
//
VTKM_CONT
zero_voxel() {}
template <typename T>
VTKM_EXEC_CONT void operator()(const vtkm::Id&,
const vtkm::Id& vtkmNotUsed(index),
T& voxel_value) const
{
voxel_value = T(0);
}
};
//-----------------------------------------------------------------------
// Return the splat footprint/neighborhood of each sample point, as
// represented by min and max boundaries in each dimension.
// Also return the size of this footprint and the voxel coordinates
// of the splat point (floating point).
//-----------------------------------------------------------------------
class GetFootprint : public vtkm::worklet::WorkletMapField
{
private:
vtkm::Vec3f_64 origin_;
vtkm::Vec3f_64 spacing_;
vtkm::Id3 VolumeDimensions;
Kernel kernel_;
public:
using ControlSignature =
void(FieldIn, FieldIn, FieldIn, FieldIn, FieldOut, FieldOut, FieldOut, FieldOut);
using ExecutionSignature = void(_1, _2, _3, _4, _5, _6, _7, _8);
VTKM_CONT
GetFootprint(const vtkm::Vec3f_64& o,
const vtkm::Vec3f_64& s,
const vtkm::Id3& dim,
const Kernel& kernel)
: origin_(o)
, spacing_(s)
, VolumeDimensions(dim)
, kernel_(kernel)
{
}
template <typename T, typename T2>
VTKM_EXEC_CONT void operator()(const T& x,
const T& y,
const T& z,
const T2& h,
vtkm::Vec3f_64& splatPoint,
vtkm::Id3& minFootprint,
vtkm::Id3& maxFootprint,
vtkm::Id& footprintSize) const
{
PointType splat, min, max;
vtkm::Vec3f_64 sample = vtkm::make_Vec(x, y, z);
vtkm::Id size = 1;
double cutoff = kernel_.maxDistance(h);
for (int i = 0; i < 3; i++)
{
splat[i] = (sample[i] - this->origin_[i]) / this->spacing_[i];
min[i] = static_cast<vtkm::Id>(ceil(static_cast<double>(splat[i]) - cutoff));
max[i] = static_cast<vtkm::Id>(floor(static_cast<double>(splat[i]) + cutoff));
if (min[i] < 0)
{
min[i] = 0;
}
if (max[i] >= this->VolumeDimensions[i])
{
max[i] = this->VolumeDimensions[i] - 1;
}
size = static_cast<vtkm::Id>(size * (1 + max[i] - min[i]));
}
splatPoint = splat;
minFootprint = min;
maxFootprint = max;
footprintSize = size;
}
};
//-----------------------------------------------------------------------
// Return the "local" Id of a voxel within a splat point's footprint.
// A splat point that affects 5 neighboring voxel gridpoints would
// have local Ids 0,1,2,3,4
//-----------------------------------------------------------------------
class ComputeLocalNeighborId : public vtkm::worklet::WorkletMapField
{
public:
using ControlSignature = void(FieldIn, FieldIn, FieldOut);
using ExecutionSignature = void(_1, _2, WorkIndex, _3);
VTKM_CONT
ComputeLocalNeighborId() {}
template <typename T>
VTKM_EXEC_CONT void operator()(const T& modulus,
const T& offset,
const vtkm::Id& index,
T& localId) const
{
localId = (index - offset) % modulus;
}
};
//-----------------------------------------------------------------------
// Compute the splat value of the input neighbour point.
// The voxel Id of this point within the volume is also determined.
//-----------------------------------------------------------------------
class GetSplatValue : public vtkm::worklet::WorkletMapField
{
private:
vtkm::Vec3f_64 spacing_;
vtkm::Vec3f_64 origin_;
vtkm::Id3 VolumeDim;
vtkm::Float64 Radius2;
vtkm::Float64 ExponentFactor;
vtkm::Float64 ScalingFactor;
Kernel kernel;
public:
using ControlSignature =
void(FieldIn, FieldIn, FieldIn, FieldIn, FieldIn, FieldIn, FieldOut, FieldOut);
using ExecutionSignature = void(_1, _2, _3, _4, _5, _6, _7, _8);
VTKM_CONT
GetSplatValue(const vtkm::Vec3f_64& orig,
const vtkm::Vec3f_64& s,
const vtkm::Id3& dim,
const Kernel& k)
: spacing_(s)
, origin_(orig)
, VolumeDim(dim)
, kernel(k)
{
}
template <typename T, typename T2, typename P>
VTKM_EXEC_CONT void operator()(const vtkm::Vec<P, 3>& splatPoint,
const T& minBound,
const T& maxBound,
const T2& kernel_H,
const T2& scale,
const vtkm::Id localNeighborId,
vtkm::Id& neighborVoxelId,
vtkm::Float32& splatValue) const
{
vtkm::Id yRange = 1 + maxBound[1] - minBound[1];
vtkm::Id xRange = 1 + maxBound[0] - minBound[0];
vtkm::Id divisor = yRange * xRange;
vtkm::Id i = localNeighborId / divisor;
vtkm::Id remainder = localNeighborId % divisor;
vtkm::Id j = remainder / xRange;
vtkm::Id k = remainder % xRange;
// note the order of k,j,i
vtkm::Id3 voxel = minBound + vtkm::make_Vec(k, j, i);
PointType dist = vtkm::make_Vec((splatPoint[0] - voxel[0]) * spacing_[0],
(splatPoint[1] - voxel[1]) * spacing_[0],
(splatPoint[2] - voxel[2]) * spacing_[0]);
vtkm::Float64 dist2 = vtkm::Dot(dist, dist);
// Compute splat value using the kernel distance_squared function
splatValue = scale * kernel.w2(kernel_H, dist2);
//
neighborVoxelId =
(voxel[2] * VolumeDim[0] * VolumeDim[1]) + (voxel[1] * VolumeDim[0]) + voxel[0];
if (neighborVoxelId < 0)
neighborVoxelId = -1;
else if (neighborVoxelId >= VolumeDim[0] * VolumeDim[1] * VolumeDim[2])
neighborVoxelId = VolumeDim[0] * VolumeDim[1] * VolumeDim[2] - 1;
}
};
//-----------------------------------------------------------------------
// Scatter worklet that writes a splat value into the larger,
// master splat value array, using the splat value's voxel Id as an index.
//-----------------------------------------------------------------------
class UpdateVoxelSplats : public vtkm::worklet::WorkletMapField
{
public:
using ControlSignature = void(FieldIn, FieldIn, WholeArrayOut);
using ExecutionSignature = void(_1, _2, _3);
VTKM_CONT
UpdateVoxelSplats() {}
template <typename ExecArgPortalType>
VTKM_EXEC_CONT void operator()(const vtkm::Id& voxelIndex,
const vtkm::Float64& splatValue,
ExecArgPortalType& execArg) const
{
execArg.Set(voxelIndex, static_cast<vtkm::Float32>(splatValue));
}
};
//-----------------------------------------------------------------------
// Construct a splatter filter/object
//
// @TODO, get the origin_ and spacing_ from the dataset coordinates
// instead of requiring them to be passed as parameters.
//-----------------------------------------------------------------------
KernelSplatterFilterUniformGrid(const vtkm::Id3& dims,
vtkm::Vec3f origin,
vtkm::Vec3f spacing,
const vtkm::cont::DataSet& dataset,
const Kernel& kernel)
: dims_(dims)
, origin_(origin)
, spacing_(spacing)
, dataset_(dataset)
, kernel_(kernel)
{
}
//-----------------------------------------------------------------------
// class variables for the splat filter
//-----------------------------------------------------------------------
vtkm::Id3 dims_;
FloatVec origin_;
FloatVec spacing_;
vtkm::cont::DataSet dataset_;
// The kernel used for this filter
Kernel kernel_;
//-----------------------------------------------------------------------
// Run the filter, given the input params
//-----------------------------------------------------------------------
template <typename StorageT>
void run(const vtkm::cont::ArrayHandle<vtkm::Float64, StorageT> xValues,
const vtkm::cont::ArrayHandle<vtkm::Float64, StorageT> yValues,
const vtkm::cont::ArrayHandle<vtkm::Float64, StorageT> zValues,
const vtkm::cont::ArrayHandle<vtkm::Float32, StorageT> rValues,
const vtkm::cont::ArrayHandle<vtkm::Float32, StorageT> sValues,
FloatHandleType scalarSplatOutput)
{
// Number of grid points in the volume bounding box
vtkm::Id3 pointDimensions = vtkm::make_Vec(dims_[0] + 1, dims_[1] + 1, dims_[2] + 1);
const vtkm::Id numVolumePoints = (dims_[0] + 1) * (dims_[1] + 1) * (dims_[2] + 1);
//---------------------------------------------------------------
// Get the splat footprint/neighborhood of each sample point, as
// represented by min and max boundaries in each dimension.
//---------------------------------------------------------------
PointHandleType splatPoints;
VecHandleType footprintMin;
VecHandleType footprintMax;
IdHandleType numNeighbors;
IdHandleType localNeighborIds;
GetFootprint footprint_worklet(origin_, spacing_, pointDimensions, kernel_);
vtkm::worklet::DispatcherMapField<GetFootprint> footprintDispatcher(footprint_worklet);
footprintDispatcher.SetDevice(DeviceAdapter());
START_TIMER_BLOCK(GetFootprint)
footprintDispatcher.Invoke(
xValues, yValues, zValues, rValues, splatPoints, footprintMin, footprintMax, numNeighbors);
END_TIMER_BLOCK(GetFootprint)
debug::OutputArrayDebug(numNeighbors, "numNeighbours");
debug::OutputArrayDebug(footprintMin, "footprintMin");
debug::OutputArrayDebug(footprintMax, "footprintMax");
debug::OutputArrayDebug(splatPoints, "splatPoints");
//---------------------------------------------------------------
// Prefix sum of the number of affected splat voxels ("neighbors")
// for each sample point. The total sum represents the number of
// voxels for which splat values will be computed.
// prefix sum is used in neighbour id lookup
//---------------------------------------------------------------
IdHandleType numNeighborsPrefixSum;
START_TIMER_BLOCK(numNeighborsPrefixSum)
const vtkm::Id totalSplatSize =
vtkm::cont::DeviceAdapterAlgorithm<DeviceAdapter>::ScanInclusive(numNeighbors,
numNeighborsPrefixSum);
END_TIMER_BLOCK(numNeighborsPrefixSum)
std::cout << "totalSplatSize " << totalSplatSize << "\n";
debug::OutputArrayDebug(numNeighborsPrefixSum, "numNeighborsPrefixSum");
// also get the neighbour counts exclusive sum for use in lookup of local neighbour id
IdHandleType numNeighborsExclusiveSum;
START_TIMER_BLOCK(numNeighborsExclusiveSum)
vtkm::cont::DeviceAdapterAlgorithm<DeviceAdapter>::ScanExclusive(numNeighbors,
numNeighborsExclusiveSum);
//END_TIMER_BLOCK(numNeighborsExclusiveSum)
debug::OutputArrayDebug(numNeighborsExclusiveSum, "numNeighborsExclusiveSum");
//---------------------------------------------------------------
// Generate a lookup array that, for each splat voxel, identifies
// the Id of its corresponding (sample) splat point.
// For example, if splat point 0 affects 5 neighbor voxels, then
// the five entries in the lookup array would be 0,0,0,0,0
//---------------------------------------------------------------
IdHandleType neighbor2SplatId;
IdCountingType countingArray(vtkm::Id(0), 1, vtkm::Id(totalSplatSize));
START_TIMER_BLOCK(Upper_bounds)
vtkm::cont::DeviceAdapterAlgorithm<DeviceAdapter>::UpperBounds(
numNeighborsPrefixSum, countingArray, neighbor2SplatId);
END_TIMER_BLOCK(Upper_bounds)
countingArray.ReleaseResources();
debug::OutputArrayDebug(neighbor2SplatId, "neighbor2SplatId");
//---------------------------------------------------------------
// Extract a "local" Id lookup array of the foregoing
// neighbor2SplatId array. So, the local version of 0,0,0,0,0
// would be 0,1,2,3,4
//---------------------------------------------------------------
IdPermType modulii(neighbor2SplatId, numNeighbors);
debug::OutputArrayDebug(modulii, "modulii");
IdPermType offsets(neighbor2SplatId, numNeighborsExclusiveSum);
debug::OutputArrayDebug(offsets, "offsets");
vtkm::worklet::DispatcherMapField<ComputeLocalNeighborId> idDispatcher;
idDispatcher.SetDevice(DeviceAdapter());
START_TIMER_BLOCK(idDispatcher)
idDispatcher.Invoke(modulii, offsets, localNeighborIds);
END_TIMER_BLOCK(idDispatcher)
debug::OutputArrayDebug(localNeighborIds, "localNeighborIds");
numNeighbors.ReleaseResources();
numNeighborsPrefixSum.ReleaseResources();
numNeighborsExclusiveSum.ReleaseResources();
//---------------------------------------------------------------
// We will perform gather operations for the generated splat points
// using permutation arrays
//---------------------------------------------------------------
PointVecPermType ptSplatPoints(neighbor2SplatId, splatPoints);
VecPermType ptFootprintMins(neighbor2SplatId, footprintMin);
VecPermType ptFootprintMaxs(neighbor2SplatId, footprintMax);
FloatPermType radii(neighbor2SplatId, rValues);
FloatPermType scale(neighbor2SplatId, sValues);
debug::OutputArrayDebug(radii, "radii");
debug::OutputArrayDebug(ptSplatPoints, "ptSplatPoints");
debug::OutputArrayDebug(ptFootprintMins, "ptFootprintMins");
//---------------------------------------------------------------
// Calculate the splat value of each affected voxel
//---------------------------------------------------------------
FloatHandleType voxelSplatSums;
IdHandleType neighborVoxelIds;
IdHandleType uniqueVoxelIds;
FloatHandleType splatValues;
GetSplatValue splatterDispatcher_worklet(origin_, spacing_, pointDimensions, kernel_);
vtkm::worklet::DispatcherMapField<GetSplatValue> splatterDispatcher(splatterDispatcher_worklet);
splatterDispatcher.SetDevice(DeviceAdapter());
START_TIMER_BLOCK(GetSplatValue)
splatterDispatcher.Invoke(ptSplatPoints,
ptFootprintMins,
ptFootprintMaxs,
radii,
scale,
localNeighborIds,
neighborVoxelIds,
splatValues);
END_TIMER_BLOCK(GetSplatValue)
debug::OutputArrayDebug(splatValues, "splatValues");
debug::OutputArrayDebug(neighborVoxelIds, "neighborVoxelIds");
ptSplatPoints.ReleaseResources();
ptFootprintMins.ReleaseResources();
ptFootprintMaxs.ReleaseResources();
neighbor2SplatId.ReleaseResources();
localNeighborIds.ReleaseResources();
splatPoints.ReleaseResources();
footprintMin.ReleaseResources();
footprintMax.ReleaseResources();
radii.ReleaseResources();
//---------------------------------------------------------------
// Sort the voxel Ids in ascending order
//---------------------------------------------------------------
START_TIMER_BLOCK(SortByKey)
vtkm::cont::DeviceAdapterAlgorithm<DeviceAdapter>::SortByKey(neighborVoxelIds, splatValues);
END_TIMER_BLOCK(SortByKey)
debug::OutputArrayDebug(splatValues, "splatValues");
//---------------------------------------------------------------
// Do a reduction to sum all contributions for each affected voxel
//---------------------------------------------------------------
START_TIMER_BLOCK(ReduceByKey)
vtkm::cont::DeviceAdapterAlgorithm<DeviceAdapter>::ReduceByKey(
neighborVoxelIds, splatValues, uniqueVoxelIds, voxelSplatSums, vtkm::Add());
END_TIMER_BLOCK(ReduceByKey)
debug::OutputArrayDebug(neighborVoxelIds, "neighborVoxelIds");
debug::OutputArrayDebug(uniqueVoxelIds, "uniqueVoxelIds");
debug::OutputArrayDebug(voxelSplatSums, "voxelSplatSums");
//
neighborVoxelIds.ReleaseResources();
splatValues.ReleaseResources();
//---------------------------------------------------------------
// initialize each field value to zero to begin with
//---------------------------------------------------------------
IdCountingType indexArray(vtkm::Id(0), 1, numVolumePoints);
vtkm::worklet::DispatcherMapField<zero_voxel> zeroDispatcher;
zeroDispatcher.SetDevice(DeviceAdapter());
zeroDispatcher.Invoke(indexArray, scalarSplatOutput);
//
indexArray.ReleaseResources();
//---------------------------------------------------------------
// Scatter operation to write the previously-computed splat
// value sums into their corresponding entries in the output array
//---------------------------------------------------------------
vtkm::worklet::DispatcherMapField<UpdateVoxelSplats> scatterDispatcher;
scatterDispatcher.SetDevice(DeviceAdapter());
START_TIMER_BLOCK(UpdateVoxelSplats)
scatterDispatcher.Invoke(uniqueVoxelIds, voxelSplatSums, scalarSplatOutput);
END_TIMER_BLOCK(UpdateVoxelSplats)
debug::OutputArrayDebug(scalarSplatOutput, "scalarSplatOutput");
//
uniqueVoxelIds.ReleaseResources();
voxelSplatSums.ReleaseResources();
}
}; //struct KernelSplatter
}
} //namespace vtkm::worklet
#endif //vtk_m_worklet_KernelSplatter_h