ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField > Class Template Reference

#include <itkWarpMeshFilter.h>

+ Inheritance diagram for itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >:
+ Collaboration diagram for itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using CoordRepType = typename TInputMesh::CoordRepType
 
using DisplacementFieldPointer = typename DisplacementFieldType::ConstPointer
 
using DisplacementFieldType = TDisplacementField
 
using DisplacementType = typename DisplacementFieldType::PixelType
 
using InputMeshPointer = typename InputMeshType::Pointer
 
using InputMeshType = TInputMesh
 
using OutputMeshPointer = typename OutputMeshType::Pointer
 
using OutputMeshType = TOutputMesh
 
using Pointer = SmartPointer< Self >
 
using Self = WarpMeshFilter
 
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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
const DisplacementFieldTypeGetDisplacementField () const
 
virtual const char * GetNameOfClass () const
 
void SetDisplacementField (const DisplacementFieldType *field)
 
- Public Member Functions inherited from itk::MeshToMeshFilter< TInputMesh, TOutputMesh >
const InputMeshTypeGetInput () const
 
const InputMeshTypeGetInput (unsigned int idx) const
 
void SetInput (const InputMeshType *input)
 
- Public Member Functions inherited from itk::MeshSource< TOutputMesh >
OutputMeshTypeGetOutput ()
 
OutputMeshTypeGetOutput (unsigned int idx)
 
void SetOutput (TOutputMesh *output)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
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 PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

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

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TInputMesh, typename TOutputMesh, typename TDisplacementField>
class itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >

WarpMeshFilter applies a deformation field to all the points of a mesh. The deformation field is represented as an image of Vectors.

The additional content of the mesh is passed untouched. Including the connectivity and the additional information contained on cells and points.

Meshes that have added information like normal vector on the points, will have to take care of transforming this data by other means.

See also
TransformMeshFilter

Definition at line 42 of file itkWarpMeshFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
using itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::ConstPointer = SmartPointer<const Self>

Definition at line 51 of file itkWarpMeshFilter.h.

◆ CoordRepType

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
using itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::CoordRepType = typename TInputMesh::CoordRepType

Type for representing coordinates.

Definition at line 60 of file itkWarpMeshFilter.h.

◆ DisplacementFieldPointer

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
using itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::DisplacementFieldPointer = typename DisplacementFieldType::ConstPointer

Definition at line 64 of file itkWarpMeshFilter.h.

◆ DisplacementFieldType

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
using itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::DisplacementFieldType = TDisplacementField

Deformation field type alias support

Definition at line 63 of file itkWarpMeshFilter.h.

◆ DisplacementType

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
using itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::DisplacementType = typename DisplacementFieldType::PixelType

Definition at line 65 of file itkWarpMeshFilter.h.

◆ InputMeshPointer

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
using itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::InputMeshPointer = typename InputMeshType::Pointer

Definition at line 54 of file itkWarpMeshFilter.h.

◆ InputMeshType

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
using itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::InputMeshType = TInputMesh

Definition at line 53 of file itkWarpMeshFilter.h.

◆ OutputMeshPointer

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
using itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::OutputMeshPointer = typename OutputMeshType::Pointer

Definition at line 57 of file itkWarpMeshFilter.h.

◆ OutputMeshType

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
using itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::OutputMeshType = TOutputMesh

Definition at line 56 of file itkWarpMeshFilter.h.

◆ Pointer

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
using itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::Pointer = SmartPointer<Self>

Definition at line 50 of file itkWarpMeshFilter.h.

◆ Self

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
using itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::Self = WarpMeshFilter

Standard class type aliases.

Definition at line 48 of file itkWarpMeshFilter.h.

◆ Superclass

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
using itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::Superclass = MeshToMeshFilter<TInputMesh, TOutputMesh>

Definition at line 49 of file itkWarpMeshFilter.h.

Constructor & Destructor Documentation

◆ WarpMeshFilter()

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::WarpMeshFilter ( )
protected

◆ ~WarpMeshFilter()

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::~WarpMeshFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
virtual::itk::LightObject::Pointer itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::MeshToMeshFilter< TInputMesh, TOutputMesh >.

◆ GenerateData()

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
void itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::GenerateData ( )
overrideprotectedvirtual

Generate Requested Data

Reimplemented from itk::ProcessObject.

◆ GetDisplacementField()

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
const DisplacementFieldType* itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::GetDisplacementField ( ) const

Get a pointer the deformation field.

◆ GetNameOfClass()

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
virtual const char* itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::MeshToMeshFilter< TInputMesh, TOutputMesh >.

◆ New()

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
static Pointer itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

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

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a SmartPointer to a DataObject. If a subclass of MeshSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().

Reimplemented from itk::MeshSource< TOutputMesh >.

◆ SetDisplacementField()

template<typename TInputMesh , typename TOutputMesh , typename TDisplacementField >
void itk::WarpMeshFilter< TInputMesh, TOutputMesh, TDisplacementField >::SetDisplacementField ( const DisplacementFieldType field)

Set the deformation field.


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