VTK-m  1.4
Public Types | Public Member Functions | Private Attributes | List of all members
vtkm::filter::MarchingCubes Class Reference

generate isosurface(s) from a Volume More...

#include <MarchingCubes.h>

Inheritance diagram for vtkm::filter::MarchingCubes:
Inheritance graph
[legend]
Collaboration diagram for vtkm::filter::MarchingCubes:
Collaboration graph
[legend]

Public Types

using SupportedTypes = vtkm::ListTagBase< vtkm::UInt8, vtkm::Int8, vtkm::Float32, vtkm::Float64 >
 
- Public Types inherited from vtkm::filter::Filter< MarchingCubes >
using SupportedTypes = vtkm::ListTagUniversal
 Specify which subset of types a filter supports. More...
 

Public Member Functions

VTKM_CONT MarchingCubes ()
 
VTKM_CONT void SetNumberOfIsoValues (vtkm::Id num)
 
VTKM_CONT vtkm::Id GetNumberOfIsoValues () const
 
VTKM_CONT void SetIsoValue (vtkm::Float64 v)
 
VTKM_CONT void SetIsoValue (vtkm::Id index, vtkm::Float64)
 
VTKM_CONT void SetIsoValues (const std::vector< vtkm::Float64 > &values)
 
VTKM_CONT vtkm::Float64 GetIsoValue (vtkm::Id index) const
 
VTKM_CONT void SetMergeDuplicatePoints (bool on)
 Set/Get whether the points generated should be unique for every triangle or will duplicate points be merged together. More...
 
VTKM_CONT bool GetMergeDuplicatePoints () const
 
VTKM_CONT void SetGenerateNormals (bool on)
 Set/Get whether normals should be generated. More...
 
VTKM_CONT bool GetGenerateNormals () const
 
VTKM_CONT void SetAddInterpolationEdgeIds (bool on)
 Set/Get whether to append the ids of the intersected edges to the vertices of the isosurface triangles. Off by default. More...
 
VTKM_CONT bool GetAddInterpolationEdgeIds () const
 
VTKM_CONT void SetComputeFastNormalsForStructured (bool on)
 Set/Get whether the fast path should be used for normals computation for structured datasets. More...
 
VTKM_CONT bool GetComputeFastNormalsForStructured () const
 
VTKM_CONT void SetComputeFastNormalsForUnstructured (bool on)
 Set/Get whether the fast path should be used for normals computation for unstructured datasets. More...
 
VTKM_CONT bool GetComputeFastNormalsForUnstructured () const
 
VTKM_CONT void SetNormalArrayName (const std::string &name)
 
VTKM_CONT const std::string & GetNormalArrayName () const
 
template<typename T , typename StorageType , typename DerivedPolicy >
VTKM_CONT vtkm::cont::DataSet DoExecute (const vtkm::cont::DataSet &input, const vtkm::cont::ArrayHandle< T, StorageType > &field, const vtkm::filter::FieldMetadata &fieldMeta, const vtkm::filter::PolicyBase< DerivedPolicy > &policy)
 
template<typename T , typename StorageType , typename DerivedPolicy >
VTKM_CONT bool DoMapField (vtkm::cont::DataSet &result, const vtkm::cont::ArrayHandle< T, StorageType > &input, const vtkm::filter::FieldMetadata &fieldMeta, const vtkm::filter::PolicyBase< DerivedPolicy > &policy)
 
- Public Member Functions inherited from vtkm::filter::FilterDataSetWithField< MarchingCubes >
VTKM_CONT FilterDataSetWithField ()
 
VTKM_CONT ~FilterDataSetWithField ()
 
VTKM_CONT void SetActiveCellSetIndex (vtkm::Id index)
 
VTKM_CONT vtkm::Id GetActiveCellSetIndex () const
 
VTKM_CONT void SetActiveCoordinateSystem (vtkm::Id index)
 
VTKM_CONT vtkm::Id GetActiveCoordinateSystemIndex () const
 
VTKM_CONT bool MapFieldOntoOutput (vtkm::cont::DataSet &result, const vtkm::cont::Field &field, const vtkm::filter::PolicyBase< DerivedPolicy > &policy)
 
VTKM_CONT vtkm::cont::DataSet PrepareForExecution (const vtkm::cont::DataSet &input, const vtkm::filter::PolicyBase< DerivedPolicy > &policy)
 
VTKM_CONT void SetActiveField (const std::string &name, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::ANY)
 Choose the field to operate on. More...
 
VTKM_CONT const std::string & GetActiveFieldName () const
 Choose the field to operate on. More...
 
VTKM_CONT vtkm::cont::Field::Association GetActiveFieldAssociation () const
 Choose the field to operate on. More...
 
VTKM_CONT void SetUseCoordinateSystemAsField (bool val)
 To simply use the active coordinate system as the field to operate on, set UseCoordinateSystemAsField to true. More...
 
VTKM_CONT bool GetUseCoordinateSystemAsField () const
 To simply use the active coordinate system as the field to operate on, set UseCoordinateSystemAsField to true. More...
 
- Public Member Functions inherited from vtkm::filter::Filter< MarchingCubes >
VTKM_CONT Filter ()
 
VTKM_CONT ~Filter ()
 
VTKM_CONT void MapFieldsToPass (const vtkm::cont::DataSet &input, vtkm::cont::DataSet &output, const vtkm::filter::PolicyBase< DerivedPolicy > &policy)
 Map fields from input dataset to output. More...
 
void SetInvoker (vtkm::cont::Invoker inv)
 Specify the vtkm::cont::Invoker to be used to execute worklets by this filter instance. More...
 
VTKM_CONT vtkm::cont::DataSet Execute (const vtkm::cont::DataSet &input)
 Executes the filter on the input and produces a result dataset. More...
 
VTKM_CONT vtkm::cont::DataSet Execute (const vtkm::cont::DataSet &input, const vtkm::filter::PolicyBase< DerivedPolicy > &policy)
 Executes the filter on the input and produces a result dataset. More...
 
VTKM_CONT vtkm::cont::MultiBlock Execute (const vtkm::cont::MultiBlock &input)
 Executes the filter on the input MultiBlock and produces a result MultiBlock. More...
 
VTKM_CONT vtkm::cont::MultiBlock Execute (const vtkm::cont::MultiBlock &input, const vtkm::filter::PolicyBase< DerivedPolicy > &policy)
 Executes the filter on the input MultiBlock and produces a result MultiBlock. More...
 
VTKM_CONT void SetFieldsToPass (const vtkm::filter::FieldSelection &fieldsToPass)
 Specify which fields get passed from input to output. More...
 
VTKM_CONT void SetFieldsToPass (const vtkm::filter::FieldSelection &fieldsToPass, vtkm::filter::FieldSelection::ModeEnum mode)
 Specify which subset of types a filter supports. More...
 
VTKM_CONT void SetFieldsToPass (const std::string &fieldname, vtkm::cont::Field::Association association, vtkm::filter::FieldSelection::ModeEnum mode=vtkm::filter::FieldSelection::MODE_SELECT)
 Specify which subset of types a filter supports. More...
 
VTKM_CONT const vtkm::filter::FieldSelectionGetFieldsToPass () const
 Specify which subset of types a filter supports. More...
 
VTKM_CONT vtkm::filter::FieldSelectionGetFieldsToPass ()
 Specify which subset of types a filter supports. More...
 

Private Attributes

std::vector< vtkm::Float64IsoValues
 
bool GenerateNormals
 
bool AddInterpolationEdgeIds
 
bool ComputeFastNormalsForStructured
 
bool ComputeFastNormalsForUnstructured
 
std::string NormalArrayName
 
std::string InterpolationEdgeIdsArrayName
 
vtkm::worklet::MarchingCubes Worklet
 

Additional Inherited Members

- Protected Attributes inherited from vtkm::filter::Filter< MarchingCubes >
vtkm::cont::Invoker Invoke
 

Detailed Description

generate isosurface(s) from a Volume

Takes as input a volume (e.g., 3D structured point set) and generates on output one or more isosurfaces. Multiple contour values must be specified to generate the isosurfaces.

Warning
This filter is currently only supports 3D volumes.

Member Typedef Documentation

Constructor & Destructor Documentation

VTKM_CONT vtkm::filter::MarchingCubes::MarchingCubes ( )

Member Function Documentation

template<typename T , typename StorageType , typename DerivedPolicy >
VTKM_CONT vtkm::cont::DataSet vtkm::filter::MarchingCubes::DoExecute ( const vtkm::cont::DataSet input,
const vtkm::cont::ArrayHandle< T, StorageType > &  field,
const vtkm::filter::FieldMetadata fieldMeta,
const vtkm::filter::PolicyBase< DerivedPolicy > &  policy 
)
template<typename T , typename StorageType , typename DerivedPolicy >
VTKM_CONT bool vtkm::filter::MarchingCubes::DoMapField ( vtkm::cont::DataSet result,
const vtkm::cont::ArrayHandle< T, StorageType > &  input,
const vtkm::filter::FieldMetadata fieldMeta,
const vtkm::filter::PolicyBase< DerivedPolicy > &  policy 
)
VTKM_CONT bool vtkm::filter::MarchingCubes::GetAddInterpolationEdgeIds ( ) const
inline
VTKM_CONT bool vtkm::filter::MarchingCubes::GetComputeFastNormalsForStructured ( ) const
inline
VTKM_CONT bool vtkm::filter::MarchingCubes::GetComputeFastNormalsForUnstructured ( ) const
inline
VTKM_CONT bool vtkm::filter::MarchingCubes::GetGenerateNormals ( ) const
inline
VTKM_CONT vtkm::Float64 vtkm::filter::MarchingCubes::GetIsoValue ( vtkm::Id  index) const
VTKM_CONT bool vtkm::filter::MarchingCubes::GetMergeDuplicatePoints ( ) const
inline
VTKM_CONT const std::string& vtkm::filter::MarchingCubes::GetNormalArrayName ( ) const
inline
VTKM_CONT vtkm::Id vtkm::filter::MarchingCubes::GetNumberOfIsoValues ( ) const
VTKM_CONT void vtkm::filter::MarchingCubes::SetAddInterpolationEdgeIds ( bool  on)
inline

Set/Get whether to append the ids of the intersected edges to the vertices of the isosurface triangles. Off by default.

VTKM_CONT void vtkm::filter::MarchingCubes::SetComputeFastNormalsForStructured ( bool  on)
inline

Set/Get whether the fast path should be used for normals computation for structured datasets.

Off by default.

VTKM_CONT void vtkm::filter::MarchingCubes::SetComputeFastNormalsForUnstructured ( bool  on)
inline

Set/Get whether the fast path should be used for normals computation for unstructured datasets.

On by default.

VTKM_CONT void vtkm::filter::MarchingCubes::SetGenerateNormals ( bool  on)
inline

Set/Get whether normals should be generated.

Off by default. If enabled, the default behaviour is to generate high quality normals for structured datasets, using gradients, and generate fast normals for unstructured datasets based on the result triangle mesh.

VTKM_CONT void vtkm::filter::MarchingCubes::SetIsoValue ( vtkm::Float64  v)
inline
VTKM_CONT void vtkm::filter::MarchingCubes::SetIsoValue ( vtkm::Id  index,
vtkm::Float64   
)
VTKM_CONT void vtkm::filter::MarchingCubes::SetIsoValues ( const std::vector< vtkm::Float64 > &  values)
VTKM_CONT void vtkm::filter::MarchingCubes::SetMergeDuplicatePoints ( bool  on)
inline

Set/Get whether the points generated should be unique for every triangle or will duplicate points be merged together.

Duplicate points are identified by the unique edge it was generated from.

VTKM_CONT void vtkm::filter::MarchingCubes::SetNormalArrayName ( const std::string &  name)
inline
VTKM_CONT void vtkm::filter::MarchingCubes::SetNumberOfIsoValues ( vtkm::Id  num)

Member Data Documentation

bool vtkm::filter::MarchingCubes::AddInterpolationEdgeIds
private
bool vtkm::filter::MarchingCubes::ComputeFastNormalsForStructured
private
bool vtkm::filter::MarchingCubes::ComputeFastNormalsForUnstructured
private
bool vtkm::filter::MarchingCubes::GenerateNormals
private
std::string vtkm::filter::MarchingCubes::InterpolationEdgeIdsArrayName
private
std::vector<vtkm::Float64> vtkm::filter::MarchingCubes::IsoValues
private
std::string vtkm::filter::MarchingCubes::NormalArrayName
private
vtkm::worklet::MarchingCubes vtkm::filter::MarchingCubes::Worklet
private

The documentation for this class was generated from the following file: