mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-08 13:23:51 +00:00
7eaedfe84b
A large portion of the VTK-m filters are now compiled into the vtkm_filter library. These pre-built filters now don't include the respective hxx file to remove the amount of template instantiation users do. To verify that this removal reduces compiler memory ( and maybe time) I profiled the compiler while it building filter tests in debug mode. Here is a selection of results: ``` CleanGrid 10.25s => 9.01s, 901MB => 795MB ExternalFaces 13.40s => 5.96s, 1122MB => 744MB ExtractStructured 4.69s => 4.75s, 492MB => 492MB GradientExplicit 22.97s => 5.88s, 1296MB => 740MB ```
133 lines
4.6 KiB
C++
133 lines
4.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_ExtractStructured_h
|
|
#define vtk_m_filter_ExtractStructured_h
|
|
|
|
#include <vtkm/filter/vtkm_filter_common_export.h>
|
|
|
|
#include <vtkm/filter/FilterDataSet.h>
|
|
#include <vtkm/worklet/ExtractStructured.h>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace filter
|
|
{
|
|
/// \brief Select piece (e.g., volume of interest) and/or subsample structured points dataset
|
|
///
|
|
/// Select or subsample a portion of an input structured dataset. The selected
|
|
/// portion of interested is referred to as the Volume Of Interest, or VOI.
|
|
/// The output of this filter is a structured dataset. The filter treats input
|
|
/// data of any topological dimension (i.e., point, line, plane, or volume) and
|
|
/// can generate output data of any topological dimension.
|
|
///
|
|
/// To use this filter set the VOI ivar which are i-j-k min/max indices that
|
|
/// specify a rectangular region in the data. (Note that these are 0-offset.)
|
|
/// You can also specify a sampling rate to subsample the data.
|
|
///
|
|
/// Typical applications of this filter are to extract a slice from a volume
|
|
/// for image processing, subsampling large volumes to reduce data size, or
|
|
/// extracting regions of a volume with interesting data.
|
|
///
|
|
class VTKM_FILTER_COMMON_EXPORT ExtractStructured
|
|
: public vtkm::filter::FilterDataSet<ExtractStructured>
|
|
{
|
|
public:
|
|
ExtractStructured();
|
|
|
|
// Set the bounding box for the volume of interest
|
|
VTKM_CONT
|
|
vtkm::RangeId3 GetVOI() const { return this->VOI; }
|
|
|
|
VTKM_CONT
|
|
void SetVOI(vtkm::Id i0, vtkm::Id i1, vtkm::Id j0, vtkm::Id j1, vtkm::Id k0, vtkm::Id k1)
|
|
{
|
|
this->VOI = vtkm::RangeId3(i0, i1, j0, j1, k0, k1);
|
|
}
|
|
VTKM_CONT
|
|
void SetVOI(vtkm::Id extents[6]) { this->VOI = vtkm::RangeId3(extents); }
|
|
VTKM_CONT
|
|
void SetVOI(vtkm::Id3 minPoint, vtkm::Id3 maxPoint)
|
|
{
|
|
this->VOI = vtkm::RangeId3(minPoint, maxPoint);
|
|
}
|
|
VTKM_CONT
|
|
void SetVOI(const vtkm::RangeId3& voi) { this->VOI = voi; }
|
|
|
|
/// Get the Sampling rate
|
|
VTKM_CONT
|
|
vtkm::Id3 GetSampleRate() const { return this->SampleRate; }
|
|
|
|
/// Set the Sampling rate
|
|
VTKM_CONT
|
|
void SetSampleRate(vtkm::Id i, vtkm::Id j, vtkm::Id k) { this->SampleRate = vtkm::Id3(i, j, k); }
|
|
|
|
/// Set the Sampling rate
|
|
VTKM_CONT
|
|
void SetSampleRate(vtkm::Id3 sampleRate) { this->SampleRate = sampleRate; }
|
|
|
|
/// Get if we should include the outer boundary on a subsample
|
|
VTKM_CONT
|
|
bool GetIncludeBoundary() { return this->IncludeBoundary; }
|
|
/// Set if we should include the outer boundary on a subsample
|
|
VTKM_CONT
|
|
void SetIncludeBoundary(bool value) { this->IncludeBoundary = value; }
|
|
|
|
VTKM_CONT
|
|
void SetIncludeOffset(bool value) { this->IncludeOffset = value; }
|
|
|
|
template <typename DerivedPolicy>
|
|
VTKM_CONT vtkm::cont::DataSet DoExecute(const vtkm::cont::DataSet& input,
|
|
vtkm::filter::PolicyBase<DerivedPolicy> policy);
|
|
|
|
VTKM_CONT bool MapFieldOntoOutput(vtkm::cont::DataSet& result, const vtkm::cont::Field& field);
|
|
|
|
template <typename DerivedPolicy>
|
|
VTKM_CONT bool MapFieldOntoOutput(vtkm::cont::DataSet& result,
|
|
const vtkm::cont::Field& field,
|
|
vtkm::filter::PolicyBase<DerivedPolicy>)
|
|
{
|
|
return this->MapFieldOntoOutput(result, field);
|
|
}
|
|
|
|
|
|
VTKM_CONT void PostExecute(const vtkm::cont::PartitionedDataSet&,
|
|
vtkm::cont::PartitionedDataSet&);
|
|
|
|
template <typename DerivedPolicy>
|
|
VTKM_CONT void PostExecute(const vtkm::cont::PartitionedDataSet& input,
|
|
vtkm::cont::PartitionedDataSet& output,
|
|
const vtkm::filter::PolicyBase<DerivedPolicy>&)
|
|
{
|
|
this->PostExecute(input, output);
|
|
}
|
|
|
|
private:
|
|
vtkm::RangeId3 VOI;
|
|
vtkm::Id3 SampleRate = { 1, 1, 1 };
|
|
bool IncludeBoundary;
|
|
bool IncludeOffset;
|
|
vtkm::worklet::ExtractStructured Worklet;
|
|
|
|
vtkm::cont::ArrayHandle<vtkm::Id> CellFieldMap;
|
|
vtkm::cont::ArrayHandle<vtkm::Id> PointFieldMap;
|
|
};
|
|
|
|
#ifndef vtkm_filter_ExtractStructured_cxx
|
|
extern template VTKM_FILTER_COMMON_TEMPLATE_EXPORT vtkm::cont::DataSet ExtractStructured::DoExecute(
|
|
const vtkm::cont::DataSet&,
|
|
vtkm::filter::PolicyBase<vtkm::filter::PolicyDefault>);
|
|
#endif
|
|
}
|
|
} // namespace vtkm::filter
|
|
|
|
|
|
#endif // vtk_m_filter_ExtractStructured_h
|