2e918c58dc
We would really like to be able to include `vtkm::cont::ColorTable` in such a way that you don't have to compile device code (unless you are actually compiling functions for the device). Thus, the `Map` functions of `ColorTable` were in a special `ColorTable.hxx` that contains the "implementation" for `ColorTable`. That is confusing to many users. It is more clear to simply have `.h` headers that do a specific thing. To achieve these two goals, the `Map` functionality of `ColorTable` is separated out into its own header file. So you don't need to be using a device compiler just to use `ColorTable` (including `ColorTable.h`), but you do need to use a device compiler if mapping values to colors (including `ColorTableMap.h`).
621 lines
25 KiB
C++
621 lines
25 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_cont_ColorTable_h
|
|
#define vtk_m_cont_ColorTable_h
|
|
|
|
#include <vtkm/Range.h>
|
|
#include <vtkm/Types.h>
|
|
|
|
#include <vtkm/cont/vtkm_cont_export.h>
|
|
|
|
#include <vtkm/cont/ArrayHandle.h>
|
|
#include <vtkm/cont/ColorTableSamples.h>
|
|
#include <vtkm/cont/ExecutionObjectBase.h>
|
|
|
|
#include <vtkm/exec/ColorTable.h>
|
|
|
|
#include <set>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
|
|
namespace detail
|
|
{
|
|
struct ColorTableInternals;
|
|
}
|
|
|
|
struct VTKM_DEPRECATED(1.6, "Use vtkm::ColorSpace.") ColorSpace
|
|
{
|
|
static constexpr vtkm::ColorSpace RGB = vtkm::ColorSpace::RGB;
|
|
static constexpr vtkm::ColorSpace HSV = vtkm::ColorSpace::HSV;
|
|
static constexpr vtkm::ColorSpace HSV_WRAP = vtkm::ColorSpace::HSVWrap;
|
|
static constexpr vtkm::ColorSpace LAB = vtkm::ColorSpace::Lab;
|
|
static constexpr vtkm::ColorSpace DIVERGING = vtkm::ColorSpace::Diverging;
|
|
};
|
|
|
|
/// \brief Color Table for coloring arbitrary fields
|
|
///
|
|
///
|
|
/// The `vtkm::cont::ColorTable` allows for color mapping in RGB or HSV space and
|
|
/// uses a piecewise hermite functions to allow opacity interpolation that can be
|
|
/// piecewise constant, piecewise linear, or somewhere in-between
|
|
/// (a modified piecewise hermite function that squishes the function
|
|
/// according to a sharpness parameter).
|
|
///
|
|
/// For colors interpolation is handled using a piecewise linear function.
|
|
///
|
|
/// For opacity we define a piecewise function mapping. This mapping allows the addition
|
|
/// of control points, and allows the user to control the function between
|
|
/// the control points. A piecewise hermite curve is used between control
|
|
/// points, based on the sharpness and midpoint parameters. A sharpness of
|
|
/// 0 yields a piecewise linear function and a sharpness of 1 yields a
|
|
/// piecewise constant function. The midpoint is the normalized distance
|
|
/// between control points at which the curve reaches the median Y value.
|
|
/// The midpoint and sharpness values specified when adding a node are used
|
|
/// to control the transition to the next node with the last node's values being
|
|
/// ignored.
|
|
///
|
|
/// When adding opacity nodes without an explicit midpoint and sharpness we
|
|
/// will default to to Midpoint = 0.5 (halfway between the control points) and
|
|
/// Sharpness = 0.0 (linear).
|
|
///
|
|
/// ColorTable also contains which ColorSpace should be used for interpolation.
|
|
/// The color space is selected with the `vtkm::ColorSpace` enumeration.
|
|
/// Currently the valid ColorSpaces are:
|
|
/// - `RGB`
|
|
/// - `HSV`
|
|
/// - `HSVWrap`
|
|
/// - `Lab`
|
|
/// - `Diverging`
|
|
///
|
|
/// In `HSVWrap` mode, it will take the shortest path
|
|
/// in Hue (going back through 0 if that is the shortest way around the hue
|
|
/// circle) whereas HSV will not go through 0 (in order to
|
|
/// match the current functionality of `vtkLookupTable`). In `Lab` mode,
|
|
/// it will take the shortest path in the Lab color space with respect to the
|
|
/// CIE Delta E 2000 color distance measure. `Diverging` is a special
|
|
/// mode where colors will pass through white when interpolating between two
|
|
/// saturated colors.
|
|
///
|
|
/// To map a field from a `vtkm::cont::DataSet` through the color and opacity transfer
|
|
/// functions and into a RGB or RGBA array you should use `vtkm::filter::FieldToColor`.
|
|
///
|
|
/// Note that modifications of `vtkm::cont::ColorTable` are not thread safe. You should
|
|
/// not modify a `ColorTable` simultaneously in 2 or more threads. Also, you should not
|
|
/// modify a `ColorTable` that might be used in the execution environment. However,
|
|
/// the `ColorTable` can be used in multiple threads and on multiple devices as long
|
|
/// as no modifications are made.
|
|
///
|
|
class VTKM_CONT_EXPORT ColorTable : public vtkm::cont::ExecutionObjectBase
|
|
{
|
|
std::shared_ptr<detail::ColorTableInternals> Internals;
|
|
|
|
public:
|
|
enum struct Preset
|
|
{
|
|
Default,
|
|
CoolToWarm,
|
|
CoolToWarmExtended,
|
|
Viridis,
|
|
Inferno,
|
|
Plasma,
|
|
BlackBodyRadiation,
|
|
XRay,
|
|
Green,
|
|
BlackBlueWhite,
|
|
BlueToOrange,
|
|
GrayToRed,
|
|
ColdAndHot,
|
|
BlueGreenOrange,
|
|
YellowGrayBlue,
|
|
RainbowUniform,
|
|
Jet,
|
|
RainbowDesaturated,
|
|
|
|
DEFAULT VTKM_DEPRECATED(1.6, "Use vtkm::ColorTable::Preset::Default."),
|
|
COOL_TO_WARM VTKM_DEPRECATED(1.6, "Use vtkm::ColorTable::Preset::CoolToWarm."),
|
|
COOL_TO_WARM_EXTENDED VTKM_DEPRECATED(1.6, "Use vtkm::ColorTable::Preset::CoolToWarmExtended."),
|
|
VIRIDIS VTKM_DEPRECATED(1.6, "Use vtkm::ColorTable::Preset::Viridis."),
|
|
INFERNO VTKM_DEPRECATED(1.6, "Use vtkm::ColorTable::Preset::Inferno."),
|
|
PLASMA VTKM_DEPRECATED(1.6, "Use vtkm::ColorTable::Preset::Plasma."),
|
|
BLACK_BODY_RADIATION VTKM_DEPRECATED(1.6, "Use vtkm::ColorTable::Preset::BlackBodyRadiation."),
|
|
X_RAY VTKM_DEPRECATED(1.6, "Use vtkm::ColorTable::Preset::XRay."),
|
|
GREEN VTKM_DEPRECATED(1.6, "Use vtkm::ColorTable::Preset::Green."),
|
|
BLACK_BLUE_WHITE VTKM_DEPRECATED(1.6, "Use vtkm::ColorTable::Preset::BlackBlueWhite."),
|
|
BLUE_TO_ORANGE VTKM_DEPRECATED(1.6, "Use vtkm::ColorTable::Preset::BlueToOrange."),
|
|
GRAY_TO_RED VTKM_DEPRECATED(1.6, "Use vtkm::ColorTable::Preset::GrayToRed."),
|
|
COLD_AND_HOT VTKM_DEPRECATED(1.6, "Use vtkm::ColorTable::Preset::ColdAndHot."),
|
|
BLUE_GREEN_ORANGE VTKM_DEPRECATED(1.6, "Use vtkm::ColorTable::Preset::BlueGreenOrange."),
|
|
YELLOW_GRAY_BLUE VTKM_DEPRECATED(1.6, "Use vtkm::ColorTable::Preset::YellowGrayBlue."),
|
|
RAINBOW_UNIFORM VTKM_DEPRECATED(1.6, "Use vtkm::ColorTable::Preset::RainbowUniform."),
|
|
JET VTKM_DEPRECATED(1.6, "Use vtkm::ColorTable::Preset::Jet."),
|
|
RAINBOW_DESATURATED VTKM_DEPRECATED(1.6, "Use vtkm::ColorTable::Preset::RainbowDesaturated.")
|
|
};
|
|
|
|
/// \brief Construct a color table from a preset
|
|
///
|
|
/// Constructs a color table from a given preset, which might include a NaN color.
|
|
/// The alpha table will have 2 entries of alpha = 1.0 with linear interpolation
|
|
///
|
|
/// Note: these are a select set of the presets you can get by providing a string identifier.
|
|
///
|
|
ColorTable(vtkm::cont::ColorTable::Preset preset = vtkm::cont::ColorTable::Preset::Default);
|
|
|
|
/// \brief Construct a color table from a preset color table
|
|
///
|
|
/// Constructs a color table from a given preset, which might include a NaN color.
|
|
/// The alpha table will have 2 entries of alpha = 1.0 with linear interpolation
|
|
///
|
|
/// Note: Names are case insensitive
|
|
/// Currently supports the following color tables:
|
|
///
|
|
/// "Default"
|
|
/// "Cool to Warm"
|
|
/// "Cool to Warm Extended"
|
|
/// "Viridis"
|
|
/// "Inferno"
|
|
/// "Plasma"
|
|
/// "Black-Body Radiation"
|
|
/// "X Ray"
|
|
/// "Green"
|
|
/// "Black - Blue - White"
|
|
/// "Blue to Orange"
|
|
/// "Gray to Red"
|
|
/// "Cold and Hot"
|
|
/// "Blue - Green - Orange"
|
|
/// "Yellow - Gray - Blue"
|
|
/// "Rainbow Uniform"
|
|
/// "Jet"
|
|
/// "Rainbow Desaturated"
|
|
///
|
|
explicit ColorTable(const std::string& name);
|
|
|
|
/// Construct a color table with a zero positions, and an invalid range
|
|
///
|
|
/// Note: The color table will have 0 entries
|
|
/// Note: The alpha table will have 0 entries
|
|
explicit ColorTable(vtkm::ColorSpace space);
|
|
|
|
/// Construct a color table with a 2 positions
|
|
///
|
|
/// Note: The color table will have 2 entries of rgb = {1.0,1.0,1.0}
|
|
/// Note: The alpha table will have 2 entries of alpha = 1.0 with linear
|
|
/// interpolation
|
|
ColorTable(const vtkm::Range& range, vtkm::ColorSpace space = vtkm::ColorSpace::Lab);
|
|
|
|
/// Construct a color table with 2 positions
|
|
//
|
|
/// Note: The alpha table will have 2 entries of alpha = 1.0 with linear
|
|
/// interpolation
|
|
ColorTable(const vtkm::Range& range,
|
|
const vtkm::Vec3f_32& rgb1,
|
|
const vtkm::Vec3f_32& rgb2,
|
|
vtkm::ColorSpace space = vtkm::ColorSpace::Lab);
|
|
|
|
/// Construct color and alpha and table with 2 positions
|
|
///
|
|
/// Note: The alpha table will use linear interpolation
|
|
ColorTable(const vtkm::Range& range,
|
|
const vtkm::Vec4f_32& rgba1,
|
|
const vtkm::Vec4f_32& rgba2,
|
|
vtkm::ColorSpace space = vtkm::ColorSpace::Lab);
|
|
|
|
/// Construct a color table with a list of colors and alphas. For this version you must also
|
|
/// specify a name.
|
|
///
|
|
/// This constructor is mostly used for presets.
|
|
ColorTable(
|
|
const std::string& name,
|
|
vtkm::ColorSpace colorSpace,
|
|
const vtkm::Vec3f_64& nanColor,
|
|
const std::vector<vtkm::Float64>& rgbPoints,
|
|
const std::vector<vtkm::Float64>& alphaPoints = { 0.0, 1.0, 0.5, 0.0, 1.0, 1.0, 0.5, 0.0 });
|
|
|
|
|
|
~ColorTable();
|
|
|
|
ColorTable& operator=(const ColorTable&) = default;
|
|
ColorTable(const ColorTable&) = default;
|
|
|
|
const std::string& GetName() const;
|
|
void SetName(const std::string& name);
|
|
|
|
bool LoadPreset(vtkm::cont::ColorTable::Preset preset);
|
|
|
|
/// Returns the name of all preset color tables
|
|
///
|
|
/// This list will include all presets defined in vtkm::cont::ColorTable::Preset and could
|
|
/// include extras as well.
|
|
///
|
|
static std::set<std::string> GetPresets();
|
|
|
|
/// Load a preset color table
|
|
///
|
|
/// Removes all existing all values in both color and alpha tables,
|
|
/// and will reset the NaN Color if the color table has that information.
|
|
/// Will not modify clamping, below, and above range state.
|
|
///
|
|
/// Note: Names are case insensitive
|
|
///
|
|
/// Currently supports the following color tables:
|
|
/// "Default"
|
|
/// "Cool to Warm"
|
|
/// "Cool to Warm Extended"
|
|
/// "Viridis"
|
|
/// "Inferno"
|
|
/// "Plasma"
|
|
/// "Black-Body Radiation"
|
|
/// "X Ray"
|
|
/// "Green"
|
|
/// "Black - Blue - White"
|
|
/// "Blue to Orange"
|
|
/// "Gray to Red"
|
|
/// "Cold and Hot"
|
|
/// "Blue - Green - Orange"
|
|
/// "Yellow - Gray - Blue"
|
|
/// "Rainbow Uniform"
|
|
/// "Jet"
|
|
/// "Rainbow Desaturated"
|
|
///
|
|
bool LoadPreset(const std::string& name);
|
|
|
|
/// Make a deep copy of the current color table
|
|
///
|
|
/// The ColorTable is implemented so that all stack based copies are 'shallow'
|
|
/// copies. This means that they all alter the same internal instance. But
|
|
/// sometimes you need to make an actual fully independent copy.
|
|
ColorTable MakeDeepCopy();
|
|
|
|
///
|
|
vtkm::ColorSpace GetColorSpace() const;
|
|
void SetColorSpace(vtkm::ColorSpace space);
|
|
|
|
/// If clamping is disabled values that lay out side
|
|
/// the color table range are colored based on Below
|
|
/// and Above settings.
|
|
///
|
|
/// By default clamping is enabled
|
|
void SetClampingOn() { this->SetClamping(true); }
|
|
void SetClampingOff() { this->SetClamping(false); }
|
|
void SetClamping(bool state);
|
|
bool GetClamping() const;
|
|
|
|
/// Color to use when clamping is disabled for any value
|
|
/// that is below the given range
|
|
///
|
|
/// Default value is {0,0,0}
|
|
void SetBelowRangeColor(const vtkm::Vec3f_32& c);
|
|
const vtkm::Vec3f_32& GetBelowRangeColor() const;
|
|
|
|
/// Color to use when clamping is disabled for any value
|
|
/// that is above the given range
|
|
///
|
|
/// Default value is {0,0,0}
|
|
void SetAboveRangeColor(const vtkm::Vec3f_32& c);
|
|
const vtkm::Vec3f_32& GetAboveRangeColor() const;
|
|
|
|
///
|
|
void SetNaNColor(const vtkm::Vec3f_32& c);
|
|
const vtkm::Vec3f_32& GetNaNColor() const;
|
|
|
|
/// Remove all existing values in both color and alpha tables.
|
|
/// Does not remove the clamping, below, and above range state or colors.
|
|
void Clear();
|
|
|
|
/// Remove only color table values
|
|
void ClearColors();
|
|
|
|
/// Remove only alpha table values
|
|
void ClearAlpha();
|
|
|
|
/// Reverse the rgb values inside the color table
|
|
void ReverseColors();
|
|
|
|
/// Reverse the alpha, mid, and sharp values inside the opacity table.
|
|
///
|
|
/// Note: To keep the shape correct the mid and sharp values of the last
|
|
/// node are not included in the reversal
|
|
void ReverseAlpha();
|
|
|
|
/// Returns min and max position of all function points
|
|
const vtkm::Range& GetRange() const;
|
|
|
|
/// Rescale the color and opacity transfer functions to match the
|
|
/// input range.
|
|
void RescaleToRange(const vtkm::Range& range);
|
|
|
|
// Functions for Colors
|
|
|
|
/// Adds a point to the color function. If the point already exists, it
|
|
/// will be updated to the new value.
|
|
///
|
|
/// Note: rgb values need to be between 0 and 1.0 (inclusive).
|
|
/// Return the index of the point (0 based), or -1 osn error.
|
|
vtkm::Int32 AddPoint(vtkm::Float64 x, const vtkm::Vec3f_32& rgb);
|
|
|
|
/// Adds a point to the color function. If the point already exists, it
|
|
/// will be updated to the new value.
|
|
///
|
|
/// Note: hsv values need to be between 0 and 1.0 (inclusive).
|
|
/// Return the index of the point (0 based), or -1 on error.
|
|
vtkm::Int32 AddPointHSV(vtkm::Float64 x, const vtkm::Vec3f_32& hsv);
|
|
|
|
/// Add a line segment to the color function. All points which lay between x1 and x2
|
|
/// (inclusive) are removed from the function.
|
|
///
|
|
/// Note: rgb1, and rgb2 values need to be between 0 and 1.0 (inclusive).
|
|
/// Return the index of the point x1 (0 based), or -1 on error.
|
|
vtkm::Int32 AddSegment(vtkm::Float64 x1,
|
|
const vtkm::Vec3f_32& rgb1,
|
|
vtkm::Float64 x2,
|
|
const vtkm::Vec3f_32& rgb2);
|
|
|
|
/// Add a line segment to the color function. All points which lay between x1 and x2
|
|
/// (inclusive) are removed from the function.
|
|
///
|
|
/// Note: hsv1, and hsv2 values need to be between 0 and 1.0 (inclusive)
|
|
/// Return the index of the point x1 (0 based), or -1 on error
|
|
vtkm::Int32 AddSegmentHSV(vtkm::Float64 x1,
|
|
const vtkm::Vec3f_32& hsv1,
|
|
vtkm::Float64 x2,
|
|
const vtkm::Vec3f_32& hsv2);
|
|
|
|
/// Get the location, and rgb information for an existing point in the opacity function.
|
|
///
|
|
/// Note: components 1-3 are rgb and will have values between 0 and 1.0 (inclusive)
|
|
/// Return the index of the point (0 based), or -1 on error.
|
|
bool GetPoint(vtkm::Int32 index, vtkm::Vec4f_64&) const;
|
|
|
|
/// Update the location, and rgb information for an existing point in the color function.
|
|
/// If the location value for the index is modified the point is removed from
|
|
/// the function and re-inserted in the proper sorted location.
|
|
///
|
|
/// Note: components 1-3 are rgb and must have values between 0 and 1.0 (inclusive).
|
|
/// Return the new index of the updated point (0 based), or -1 on error.
|
|
vtkm::Int32 UpdatePoint(vtkm::Int32 index, const vtkm::Vec4f_64&);
|
|
|
|
/// Remove the Color function point that exists at exactly x
|
|
///
|
|
/// Return true if the point x exists and has been removed
|
|
bool RemovePoint(vtkm::Float64 x);
|
|
|
|
/// Remove the Color function point n
|
|
///
|
|
/// Return true if n >= 0 && n < GetNumberOfPoints
|
|
bool RemovePoint(vtkm::Int32 index);
|
|
|
|
/// Returns the number of points in the color function
|
|
vtkm::Int32 GetNumberOfPoints() const;
|
|
|
|
// Functions for Opacity
|
|
|
|
/// Adds a point to the opacity function. If the point already exists, it
|
|
/// will be updated to the new value. Uses a midpoint of 0.5 (halfway between the control points)
|
|
/// and sharpness of 0.0 (linear).
|
|
///
|
|
/// Note: alpha needs to be a value between 0 and 1.0 (inclusive).
|
|
/// Return the index of the point (0 based), or -1 on error.
|
|
vtkm::Int32 AddPointAlpha(vtkm::Float64 x, vtkm::Float32 alpha)
|
|
{
|
|
return AddPointAlpha(x, alpha, 0.5f, 0.0f);
|
|
}
|
|
|
|
/// Adds a point to the opacity function. If the point already exists, it
|
|
/// will be updated to the new value.
|
|
///
|
|
/// Note: alpha, midpoint, and sharpness values need to be between 0 and 1.0 (inclusive)
|
|
/// Return the index of the point (0 based), or -1 on error.
|
|
vtkm::Int32 AddPointAlpha(vtkm::Float64 x,
|
|
vtkm::Float32 alpha,
|
|
vtkm::Float32 midpoint,
|
|
vtkm::Float32 sharpness);
|
|
|
|
/// Add a line segment to the opacity function. All points which lay between x1 and x2
|
|
/// (inclusive) are removed from the function. Uses a midpoint of
|
|
/// 0.5 (halfway between the control points) and sharpness of 0.0 (linear).
|
|
///
|
|
/// Note: alpha values need to be between 0 and 1.0 (inclusive)
|
|
/// Return the index of the point x1 (0 based), or -1 on error
|
|
vtkm::Int32 AddSegmentAlpha(vtkm::Float64 x1,
|
|
vtkm::Float32 alpha1,
|
|
vtkm::Float64 x2,
|
|
vtkm::Float32 alpha2)
|
|
{
|
|
vtkm::Vec2f_32 mid_sharp(0.5f, 0.0f);
|
|
return AddSegmentAlpha(x1, alpha1, x2, alpha2, mid_sharp, mid_sharp);
|
|
}
|
|
|
|
/// Add a line segment to the opacity function. All points which lay between x1 and x2
|
|
/// (inclusive) are removed from the function.
|
|
///
|
|
/// Note: alpha, midpoint, and sharpness values need to be between 0 and 1.0 (inclusive)
|
|
/// Return the index of the point x1 (0 based), or -1 on error
|
|
vtkm::Int32 AddSegmentAlpha(vtkm::Float64 x1,
|
|
vtkm::Float32 alpha1,
|
|
vtkm::Float64 x2,
|
|
vtkm::Float32 alpha2,
|
|
const vtkm::Vec2f_32& mid_sharp1,
|
|
const vtkm::Vec2f_32& mid_sharp2);
|
|
|
|
/// Get the location, alpha, midpoint and sharpness information for an existing
|
|
/// point in the opacity function.
|
|
///
|
|
/// Note: alpha, midpoint, and sharpness values all will be between 0 and 1.0 (inclusive)
|
|
/// Return the index of the point (0 based), or -1 on error.
|
|
bool GetPointAlpha(vtkm::Int32 index, vtkm::Vec4f_64&) const;
|
|
|
|
/// Update the location, alpha, midpoint and sharpness information for an existing
|
|
/// point in the opacity function.
|
|
/// If the location value for the index is modified the point is removed from
|
|
/// the function and re-inserted in the proper sorted location
|
|
///
|
|
/// Note: alpha, midpoint, and sharpness values need to be between 0 and 1.0 (inclusive)
|
|
/// Return the new index of the updated point (0 based), or -1 on error.
|
|
vtkm::Int32 UpdatePointAlpha(vtkm::Int32 index, const vtkm::Vec4f_64&);
|
|
|
|
/// Remove the Opacity function point that exists at exactly x
|
|
///
|
|
/// Return true if the point x exists and has been removed
|
|
bool RemovePointAlpha(vtkm::Float64 x);
|
|
|
|
/// Remove the Opacity function point n
|
|
///
|
|
/// Return true if n >= 0 && n < GetNumberOfPointsAlpha
|
|
bool RemovePointAlpha(vtkm::Int32 index);
|
|
|
|
/// Returns the number of points in the alpha function
|
|
vtkm::Int32 GetNumberOfPointsAlpha() const;
|
|
|
|
/// Fill the Color table from a vtkm::Float64 pointer
|
|
///
|
|
/// The vtkm::Float64 pointer is required to have the layout out of [X1, R1,
|
|
/// G1, B1, X2, R2, G2, B2, ..., Xn, Rn, Gn, Bn] where n is the
|
|
/// number of nodes.
|
|
/// This will remove any existing color control points.
|
|
///
|
|
/// Note: n represents the length of the array, so ( n/4 == number of control points )
|
|
///
|
|
/// Note: This is provided as a interoperability method with VTK
|
|
/// Will return false and not modify anything if n is <= 0 or ptr == nullptr
|
|
bool FillColorTableFromDataPointer(vtkm::Int32 n, const vtkm::Float64* ptr);
|
|
|
|
/// Fill the Color table from a vtkm::Float32 pointer
|
|
///
|
|
/// The vtkm::Float64 pointer is required to have the layout out of [X1, R1,
|
|
/// G1, B1, X2, R2, G2, B2, ..., Xn, Rn, Gn, Bn] where n is the
|
|
/// number of nodes.
|
|
/// This will remove any existing color control points.
|
|
///
|
|
/// Note: n represents the length of the array, so ( n/4 == number of control points )
|
|
///
|
|
/// Note: This is provided as a interoperability method with VTK
|
|
/// Will return false and not modify anything if n is <= 0 or ptr == nullptr
|
|
bool FillColorTableFromDataPointer(vtkm::Int32 n, const vtkm::Float32* ptr);
|
|
|
|
/// Fill the Opacity table from a vtkm::Float64 pointer
|
|
///
|
|
/// The vtkm::Float64 pointer is required to have the layout out of [X1, A1, M1, S1, X2, A2, M2, S2,
|
|
/// ..., Xn, An, Mn, Sn] where n is the number of nodes. The Xi values represent the value to
|
|
/// map, the Ai values represent alpha (opacity) value, the Mi values represent midpoints, and
|
|
/// the Si values represent sharpness. Use 0.5 for midpoint and 0.0 for sharpness to have linear
|
|
/// interpolation of the alpha.
|
|
///
|
|
/// This will remove any existing opacity control points.
|
|
///
|
|
/// Note: n represents the length of the array, so ( n/4 == number of control points )
|
|
///
|
|
/// Will return false and not modify anything if n is <= 0 or ptr == nullptr
|
|
bool FillOpacityTableFromDataPointer(vtkm::Int32 n, const vtkm::Float64* ptr);
|
|
|
|
/// Fill the Opacity table from a vtkm::Float32 pointer
|
|
///
|
|
/// The vtkm::Float32 pointer is required to have the layout out of [X1, A1, M1, S1, X2, A2, M2, S2,
|
|
/// ..., Xn, An, Mn, Sn] where n is the number of nodes. The Xi values represent the value to
|
|
/// map, the Ai values represent alpha (opacity) value, the Mi values represent midpoints, and
|
|
/// the Si values represent sharpness. Use 0.5 for midpoint and 0.0 for sharpness to have linear
|
|
/// interpolation of the alpha.
|
|
///
|
|
/// This will remove any existing opacity control points.
|
|
///
|
|
/// Note: n represents the length of the array, so ( n/4 == number of control points )
|
|
///
|
|
/// Will return false and not modify anything if n is <= 0 or ptr == nullptr
|
|
bool FillOpacityTableFromDataPointer(vtkm::Int32 n, const vtkm::Float32* ptr);
|
|
|
|
|
|
/// \brief generate RGB colors using regular spaced samples along the range.
|
|
///
|
|
/// Will use the current range of the color table to generate evenly spaced
|
|
/// values using either vtkm::Float32 or vtkm::Float64 space.
|
|
/// Will use vtkm::Float32 space when the difference between the vtkm::Float32 and vtkm::Float64
|
|
/// values when the range is within vtkm::Float32 space and the following are within a tolerance:
|
|
///
|
|
/// - (max-min) / numSamples
|
|
/// - ((max-min) / numSamples) * numSamples
|
|
///
|
|
/// Note: This will return false if the number of samples is less than 2
|
|
bool Sample(vtkm::Int32 numSamples,
|
|
vtkm::cont::ColorTableSamplesRGBA& samples,
|
|
vtkm::Float64 tolerance = 0.002) const;
|
|
|
|
/// \brief generate a sample lookup table using regular spaced samples along the range.
|
|
///
|
|
/// Will use the current range of the color table to generate evenly spaced
|
|
/// values using either vtkm::Float32 or vtkm::Float64 space.
|
|
/// Will use vtkm::Float32 space when the difference between the vtkm::Float32 and vtkm::Float64
|
|
/// values when the range is within vtkm::Float32 space and the following are within a tolerance:
|
|
///
|
|
/// - (max-min) / numSamples
|
|
/// - ((max-min) / numSamples) * numSamples
|
|
///
|
|
/// Note: This will return false if the number of samples is less than 2
|
|
bool Sample(vtkm::Int32 numSamples,
|
|
vtkm::cont::ColorTableSamplesRGB& samples,
|
|
vtkm::Float64 tolerance = 0.002) const;
|
|
|
|
/// \brief generate RGBA colors using regular spaced samples along the range.
|
|
///
|
|
/// Will use the current range of the color table to generate evenly spaced
|
|
/// values using either vtkm::Float32 or vtkm::Float64 space.
|
|
/// Will use vtkm::Float32 space when the difference between the vtkm::Float32 and vtkm::Float64
|
|
/// values when the range is within vtkm::Float32 space and the following are within a tolerance:
|
|
///
|
|
/// - (max-min) / numSamples
|
|
/// - ((max-min) / numSamples) * numSamples
|
|
///
|
|
/// Note: This will return false if the number of samples is less than 2
|
|
bool Sample(vtkm::Int32 numSamples,
|
|
vtkm::cont::ArrayHandle<vtkm::Vec4ui_8>& colors,
|
|
vtkm::Float64 tolerance = 0.002) const;
|
|
|
|
/// \brief generate RGB colors using regular spaced samples along the range.
|
|
///
|
|
/// Will use the current range of the color table to generate evenly spaced
|
|
/// values using either vtkm::Float32 or vtkm::Float64 space.
|
|
/// Will use vtkm::Float32 space when the difference between the vtkm::Float32 and vtkm::Float64
|
|
/// values when the range is within vtkm::Float32 space and the following are within a tolerance:
|
|
///
|
|
/// - (max-min) / numSamples
|
|
/// - ((max-min) / numSamples) * numSamples
|
|
///
|
|
/// Note: This will return false if the number of samples is less than 2
|
|
bool Sample(vtkm::Int32 numSamples,
|
|
vtkm::cont::ArrayHandle<vtkm::Vec3ui_8>& colors,
|
|
vtkm::Float64 tolerance = 0.002) const;
|
|
|
|
|
|
/// \brief returns a virtual object pointer of the exec color table
|
|
///
|
|
/// This pointer is only valid as long as the ColorTable is unmodified
|
|
vtkm::exec::ColorTable PrepareForExecution(vtkm::cont::DeviceAdapterId deviceId,
|
|
vtkm::cont::Token& token) const;
|
|
|
|
VTKM_DEPRECATED(1.6, "PrepareForExecution now requires a vtkm::cont::Token object")
|
|
inline vtkm::exec::ColorTable PrepareForExecution(vtkm::cont::DeviceAdapterId deviceId) const;
|
|
|
|
/// \brief Returns the modified count for changes of the color table
|
|
///
|
|
/// The `ModifiedCount` of the color table starts at 1 and gets incremented
|
|
/// every time a change is made to the color table.
|
|
/// The modified count allows consumers of a shared color table to keep track
|
|
/// if the color table has been modified since the last time they used it.
|
|
/// This is important for consumers that need to sample the color table.
|
|
/// You only want to resample the color table if changes have been made.
|
|
vtkm::Id GetModifiedCount() const;
|
|
|
|
private:
|
|
void UpdateArrayHandles() const;
|
|
};
|
|
}
|
|
} //namespace vtkm::cont
|
|
#endif //vtk_m_cont_ColorTable_h
|