Medical Imaging Interaction Toolkit  2018.4.99-12ad79a3
Medical Imaging Interaction Toolkit
mitk::Contour Class Reference

Stores vertices for drawing a contour. More...

#include <mitkContour.h>

Inheritance diagram for mitk::Contour:
Collaboration diagram for mitk::Contour:

Public Types

typedef itk::PolyLineParametricPath< 3 > PathType
 
typedef PathType::Pointer PathPointer
 
typedef PathType::ContinuousIndexType ContinuousIndexType
 
typedef PathType::InputType InputType
 
typedef PathType::OutputType OutputType
 
typedef PathType::OffsetType OffsetType
 
typedef itk::BoundingBox< unsigned long, 3, ScalarType, itk::VectorContainer< unsigned long, mitk::Point< ScalarType, 3 > > > BoundingBoxType
 
typedef BoundingBoxType::PointsContainer PointsContainer
 
typedef BoundingBoxType::PointsContainer::Pointer PointsContainerPointer
 
typedef BoundingBoxType::PointsContainerIterator PointsContainerIterator
 
- Public Types inherited from mitk::BaseData
typedef BaseData Self
 
typedef itk::DataObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::Identifiable
using UIDType = std::string
 

Public Member Functions

 mitkClassMacro (Contour, BaseData)
 
Pointer Clone () const
 
virtual void SetClosed (bool _arg)
 
virtual bool GetClosed ()
 
virtual void SetSelected (bool _arg)
 
virtual bool GetSelected ()
 
virtual void SetWidth (float _arg)
 
virtual float GetWidth ()
 
void Initialize () override
 
void AddVertex (mitk::Point3D newPoint)
 
PathPointer GetContourPath () const
 
void SetCurrentWindow (vtkRenderWindow *rw)
 
vtkRenderWindow * GetCurrentWindow () const
 
unsigned int GetNumberOfPoints () const
 
PointsContainerPointer GetPoints () const
 
void SetPoints (PointsContainerPointer points)
 
void UpdateOutputInformation () override
 
void SetRequestedRegionToLargestPossibleRegion () override
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
bool VerifyRequestedRegion () override
 
void SetRequestedRegion (const itk::DataObject *data) override
 
- Public Member Functions inherited from mitk::BaseData
virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
BaseProperty::ConstPointer GetConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) const override
 Get property by its key. More...
 
std::vector< std::string > GetPropertyKeys (const std::string &contextName="", bool includeDefaultContext=false) const override
 Query keys of existing properties. More...
 
std::vector< std::string > GetPropertyContextNames () const override
 Query names of existing contexts. More...
 
BasePropertyGetNonConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) override
 Get property by its key. More...
 
void SetProperty (const std::string &propertyKey, BaseProperty *property, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
 Add new or change existent property. More...
 
void RemoveProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
 Removes a property. If the property does not exist, nothing will be done. More...
 
const mitk::TimeGeometryGetTimeGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
const mitk::TimeGeometryGetTimeSlicedGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
mitk::TimeGeometryGetTimeGeometry ()
 Return the TimeGeometry of the data as pointer. More...
 
const mitk::TimeGeometryGetUpdatedTimeGeometry ()
 Return the TimeGeometry of the data. More...
 
const mitk::TimeGeometryGetUpdatedTimeSliceGeometry ()
 Return the TimeGeometry of the data. More...
 
virtual void Expand (unsigned int timeSteps)
 Expands the TimeGeometry to a number of TimeSteps. More...
 
const mitk::BaseGeometryGetUpdatedGeometry (int t=0)
 Return the BaseGeometry of the data at time t. More...
 
mitk::BaseGeometryGetGeometry (int t=0) const
 Return the geometry, which is a TimeGeometry, of the data as non-const pointer. More...
 
void UpdateOutputInformation () override
 Update the information for this BaseData (the geometry in particular) so that it can be used as an output of a BaseProcess. More...
 
void CopyInformation (const itk::DataObject *data) override
 Copy information from the specified data set. More...
 
virtual bool IsInitialized () const
 Check whether the data has been initialized, i.e., at least the Geometry and other header data has been set. More...
 
virtual void Clear ()
 Calls ClearData() and InitializeEmpty();. More...
 
virtual bool IsEmptyTimeStep (unsigned int t) const
 Check whether object contains data (at a specified time), e.g., a set of points may be empty. More...
 
virtual bool IsEmpty () const
 Check whether object contains data (at least at one point in time), e.g., a set of points may be empty. More...
 
void ExecuteOperation (Operation *operation) override
 overwrite if the Data can be called by an Interactor (StateMachine). More...
 
virtual void SetGeometry (BaseGeometry *aGeometry3D)
 Set the BaseGeometry of the data, which will be referenced (not copied!). Assumes the data object has only 1 time step ( is a 3D object ) and creates a new TimeGeometry which saves the given BaseGeometry. If an TimeGeometry has already been set for the object, it will be replaced after calling this function. More...
 
virtual void SetTimeGeometry (TimeGeometry *geometry)
 Set the TimeGeometry of the data, which will be referenced (not copied!). More...
 
virtual void SetClonedGeometry (const BaseGeometry *aGeometry3D)
 Set a clone of the provided Geometry as Geometry of the data. Assumes the data object has only 1 time step ( is a 3D object ) and creates a new TimeGeometry. If an TimeGeometry has already been set for the object, it will be replaced after calling this function. More...
 
virtual void SetClonedTimeGeometry (const TimeGeometry *geometry)
 Set a clone of the provided TimeGeometry as TimeGeometry of the data. More...
 
virtual void SetClonedGeometry (const BaseGeometry *aGeometry3D, unsigned int time)
 Set a clone of the provided geometry as BaseGeometry of a given time step. More...
 
mitk::PropertyList::Pointer GetPropertyList () const
 Get the data's property list. More...
 
void SetPropertyList (PropertyList *propertyList)
 Set the data's property list. More...
 
mitk::BaseProperty::Pointer GetProperty (const char *propertyKey) const
 Get the property (instance of BaseProperty) with key propertyKey from the PropertyList, and set it to this, respectively;. More...
 
void SetProperty (const char *propertyKey, BaseProperty *property)
 
virtual void SetOrigin (const Point3D &origin)
 Convenience method for setting the origin of the BaseGeometry instances of all time steps. More...
 
itk::SmartPointer< mitk::BaseDataSourceGetSource () const
 Get the process object that generated this data object. More...
 
unsigned int GetTimeSteps () const
 Get the number of time steps from the TimeGeometry As the base data has not a data vector given by itself, the number of time steps is defined over the time sliced geometry. In sub classes, a better implementation could be over the length of the data vector. More...
 
unsigned long GetMTime () const override
 Get the modified time of the last change of the contents this data object or its geometry. More...
 
void Graft (const DataObject *) override
 
- Public Member Functions inherited from mitk::OperationActor
 itkTypeMacroNoParent (OperationActor) virtual ~OperationActor()
 
- Public Member Functions inherited from mitk::Identifiable
 Identifiable ()
 
 Identifiable (const UIDType &uid)
 
 Identifiable (const Identifiable &)=delete
 
 Identifiable (Identifiable &&) noexcept
 
virtual ~Identifiable ()
 
Identifiableoperator= (const Identifiable &)=delete
 
Identifiableoperator= (Identifiable &&other) noexcept
 
UIDType GetUID () const
 Get unique ID of an object. More...
 
- Public Member Functions inherited from mitk::IPropertyOwner
 ~IPropertyOwner () override
 
- Public Member Functions inherited from mitk::IPropertyProvider
virtual ~IPropertyProvider ()
 

Static Public Member Functions

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

Protected Member Functions

 mitkCloneMacro (Self)
 
 Contour ()
 
 Contour (const Contour &other)
 
 ~Contour () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Member Functions inherited from mitk::BaseData
 BaseData ()
 
 BaseData (const BaseData &other)
 
 ~BaseData () override
 
virtual void InitializeTimeGeometry (unsigned int timeSteps=1)
 Initialize the TimeGeometry for a number of time steps. The TimeGeometry is initialized empty and evenly timed. In many cases it will be necessary to overwrite this in sub-classes. More...
 
virtual void InitializeTimeSlicedGeometry (unsigned int timeSteps=1)
 Initialize the TimeGeometry for a number of time steps. The TimeGeometry is initialized empty and evenly timed. In many cases it will be necessary to overwrite this in sub-classes. More...
 
virtual void ClearData ()
 reset to non-initialized state, release memory More...
 
virtual void InitializeEmpty ()
 Pure virtual; Must be used in subclasses to get a data object to a valid state. Should at least create one empty object and call Superclass::InitializeTimeGeometry() to ensure an existing valid geometry. More...
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 

Additional Inherited Members

- Protected Attributes inherited from mitk::BaseData
bool m_LastRequestedRegionWasOutsideOfTheBufferedRegion
 
unsigned int m_SourceOutputIndexDuplicate
 
bool m_Initialized
 

Detailed Description

Stores vertices for drawing a contour.

Deprecated:
Use class mitk::ContourModel instead.
See also
ContourModel

Definition at line 31 of file mitkContour.h.

Member Typedef Documentation

◆ BoundingBoxType

typedef itk:: BoundingBox<unsigned long, 3, ScalarType, itk::VectorContainer<unsigned long, mitk::Point<ScalarType, 3> > > mitk::Contour::BoundingBoxType

Definition at line 46 of file mitkContour.h.

◆ ContinuousIndexType

typedef PathType::ContinuousIndexType mitk::Contour::ContinuousIndexType

Definition at line 40 of file mitkContour.h.

◆ InputType

typedef PathType::InputType mitk::Contour::InputType

Definition at line 41 of file mitkContour.h.

◆ OffsetType

typedef PathType::OffsetType mitk::Contour::OffsetType

Definition at line 43 of file mitkContour.h.

◆ OutputType

typedef PathType::OutputType mitk::Contour::OutputType

Definition at line 42 of file mitkContour.h.

◆ PathPointer

typedef PathType::Pointer mitk::Contour::PathPointer

Definition at line 39 of file mitkContour.h.

◆ PathType

typedef itk::PolyLineParametricPath<3> mitk::Contour::PathType

Definition at line 38 of file mitkContour.h.

◆ PointsContainer

typedef BoundingBoxType::PointsContainer mitk::Contour::PointsContainer

Definition at line 47 of file mitkContour.h.

◆ PointsContainerIterator

typedef BoundingBoxType::PointsContainerIterator mitk::Contour::PointsContainerIterator

Definition at line 49 of file mitkContour.h.

◆ PointsContainerPointer

typedef BoundingBoxType::PointsContainer::Pointer mitk::Contour::PointsContainerPointer

Definition at line 48 of file mitkContour.h.

Constructor & Destructor Documentation

◆ Contour() [1/2]

mitk::Contour::Contour ( )
protected

Definition at line 16 of file mitkContour.cpp.

◆ Contour() [2/2]

mitk::Contour::Contour ( const Contour other)
protected

Definition at line 28 of file mitkContour.cpp.

◆ ~Contour()

mitk::Contour::~Contour ( )
overrideprotected

Definition at line 40 of file mitkContour.cpp.

Member Function Documentation

◆ AddVertex()

void mitk::Contour::AddVertex ( mitk::Point3D  newPoint)

add a new vertex to the contour

Definition at line 44 of file mitkContour.cpp.

◆ Clone()

Pointer mitk::Contour::Clone ( ) const

◆ GetClosed()

virtual bool mitk::Contour::GetClosed ( )
virtual

returns if the contour is closed or opened

◆ GetContourPath()

mitk::Contour::PathType::Pointer mitk::Contour::GetContourPath ( ) const

return an itk parametric path of the contour

Definition at line 103 of file mitkContour.cpp.

◆ GetCurrentWindow()

vtkRenderWindow * mitk::Contour::GetCurrentWindow ( ) const

returns the points to the current render window

Definition at line 113 of file mitkContour.cpp.

◆ GetNumberOfPoints()

unsigned int mitk::Contour::GetNumberOfPoints ( ) const

returns the number of points stored in the contour

Definition at line 129 of file mitkContour.cpp.

Referenced by PrintSelf().

◆ GetPoints()

mitk::Contour::PointsContainerPointer mitk::Contour::GetPoints ( ) const

◆ GetSelected()

virtual bool mitk::Contour::GetSelected ( )
virtual

◆ GetWidth()

virtual float mitk::Contour::GetWidth ( )
virtual

◆ Initialize()

void mitk::Contour::Initialize ( )
override

clean up the contour data

Definition at line 118 of file mitkContour.cpp.

References mitk::ProportionalTimeGeometry::New(), and mitk::BaseData::SetTimeGeometry().

◆ mitkClassMacro()

mitk::Contour::mitkClassMacro ( Contour  ,
BaseData   
)

◆ mitkCloneMacro()

mitk::Contour::mitkCloneMacro ( Self  )
protected

◆ New()

static Pointer mitk::Contour::New ( )
static

◆ PrintSelf()

void mitk::Contour::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Definition at line 145 of file mitkContour.cpp.

References GetNumberOfPoints().

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

bool mitk::Contour::RequestedRegionIsOutsideOfTheBufferedRegion ( )
overridevirtual

intherited from parent

Implements mitk::BaseData.

Definition at line 89 of file mitkContour.cpp.

◆ SetClosed()

virtual void mitk::Contour::SetClosed ( bool  _arg)
virtual

sets whether the contour should be closed or open. by default the contour is closed

◆ SetCurrentWindow()

void mitk::Contour::SetCurrentWindow ( vtkRenderWindow *  rw)

set the current render window. This is helpful if one wants to draw the contour in one special window only.

Definition at line 108 of file mitkContour.cpp.

◆ SetPoints()

void mitk::Contour::SetPoints ( PointsContainerPointer  points)

set the contour points container.

Definition at line 139 of file mitkContour.cpp.

◆ SetRequestedRegion()

void mitk::Contour::SetRequestedRegion ( const itk::DataObject *  data)
overridevirtual

intherited from parent

Implements mitk::BaseData.

Definition at line 99 of file mitkContour.cpp.

◆ SetRequestedRegionToLargestPossibleRegion()

void mitk::Contour::SetRequestedRegionToLargestPossibleRegion ( )
overridevirtual

intherited from parent

Implements mitk::BaseData.

Definition at line 85 of file mitkContour.cpp.

◆ SetSelected()

virtual void mitk::Contour::SetSelected ( bool  _arg)
virtual

◆ SetWidth()

virtual void mitk::Contour::SetWidth ( float  _arg)
virtual

◆ UpdateOutputInformation()

void mitk::Contour::UpdateOutputInformation ( )
override

◆ VerifyRequestedRegion()

bool mitk::Contour::VerifyRequestedRegion ( )
overridevirtual

intherited from parent

Implements mitk::BaseData.

Definition at line 94 of file mitkContour.cpp.


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