ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage > Class Template Reference

#include <itkFastMarchingUpwindGradientImageFilter.h>

Detailed Description

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
class itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >

Generates the upwind gradient field of fast marching arrival times.

This filter adds some extra functionality to its base class. While the solution T(x) of the Eikonal equation is being generated by the base class with the fast marching method, the filter generates the upwind gradient vectors of T(x), storing them in an image.

Since the Eikonal equation generates the arrival times of a wave traveling at a given speed, the generated gradient vectors can be interpreted as the slowness (1/velocity) vectors of the front (the quantity inside the modulus operator in the Eikonal equation).

Gradient vectors are computed using upwind finite differences, that is, information only propagates from points where the wavefront has already passed. This is consistent with how the fast marching method works.

One more extra feature is the possibility to define a set of Target points where the propagation stops. This can be used to avoid computing the Eikonal solution for the whole domain. The front can be stopped either when one Target point is reached or all Target points are reached. The propagation can stop after a time TargetOffset has passed since the stop condition is met. This way the solution is computed a bit downstream the Target points, so that the level sets of T(x) corresponding to the Target are smooth.

For an alternative implementation, see itk::FastMarchingUpwindGradientImageFilterBase.

Author
Luca Antiga Ph.D. Biomedical Technologies Laboratory, Bioengineering Department, Mario Negri Institute, Italy.

Definition at line 88 of file itkFastMarchingUpwindGradientImageFilter.h.

+ Inheritance diagram for itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >:
+ Collaboration diagram for itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using GradientImagePointer = typename GradientImageType::Pointer
 
using GradientImageType = Image< GradientPixelType, Self::SetDimension >
 
using GradientPixelType = CovariantVector< PixelType, Self::SetDimension >
 
using Pointer = SmartPointer< Self >
 
using PointType = typename Superclass::OutputPointType
 
using Self = FastMarchingUpwindGradientImageFilter
 
using Superclass = FastMarchingImageFilter< TLevelSet, TSpeedImage >
 
using TargetConditionEnum = FastMarchingUpwindGradientImageFilterEnums::TargetCondition
 
- Public Types inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
using ConstPointer = SmartPointer< const Self >
 
using IndexType = Index< Self::SetDimension >
 
using LabelEnum = FastMarchingImageFilterEnums::Label
 
using LabelImagePointer = typename LabelImageType::Pointer
 
using LabelImageType = Image< LabelEnum, Self::SetDimension >
 
using LevelSetImageType = typename LevelSetType::LevelSetImageType
 
using LevelSetPointer = typename LevelSetType::LevelSetPointer
 
using LevelSetType = LevelSetTypeDefault< TLevelSet >
 
using NodeContainer = typename LevelSetType::NodeContainer
 
using NodeContainerPointer = typename LevelSetType::NodeContainerPointer
 
using NodeIndexType = typename NodeType::IndexType
 
using NodeType = typename LevelSetType::NodeType
 
using OutputDirectionType = typename LevelSetImageType::DirectionType
 
using OutputPointType = typename LevelSetImageType::PointType
 
using OutputRegionType = typename LevelSetImageType::RegionType
 
using OutputSizeType = typename LevelSetImageType::SizeType
 
using OutputSpacingType = typename LevelSetImageType::SpacingType
 
using PixelType = typename LevelSetType::PixelType
 
using Pointer = SmartPointer< Self >
 
using Self = FastMarchingImageFilter
 
using SpeedImageConstPointer = typename SpeedImageType::ConstPointer
 
using SpeedImagePointer = typename SpeedImageType::Pointer
 
using SpeedImageType = TSpeedImage
 
using Superclass = ImageToImageFilter< TSpeedImage, TLevelSet >
 
- Public Types inherited from itk::ImageToImageFilter< TSpeedImage, TLevelSet >
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 = TSpeedImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TLevelSet >
 
- Public Types inherited from itk::ImageSource< TLevelSet >
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 = TLevelSet
 
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

GradientImagePointer GetGradientImage () const
 
const char * GetNameOfClass () const override
 
virtual const SizeValueTypeGetNumberOfTargets () const
 
NodeContainerPointer GetReachedTargetPoints ()
 
virtual const double & GetTargetOffset () const
 
NodeContainerPointer GetTargetPoints ()
 
virtual const double & GetTargetValue () const
 
virtual void SetGenerateGradientImage (bool _arg)
 
virtual void SetTargetOffset (double _arg)
 
void SetTargetReachedModeToAllTargets ()
 
void SetTargetPoints (NodeContainer *points)
 
virtual const bool & GetGenerateGradientImage () const
 
virtual void GenerateGradientImageOn ()
 
virtual void SetTargetReachedMode (TargetConditionEnum _arg)
 
virtual const TargetConditionEnumGetTargetReachedMode () const
 
void SetTargetReachedModeToNoTargets ()
 
void SetTargetReachedModeToOneTarget ()
 
void SetTargetReachedModeToSomeTargets (SizeValueType numberOfTargets)
 
- Public Member Functions inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
NodeContainerPointer GetAlivePoints ()
 
LabelImagePointer GetLabelImage () const
 
NodeContainerPointer GetProcessedPoints () const
 
virtual const double & GetSpeedConstant () const
 
virtual const double & GetStoppingValue () const
 
NodeContainerPointer GetTrialPoints ()
 
template<typename TPixel >
void SetBinaryMask (Image< TPixel, SetDimension > *iImage)
 
virtual void SetCollectPoints (bool _arg)
 
virtual void SetStoppingValue (double _arg)
 
void SetOutsidePoints (NodeContainer *points)
 
void SetAlivePoints (NodeContainer *points)
 
void SetTrialPoints (NodeContainer *points)
 
void SetSpeedConstant (double value)
 
virtual void SetNormalizationFactor (double _arg)
 
virtual double GetNormalizationFactor () const
 
virtual const bool & GetCollectPoints () const
 
virtual void CollectPointsOn ()
 
virtual void SetOutputSize (const OutputSizeType &size)
 
virtual OutputSizeType GetOutputSize () const
 
virtual void SetOutputRegion (OutputRegionType _arg)
 
virtual const OutputRegionTypeGetOutputRegion () const
 
virtual void SetOutputSpacing (OutputSpacingType _arg)
 
virtual const OutputSpacingTypeGetOutputSpacing () const
 
virtual void SetOutputDirection (OutputDirectionType _arg)
 
virtual const OutputDirectionTypeGetOutputDirection () const
 
virtual void SetOutputOrigin (OutputPointType _arg)
 
virtual const OutputPointTypeGetOutputOrigin () const
 
virtual void SetOverrideOutputInformation (bool _arg)
 
virtual const bool & GetOverrideOutputInformation () const
 
virtual void OverrideOutputInformationOn ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TSpeedImage, TLevelSet >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
const char * GetNameOfClass () const override
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *input)
 
virtual void PushFrontInput (const InputImageType *input)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *input)
 
virtual void SetInput (unsigned int, const TSpeedImage *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< TLevelSet >
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
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 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) const
 
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::FastMarchingImageFilter< TLevelSet, TSpeedImage >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToImageFilter< TSpeedImage, TLevelSet >
static double GetGlobalDefaultCoordinateTolerance ()
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static void SetGlobalDefaultDirectionTolerance (double)
 
- 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 ()
 

Static Public Attributes

static constexpr unsigned int SetDimension = Superclass::SetDimension
 
- Static Public Attributes inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
static constexpr unsigned int SetDimension = LevelSetType::SetDimension
 
static constexpr unsigned int SpeedImageDimension = SpeedImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TSpeedImage, TLevelSet >
static constexpr unsigned int InputImageDimension
 
static constexpr unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TLevelSet >
static constexpr unsigned int OutputImageDimension
 

Protected Member Functions

virtual void ComputeGradient (const IndexType &index, const LevelSetImageType *output, const LabelImageType *labelImage, GradientImageType *gradientImage)
 
 FastMarchingUpwindGradientImageFilter ()
 
void GenerateData () override
 
void Initialize (LevelSetImageType *) override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void UpdateNeighbors (const IndexType &index, const SpeedImageType *, LevelSetImageType *) override
 
virtual void VerifyPreconditions () ITKv5_CONST override
 
 ~FastMarchingUpwindGradientImageFilter () override=default
 
bool IsTargetPointsExistenceConditionSatisfied () const
 
void VerifyTargetReachedModeConditions (unsigned int targetModeMinPoints=1) const
 
- Protected Member Functions inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
void EnlargeOutputRequestedRegion (DataObject *output) override
 
 FastMarchingImageFilter ()
 
void GenerateOutputInformation () override
 
virtual const PixelTypeGetLargeValue () const
 
virtual const LevelSetIndexTypeGetLastIndex () const
 
const AxisNodeTypeGetNodeUsedInCalculation (unsigned int idx) const
 
virtual const LevelSetIndexTypeGetStartIndex () const
 
virtual double UpdateValue (const IndexType &index, const SpeedImageType *, LevelSetImageType *)
 
 ~FastMarchingImageFilter () override=default
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TSpeedImage, TLevelSet >
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=default
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
- Protected Member Functions inherited from itk::ImageSource< TLevelSet >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
- 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 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
 
 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 &)
 
 ~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 ()
 

Private Attributes

bool m_GenerateGradientImage {}
 
GradientImagePointer m_GradientImage {}
 
SizeValueType m_NumberOfTargets {}
 
NodeContainerPointer m_ReachedTargetPoints {}
 
double m_TargetOffset {}
 
NodeContainerPointer m_TargetPoints {}
 
TargetConditionEnum m_TargetReachedMode {}
 
double m_TargetValue {}
 

Additional Inherited Members

- Protected Types inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
using LevelSetIndexType = typename LevelSetImageType::IndexType
 
- Protected Types inherited from itk::ImageToImageFilter< TSpeedImage, TLevelSet >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Static Protected Member Functions inherited from itk::ImageSource< TLevelSet >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- 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::FastMarchingImageFilter< TLevelSet, TSpeedImage >
OutputRegionType m_BufferedRegion {}
 
LevelSetIndexType m_LastIndex {}
 
LevelSetIndexType m_StartIndex {}
 
- Protected Attributes inherited from itk::ImageSource< TLevelSet >
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

◆ ConstPointer

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
using itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::ConstPointer = SmartPointer<const Self>

Definition at line 97 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ GradientImagePointer

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
using itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GradientImagePointer = typename GradientImageType::Pointer

GradientImagePointer type alias support

Definition at line 170 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ GradientImageType

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
using itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GradientImageType = Image<GradientPixelType, Self::SetDimension>

GradientImage type alias support

Definition at line 167 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ GradientPixelType

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
using itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GradientPixelType = CovariantVector<PixelType, Self::SetDimension>

GradientPixel type alias support

Definition at line 164 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ Pointer

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
using itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::Pointer = SmartPointer<Self>

Definition at line 96 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ PointType

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
using itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::PointType = typename Superclass::OutputPointType

Definition at line 122 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ Self

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
using itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::Self = FastMarchingUpwindGradientImageFilter

Standard class typedefs.

Definition at line 94 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ Superclass

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
using itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::Superclass = FastMarchingImageFilter<TLevelSet, TSpeedImage>

Definition at line 95 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ TargetConditionEnum

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
using itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::TargetConditionEnum = FastMarchingUpwindGradientImageFilterEnums::TargetCondition

Definition at line 127 of file itkFastMarchingUpwindGradientImageFilter.h.

Constructor & Destructor Documentation

◆ FastMarchingUpwindGradientImageFilter()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::FastMarchingUpwindGradientImageFilter ( )
protected

◆ ~FastMarchingUpwindGradientImageFilter()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::~FastMarchingUpwindGradientImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ ComputeGradient()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
virtual void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::ComputeGradient ( const IndexType index,
const LevelSetImageType output,
const LabelImageType labelImage,
GradientImageType gradientImage 
)
protectedvirtual

◆ GenerateData()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GenerateData ( )
overrideprotectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >.

◆ GenerateGradientImageOn()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
virtual void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GenerateGradientImageOn ( )
virtual

Get the GenerateGradientImage flag.

◆ GetGenerateGradientImage()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
virtual const bool& itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GetGenerateGradientImage ( ) const
virtual

Get the GenerateGradientImage flag.

◆ GetGradientImage()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
GradientImagePointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GetGradientImage ( ) const
inline

Get the gradient image.

Definition at line 174 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ GetNameOfClass()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
const char* itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GetNameOfClass ( ) const
overridevirtual

◆ GetNumberOfTargets()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
virtual const SizeValueType& itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GetNumberOfTargets ( ) const
virtual

Get the number of targets.

◆ GetReachedTargetPoints()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
NodeContainerPointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GetReachedTargetPoints ( )
inline

Get the container of Reached Target Points.

Definition at line 158 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ GetTargetOffset()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
virtual const double& itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GetTargetOffset ( ) const
virtual

Get the TargetOffset ivar.

◆ GetTargetPoints()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
NodeContainerPointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GetTargetPoints ( )
inline

Get the container of Target Points.

Definition at line 151 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ GetTargetReachedMode()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
virtual const TargetConditionEnum& itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GetTargetReachedMode ( ) const
virtual

Choose whether the front must stop when the first target has been reached or all targets have been reached.

◆ GetTargetValue()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
virtual const double& itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::GetTargetValue ( ) const
virtual

Get the arrival time corresponding to the last reached target. If TargetReachedMode is set to TargetConditionEnum::NoTargets, TargetValue contains the last (aka largest) Eikonal solution value generated.

◆ Initialize()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::Initialize ( LevelSetImageType )
overrideprotectedvirtual

◆ IsTargetPointsExistenceConditionSatisfied()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
bool itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::IsTargetPointsExistenceConditionSatisfied ( ) const
inlineprotected

Check that target points are set. Returns true if at least a target point exists; returns false otherwise.

Definition at line 274 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ New()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
static Pointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::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::FastMarchingImageFilter< TLevelSet, TSpeedImage >.

◆ SetGenerateGradientImage()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
virtual void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetGenerateGradientImage ( bool  _arg)
virtual

Set the GenerateGradientImage flag. Instrument the algorithm to generate the gradient of the Eikonal equation solution while fast marching.

◆ SetTargetOffset()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
virtual void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetTargetOffset ( double  _arg)
virtual

Set how long (in terms of arrival times) after targets are reached the front must stop. This is useful to ensure that the level set of target arrival time is smooth.

◆ SetTargetPoints()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetTargetPoints ( NodeContainer points)
inline

Backwards compatibility for enum values Set the container of Target Points. If a target point is reached, the propagation stops. Trial points are represented as a VectorContainer of LevelSetNodes.

Definition at line 142 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ SetTargetReachedMode()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
virtual void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetTargetReachedMode ( TargetConditionEnum  _arg)
virtual

Choose whether the front must stop when the first target has been reached or all targets have been reached.

◆ SetTargetReachedModeToAllTargets()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetTargetReachedModeToAllTargets ( )
inline

Definition at line 222 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ SetTargetReachedModeToNoTargets()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetTargetReachedModeToNoTargets ( )
inline

Choose whether the front must stop when the first target has been reached or all targets have been reached.

Definition at line 202 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ SetTargetReachedModeToOneTarget()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetTargetReachedModeToOneTarget ( )
inline

Choose whether the front must stop when the first target has been reached or all targets have been reached.

Definition at line 208 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ SetTargetReachedModeToSomeTargets()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetTargetReachedModeToSomeTargets ( SizeValueType  numberOfTargets)
inline

Choose whether the front must stop when the first target has been reached or all targets have been reached.

Definition at line 214 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ UpdateNeighbors()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::UpdateNeighbors ( const IndexType index,
const SpeedImageType ,
LevelSetImageType  
)
overrideprotectedvirtual

◆ VerifyPreconditions()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
virtual void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::VerifyPreconditions ( )
overrideprotectedvirtual

Verifies that the process object has been configured correctly, that all required inputs are set, and needed parameters are set appropriately. If not valid an exceptions will be thrown.

This method is called before UpdateOutputInformation() is propagated to the inputs.

The ProcessObject's implementation verifies that the m_NumberOfRequiredInputs are set and not null.

Reimplemented from itk::ProcessObject.

◆ VerifyTargetReachedModeConditions()

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
void itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::VerifyTargetReachedModeConditions ( unsigned int  targetModeMinPoints = 1) const
inlineprotected

Check that the conditions to set the target reached mode are satisfied.

The sufficient target point count is 1 for TargetConditionEnum::OneTarget and TargetConditionEnum::AllTargets
modes; and it is given by a particular value for the TargetConditionEnum::SomeTargets mode.

Raises an exception if the conditions are not satisfied.

Definition at line 295 of file itkFastMarchingUpwindGradientImageFilter.h.

Member Data Documentation

◆ m_GenerateGradientImage

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
bool itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::m_GenerateGradientImage {}
private

Definition at line 322 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ m_GradientImage

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
GradientImagePointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::m_GradientImage {}
private

Definition at line 320 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ m_NumberOfTargets

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
SizeValueType itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::m_NumberOfTargets {}
private

Definition at line 330 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ m_ReachedTargetPoints

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
NodeContainerPointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::m_ReachedTargetPoints {}
private

Definition at line 318 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ m_TargetOffset

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
double itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::m_TargetOffset {}
private

Definition at line 324 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ m_TargetPoints

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
NodeContainerPointer itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::m_TargetPoints {}
private

Definition at line 317 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ m_TargetReachedMode

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
TargetConditionEnum itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::m_TargetReachedMode {}
private

Definition at line 326 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ m_TargetValue

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
double itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::m_TargetValue {}
private

Definition at line 328 of file itkFastMarchingUpwindGradientImageFilter.h.

◆ SetDimension

template<typename TLevelSet , typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>
constexpr unsigned int itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetDimension = Superclass::SetDimension
staticconstexpr

The dimension of the level set.

Definition at line 125 of file itkFastMarchingUpwindGradientImageFilter.h.


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