ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Private Attributes | List of all members
itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType > Class Template Reference

#include <itkTransformToStrainFilter.h>

+ Inheritance diagram for itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >:
+ Collaboration diagram for itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >:

Detailed Description

template<typename TTransform, typename TOperatorValueType = float, typename TOutputValueType = float>
class itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >

Generate a strain field image from a transform.

Template Parameters
TTransformThe first template parameter is the input transform type.
TOperatorValueTypeThe second template parameter defines the value type used in the derivative operator (defaults to float).
TOutputValueTypeThe third template parameter defines the value type used for output image (defaults to float). The output image is defined as a symmetric second rank tensor image whose value type is specified as this third template parameter.

Three different types of strains can be calculated, infinitesimal (default), aka engineering strain, which is appropriate for small strains, Green-Lagrangian, which uses a material reference system, and Eulerian-Almansi, which uses a spatial reference system. This is set with SetStrainForm().

See Also
StrainImageFilter

Definition at line 54 of file itkTransformToStrainFilter.h.

Public Types

using ConstPointer = SmartPointer< const Self >
 
using OutputImageType = Image< OutputPixelType, ImageDimension >
 
using OutputPixelType = SymmetricSecondRankTensor< TOutputValueType, ImageDimension >
 
using Pointer = SmartPointer< Self >
 
using Self = TransformToStrainFilter
 
enum  StrainFormType {
  INFINITESIMAL = 0,
  GREENLAGRANGIAN = 1,
  EULERIANALMANSI = 2
}
 
using Superclass = GenerateImageSource< OutputImageType >
 
using TransformInputType = DataObjectDecorator< TransformType >
 
using TransformType = TTransform
 
- Public Types inherited from itk::GenerateImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension > >
using ConstPointer = SmartPointer< const Self >
 
using DirectionType = typename OutputImageType::DirectionType
 
using IndexType = typename OutputImageType::IndexType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageType = Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension >
 
using PixelType = typename OutputImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename OutputImageType::PointType
 
using ReferenceImageBaseType = ImageBase< Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension >::ImageDimension >
 
using RegionType = typename OutputImageType::RegionType
 
using Self = GenerateImageSource
 
using SizeType = typename Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension >::SizeType
 
using SizeValueType = typename Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension >::SizeValueType
 
using SpacingType = typename OutputImageType::SpacingType
 
using Superclass = ImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension > >
 
- Public Types inherited from itk::ImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension > >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension >
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- 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
 
virtual const
DataObjectDecorator
< TransformType > * 
GetInputnumber () const
 
virtual const char * GetNameOfClass () const
 
virtual StrainFormType GetStrainForm () const
 
virtual const TransformTypeGetTransform () const
 
virtual const
DataObjectDecorator
< TransformType > * 
GetTransformInput () const
 
virtual const
DataObjectDecorator
< TransformType > * 
GetTransformInput () const
 
virtual void SetInputnumber (const DataObjectDecorator< TransformType > *_arg)
 
virtual void SetStrainForm (StrainFormType _arg)
 
virtual void SetTransform (const TransformType *_arg)
 
virtual void SetTransformInput (const DataObjectDecorator< TransformType > *_arg)
 
- Public Member Functions inherited from itk::GenerateImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension > >
virtual const
ReferenceImageBaseType
GetReferenceImage () const
 
virtual bool GetUseReferenceImage () const
 
void SetOutputParametersFromImage (const ReferenceImageBaseType *image)
 
virtual void SetReferenceImage (const ReferenceImageBaseType *input)
 
virtual void SetUseReferenceImage (bool _arg)
 
virtual void UseReferenceImageOff ()
 
virtual void UseReferenceImageOn ()
 
virtual void SetSize (SizeType _arg)
 
virtual void SetSize (SizeValueType data[])
 
virtual const SizeTypeGetSize () const
 
virtual void SetSpacing (SpacingType _arg)
 
virtual void SetSpacing (const float data[])
 
virtual const SpacingTypeGetSpacing () const
 
virtual void SetOrigin (PointType _arg)
 
virtual void SetOrigin (const float data[])
 
virtual const PointTypeGetOrigin () const
 
virtual void SetDirection (DirectionType _arg)
 
virtual const DirectionTypeGetDirection () const
 
virtual void SetStartIndex (IndexType _arg)
 
virtual const IndexTypeGetStartIndex () const
 
- Public Member Functions inherited from itk::ImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension > >
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) 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 ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
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 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
 
- 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 noexceptoverride
 
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::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 ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TTransform::InputSpaceDimension
 
- Static Public Attributes inherited from itk::GenerateImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension > >
static constexpr unsigned int NDimensions
 
- Static Public Attributes inherited from itk::ImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension > >
static constexpr unsigned int OutputImageDimension
 

Protected Types

using OutputRegionType = typename OutputImageType::RegionType
 

Protected Member Functions

void BeforeThreadedGenerateData () override
 
void DynamicThreadedGenerateData (const OutputRegionType &outputRegion) override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 TransformToStrainFilter ()
 
- Protected Member Functions inherited from itk::GenerateImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension > >
 GenerateImageSource ()
 
void GenerateOutputInformation () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~GenerateImageSource () override=default
 
- Protected Member Functions inherited from itk::ImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension > >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicMultiThreadingOff ()
 
- 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 GenerateInputRequestedRegion ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () 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 num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
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 idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
 ~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 ()
 

Private Attributes

StrainFormType m_StrainForm
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension > >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static
ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION 
ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension > >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::ConstPointer = SmartPointer< const Self >

Definition at line 74 of file itkTransformToStrainFilter.h.

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::OutputImageType = Image< OutputPixelType, ImageDimension >

Definition at line 67 of file itkTransformToStrainFilter.h.

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::OutputPixelType = SymmetricSecondRankTensor< TOutputValueType, ImageDimension >

Definition at line 66 of file itkTransformToStrainFilter.h.

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::OutputRegionType = typename OutputImageType::RegionType
protected

Definition at line 98 of file itkTransformToStrainFilter.h.

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::Pointer = SmartPointer< Self >

Definition at line 73 of file itkTransformToStrainFilter.h.

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::Self = TransformToStrainFilter

Standard class type alias.

Definition at line 70 of file itkTransformToStrainFilter.h.

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::Superclass = GenerateImageSource< OutputImageType >

Definition at line 71 of file itkTransformToStrainFilter.h.

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::TransformInputType = DataObjectDecorator< TransformType >

Definition at line 65 of file itkTransformToStrainFilter.h.

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::TransformType = TTransform

Definition at line 64 of file itkTransformToStrainFilter.h.

Member Enumeration Documentation

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
enum itk::TransformToStrainFilter::StrainFormType

Three different types of strains can be calculated, infinitesimal (default), aka engineering strain, which is appropriate for small strains, Green-Lagrangian, which uses a material reference system, and Eulerian-Almansi, which uses a spatial reference system. This is set with SetStrainForm().

Enumerator
INFINITESIMAL 
GREENLAGRANGIAN 
EULERIANALMANSI 

Definition at line 92 of file itkTransformToStrainFilter.h.

Constructor & Destructor Documentation

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::TransformToStrainFilter ( )
protected

Member Function Documentation

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
void itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::BeforeThreadedGenerateData ( )
overrideprotectedvirtual

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension > >.

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual::itk::LightObject::Pointer itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::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::Object.

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
void itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::DynamicThreadedGenerateData ( const OutputRegionType outputRegionForThread)
overrideprotectedvirtual

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData() or DynamicThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call (Dynamic)ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of (Dynamic)ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a (Dynamic)ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The (Dynamic)ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. (Dynamic)ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

DynamicThreadedGenerateData() is the newer variant without threadId, and is the preferred signature, which is called by default. This variant can split the requested region into different number of pieces depending on current multi-processing load, which allows better load balancing. The non-dynamic (also known as classic) ThreadedGenerateData() signature has threadId, and number of pieces to be split into is known in advance. It is activated by calling this->DynamicMultiThreadingOff(); in derived class constructor. It should be used when the multi-threaded algorithm needs to pre-allocate some data structure with size dependent on the number of pieces (also known as chunks, work units, and sometimes also incorrectly as threads). Only PlatformMultiThreader guarantees that each piece will be processed in its own specific thread. Pool and TBB multi-threaders maintain a pool of threads (normally equal to number of processing cores) which they use to process the pieces. This normally results in a single thread being reused to process multiple work units.

See Also
GenerateData(), SplitRequestedRegion()

Reimplemented from itk::ImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension > >.

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual const DataObjectDecorator< TransformType >* itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::GetInputnumber ( ) const
virtual
template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual const char* itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::GetNameOfClass ( ) const
virtual
template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual StrainFormType itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::GetStrainForm ( ) const
virtual
template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual const TransformType* itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::GetTransform ( ) const
virtual
template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual const DataObjectDecorator< TransformType >* itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::GetTransformInput ( ) const
virtual
template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual const DataObjectDecorator< TransformType >* itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::GetTransformInput ( ) const
virtual
template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
static Pointer itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::New ( )
static

Method for creation through the object factory.

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
void itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::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.

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual void itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::SetInputnumber ( const DataObjectDecorator< TransformType > *  _arg)
virtual
template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual void itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::SetStrainForm ( StrainFormType  _arg)
virtual
template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual void itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::SetTransform ( const TransformType _arg)
virtual
template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual void itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::SetTransformInput ( const DataObjectDecorator< TransformType > *  _arg)
virtual

Get/Set the coordinate transformation. Set the coordinate transform to use for resampling. Note that this must be in physical coordinates.

Member Data Documentation

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
constexpr unsigned int itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::ImageDimension = TTransform::InputSpaceDimension
static

ImageDimension enumeration.

Definition at line 62 of file itkTransformToStrainFilter.h.

template<typename TTransform , typename TOperatorValueType = float, typename TOutputValueType = float>
StrainFormType itk::TransformToStrainFilter< TTransform, TOperatorValueType, TOutputValueType >::m_StrainForm
private

Definition at line 108 of file itkTransformToStrainFilter.h.


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