vtk-m/vtkm/worklet/ExtractStructured.h
Kenneth Moreland 4d8f05baef Update CellSetExtrude to not specify exec types by device
Somewhere during this edit I removed a header file that didn't strictly
need to be there. This caused me to have to add

```cpp
```

in several places in the code.
2021-02-08 16:57:16 -07:00

562 lines
20 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_ExtractStructured_h
#define vtk_m_worklet_ExtractStructured_h
#include <vtkm/RangeId3.h>
#include <vtkm/cont/ArrayCopy.h>
#include <vtkm/cont/ArrayGetValues.h>
#include <vtkm/cont/ArrayHandle.h>
#include <vtkm/cont/ArrayHandleCartesianProduct.h>
#include <vtkm/cont/ArrayHandleCounting.h>
#include <vtkm/cont/ArrayHandleImplicit.h>
#include <vtkm/cont/ArrayHandlePermutation.h>
#include <vtkm/cont/ArrayHandleTransform.h>
#include <vtkm/cont/ArrayHandleUniformPointCoordinates.h>
#include <vtkm/cont/CellSetList.h>
#include <vtkm/cont/CellSetStructured.h>
#include <vtkm/cont/CoordinateSystem.h>
#include <vtkm/cont/DynamicCellSet.h>
#include <vtkm/cont/UnknownArrayHandle.h>
#include <vtkm/worklet/WorkletMapField.h>
namespace vtkm
{
namespace worklet
{
namespace extractstructured
{
namespace internal
{
class SubArrayPermutePoints
{
public:
SubArrayPermutePoints() = default;
SubArrayPermutePoints(vtkm::Id size,
vtkm::Id first,
vtkm::Id last,
vtkm::Id stride,
bool includeBoundary)
: MaxIdx(size - 1)
, First(first)
, Last(last)
, Stride(stride)
, IncludeBoundary(includeBoundary)
{
}
VTKM_EXEC_CONT
vtkm::Id operator()(vtkm::Id idx) const
{
return (this->IncludeBoundary && (idx == this->MaxIdx)) ? (this->Last)
: (this->First + (idx * this->Stride));
}
private:
vtkm::Id MaxIdx;
vtkm::Id First, Last;
vtkm::Id Stride;
bool IncludeBoundary;
};
struct ExtractCopy : public vtkm::worklet::WorkletMapField
{
using ControlSignature = void(FieldIn, FieldOut, WholeArrayIn);
ExtractCopy(const vtkm::Id3& dim)
: XDim(dim[0])
, XYDim(dim[0] * dim[1])
{
}
VTKM_EXEC_CONT
inline vtkm::Id ToFlat(const vtkm::Id3& index) const
{
return index[0] + index[1] * this->XDim + index[2] * this->XYDim;
}
template <typename ScalarType, typename WholeFieldIn>
VTKM_EXEC void operator()(vtkm::Id3& index,
ScalarType& output,
const WholeFieldIn& inputField) const
{
output = inputField.Get(this->ToFlat(index));
}
vtkm::Id XDim;
vtkm::Id XYDim;
};
}
} // extractstructured::internal
class ExtractStructured
{
public:
using DynamicCellSetStructured =
vtkm::cont::DynamicCellSetBase<vtkm::cont::CellSetListStructured>;
private:
using AxisIndexArrayPoints =
vtkm::cont::ArrayHandleImplicit<extractstructured::internal::SubArrayPermutePoints>;
using PointIndexArray = vtkm::cont::
ArrayHandleCartesianProduct<AxisIndexArrayPoints, AxisIndexArrayPoints, AxisIndexArrayPoints>;
using AxisIndexArrayCells = vtkm::cont::ArrayHandleCounting<vtkm::Id>;
using CellIndexArray = vtkm::cont::
ArrayHandleCartesianProduct<AxisIndexArrayCells, AxisIndexArrayCells, AxisIndexArrayCells>;
inline AxisIndexArrayPoints MakeAxisIndexArrayPoints(vtkm::Id count,
vtkm::Id first,
vtkm::Id last,
vtkm::Id stride,
bool includeBoundary)
{
auto fnctr = extractstructured::internal::SubArrayPermutePoints(
count, first, last, stride, includeBoundary);
return vtkm::cont::make_ArrayHandleImplicit(fnctr, count);
}
inline AxisIndexArrayCells MakeAxisIndexArrayCells(vtkm::Id count,
vtkm::Id start,
vtkm::Id stride)
{
return vtkm::cont::make_ArrayHandleCounting(start, stride, count);
}
DynamicCellSetStructured MakeCellSetStructured(const vtkm::Id3& inputPointDims,
const vtkm::Id3& inputOffsets,
vtkm::IdComponent forcedDimensionality = 0)
{
// when the point dimension for a given axis is 1 we
// need to lower the dimensonality by 1. So a Plane
// in XZ space would have a dimensonality of 2.
// likewise the global offsets need to also
// be updated when this occurs
vtkm::IdComponent dimensionality = forcedDimensionality;
vtkm::Id3 dimensions = inputPointDims;
vtkm::Id3 offset = inputOffsets;
for (int i = 0; i < 3 && (forcedDimensionality == 0); ++i)
{
if (inputPointDims[i] > 1)
{
dimensions[dimensionality] = inputPointDims[i];
offset[dimensionality] = inputOffsets[i];
++dimensionality;
}
}
switch (dimensionality)
{
case 1:
{
vtkm::cont::CellSetStructured<1> outCs;
outCs.SetPointDimensions(dimensions[0]);
outCs.SetGlobalPointIndexStart(offset[0]);
return outCs;
}
case 2:
{
vtkm::cont::CellSetStructured<2> outCs;
outCs.SetPointDimensions(vtkm::Id2(dimensions[0], dimensions[1]));
outCs.SetGlobalPointIndexStart(vtkm::Id2(offset[0], offset[1]));
return outCs;
}
case 3:
{
vtkm::cont::CellSetStructured<3> outCs;
outCs.SetPointDimensions(dimensions);
outCs.SetGlobalPointIndexStart(offset);
return outCs;
}
default:
return DynamicCellSetStructured();
}
}
public:
inline DynamicCellSetStructured Run(const vtkm::cont::CellSetStructured<1>& cellset,
const vtkm::RangeId3& voi,
const vtkm::Id3& sampleRate,
bool includeBoundary,
bool includeOffset)
{
vtkm::Id pdims = cellset.GetPointDimensions();
vtkm::Id offsets = cellset.GetGlobalPointIndexStart();
return this->Compute(1,
vtkm::Id3{ pdims, 1, 1 },
vtkm::Id3{ offsets, 0, 0 },
voi,
sampleRate,
includeBoundary,
includeOffset);
}
inline DynamicCellSetStructured Run(const vtkm::cont::CellSetStructured<2>& cellset,
const vtkm::RangeId3& voi,
const vtkm::Id3& sampleRate,
bool includeBoundary,
bool includeOffset)
{
vtkm::Id2 pdims = cellset.GetPointDimensions();
vtkm::Id2 offsets = cellset.GetGlobalPointIndexStart();
return this->Compute(2,
vtkm::Id3{ pdims[0], pdims[1], 1 },
vtkm::Id3{ offsets[0], offsets[1], 0 },
voi,
sampleRate,
includeBoundary,
includeOffset);
}
inline DynamicCellSetStructured Run(const vtkm::cont::CellSetStructured<3>& cellset,
const vtkm::RangeId3& voi,
const vtkm::Id3& sampleRate,
bool includeBoundary,
bool includeOffset)
{
vtkm::Id3 pdims = cellset.GetPointDimensions();
vtkm::Id3 offsets = cellset.GetGlobalPointIndexStart();
return this->Compute(3, pdims, offsets, voi, sampleRate, includeBoundary, includeOffset);
}
DynamicCellSetStructured Compute(const int dimensionality,
const vtkm::Id3& ptdim,
const vtkm::Id3& offsets,
const vtkm::RangeId3& voi,
const vtkm::Id3& sampleRate,
bool includeBoundary,
bool includeOffset)
{
// Verify input parameters
vtkm::Id3 offset_vec(0, 0, 0);
vtkm::Id3 globalOffset(0, 0, 0);
this->InputDimensions = ptdim;
this->InputDimensionality = dimensionality;
this->SampleRate = sampleRate;
if (sampleRate[0] < 1 || sampleRate[1] < 1 || sampleRate[2] < 1)
{
throw vtkm::cont::ErrorBadValue("Bad sampling rate");
}
if (includeOffset)
{
vtkm::Id3 tmpDims = ptdim;
offset_vec = offsets;
for (int i = 0; i < dimensionality; ++i)
{
if (dimensionality > i)
{
if (offset_vec[i] >= voi[i].Min)
{
globalOffset[i] = offset_vec[i];
this->VOI[i].Min = offset_vec[i];
if (globalOffset[i] + ptdim[i] < voi[i].Max)
{
// Start from our GPIS (start point) up to the length of the
// dimensions (if that is within VOI)
this->VOI[i].Max = globalOffset[i] + ptdim[i];
}
else
{
// If it isn't within the voi we set our dimensions from the
// GPIS up to the VOI.
tmpDims[i] = voi[i].Max - globalOffset[i];
}
}
else if (offset_vec[i] < voi[i].Min)
{
if (offset_vec[i] + ptdim[i] < voi[i].Min)
{
// If we're out of bounds we set the dimensions to 0. This
// causes a return of DynamicCellSetStructured
tmpDims[i] = 0;
}
else
{
// If our GPIS is less than VOI min, but our dimensions
// include the VOI we go from the minimal value that we
// can up to how far has been specified.
globalOffset[i] = voi[i].Min;
this->VOI[i].Min = voi[i].Min;
if (globalOffset[i] + ptdim[i] < voi[i].Max)
{
this->VOI[i].Max = globalOffset[i] + ptdim[i];
}
else
{
tmpDims[i] = voi[i].Max - globalOffset[i];
}
}
}
}
}
this->OutputDimensions = vtkm::Id3(tmpDims[0], tmpDims[1], tmpDims[2]);
}
this->VOI.X.Min = vtkm::Max(vtkm::Id(0), voi.X.Min);
this->VOI.X.Max = vtkm::Min(this->InputDimensions[0] + globalOffset[0], voi.X.Max);
this->VOI.Y.Min = vtkm::Max(vtkm::Id(0), voi.Y.Min);
this->VOI.Y.Max = vtkm::Min(this->InputDimensions[1] + globalOffset[1], voi.Y.Max);
this->VOI.Z.Min = vtkm::Max(vtkm::Id(0), voi.Z.Min);
this->VOI.Z.Max = vtkm::Min(this->InputDimensions[2] + globalOffset[2], voi.Z.Max);
if (!this->VOI.IsNonEmpty())
{
vtkm::Id3 empty = { 0, 0, 0 };
return MakeCellSetStructured(empty, empty, dimensionality);
}
if (!includeOffset)
{
// compute output dimensions
this->OutputDimensions = vtkm::Id3(1, 1, 1);
vtkm::Id3 voiDims = this->VOI.Dimensions();
for (int i = 0; i < dimensionality; ++i)
{
this->OutputDimensions[i] = ((voiDims[i] + this->SampleRate[i] - 1) / this->SampleRate[i]) +
((includeBoundary && ((voiDims[i] - 1) % this->SampleRate[i])) ? 1 : 0);
}
this->ValidPoints = vtkm::cont::make_ArrayHandleCartesianProduct(
MakeAxisIndexArrayPoints(this->OutputDimensions[0],
this->VOI.X.Min,
this->VOI.X.Max - 1,
this->SampleRate[0],
includeBoundary),
MakeAxisIndexArrayPoints(this->OutputDimensions[1],
this->VOI.Y.Min,
this->VOI.Y.Max - 1,
this->SampleRate[1],
includeBoundary),
MakeAxisIndexArrayPoints(this->OutputDimensions[2],
this->VOI.Z.Min,
this->VOI.Z.Max - 1,
this->SampleRate[2],
includeBoundary));
this->ValidCells = vtkm::cont::make_ArrayHandleCartesianProduct(
MakeAxisIndexArrayCells(vtkm::Max(vtkm::Id(1), this->OutputDimensions[0] - 1),
this->VOI.X.Min,
this->SampleRate[0]),
MakeAxisIndexArrayCells(vtkm::Max(vtkm::Id(1), this->OutputDimensions[1] - 1),
this->VOI.Y.Min,
this->SampleRate[1]),
MakeAxisIndexArrayCells(vtkm::Max(vtkm::Id(1), this->OutputDimensions[2] - 1),
this->VOI.Z.Min,
this->SampleRate[2]));
}
return MakeCellSetStructured(this->OutputDimensions, globalOffset);
}
private:
class CallRun
{
public:
CallRun(ExtractStructured* worklet,
const vtkm::RangeId3& voi,
const vtkm::Id3& sampleRate,
bool includeBoundary,
bool includeOffset,
DynamicCellSetStructured& output)
: Worklet(worklet)
, VOI(&voi)
, SampleRate(&sampleRate)
, IncludeBoundary(includeBoundary)
, IncludeOffset(includeOffset)
, Output(&output)
{
}
template <int N>
void operator()(const vtkm::cont::CellSetStructured<N>& cellset) const
{
*this->Output = this->Worklet->Run(
cellset, *this->VOI, *this->SampleRate, this->IncludeBoundary, this->IncludeOffset);
}
template <typename CellSetType>
void operator()(const CellSetType&) const
{
throw vtkm::cont::ErrorBadType("ExtractStructured only works with structured datasets");
}
private:
ExtractStructured* Worklet;
const vtkm::RangeId3* VOI;
const vtkm::Id3* SampleRate;
bool IncludeBoundary;
bool IncludeOffset;
DynamicCellSetStructured* Output;
};
public:
template <typename CellSetList>
DynamicCellSetStructured Run(const vtkm::cont::DynamicCellSetBase<CellSetList>& cellset,
const vtkm::RangeId3& voi,
const vtkm::Id3& sampleRate,
bool includeBoundary,
bool includeOffset)
{
DynamicCellSetStructured output;
CallRun cr(this, voi, sampleRate, includeBoundary, includeOffset, output);
vtkm::cont::CastAndCall(cellset, cr);
return output;
}
private:
using UniformCoordinatesArrayHandle = vtkm::cont::ArrayHandleUniformPointCoordinates;
using RectilinearCoordinatesArrayHandle =
vtkm::cont::ArrayHandleCartesianProduct<vtkm::cont::ArrayHandle<vtkm::FloatDefault>,
vtkm::cont::ArrayHandle<vtkm::FloatDefault>,
vtkm::cont::ArrayHandle<vtkm::FloatDefault>>;
UniformCoordinatesArrayHandle MapCoordinatesUniform(const UniformCoordinatesArrayHandle& coords)
{
using CoordsArray = vtkm::cont::ArrayHandleUniformPointCoordinates;
using CoordType = CoordsArray::ValueType;
using ValueType = CoordType::ComponentType;
const auto& portal = coords.ReadPortal();
CoordType inOrigin = portal.GetOrigin();
CoordType inSpacing = portal.GetSpacing();
CoordType outOrigin =
vtkm::make_Vec(inOrigin[0] + static_cast<ValueType>(this->VOI.X.Min) * inSpacing[0],
inOrigin[1] + static_cast<ValueType>(this->VOI.Y.Min) * inSpacing[1],
inOrigin[2] + static_cast<ValueType>(this->VOI.Z.Min) * inSpacing[2]);
CoordType outSpacing = inSpacing * static_cast<CoordType>(this->SampleRate);
return CoordsArray(this->OutputDimensions, outOrigin, outSpacing);
}
RectilinearCoordinatesArrayHandle MapCoordinatesRectilinear(
const RectilinearCoordinatesArrayHandle& coords)
{
// For structured datasets, the cellsets are of different types based on
// its dimensionality, but the coordinates are always 3 dimensional.
// We can map the axis of the cellset to the coordinates by looking at the
// length of a coordinate axis array.
AxisIndexArrayPoints validIds[3] = { this->ValidPoints.GetFirstArray(),
this->ValidPoints.GetSecondArray(),
this->ValidPoints.GetThirdArray() };
vtkm::cont::ArrayHandle<vtkm::FloatDefault> arrays[3] = { coords.GetFirstArray(),
coords.GetSecondArray(),
coords.GetThirdArray() };
vtkm::cont::ArrayHandle<vtkm::FloatDefault> xyzs[3];
int dim = 0;
for (int i = 0; i < 3; ++i)
{
if (arrays[i].GetNumberOfValues() == 1)
{
xyzs[i].Allocate(1);
xyzs[i].WritePortal().Set(0, vtkm::cont::ArrayGetValue(0, arrays[i]));
}
else
{
vtkm::cont::ArrayCopy(vtkm::cont::make_ArrayHandlePermutation(validIds[i], arrays[i]),
xyzs[i]);
++dim;
}
}
VTKM_ASSERT(dim == this->InputDimensionality);
return vtkm::cont::make_ArrayHandleCartesianProduct(xyzs[0], xyzs[1], xyzs[2]);
}
struct MapCoordinatesFunctor
{
template <typename T, typename S>
VTKM_CONT void operator()(const vtkm::cont::ArrayHandle<T, S>& coords,
ExtractStructured& self,
vtkm::cont::UnknownArrayHandle& output) const
{
output = self.ProcessPointField(coords);
}
VTKM_CONT void operator()(const UniformCoordinatesArrayHandle::Superclass& coords,
ExtractStructured& self,
vtkm::cont::UnknownArrayHandle& output) const
{
output = self.MapCoordinatesUniform(coords);
}
VTKM_CONT void operator()(const RectilinearCoordinatesArrayHandle::Superclass& coords,
ExtractStructured& self,
vtkm::cont::UnknownArrayHandle& output) const
{
output = self.MapCoordinatesRectilinear(coords);
}
};
friend MapCoordinatesFunctor;
public:
vtkm::cont::UnknownArrayHandle MapCoordinates(const vtkm::cont::CoordinateSystem& coordinates)
{
vtkm::cont::UnknownArrayHandle output;
vtkm::cont::CastAndCall(coordinates, MapCoordinatesFunctor{}, *this, output);
return output;
}
public:
template <typename T, typename Storage>
vtkm::cont::ArrayHandle<T> ProcessPointField(
const vtkm::cont::ArrayHandle<T, Storage>& field) const
{
using namespace extractstructured::internal;
vtkm::cont::ArrayHandle<T> result;
result.Allocate(this->ValidPoints.GetNumberOfValues());
ExtractCopy worklet(this->InputDimensions);
DispatcherMapField<ExtractCopy> dispatcher(worklet);
dispatcher.Invoke(this->ValidPoints, result, field);
return result;
}
template <typename T, typename Storage>
vtkm::cont::ArrayHandle<T> ProcessCellField(
const vtkm::cont::ArrayHandle<T, Storage>& field) const
{
using namespace extractstructured::internal;
vtkm::cont::ArrayHandle<T> result;
result.Allocate(this->ValidCells.GetNumberOfValues());
auto inputCellDimensions = this->InputDimensions - vtkm::Id3(1);
ExtractCopy worklet(inputCellDimensions);
DispatcherMapField<ExtractCopy> dispatcher(worklet);
dispatcher.Invoke(this->ValidCells, result, field);
return result;
}
private:
vtkm::RangeId3 VOI;
vtkm::Id3 SampleRate = { 1, 1, 1 };
int InputDimensionality;
vtkm::Id3 InputDimensions;
vtkm::Id3 OutputDimensions;
PointIndexArray ValidPoints;
CellIndexArray ValidCells;
};
}
} // namespace vtkm::worklet
#endif // vtk_m_worklet_ExtractStructured_h