mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-19 18:45:43 +00:00
a68422d454
This filter adds a pair of fields to a `DataSet` which mirror the indices of the points and cells, respectively. These fields are useful for tracking the provenance of the elements of a `DataSet` as it gets manipulated by the filters. It is also convenient for adding indices to operations designed for fields and for testing purposes.
105 lines
3.6 KiB
C++
105 lines
3.6 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_filter_GenerateIds_h
|
|
#define vtk_m_filter_GenerateIds_h
|
|
|
|
#include <vtkm/filter/Filter.h>
|
|
|
|
#include <vtkm/filter/vtkm_filter_extra_export.h>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace filter
|
|
{
|
|
|
|
/// \brief Adds fields to a `DataSet` that give the ids for the points and cells.
|
|
///
|
|
/// This filter will add (by default) a point field named `pointids` that gives the
|
|
/// index of the associated point and likewise a cell field named `cellids` for the
|
|
/// associated cell indices. These fields are useful for tracking the provenance of
|
|
/// the elements of a `DataSet` as it gets manipulated by filters. It is also
|
|
/// convenient for adding indices to operations designed for fields and generally
|
|
/// creating test data.
|
|
///
|
|
class VTKM_FILTER_EXTRA_EXPORT GenerateIds : public vtkm::filter::Filter<GenerateIds>
|
|
{
|
|
std::string PointFieldName = "pointids";
|
|
std::string CellFieldName = "cellids";
|
|
bool GeneratePointIds = true;
|
|
bool GenerateCellIds = true;
|
|
bool UseFloat = false;
|
|
|
|
public:
|
|
GenerateIds() = default;
|
|
~GenerateIds() = default;
|
|
|
|
/// \{
|
|
/// \brief The name given to the generated point field.
|
|
///
|
|
/// By default, the name is `pointids`.
|
|
///
|
|
const std::string& GetPointFieldName() const { return this->PointFieldName; }
|
|
void SetPointFieldName(const std::string& name) { this->PointFieldName = name; }
|
|
/// \}
|
|
|
|
/// \{
|
|
/// \brief The name given to the generated cell field.
|
|
///
|
|
/// By default, the name is `cellids`.
|
|
///
|
|
const std::string& GetCellFieldName() const { return this->CellFieldName; }
|
|
void SetCellFieldName(const std::string& name) { this->CellFieldName = name; }
|
|
/// \}
|
|
|
|
/// \{
|
|
/// \brief Specify whether the point id field is generated.
|
|
///
|
|
/// When `GeneratePointIds` is `true` (the default), a field echoing the point
|
|
/// indices is generated. When set to `false`, this output is not created.
|
|
///
|
|
bool GetGeneratePointIds() const { return this->GeneratePointIds; }
|
|
void SetGeneratePointIds(bool flag) { this->GeneratePointIds = flag; }
|
|
/// \}
|
|
|
|
/// \{
|
|
/// \brief Specify whether the cell id field is generated.
|
|
///
|
|
/// When `GenerateCellIds` is `true` (the default), a field echoing the cell
|
|
/// indices is generated. When set to `false`, this output is not created.
|
|
///
|
|
bool GetGenerateCellIds() const { return this->GenerateCellIds; }
|
|
void SetGenerateCellIds(bool flag) { this->GenerateCellIds = flag; }
|
|
/// \}
|
|
|
|
/// \{
|
|
/// \brief Specify whether the generated fields should be integer or float.
|
|
///
|
|
/// When `UseFloat` is `false` (the default), then the fields generated will have
|
|
/// type `vtkm::Id`. If it is set to `true`, then the fields will be generated
|
|
/// with type `vtkm::FloatDefault`.
|
|
///
|
|
bool GetUseFloat() const { return this->UseFloat; }
|
|
void SetUseFloat(bool flag) { this->UseFloat = flag; }
|
|
|
|
vtkm::cont::DataSet DoExecute(const vtkm::cont::DataSet& input) const;
|
|
|
|
template <typename DerivedPolicy>
|
|
vtkm::cont::DataSet PrepareForExecution(const vtkm::cont::DataSet& input,
|
|
vtkm::filter::PolicyBase<DerivedPolicy>) const
|
|
{
|
|
return this->DoExecute(input);
|
|
}
|
|
};
|
|
|
|
} // namespace vtkm::filter
|
|
} // namespace vtkm
|
|
|
|
#endif //vtk_m_filter_GenerateIds_h
|