worklet/testing/UnitTestScalarsToColors.cxx

//============================================================================
//  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.
//============================================================================

#include <vtkm/cont/testing/Testing.h>
#include <vtkm/worklet/ScalarsToColors.h>

namespace
{

// data we want are valid values between 0 and 1 that represent the fraction
// of the range we want to map into.
std::vector<float> test_values = { 0.0f, 0.125f, 0.25f, 0.5f, 0.625, 0.75f, 1.0f };
std::vector<vtkm::Vec<vtkm::UInt8, 3>> rgb_result = {
  { 0, 0, 0 },       { 32, 32, 32 },    { 64, 64, 64 },    { 128, 128, 128 },
  { 159, 159, 159 }, { 191, 191, 191 }, { 255, 255, 255 },
};

template <typename T>
T as_color(vtkm::Float32 v, vtkm::Float32)
{
  return static_cast<T>(v);
}

template <>
vtkm::UInt8 as_color<vtkm::UInt8>(vtkm::Float32 v, vtkm::Float32)
{
  return static_cast<vtkm::UInt8>(v * 255.0f + 0.5f);
}

template <>
vtkm::Vec<vtkm::Float32, 2> as_color<vtkm::Vec<vtkm::Float32, 2>>(vtkm::Float32 v,
                                                                  vtkm::Float32 alpha)
{ //generate luminance+alpha values
  return vtkm::Vec<vtkm::Float32, 2>(v, alpha);
}
template <>
vtkm::Vec<vtkm::Float64, 2> as_color<vtkm::Vec<vtkm::Float64, 2>>(vtkm::Float32 v,
                                                                  vtkm::Float32 alpha)
{ //generate luminance+alpha values
  return vtkm::Vec<vtkm::Float64, 2>(v, alpha);
}
template <>
vtkm::Vec<vtkm::UInt8, 2> as_color<vtkm::Vec<vtkm::UInt8, 2>>(vtkm::Float32 v, vtkm::Float32 alpha)
{ //generate luminance+alpha values
  return vtkm::Vec<vtkm::UInt8, 2>(static_cast<vtkm::UInt8>(v * 255.0f + 0.5f),
                                   static_cast<vtkm::UInt8>(alpha * 255.0f + 0.5f));
}

template <>
vtkm::Vec<vtkm::UInt8, 3> as_color<vtkm::Vec<vtkm::UInt8, 3>>(vtkm::Float32 v, vtkm::Float32)
{ //vec 3 are always rgb
  return vtkm::Vec<vtkm::UInt8, 3>(static_cast<vtkm::UInt8>(v * 255.0f + 0.5f));
}

template <>
vtkm::Vec<vtkm::Float32, 4> as_color<vtkm::Vec<vtkm::Float32, 4>>(vtkm::Float32 v,
                                                                  vtkm::Float32 alpha)
{ //generate rgba
  return vtkm::Vec<vtkm::Float32, 4>(v, v, v, alpha);
}
template <>
vtkm::Vec<vtkm::Float64, 4> as_color<vtkm::Vec<vtkm::Float64, 4>>(vtkm::Float32 v,
                                                                  vtkm::Float32 alpha)
{ //generate rgba
  return vtkm::Vec<vtkm::Float64, 4>(v, v, v, alpha);
}
template <>
vtkm::Vec<vtkm::UInt8, 4> as_color<vtkm::Vec<vtkm::UInt8, 4>>(vtkm::Float32 v, vtkm::Float32 alpha)
{ //generate rgba
  return vtkm::Vec<vtkm::UInt8, 4>(static_cast<vtkm::UInt8>(v * 255.0f + 0.5f),
                                   static_cast<vtkm::UInt8>(v * 255.0f + 0.5f),
                                   static_cast<vtkm::UInt8>(v * 255.0f + 0.5f),
                                   static_cast<vtkm::UInt8>(alpha * 255.0f + 0.5f));
}


template <typename T>
vtkm::cont::ArrayHandle<T> make_data(const vtkm::Range& r)
{
  using BaseT = typename vtkm::BaseComponent<T>::Type;
  vtkm::Float32 shift, scale;
  vtkm::worklet::colorconversion::ComputeShiftScale(r, shift, scale);
  const bool shiftscale = vtkm::worklet::colorconversion::needShiftScale(BaseT{}, shift, scale);


  vtkm::cont::ArrayHandle<T> handle;
  handle.Allocate(static_cast<vtkm::Id>(test_values.size()));

  auto portal = handle.GetPortalControl();
  vtkm::Id index = 0;
  if (shiftscale)
  {
    const vtkm::Float32 alpha = static_cast<vtkm::Float32>(r.Max);
    for (const auto& i : test_values)
    {
      //we want to apply the shift and scale, and than clamp to the allowed
      //range of the data. The problem is that we might need to shift and scale the alpha value
      //for the color
      //
      const float c = (i * static_cast<float>(r.Length())) - shift;
      portal.Set(index++, as_color<T>(c, alpha));
    }
  }
  else
  {
    const vtkm::Float32 alpha = 1.0f;
    //no shift or scale required
    for (const auto& i : test_values)
    {
      portal.Set(index++, as_color<T>(i, alpha));
    }
  }
  return handle;
}

bool verify(vtkm::cont::ArrayHandle<vtkm::Vec<vtkm::UInt8, 3>> output)
{
  auto portal = output.GetPortalConstControl();
  vtkm::Id index = 0;
  for (auto i : rgb_result)
  {
    auto v = portal.Get(index);
    if (v != i)
    {
      std::cerr << "failed comparison at index: " << index
                << " found: " << static_cast<vtkm::Vec<int, 3>>(v)
                << " was expecting: " << static_cast<vtkm::Vec<int, 3>>(i) << std::endl;
      break;
    }
    index++;
  }
  bool valid = static_cast<std::size_t>(index) == rgb_result.size();
  return valid;
}

bool verify(vtkm::Float32 alpha, vtkm::cont::ArrayHandle<vtkm::Vec<vtkm::UInt8, 4>> output)
{
  const vtkm::UInt8 a = vtkm::worklet::colorconversion::ColorToUChar(alpha);
  auto portal = output.GetPortalConstControl();
  vtkm::Id index = 0;
  for (auto i : rgb_result)
  {
    auto v = portal.Get(index);
    auto e = vtkm::make_Vec(i[0], i[1], i[2], a);
    if (v != e)
    {
      std::cerr << "failed comparison at index: " << index
                << " found: " << static_cast<vtkm::Vec<int, 4>>(v)
                << " was expecting: " << static_cast<vtkm::Vec<int, 4>>(e) << std::endl;
      break;
    }
    index++;
  }
  bool valid = static_cast<std::size_t>(index) == rgb_result.size();
  return valid;
}

#if defined(VTKM_MSVC)
#pragma warning(push)
#pragma warning(disable : 4127) // conditional expression is constant
#endif

struct TestToRGB
{
  vtkm::worklet::ScalarsToColors Worklet;

  TestToRGB()
    : Worklet()
  {
  }

  TestToRGB(vtkm::Float32 minR, vtkm::Float32 maxR)
    : Worklet(vtkm::Range(minR, maxR))
  {
  }

  using DeviceAdapter = VTKM_DEFAULT_DEVICE_ADAPTER_TAG;
  template <typename T>
  VTKM_CONT void operator()(T) const
  {
    //use each component to generate the output
    vtkm::cont::ArrayHandle<vtkm::Vec<vtkm::UInt8, 3>> output;
    this->Worklet.Run(make_data<T>(this->Worklet.GetRange()), output, DeviceAdapter());
    bool valid = verify(output);
    VTKM_TEST_ASSERT(valid, "scalar RGB failed");
  }

  template <typename U, int N>
  VTKM_CONT void operator()(vtkm::Vec<U, N>) const
  {
    bool valid = false;
    using T = vtkm::Vec<U, N>;

    auto input = make_data<T>(this->Worklet.GetRange());
    vtkm::cont::ArrayHandle<vtkm::Vec<vtkm::UInt8, 3>> output;

    //use all components to generate the output
    this->Worklet.Run(input, output, DeviceAdapter());
    valid = verify(output);
    VTKM_TEST_ASSERT(valid, "all components RGB failed");

    //use the magnitude of the vector if vector is 3 components
    if (N == 3)
    {
      //compute the range needed for the magnitude, since the range can span
      //negative/positive space we need to find the magnitude of each value
      //and them to the range to get the correct range
      vtkm::worklet::colorconversion::MagnitudePortal wrapper;
      vtkm::Range magr;
      auto portal = input.GetPortalControl();
      for (vtkm::Id i = 0; i < input.GetNumberOfValues(); ++i)
      {
        const auto magv = wrapper(portal.Get(i));
        magr.Include(static_cast<double>(magv));
      }

      vtkm::worklet::ScalarsToColors magWorklet(magr);
      magWorklet.RunMagnitude(input, output, DeviceAdapter());
      // vtkm::cont::printSummary_ArrayHandle(output, std::cout, true);

      auto portal2 = output.GetPortalControl();
      for (vtkm::Id i = 0; i < input.GetNumberOfValues(); ++i)
      {
        const auto expected = wrapper(portal.Get(i));
        const auto percent = (portal2.Get(i)[0] / 255.0f);
        const auto result = (percent * magr.Length()) + magr.Min;
        if (!test_equal(expected, result, 0.005))
        {
          std::cerr << "failed comparison at index: " << i << " found: " << result
                    << " was expecting: " << expected << std::endl;
          VTKM_TEST_ASSERT(test_equal(expected, result), "magnitude RGB failed");
        }
      }
    }

    //use the components of the vector, if the vector is 2 or 4 we need
    //to ignore the last component as it is alpha
    int end = (N % 2 == 0) ? (N - 1) : N;
    for (int i = 0; i < end; ++i)
    {
      this->Worklet.RunComponent(input, i, output, DeviceAdapter());
      valid = verify(output);
      VTKM_TEST_ASSERT(valid, "per component RGB failed");
    }
  }
};

struct TestToRGBA
{
  vtkm::worklet::ScalarsToColors Worklet;

  TestToRGBA()
    : Worklet()
  {
  }

  TestToRGBA(vtkm::Float32 minR, vtkm::Float32 maxR, vtkm::Float32 alpha)
    : Worklet(vtkm::Range(minR, maxR), alpha)
  {
  }

  using DeviceAdapter = VTKM_DEFAULT_DEVICE_ADAPTER_TAG;
  template <typename T>
  VTKM_CONT void operator()(T) const
  {
    //use each component to generate the output
    vtkm::cont::ArrayHandle<vtkm::Vec<vtkm::UInt8, 4>> output;
    this->Worklet.Run(make_data<T>(this->Worklet.GetRange()), output, DeviceAdapter());

    bool valid = verify(this->Worklet.GetAlpha(), output);
    VTKM_TEST_ASSERT(valid, "scalar RGBA failed");
  }

  template <typename U, int N>
  VTKM_CONT void operator()(vtkm::Vec<U, N>) const
  {
    bool valid = false;
    using T = vtkm::Vec<U, N>;
    vtkm::cont::ArrayHandle<vtkm::Vec<vtkm::UInt8, 4>> output;

    auto input = make_data<T>(this->Worklet.GetRange());
    // vtkm::cont::printSummary_ArrayHandle(input, std::cout, true);

    //use all components to generate the output
    this->Worklet.Run(input, output, DeviceAdapter());
    valid = verify(this->Worklet.GetAlpha(), output);
    VTKM_TEST_ASSERT(valid, "all components RGBA failed");

    //use the magnitude of the vector if vector is 3 components
    if (N == 3)
    {
      //compute the range needed for the magnitude, since the range can span
      //negative/positive space we need to find the magnitude of each value
      //and them to the range to get the correct range
      vtkm::worklet::colorconversion::MagnitudePortal wrapper;
      vtkm::Range magr;
      auto portal = input.GetPortalControl();
      for (vtkm::Id i = 0; i < input.GetNumberOfValues(); ++i)
      {
        const auto magv = wrapper(portal.Get(i));
        magr.Include(static_cast<double>(magv));
      }

      vtkm::worklet::ScalarsToColors magWorklet(magr);
      magWorklet.RunMagnitude(input, output, DeviceAdapter());
      // vtkm::cont::printSummary_ArrayHandle(output, std::cout, true);

      auto portal2 = output.GetPortalControl();
      for (vtkm::Id i = 0; i < input.GetNumberOfValues(); ++i)
      {
        const auto expected = wrapper(portal.Get(i));
        const auto percent = (portal2.Get(i)[0] / 255.0f);
        const auto result = (percent * magr.Length()) + magr.Min;
        if (!test_equal(expected, result, 0.005))
        {
          std::cerr << "failed comparison at index: " << i << " found: " << result
                    << " was expecting: " << expected << std::endl;
          VTKM_TEST_ASSERT(test_equal(expected, result), "magnitude RGB failed");
        }
      }
    }

    //use the components of the vector, if the vector is 2 or 4 we need
    //to ignore the last component as it is alpha
    int end = (N % 2 == 0) ? (N - 1) : N;
    for (int i = 0; i < end; ++i)
    {
      this->Worklet.RunComponent(input, i, output, DeviceAdapter());
      valid = verify(this->Worklet.GetAlpha(), output);
      VTKM_TEST_ASSERT(valid, "per component RGB failed");
    }
  }
};

#if defined(VTKM_MSVC)
#pragma warning(pop)
#endif


struct TypeListTagScalarColorTypes : vtkm::ListTagBase<vtkm::Float32,
                                                       vtkm::Float64,
                                                       vtkm::Vec<vtkm::Float32, 2>,
                                                       vtkm::Vec<vtkm::Float64, 2>,
                                                       vtkm::Vec<vtkm::Float32, 3>,
                                                       vtkm::Vec<vtkm::Float64, 3>,
                                                       vtkm::Vec<vtkm::Float32, 4>,
                                                       vtkm::Vec<vtkm::Float64, 4>>
{
};

struct TypeListTagUIntColorTypes : vtkm::ListTagBase<vtkm::UInt8,
                                                     vtkm::Vec<vtkm::UInt8, 2>,
                                                     vtkm::Vec<vtkm::UInt8, 3>,
                                                     vtkm::Vec<vtkm::UInt8, 4>>
{
};


void TestScalarsToColors()
{
  std::cout << "Test ConvertToRGB with UInt8 types" << std::endl;
  vtkm::testing::Testing::TryTypes(TestToRGB(), TypeListTagUIntColorTypes());
  std::cout << "Test ConvertToRGB with Scalar types" << std::endl;
  vtkm::testing::Testing::TryTypes(TestToRGB(0.0f, 1.0f), TypeListTagScalarColorTypes());
  std::cout << "Test ShiftScaleToRGB with scalar types and varying range" << std::endl;
  vtkm::testing::Testing::TryTypes(TestToRGB(1024.0f, 4096.0f), TypeListTagScalarColorTypes());
  vtkm::testing::Testing::TryTypes(TestToRGB(-2048.0f, 1024.0f), TypeListTagScalarColorTypes());

  std::cout << "Test ConvertToRGBA with UInt8 types and alpha values=[1.0, 0.5, 0.0]" << std::endl;
  vtkm::testing::Testing::TryTypes(TestToRGBA(), TypeListTagUIntColorTypes());
  vtkm::testing::Testing::TryTypes(TestToRGBA(0.0f, 255.0f, 0.5f), TypeListTagUIntColorTypes());
  vtkm::testing::Testing::TryTypes(TestToRGBA(0.0f, 255.0f, 0.0f), TypeListTagUIntColorTypes());

  std::cout << "Test ConvertToRGBA with Scalar types and alpha values=[0.3, 0.6, 1.0]" << std::endl;
  vtkm::testing::Testing::TryTypes(TestToRGBA(0.0f, 1.0f, 0.3f), TypeListTagScalarColorTypes());
  vtkm::testing::Testing::TryTypes(TestToRGBA(0.0f, 1.0f, 0.6f), TypeListTagScalarColorTypes());
  vtkm::testing::Testing::TryTypes(TestToRGBA(0.0f, 1.0f, 1.0f), TypeListTagScalarColorTypes());

  std::cout
    << "Test ConvertToRGBA with Scalar types and varying range with alpha values=[0.25, 0.5, 0.75]"
    << std::endl;
  vtkm::testing::Testing::TryTypes(TestToRGBA(-0.075f, -0.025f, 0.25f),
                                   TypeListTagScalarColorTypes());
  vtkm::testing::Testing::TryTypes(TestToRGBA(0.0f, 2048.0f, 0.5f), TypeListTagScalarColorTypes());
  vtkm::testing::Testing::TryTypes(TestToRGBA(-2048.0f, 2048.0f, 0.75f),
                                   TypeListTagScalarColorTypes());
}
}

int UnitTestScalarsToColors(int, char* [])
{
  return vtkm::cont::testing::Testing::Run(TestScalarsToColors);
}