vtkArrayComponents.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkArrayComponents_h
#define vtkArrayComponents_h

#include "vtkCommonCoreModule.h" // For export macros
#include "vtkCompiler.h"         // For VTK_ALWAYS_EXPORT
#include "vtkDataArray.h"        // For API
#include "vtkSmartPointer.h"     // For API

#include <string>

VTK_ABI_NAMESPACE_BEGIN

class vtkAbstractArray;
class vtkDataArray;

enum vtkArrayComponents : int
{
  L1Norm = -1,          // Take the L₁ norm of all components and treat it as a virtual component.
  L2Norm = -2,          // Take the L₂ norm of all components and treat it as a virtual component.
  LInfNorm = -99,       // Take the L∞ norm of all components and treat it as a virtual component.
  AllComponents = -100, // Do not isolate a single component; use the entire tuple value.
  Requested = -101      // Use whatever component(s) a filter was requested to process.
};

VTK_ABI_NAMESPACE_END

namespace vtk
{

VTK_ABI_NAMESPACE_BEGIN

int VTKCOMMONCORE_EXPORT ArrayComponents(const std::string& enumerantStr);

std::string VTKCOMMONCORE_EXPORT to_string(vtkArrayComponents enumerant);

template <typename T>
T VTK_ALWAYS_EXPORT to_enumerant(const std::string&);

template <>
inline vtkArrayComponents to_enumerant<vtkArrayComponents>(const std::string& enumerantStr)
{
  return static_cast<vtkArrayComponents>(ArrayComponents(enumerantStr));
}


vtkSmartPointer<vtkAbstractArray> VTKCOMMONCORE_EXPORT ComponentOrNormAsArray(
  vtkAbstractArray* array, int compOrNorm);

inline vtkSmartPointer<vtkDataArray> ComponentOrNormAsDataArray(vtkDataArray* array, int compOrNorm)
{
  // This variant only handles input data arrays, but returns a vtkDataArray
  // rather than forcing you to cast it afterward.
  auto intermediate = ComponentOrNormAsArray(array, compOrNorm);
  vtkSmartPointer<vtkDataArray> result = vtkDataArray::SafeDownCast(intermediate.GetPointer());
  return result;
}

VTK_ABI_NAMESPACE_END

} // vtk namespace

#endif // vtkArrayComponents_h
// VTK-HeaderTest-Exclude: vtkArrayComponents.h