vtk-m/vtkm/filter/testing/UnitTestProbe.cxx
Kenneth Moreland 7be44c847f Enable setting invalid value in probe filter
Initially, the probe filter would simply not set a value if a sample was
outside the input `DataSet`. This is not great as the memory could be
left uninitalized and lead to unpredictable results. The testing
compared these invalid results to 0, which seemed to work but is
probably unstable.

This was partially fixed by a previous change that consolidated to
mapping of cell data with a general routine that permuted data. However,
the fix did not extend to point data in the input, and it was not
possible to specify a particular invalid value.

This change specifically updates the probe filter so that invalid values
are set to a user-specified value.
2020-06-03 15:29:37 -06:00

230 lines
9.3 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.
//============================================================================
#include <vtkm/filter/Probe.h>
#include <vtkm/cont/ArrayCopy.h>
#include <vtkm/cont/DataSetBuilderUniform.h>
#include <vtkm/cont/testing/Testing.h>
#include <vtkm/worklet/CellDeepCopy.h>
namespace
{
vtkm::cont::DataSet MakeInputDataSet()
{
std::vector<vtkm::Float32> pvec(16), cvec(9);
for (std::size_t i = 0; i < 16; ++i)
{
pvec[i] = static_cast<vtkm::Float32>(i) * 0.3f;
}
for (std::size_t i = 0; i < 9; ++i)
{
cvec[i] = static_cast<vtkm::Float32>(i) * 0.7f;
}
auto input = vtkm::cont::DataSetBuilderUniform::Create(
vtkm::Id2(4, 4), vtkm::make_Vec(0.0f, 0.0f), vtkm::make_Vec(1.0f, 1.0f));
input.AddPointField("pointdata", pvec);
input.AddCellField("celldata", cvec);
return input;
}
vtkm::cont::DataSet MakeGeometryDataSet()
{
auto geometry = vtkm::cont::DataSetBuilderUniform::Create(
vtkm::Id2(9, 9), vtkm::make_Vec(0.7f, 0.7f), vtkm::make_Vec(0.35f, 0.35f));
return geometry;
}
vtkm::cont::DataSet ConvertDataSetUniformToExplicit(const vtkm::cont::DataSet& uds)
{
vtkm::cont::DataSet eds;
vtkm::cont::CellSetExplicit<> cs;
vtkm::worklet::CellDeepCopy::Run(uds.GetCellSet(), cs);
eds.SetCellSet(cs);
vtkm::cont::ArrayHandle<vtkm::Vec3f> points;
vtkm::cont::ArrayCopy(uds.GetCoordinateSystem().GetData(), points);
eds.AddCoordinateSystem(
vtkm::cont::CoordinateSystem(uds.GetCoordinateSystem().GetName(), points));
for (vtkm::IdComponent i = 0; i < uds.GetNumberOfFields(); ++i)
{
eds.AddField(uds.GetField(i));
}
return eds;
}
const std::vector<vtkm::Float32>& GetExpectedPointData()
{
static std::vector<vtkm::Float32> expected = {
1.05f, 1.155f, 1.26f, 1.365f, 1.47f, 1.575f,
1.68f, vtkm::Nan32(), vtkm::Nan32(), 1.47f, 1.575f, 1.68f,
1.785f, 1.89f, 1.995f, 2.1f, vtkm::Nan32(), vtkm::Nan32(),
1.89f, 1.995f, 2.1f, 2.205f, 2.31f, 2.415f,
2.52f, vtkm::Nan32(), vtkm::Nan32(), 2.31f, 2.415f, 2.52f,
2.625f, 2.73f, 2.835f, 2.94f, vtkm::Nan32(), vtkm::Nan32(),
2.73f, 2.835f, 2.94f, 3.045f, 3.15f, 3.255f,
3.36f, vtkm::Nan32(), vtkm::Nan32(), 3.15f, 3.255f, 3.36f,
3.465f, 3.57f, 3.675f, 3.78f, vtkm::Nan32(), vtkm::Nan32(),
3.57f, 3.675f, 3.78f, 3.885f, 3.99f, 4.095f,
4.2f, vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(),
vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(),
vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(),
vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32()
};
return expected;
}
const std::vector<vtkm::Float32>& GetExpectedCellData()
{
static std::vector<vtkm::Float32> expected = {
0.0f, 0.7f, 0.7f, 0.7f, 1.4f, 1.4f,
1.4f, vtkm::Nan32(), vtkm::Nan32(), 2.1f, 2.8f, 2.8f,
2.8f, 3.5f, 3.5f, 3.5f, vtkm::Nan32(), vtkm::Nan32(),
2.1f, 2.8f, 2.8f, 2.8f, 3.5f, 3.5f,
3.5f, vtkm::Nan32(), vtkm::Nan32(), 2.1f, 2.8f, 2.8f,
2.8f, 3.5f, 3.5f, 3.5f, vtkm::Nan32(), vtkm::Nan32(),
4.2f, 4.9f, 4.9f, 4.9f, 5.6f, 5.6f,
5.6f, vtkm::Nan32(), vtkm::Nan32(), 4.2f, 4.9f, 4.9f,
4.9f, 5.6f, 5.6f, 5.6f, vtkm::Nan32(), vtkm::Nan32(),
4.2f, 4.9f, 4.9f, 4.9f, 5.6f, 5.6f,
5.6f, vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(),
vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(),
vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32(),
vtkm::Nan32(), vtkm::Nan32(), vtkm::Nan32()
};
return expected;
}
const std::vector<vtkm::UInt8>& GetExpectedHiddenPoints()
{
static std::vector<vtkm::UInt8> expected = { 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 0, 0, 0, 0, 0, 0, 2,
2, 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 0, 0, 0, 0, 0, 0,
2, 2, 0, 0, 0, 0, 0, 0, 0, 2, 2, 0, 0, 0, 0, 0, 0,
0, 2, 2, 0, 0, 0, 0, 0, 0, 0, 2, 2, 2, 2, 2, 2, 2,
2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 };
return expected;
}
const std::vector<vtkm::UInt8>& GetExpectedHiddenCells()
{
static std::vector<vtkm::UInt8> expected = { 0, 0, 0, 0, 0, 0, 2, 2, 0, 0, 0, 0, 0, 0, 2, 2,
0, 0, 0, 0, 0, 0, 2, 2, 0, 0, 0, 0, 0, 0, 2, 2,
0, 0, 0, 0, 0, 0, 2, 2, 0, 0, 0, 0, 0, 0, 2, 2,
2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 };
return expected;
}
template <typename T>
void TestResultArray(const vtkm::cont::ArrayHandle<T>& result, const std::vector<T>& expected)
{
VTKM_TEST_ASSERT(result.GetNumberOfValues() == static_cast<vtkm::Id>(expected.size()),
"Incorrect field size");
auto portal = result.ReadPortal();
vtkm::Id size = portal.GetNumberOfValues();
for (vtkm::Id i = 0; i < size; ++i)
{
VTKM_TEST_ASSERT(test_equal(portal.Get(i), expected[static_cast<std::size_t>(i)]),
"Incorrect field value");
}
}
class TestProbe
{
private:
using FieldArrayType = vtkm::cont::ArrayHandle<vtkm::Float32>;
using HiddenArrayType = vtkm::cont::ArrayHandle<vtkm::UInt8>;
static void ExplicitToUnifrom()
{
std::cout << "Testing Probe Explicit to Uniform:\n";
auto input = ConvertDataSetUniformToExplicit(MakeInputDataSet());
auto geometry = MakeGeometryDataSet();
vtkm::filter::Probe probe;
probe.SetGeometry(geometry);
probe.SetFieldsToPass({ "pointdata", "celldata" });
auto output = probe.Execute(input);
TestResultArray(vtkm::cont::Cast<FieldArrayType>(output.GetField("pointdata").GetData()),
GetExpectedPointData());
TestResultArray(vtkm::cont::Cast<FieldArrayType>(output.GetField("celldata").GetData()),
GetExpectedCellData());
TestResultArray(vtkm::cont::Cast<HiddenArrayType>(output.GetPointField("HIDDEN").GetData()),
GetExpectedHiddenPoints());
TestResultArray(vtkm::cont::Cast<HiddenArrayType>(output.GetCellField("HIDDEN").GetData()),
GetExpectedHiddenCells());
}
static void UniformToExplict()
{
std::cout << "Testing Probe Uniform to Explicit:\n";
auto input = MakeInputDataSet();
auto geometry = ConvertDataSetUniformToExplicit(MakeGeometryDataSet());
vtkm::filter::Probe probe;
probe.SetGeometry(geometry);
probe.SetFieldsToPass({ "pointdata", "celldata" });
auto output = probe.Execute(input);
TestResultArray(vtkm::cont::Cast<FieldArrayType>(output.GetField("pointdata").GetData()),
GetExpectedPointData());
TestResultArray(vtkm::cont::Cast<FieldArrayType>(output.GetField("celldata").GetData()),
GetExpectedCellData());
TestResultArray(vtkm::cont::Cast<HiddenArrayType>(output.GetPointField("HIDDEN").GetData()),
GetExpectedHiddenPoints());
TestResultArray(vtkm::cont::Cast<HiddenArrayType>(output.GetCellField("HIDDEN").GetData()),
GetExpectedHiddenCells());
}
static void ExplicitToExplict()
{
std::cout << "Testing Probe Explicit to Explicit:\n";
auto input = ConvertDataSetUniformToExplicit(MakeInputDataSet());
auto geometry = ConvertDataSetUniformToExplicit(MakeGeometryDataSet());
vtkm::filter::Probe probe;
probe.SetGeometry(geometry);
probe.SetFieldsToPass({ "pointdata", "celldata" });
auto output = probe.Execute(input);
TestResultArray(vtkm::cont::Cast<FieldArrayType>(output.GetField("pointdata").GetData()),
GetExpectedPointData());
TestResultArray(vtkm::cont::Cast<FieldArrayType>(output.GetField("celldata").GetData()),
GetExpectedCellData());
TestResultArray(vtkm::cont::Cast<HiddenArrayType>(output.GetPointField("HIDDEN").GetData()),
GetExpectedHiddenPoints());
TestResultArray(vtkm::cont::Cast<HiddenArrayType>(output.GetCellField("HIDDEN").GetData()),
GetExpectedHiddenCells());
}
public:
static void Run()
{
ExplicitToUnifrom();
UniformToExplict();
ExplicitToExplict();
}
};
} // anonymous namespace
int UnitTestProbe(int argc, char* argv[])
{
return vtkm::cont::testing::Testing::Run(TestProbe::Run, argc, argv);
}