98f20ec269
According to talks with Rob Maynard, using a worklet should be (counterintuitively) faster than using ArrayHandlePermutation with ArrayCopy. This change also gives an opportunity to handle invalid indices, which may be intentionally set when no mapping is available for that value. For this case, MapFieldPermutation now takes an invalidValue argument to set such values.
83 lines
3.8 KiB
C++
83 lines
3.8 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_MapFieldPermutation_h
|
|
#define vtk_m_filter_MapFieldPermutation_h
|
|
|
|
#include <vtkm/cont/ArrayHandle.h>
|
|
#include <vtkm/cont/DataSet.h>
|
|
#include <vtkm/cont/Field.h>
|
|
|
|
#include <vtkm/filter/vtkm_filter_export.h>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace filter
|
|
{
|
|
|
|
/// \brief Maps a field by permuting it by a given index array.
|
|
///
|
|
/// This method will create a new field containing the data from the provided `inputField` but
|
|
/// reorded by the given `permutation` index array. The value in the resulting field for index _i_
|
|
/// will be be a value from `inputField`, but comes from the index that comes from `permutation` at
|
|
/// position _i_. The result is placed in `outputField`.
|
|
///
|
|
/// The intention of this method is to implement the `MapFieldOntoOutput` methods in filters (many
|
|
/// of which require this permutation of a field), but can be used in other places as well.
|
|
///
|
|
/// `outputField` is set to have the same metadata as the input. If the metadata needs to change
|
|
/// (such as the name or the association) that should be done after the function returns.
|
|
///
|
|
/// This function returns whether the field was successfully permuted. If the returned result is
|
|
/// `true`, then the results in `outputField` are valid. If it is `false`, then `outputField`
|
|
/// should not be used.
|
|
///
|
|
/// If an invalid index is given in the permutation array (i.e. less than 0 or greater than the
|
|
/// size of the array), then the resulting outputField will be given `invalidValue` (converted as
|
|
/// best as possible to the correct data type).
|
|
///
|
|
VTKM_FILTER_EXPORT VTKM_CONT bool MapFieldPermutation(
|
|
const vtkm::cont::Field& inputField,
|
|
const vtkm::cont::ArrayHandle<vtkm::Id>& permutation,
|
|
vtkm::cont::Field& outputField,
|
|
vtkm::Float64 invalidValue = vtkm::Nan<vtkm::Float64>());
|
|
|
|
/// \brief Maps a field by permuting it by a given index array.
|
|
///
|
|
/// This method will create a new field containing the data from the provided `inputField` but
|
|
/// reorded by the given `permutation` index array. The value in the resulting field for index _i_
|
|
/// will be be a value from `inputField`, but comes from the index that comes from `permutation` at
|
|
/// position _i_.
|
|
///
|
|
/// The intention of this method is to implement the `MapFieldOntoOutput` methods in filters (many
|
|
/// of which require this permutation of a field), but can be used in other places as well. The
|
|
/// resulting field is put in the given `DataSet`.
|
|
///
|
|
/// The returned `Field` has the same metadata as the input. If the metadata needs to change (such
|
|
/// as the name or the association), then a different form of `MapFieldPermutation` should be used.
|
|
///
|
|
/// This function returns whether the field was successfully permuted. If the returned result is
|
|
/// `true`, then `outputData` has the permuted field. If it is `false`, then the field is not
|
|
/// placed in `outputData`.
|
|
///
|
|
/// If an invalid index is given in the permutation array (i.e. less than 0 or greater than the
|
|
/// size of the array), then the resulting outputField will be given `invalidValue` (converted as
|
|
/// best as possible to the correct data type).
|
|
///
|
|
VTKM_FILTER_EXPORT VTKM_CONT bool MapFieldPermutation(
|
|
const vtkm::cont::Field& inputField,
|
|
const vtkm::cont::ArrayHandle<vtkm::Id>& permutation,
|
|
vtkm::cont::DataSet& outputData,
|
|
vtkm::Float64 invalidValue = vtkm::Nan<vtkm::Float64>());
|
|
}
|
|
} // namespace vtkm::filter
|
|
|
|
#endif //vtk_m_filter_MapFieldPermutation_h
|