You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

98 lines
3.3 KiB
C++

/*=========================================================================
Program: Visualization Toolkit
Module: vtkVectorNorm.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm 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.
=========================================================================*/
/**
* @class vtkVectorNorm
* @brief generate scalars from Euclidean norm of vectors
*
* vtkVectorNorm is a filter that generates scalar values by computing
* Euclidean norm of vector triplets. Scalars can be normalized
* 0<=s<=1 if desired.
*
* Note that this filter operates on point or cell attribute data, or
* both. By default, the filter operates on both point and cell data
* if vector point and cell data, respectively, are available from the
* input. Alternatively, you can choose to generate scalar norm values
* for just cell or point data.
*
* @warning
* This class has been threaded with vtkSMPTools. Using TBB or other
* non-sequential type (set in the CMake variable
* VTK_SMP_IMPLEMENTATION_TYPE) may improve performance significantly.
*/
#ifndef vtkVectorNorm_h
#define vtkVectorNorm_h
#define VTK_ATTRIBUTE_MODE_DEFAULT 0
#define VTK_ATTRIBUTE_MODE_USE_POINT_DATA 1
#define VTK_ATTRIBUTE_MODE_USE_CELL_DATA 2
#include "vtkDataSetAlgorithm.h"
#include "vtkFiltersCoreModule.h" // For export macro
class VTKFILTERSCORE_EXPORT vtkVectorNorm : public vtkDataSetAlgorithm
{
public:
vtkTypeMacro(vtkVectorNorm, vtkDataSetAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent) override;
/**
* Construct with normalize flag off.
*/
static vtkVectorNorm* New();
// Specify whether to normalize scalar values. If the data is normalized,
// then it will fall in the range [0,1].
vtkSetMacro(Normalize, vtkTypeBool);
vtkGetMacro(Normalize, vtkTypeBool);
vtkBooleanMacro(Normalize, vtkTypeBool);
//@{
/**
* Control how the filter works to generate scalar data from the
* input vector data. By default, (AttributeModeToDefault) the
* filter will generate the scalar norm for point and cell data (if
* vector data present in the input). Alternatively, you can
* explicitly set the filter to generate point data
* (AttributeModeToUsePointData) or cell data
* (AttributeModeToUseCellData).
*/
vtkSetMacro(AttributeMode, int);
vtkGetMacro(AttributeMode, int);
void SetAttributeModeToDefault() { this->SetAttributeMode(VTK_ATTRIBUTE_MODE_DEFAULT); }
void SetAttributeModeToUsePointData()
{
this->SetAttributeMode(VTK_ATTRIBUTE_MODE_USE_POINT_DATA);
}
void SetAttributeModeToUseCellData() { this->SetAttributeMode(VTK_ATTRIBUTE_MODE_USE_CELL_DATA); }
const char* GetAttributeModeAsString();
//@}
protected:
vtkVectorNorm();
~vtkVectorNorm() override {}
int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
vtkTypeBool Normalize; // normalize 0<=n<=1 if true.
int AttributeMode; // control whether to use point or cell data, or both
private:
vtkVectorNorm(const vtkVectorNorm&) = delete;
void operator=(const vtkVectorNorm&) = delete;
};
#endif