Medical Imaging Interaction Toolkit  2025.08.00
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mitk::ImageLiveWireContourModelFilter Class Reference
MITK Modules » Core » Process and Adaptor Classes » Process Classes

Calculates a LiveWire contour between two points in an image. More...

#include <mitkImageLiveWireContourModelFilter.h>

Inheritance diagram for mitk::ImageLiveWireContourModelFilter:
Inheritance graph
[legend]
Collaboration diagram for mitk::ImageLiveWireContourModelFilter:
Collaboration graph
[legend]

Public Types

typedef ContourModel OutputType
 
typedef OutputType::Pointer OutputTypePointer
 
typedef mitk::Image InputType
 
typedef itk::Image< float, 2 > InternalImageType
 
typedef itk::ShortestPathImageFilter< InternalImageType, InternalImageType > ShortestPathImageFilterType
 
typedef itk::ShortestPathCostFunctionLiveWire< InternalImageType > CostFunctionType
 
typedef std::vector< itk::Index< 2 > > ShortestPathType
 
- Public Types inherited from mitk::ContourModelSource
typedef ContourModel OutputType
 
typedef OutputType::Pointer OutputTypePointer
 
- Public Types inherited from mitk::BaseDataSource
typedef BaseDataSource Self
 
typedef itk::ProcessObject Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef BaseData OutputType
 
typedef itk::DataObject::DataObjectIdentifierType DataObjectIdentifierType
 

Public Member Functions

 mitkClassMacro (ImageLiveWireContourModelFilter, ContourModelSource)
 
Pointer Clone () const
 
virtual void SetStartPoint (mitk::Point3D _arg)
 start point in world coordinates More...
 
virtual mitk::Point3D GetStartPoint ()
 
virtual void SetEndPoint (mitk::Point3D _arg)
 end point in woorld coordinates More...
 
virtual mitk::Point3D GetEndPoint ()
 
virtual void SetUseDynamicCostMap (bool _arg)
 Create dynamic cost transfer map - use on the fly training. More...
 
virtual bool GetUseDynamicCostMap ()
 
void ClearRepulsivePoints ()
 Clear all repulsive points used in the cost function. More...
 
void SetRepulsivePoints (const ShortestPathType &points)
 Set a vector with repulsive points to use in the cost function. More...
 
void AddRepulsivePoint (const itk::Index< 2 > &idx)
 Add a single repulsive point to the cost function. More...
 
void RemoveRepulsivePoint (const itk::Index< 2 > &idx)
 Remove a single repulsive point from the cost function. More...
 
virtual void SetInput (const InputType *input)
 
virtual void SetInput (unsigned int idx, const InputType *input)
 
const InputType * GetInput (void)
 
const InputType * GetInput (unsigned int idx)
 
virtual OutputType * GetOutput ()
 
virtual void DumpMaskImage ()
 
bool CreateDynamicCostMap (mitk::ContourModel *path=nullptr)
 Create dynamic cost transfer map - on the fly training. More...
 
void SetUseCostFunction (bool doUseCostFunction)
 
- Public Member Functions inherited from mitk::ContourModelSource
 mitkClassMacro (ContourModelSource, BaseDataSource)
 
Pointer Clone () const
 
mitkBaseDataSourceGetOutputDeclarations itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 
- Public Member Functions inherited from mitk::BaseDataSource
virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
OutputType * GetOutput ()
 
const OutputType * GetOutput () const
 
OutputType * GetOutput (DataObjectPointerArraySizeType idx)
 
const OutputType * GetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void GraftOutput (OutputType *output)
 Graft the specified BaseData onto this BaseDataSource's output. More...
 
virtual void GraftOutput (const DataObjectIdentifierType &key, OutputType *output)
 
virtual void GraftNthOutput (unsigned int idx, OutputType *output)
 Graft the specified base data object onto this BaseDataSource's idx'th output. More...
 
bool Updating () const
 Access itk::ProcessObject::m_Updating. More...
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from mitk::ContourModelSource
static Pointer New ()
 
- Static Public Member Functions inherited from mitk::BaseDataSource
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 ImageLiveWireContourModelFilter ()
 
 ~ImageLiveWireContourModelFilter () override
 
void GenerateOutputInformation () override
 
void GenerateData () override
 
void UpdateLiveWire ()
 
template<typename TPixel , unsigned int VImageDimension>
void ItkPreProcessImage (const itk::Image< TPixel, VImageDimension > *inputImage)
 
template<typename TPixel , unsigned int VImageDimension>
void CreateDynamicCostMapByITK (const itk::Image< TPixel, VImageDimension > *inputImage, mitk::ContourModel *path=nullptr)
 
- Protected Member Functions inherited from mitk::ContourModelSource
 ContourModelSource ()
 
 ~ContourModelSource () override
 
- Protected Member Functions inherited from mitk::BaseDataSource
 BaseDataSource ()
 
 ~BaseDataSource () override
 

Protected Attributes

mitk::Point3D m_StartPoint
 start point in worldcoordinates More...
 
mitk::Point3D m_EndPoint
 end point in woorldcoordinates More...
 
mitk::Point3D m_StartPointInIndex
 Start point in index. More...
 
mitk::Point3D m_EndPointInIndex
 End point in index. More...
 
CostFunctionType::Pointer m_CostFunction
 The cost function to compute costs between two pixels. More...
 
ShortestPathImageFilterType::Pointer m_ShortestPathFilter
 Shortest path filter according to cost function m_CostFunction. More...
 
bool m_UseDynamicCostMap
 Flag to use a dynamic cost map or not. More...
 
unsigned int m_TimeStep
 
InternalImageType::Pointer m_InternalImage
 

Additional Inherited Members

- Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer New ()
 

Detailed Description

Calculates a LiveWire contour between two points in an image.

For defining costs between two pixels specific features are extracted from the image and transformed into a single cost value.

See also
ShortestPathCostFunctionLiveWire

The filter is able to create dynamic cost transfer map and thus use on the fly training.

Note
On the fly training will only be used for next update. The computation uses the last calculated segment to map cost according to features in the area of the segment.

Caution: time support currently not available. Filter will always work on the first timestep in its current implementation.

Definition at line 48 of file mitkImageLiveWireContourModelFilter.h.

Member Typedef Documentation

◆ CostFunctionType

typedef itk::ShortestPathCostFunctionLiveWire<InternalImageType> mitk::ImageLiveWireContourModelFilter::CostFunctionType

Definition at line 61 of file mitkImageLiveWireContourModelFilter.h.

◆ InputType

typedef mitk::Image mitk::ImageLiveWireContourModelFilter::InputType

Definition at line 57 of file mitkImageLiveWireContourModelFilter.h.

◆ InternalImageType

typedef itk::Image<float, 2> mitk::ImageLiveWireContourModelFilter::InternalImageType

Definition at line 59 of file mitkImageLiveWireContourModelFilter.h.

◆ OutputType

typedef ContourModel mitk::ImageLiveWireContourModelFilter::OutputType

Definition at line 53 of file mitkImageLiveWireContourModelFilter.h.

◆ OutputTypePointer

typedef OutputType::Pointer mitk::ImageLiveWireContourModelFilter::OutputTypePointer

Definition at line 56 of file mitkImageLiveWireContourModelFilter.h.

◆ ShortestPathImageFilterType

typedef itk::ShortestPathImageFilter<InternalImageType, InternalImageType> mitk::ImageLiveWireContourModelFilter::ShortestPathImageFilterType

Definition at line 60 of file mitkImageLiveWireContourModelFilter.h.

◆ ShortestPathType

typedef std::vector<itk::Index<2> > mitk::ImageLiveWireContourModelFilter::ShortestPathType

Definition at line 62 of file mitkImageLiveWireContourModelFilter.h.

Constructor & Destructor Documentation

◆ ImageLiveWireContourModelFilter()

mitk::ImageLiveWireContourModelFilter::ImageLiveWireContourModelFilter ( )
protected

◆ ~ImageLiveWireContourModelFilter()

mitk::ImageLiveWireContourModelFilter::~ImageLiveWireContourModelFilter ( )
overrideprotected

Member Function Documentation

◆ AddRepulsivePoint()

void mitk::ImageLiveWireContourModelFilter::AddRepulsivePoint ( const itk::Index< 2 > &  idx)

Add a single repulsive point to the cost function.

◆ ClearRepulsivePoints()

void mitk::ImageLiveWireContourModelFilter::ClearRepulsivePoints ( )

Clear all repulsive points used in the cost function.

◆ Clone()

Pointer mitk::ImageLiveWireContourModelFilter::Clone ( ) const

◆ CreateDynamicCostMap()

bool mitk::ImageLiveWireContourModelFilter::CreateDynamicCostMap ( mitk::ContourModel *  path = nullptr)

Create dynamic cost transfer map - on the fly training.

◆ CreateDynamicCostMapByITK()

template<typename TPixel , unsigned int VImageDimension>
void mitk::ImageLiveWireContourModelFilter::CreateDynamicCostMapByITK ( const itk::Image< TPixel, VImageDimension > *  inputImage,
mitk::ContourModel *  path = nullptr 
)
protected

◆ DumpMaskImage()

virtual void mitk::ImageLiveWireContourModelFilter::DumpMaskImage ( )
virtual

◆ GenerateData()

void mitk::ImageLiveWireContourModelFilter::GenerateData ( )
overrideprotected

◆ GenerateOutputInformation()

void mitk::ImageLiveWireContourModelFilter::GenerateOutputInformation ( )
inlineoverrideprotected

Definition at line 118 of file mitkImageLiveWireContourModelFilter.h.

◆ GetEndPoint()

virtual mitk::Point3D mitk::ImageLiveWireContourModelFilter::GetEndPoint ( )
virtual

◆ GetInput() [1/2]

const InputType* mitk::ImageLiveWireContourModelFilter::GetInput ( unsigned int  idx)

◆ GetInput() [2/2]

const InputType* mitk::ImageLiveWireContourModelFilter::GetInput ( void  )

◆ GetOutput()

virtual OutputType* mitk::ImageLiveWireContourModelFilter::GetOutput ( )
virtual

◆ GetStartPoint()

virtual mitk::Point3D mitk::ImageLiveWireContourModelFilter::GetStartPoint ( )
virtual

◆ GetUseDynamicCostMap()

virtual bool mitk::ImageLiveWireContourModelFilter::GetUseDynamicCostMap ( )
virtual

◆ ItkPreProcessImage()

template<typename TPixel , unsigned int VImageDimension>
void mitk::ImageLiveWireContourModelFilter::ItkPreProcessImage ( const itk::Image< TPixel, VImageDimension > *  inputImage)
protected

◆ mitkClassMacro()

mitk::ImageLiveWireContourModelFilter::mitkClassMacro ( ImageLiveWireContourModelFilter  ,
ContourModelSource   
)

◆ New()

static Pointer mitk::ImageLiveWireContourModelFilter::New ( )
static

◆ RemoveRepulsivePoint()

void mitk::ImageLiveWireContourModelFilter::RemoveRepulsivePoint ( const itk::Index< 2 > &  idx)

Remove a single repulsive point from the cost function.

◆ SetEndPoint()

virtual void mitk::ImageLiveWireContourModelFilter::SetEndPoint ( mitk::Point3D  _arg)
virtual

end point in woorld coordinates

◆ SetInput() [1/2]

virtual void mitk::ImageLiveWireContourModelFilter::SetInput ( const InputType *  input)
virtual

◆ SetInput() [2/2]

virtual void mitk::ImageLiveWireContourModelFilter::SetInput ( unsigned int  idx,
const InputType *  input 
)
virtual

◆ SetRepulsivePoints()

void mitk::ImageLiveWireContourModelFilter::SetRepulsivePoints ( const ShortestPathType &  points)

Set a vector with repulsive points to use in the cost function.

◆ SetStartPoint()

virtual void mitk::ImageLiveWireContourModelFilter::SetStartPoint ( mitk::Point3D  _arg)
virtual

start point in world coordinates

◆ SetUseCostFunction()

void mitk::ImageLiveWireContourModelFilter::SetUseCostFunction ( bool  doUseCostFunction)
inline

Definition at line 111 of file mitkImageLiveWireContourModelFilter.h.

◆ SetUseDynamicCostMap()

virtual void mitk::ImageLiveWireContourModelFilter::SetUseDynamicCostMap ( bool  _arg)
virtual

Create dynamic cost transfer map - use on the fly training.

Note
On the fly training will be used for next update only. The computation uses the last calculated segment to map cost according to features in the area of the segment.

◆ UpdateLiveWire()

void mitk::ImageLiveWireContourModelFilter::UpdateLiveWire ( )
protected

Member Data Documentation

◆ m_CostFunction

CostFunctionType::Pointer mitk::ImageLiveWireContourModelFilter::m_CostFunction
protected

The cost function to compute costs between two pixels.

Definition at line 137 of file mitkImageLiveWireContourModelFilter.h.

◆ m_EndPoint

mitk::Point3D mitk::ImageLiveWireContourModelFilter::m_EndPoint
protected

end point in woorldcoordinates

Definition at line 128 of file mitkImageLiveWireContourModelFilter.h.

◆ m_EndPointInIndex

mitk::Point3D mitk::ImageLiveWireContourModelFilter::m_EndPointInIndex
protected

End point in index.

Definition at line 134 of file mitkImageLiveWireContourModelFilter.h.

◆ m_InternalImage

InternalImageType::Pointer mitk::ImageLiveWireContourModelFilter::m_InternalImage
protected

Definition at line 154 of file mitkImageLiveWireContourModelFilter.h.

◆ m_ShortestPathFilter

ShortestPathImageFilterType::Pointer mitk::ImageLiveWireContourModelFilter::m_ShortestPathFilter
protected

Shortest path filter according to cost function m_CostFunction.

Definition at line 140 of file mitkImageLiveWireContourModelFilter.h.

◆ m_StartPoint

mitk::Point3D mitk::ImageLiveWireContourModelFilter::m_StartPoint
protected

start point in worldcoordinates

Definition at line 125 of file mitkImageLiveWireContourModelFilter.h.

◆ m_StartPointInIndex

mitk::Point3D mitk::ImageLiveWireContourModelFilter::m_StartPointInIndex
protected

Start point in index.

Definition at line 131 of file mitkImageLiveWireContourModelFilter.h.

◆ m_TimeStep

unsigned int mitk::ImageLiveWireContourModelFilter::m_TimeStep
protected

Definition at line 145 of file mitkImageLiveWireContourModelFilter.h.

◆ m_UseDynamicCostMap

bool mitk::ImageLiveWireContourModelFilter::m_UseDynamicCostMap
protected

Flag to use a dynamic cost map or not.

Definition at line 143 of file mitkImageLiveWireContourModelFilter.h.

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