vtk-m/docs/users-guide/examples/GuideExampleColorTables.cxx
Kenneth Moreland 5b8c282e9f Continue transfer of Users' Guide text
These changes complete the using part of the guide.
2023-11-21 10:33:45 -07:00

112 lines
3.4 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/cont/ColorTable.h>
#include <vtkm/rendering/CanvasRayTracer.h>
#include <vtkm/cont/testing/Testing.h>
#include <sys/stat.h>
#include <fstream>
namespace
{
static const vtkm::Id TABLE_IMAGE_WIDTH = 150;
static const vtkm::Id TABLE_IMAGE_HEIGHT = 20;
std::string FilenameFriendly(const std::string& name)
{
std::string filename;
for (auto&& ch : name)
{
if (((ch >= 'a') && (ch <= 'z')) || ((ch >= 'A') && (ch <= 'Z')) ||
((ch >= '0') && (ch <= '9')))
{
filename.push_back(ch);
}
else
{
filename.push_back('-');
}
}
return filename;
}
void CreateColorTableImage(const std::string& name)
{
std::cout << "Creating color table " << name << std::endl;
vtkm::cont::ColorTable colorTable(name);
// Create a CanvasRayTracer simply for the color buffer and the ability to
// write out images.
vtkm::rendering::CanvasRayTracer canvas(TABLE_IMAGE_WIDTH, TABLE_IMAGE_HEIGHT);
using ColorBufferType = vtkm::rendering::CanvasRayTracer::ColorBufferType;
ColorBufferType colorBuffer = canvas.GetColorBuffer();
ColorBufferType::WritePortalType colorPortal = colorBuffer.WritePortal();
VTKM_TEST_ASSERT(colorPortal.GetNumberOfValues() ==
TABLE_IMAGE_WIDTH * TABLE_IMAGE_HEIGHT,
"Wrong size of color buffer.");
vtkm::cont::ArrayHandle<vtkm::Vec4ui_8> temp;
colorTable.Sample(TABLE_IMAGE_WIDTH, temp);
constexpr vtkm::Float32 conversionToFloatSpace = (1.0f / 255.0f);
for (vtkm::Id j = 0; j < TABLE_IMAGE_HEIGHT; ++j)
{
auto tempPortal = temp.ReadPortal();
for (vtkm::Id i = 0; i < TABLE_IMAGE_WIDTH; ++i)
{
auto color = tempPortal.Get(i);
vtkm::Vec4f_32 t(color[0] * conversionToFloatSpace,
color[1] * conversionToFloatSpace,
color[2] * conversionToFloatSpace,
color[3] * conversionToFloatSpace);
colorPortal.Set(j * TABLE_IMAGE_WIDTH + i, t);
}
}
canvas.SaveAs("color-tables/" + FilenameFriendly(name) + ".png");
}
void DoColorTables()
{
#ifndef VTKM_MSVC
// Disabled for MSVC because POSIX mkdir is not supported.
// We can use std::filestyem::create_directories later when we support C++17.
mkdir("color-tables", S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH);
std::ofstream rstTable("color-tables/color-table-presets.rst",
std::ios::out | std::ios::trunc);
rstTable << ".. DO NOT EDIT!\n";
rstTable << ".. Created by GuideExampleColorTables test.\n";
rstTable << "\n";
vtkm::cont::ColorTable table;
std::set<std::string> names = table.GetPresets();
for (auto& n : names)
{
CreateColorTableImage(n);
rstTable << ".. |" << FilenameFriendly(n) << "| image:: images/color-tables/"
<< FilenameFriendly(n) << ".png\n";
}
#endif
}
} // anonymous namespace
int GuideExampleColorTables(int argc, char* argv[])
{
return vtkm::cont::testing::Testing::Run(DoColorTables, argc, argv);
}