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::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType > Class Template Reference

#include <itkStrainImageFilter.h>

+ Inheritance diagram for itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >:
+ Collaboration diagram for itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >:

Detailed Description

template<typename TInputImage, typename TOperatorValueType = float, typename TOutputValueType = float>
class itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >

Generate a strain field image from a displacement field image.

Internally, a gradient filter (see SetGradientFilter()) is used to calculate displacement gradient tensors. This filter is used by default on each displacement Vector component. The gradient filter should take a scalar image as input and generate a CovariantVector image as output. Alternatively, if a VectorGradientFilter is set, it is used instead. The VectorGradientFilter should take a Vector image as input and produce a CovariantVector image on each output corresponding to each Vector component.

Template Parameters
TInputImageThe first template parameter is the input image type. It should be an image of displacement vectors.
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
TransformToStrainFilter

Definition at line 63 of file itkStrainImageFilter.h.

Public Types

using ConstPointer = SmartPointer< const Self >
 
using GradientFilterType = ImageToImageFilter< OperatorImageType, GradientOutputImageType >
 
using GradientOutputImageType = Image< GradientOutputPixelType, ImageDimension >
 
using GradientOutputPixelType = CovariantVector< TOperatorValueType, ImageDimension >
 
using InputImageType = TInputImage
 
using OperatorImageType = Image< TOperatorValueType, ImageDimension >
 
using OutputImageType = Image< OutputPixelType, ImageDimension >
 
using OutputPixelType = SymmetricSecondRankTensor< TOutputValueType, ImageDimension >
 
using Pointer = SmartPointer< Self >
 
using Self = StrainImageFilter
 
enum  StrainFormType {
  INFINITESIMAL = 0,
  GREENLAGRANGIAN = 1,
  EULERIANALMANSI = 2
}
 
using Superclass = ImageToImageFilter< InputImageType, OutputImageType >
 
using VectorGradientFilterType = ImageToImageFilter< InputImageType, GradientOutputImageType >
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, Image< SymmetricSecondRankTensor< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using OutputImagePixelType = typename Superclass::OutputImagePixelType
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
 
- Public Types inherited from itk::ImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
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, TInputImage::ImageDimension >, TInputImage::ImageDimension >
 
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 char * GetNameOfClass () const
 
virtual StrainFormType GetStrainForm () const
 
virtual void SetStrainForm (StrainFormType _arg)
 
virtual void SetGradientFilter (GradientFilterType *_arg)
 
virtual const GradientFilterTypeGetGradientFilter () const
 
virtual void SetVectorGradientFilter (VectorGradientFilterType *_arg)
 
virtual const
VectorGradientFilterType
GetVectorGradientFilter () const
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, Image< SymmetricSecondRankTensor< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
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 = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, Image< SymmetricSecondRankTensor< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
static constexpr unsigned int InputImageDimension
 
static constexpr unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
static constexpr unsigned int OutputImageDimension
 

Protected Types

using InputComponentsImageFilterType = itk::SplitComponentsImageFilter< InputImageType, OperatorImageType >
 
using OutputRegionType = typename OutputImageType::RegionType
 
- Protected Types inherited from itk::ImageToImageFilter< TInputImage, Image< SymmetricSecondRankTensor< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 

Protected Member Functions

void BeforeThreadedGenerateData () override
 
void DynamicThreadedGenerateData (const OutputRegionType &outputRegion) override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 StrainImageFilter ()
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, Image< SymmetricSecondRankTensor< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
void GenerateInputRequestedRegion () override
 
 ImageToImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void VerifyInputInformation () ITKv5_CONST override
 
 ~ImageToImageFilter () override
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
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 GenerateOutputInformation ()
 
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
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
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 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

GradientFilterType::Pointer m_GradientFilter
 
InputComponentsImageFilterType::Pointer m_InputComponentsFilter
 
StrainFormType m_StrainForm
 
VectorGradientFilterType::Pointer m_VectorGradientFilter
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static
ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION 
ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ImageSource< Image< SymmetricSecondRankTensor< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
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 TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::ConstPointer = SmartPointer< const Self >

Definition at line 84 of file itkStrainImageFilter.h.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::GradientFilterType = ImageToImageFilter< OperatorImageType, GradientOutputImageType >

Definition at line 90 of file itkStrainImageFilter.h.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::GradientOutputImageType = Image< GradientOutputPixelType, ImageDimension >

Definition at line 89 of file itkStrainImageFilter.h.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::GradientOutputPixelType = CovariantVector< TOperatorValueType, ImageDimension >

Type of the filter used to calculate the gradients.

Definition at line 88 of file itkStrainImageFilter.h.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::InputComponentsImageFilterType = itk::SplitComponentsImageFilter< InputImageType, OperatorImageType >
protected

Definition at line 134 of file itkStrainImageFilter.h.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::InputImageType = TInputImage

Definition at line 74 of file itkStrainImageFilter.h.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::OperatorImageType = Image< TOperatorValueType, ImageDimension >

Definition at line 77 of file itkStrainImageFilter.h.

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

Definition at line 76 of file itkStrainImageFilter.h.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::OutputPixelType = SymmetricSecondRankTensor< TOutputValueType, ImageDimension >

Definition at line 75 of file itkStrainImageFilter.h.

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

Definition at line 126 of file itkStrainImageFilter.h.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::Pointer = SmartPointer< Self >

Definition at line 83 of file itkStrainImageFilter.h.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::Self = StrainImageFilter

Standard class type alias.

Definition at line 80 of file itkStrainImageFilter.h.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::Superclass = ImageToImageFilter< InputImageType, OutputImageType >

Definition at line 81 of file itkStrainImageFilter.h.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
using itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::VectorGradientFilterType = ImageToImageFilter< InputImageType, GradientOutputImageType >

Alternate type of filter used to calculate the gradients.

Definition at line 93 of file itkStrainImageFilter.h.

Member Enumeration Documentation

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
enum itk::StrainImageFilter::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 120 of file itkStrainImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::StrainImageFilter ( )
protected

Member Function Documentation

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
void itk::StrainImageFilter< TInputImage, 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, TInputImage::ImageDimension >, TInputImage::ImageDimension > >.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual::itk::LightObject::Pointer itk::StrainImageFilter< TInputImage, 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 TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
void itk::StrainImageFilter< TInputImage, 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, TInputImage::ImageDimension >, TInputImage::ImageDimension > >.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual const GradientFilterType* itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::GetGradientFilter ( ) const
virtual

Set the filter used to calculate the gradients internally. The default is an itk::GradientImageFilter.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual const char* itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::GetNameOfClass ( ) const
virtual
template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual StrainFormType itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::GetStrainForm ( ) const
virtual
template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual const VectorGradientFilterType* itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::GetVectorGradientFilter ( ) const
virtual

Set the filter used to calculate the gradients internally. This filter should take a Vector image as input and produce a CovariantVector gradient image on each output corresponding to every Vector component. If this filter is non-NULL, it is used instead of the GradientFilter.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
static Pointer itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::New ( )
static

Method for creation through the object factory.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
void itk::StrainImageFilter< TInputImage, 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 TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual void itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::SetGradientFilter ( GradientFilterType _arg)
virtual

Set the filter used to calculate the gradients internally. The default is an itk::GradientImageFilter.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual void itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::SetStrainForm ( StrainFormType  _arg)
virtual
template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
virtual void itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::SetVectorGradientFilter ( VectorGradientFilterType _arg)
virtual

Set the filter used to calculate the gradients internally. This filter should take a Vector image as input and produce a CovariantVector gradient image on each output corresponding to every Vector component. If this filter is non-NULL, it is used instead of the GradientFilter.

Member Data Documentation

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
constexpr unsigned int itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::ImageDimension = TInputImage::ImageDimension
static

ImageDimension enumeration.

Definition at line 72 of file itkStrainImageFilter.h.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
GradientFilterType::Pointer itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::m_GradientFilter
private

Definition at line 141 of file itkStrainImageFilter.h.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
InputComponentsImageFilterType::Pointer itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::m_InputComponentsFilter
private

Definition at line 139 of file itkStrainImageFilter.h.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
StrainFormType itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::m_StrainForm
private

Definition at line 145 of file itkStrainImageFilter.h.

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float>
VectorGradientFilterType::Pointer itk::StrainImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::m_VectorGradientFilter
private

Definition at line 143 of file itkStrainImageFilter.h.


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