ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction > Class Template Reference

#include <itkInteriorExteriorMeshFilter.h>

Detailed Description

template<typename TInputMesh, typename TOutputMesh, typename TSpatialFunction>
class itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >

InteriorExteriorMeshFilter takes an itk::Mesh and extracts from it a Sub-Mesh such that all its points Evaluate > 0 in an itk::SpatialFunction provided by the user.

This filter is templated over the Input Mesh type, the Output Mesh type and the SpatialFunctionType. However the only requirement for the Spatial function is to support SmartPointers and to provide an Execute() method, along with a type alias for OutputType (for the type returned by Execute() ).

The additional content of the mesh is passed untouched. Including the connectivity and the additional information contained on cells and points. However, attention should be paid to the cells because some of their points could not exist in the output mesh, if they did not satisfy the criterion imposed by the spatial function.

Definition at line 48 of file itkInteriorExteriorMeshFilter.h.

+ Inheritance diagram for itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >:
+ Collaboration diagram for itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using CoordRepType = typename TInputMesh::CoordRepType
 
using InputMeshPointer = typename InputMeshType::Pointer
 
using InputMeshType = TInputMesh
 
using OutputMeshPointer = typename OutputMeshType::Pointer
 
using OutputMeshType = TOutputMesh
 
using Pointer = SmartPointer< Self >
 
using Self = InteriorExteriorMeshFilter
 
using SpatialFunctionDataObjectPointer = typename SpatialFunctionDataObjectType::Pointer
 
using SpatialFunctionDataObjectType = DataObjectDecorator< SpatialFunctionType >
 
using SpatialFunctionType = TSpatialFunction
 
using Superclass = MeshToMeshFilter< TInputMesh, TOutputMesh >
 
- Public Types inherited from itk::MeshToMeshFilter< TInputMesh, TOutputMesh >
using ConstPointer = SmartPointer< const Self >
 
using InputMeshPointer = typename InputMeshType::Pointer
 
using InputMeshType = TInputMesh
 
using OutputMeshPointer = typename OutputMeshType::Pointer
 
using OutputMeshType = TOutputMesh
 
using Pointer = SmartPointer< Self >
 
using Self = MeshToMeshFilter
 
using Superclass = MeshSource< TOutputMesh >
 
- Public Types inherited from itk::MeshSource< TOutputMesh >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using OutputMeshPointer = typename OutputMeshType::Pointer
 
using OutputMeshType = TOutputMesh
 
using Pointer = SmartPointer< Self >
 
using Self = MeshSource
 
using Superclass = ProcessObject
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

const char * GetNameOfClass () const override
 
virtual void SetSpatialFunction (SpatialFunctionType *_arg)
 
virtual SpatialFunctionTypeGetModifiableSpatialFunction ()
 
- Public Member Functions inherited from itk::MeshToMeshFilter< TInputMesh, TOutputMesh >
const InputMeshTypeGetInput () const
 
const InputMeshTypeGetInput (unsigned int idx) const
 
const char * GetNameOfClass () const override
 
void SetInput (const InputMeshType *input)
 
- Public Member Functions inherited from itk::MeshSource< TOutputMesh >
OutputMeshTypeGetOutput ()
 
OutputMeshTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftOutput (DataObject *graft)
 
void SetOutput (TOutputMesh *output)
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::MeshToMeshFilter< TInputMesh, TOutputMesh >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::MeshSource< TOutputMesh >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void GenerateData () override
 
 InteriorExteriorMeshFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~InteriorExteriorMeshFilter () override=default
 
- Protected Member Functions inherited from itk::MeshToMeshFilter< TInputMesh, TOutputMesh >
void CopyInputMeshToOutputMeshCellData ()
 
void CopyInputMeshToOutputMeshCellLinks ()
 
void CopyInputMeshToOutputMeshCells ()
 
void CopyInputMeshToOutputMeshPointData ()
 
void CopyInputMeshToOutputMeshPoints ()
 
 MeshToMeshFilter ()
 
 ~MeshToMeshFilter () override=default
 
- Protected Member Functions inherited from itk::MeshSource< TOutputMesh >
void GenerateInputRequestedRegion () override
 
 MeshSource ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~MeshSource () override=default
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

SpatialFunctionType::Pointer m_SpatialFunction {}
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 

Member Typedef Documentation

◆ ConstPointer

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
using itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::ConstPointer = SmartPointer<const Self>

Definition at line 57 of file itkInteriorExteriorMeshFilter.h.

◆ CoordRepType

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
using itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::CoordRepType = typename TInputMesh::CoordRepType

Type for representing coordinates.

Definition at line 65 of file itkInteriorExteriorMeshFilter.h.

◆ InputMeshPointer

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
using itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::InputMeshPointer = typename InputMeshType::Pointer

Definition at line 61 of file itkInteriorExteriorMeshFilter.h.

◆ InputMeshType

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
using itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::InputMeshType = TInputMesh

Definition at line 59 of file itkInteriorExteriorMeshFilter.h.

◆ OutputMeshPointer

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
using itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::OutputMeshPointer = typename OutputMeshType::Pointer

Definition at line 62 of file itkInteriorExteriorMeshFilter.h.

◆ OutputMeshType

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
using itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::OutputMeshType = TOutputMesh

Definition at line 60 of file itkInteriorExteriorMeshFilter.h.

◆ Pointer

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
using itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::Pointer = SmartPointer<Self>

Definition at line 56 of file itkInteriorExteriorMeshFilter.h.

◆ Self

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
using itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::Self = InteriorExteriorMeshFilter

Standard class type aliases.

Definition at line 54 of file itkInteriorExteriorMeshFilter.h.

◆ SpatialFunctionDataObjectPointer

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
using itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::SpatialFunctionDataObjectPointer = typename SpatialFunctionDataObjectType::Pointer

Definition at line 82 of file itkInteriorExteriorMeshFilter.h.

◆ SpatialFunctionDataObjectType

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
using itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::SpatialFunctionDataObjectType = DataObjectDecorator<SpatialFunctionType>

Definition at line 81 of file itkInteriorExteriorMeshFilter.h.

◆ SpatialFunctionType

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
using itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::SpatialFunctionType = TSpatialFunction

Type of the transform.

Definition at line 68 of file itkInteriorExteriorMeshFilter.h.

◆ Superclass

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
using itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::Superclass = MeshToMeshFilter<TInputMesh, TOutputMesh>

Definition at line 55 of file itkInteriorExteriorMeshFilter.h.

Constructor & Destructor Documentation

◆ InteriorExteriorMeshFilter()

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::InteriorExteriorMeshFilter ( )
protected

◆ ~InteriorExteriorMeshFilter()

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::~InteriorExteriorMeshFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ GenerateData()

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
void itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::GenerateData ( )
overrideprotectedvirtual

Generate requested data.

Reimplemented from itk::ProcessObject.

◆ GetModifiableSpatialFunction()

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
virtual SpatialFunctionType* itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::GetModifiableSpatialFunction ( )
virtual

Get/Set the spatial function.

◆ GetNameOfClass()

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
const char* itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::GetNameOfClass ( ) const
overridevirtual

◆ New()

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
static Pointer itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
void itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ProcessObject.

◆ SetSpatialFunction()

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
virtual void itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::SetSpatialFunction ( SpatialFunctionType _arg)
virtual

Get/Set the spatial function.

Member Data Documentation

◆ m_SpatialFunction

template<typename TInputMesh , typename TOutputMesh , typename TSpatialFunction >
SpatialFunctionType::Pointer itk::InteriorExteriorMeshFilter< TInputMesh, TOutputMesh, TSpatialFunction >::m_SpatialFunction {}
protected

Transform applied to all the mesh points.

Definition at line 95 of file itkInteriorExteriorMeshFilter.h.


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