Implementation of PlanarFigure representing a circle. More...

#include <mitkPlanarCircle.h>

Inheritance diagram for mitk::PlanarCircle:

[legend]

Collaboration diagram for mitk::PlanarCircle:

[legend]

Public Member Functions
	mitkClassMacro (PlanarCircle, PlanarFigure)

	mitkNewMacro1Param (PlanarCircle, double)
	Creates a PlanarCircle with a fixed radius. More...

Pointer	Clone () const

bool	SetControlPoint (unsigned int index, const Point2D &point, bool createIfDoesNotExist=false) override
	Sets a control point position with optional radius constraints. More...

unsigned int	GetMinimumNumberOfControlPoints () const override
	Returns 1 in fixed-radius mode, 2 otherwise. More...

unsigned int	GetMaximumNumberOfControlPoints () const override
	Returns 1 in fixed-radius mode, 2 otherwise. More...

void	SetMinimumRadius (double radius)
	Sets the minimum allowed radius. More...

double	GetMinimumRadius ()
	Returns the minimum allowed radius. More...

void	SetMaximumRadius (double radius)
	Sets the maximum allowed radius. More...

double	GetMaximumRadius ()
	Returns the maximum allowed radius. More...

void	ActivateMinMaxRadiusContstraints (bool active)
	Activates or deactivates minimum/maximum radius constraints. More...

bool	SetCurrentControlPoint (const Point2D &point) override
	Sets the currently selected control point, applying radius constraints if active. More...

bool	Equals (const mitk::PlanarFigure &other) const override
	Compares this PlanarCircle with another PlanarFigure for equality. More...

Public Member Functions inherited from mitk::PlanarFigure
	mitkClassMacro (PlanarFigure, BaseData)

Pointer	Clone () const

virtual void	SetPlaneGeometry (mitk::PlaneGeometry *geometry)
	Sets the 2D geometry on which this figure will be placed. More...

virtual const PlaneGeometry *	GetPlaneGeometry () const
	Returns (previously set) 2D geometry of this figure. More...

virtual bool	IsClosed () const
	True if the planar figure is closed. More...

virtual bool	IsPlaced () const
	True if the planar figure has been placed (and can be displayed/interacted with). More...

virtual void	PlaceFigure (const Point2D &point)
	Place figure at the given point (in 2D index coordinates) onto the given 2D geometry. More...

virtual bool	AddControlPoint (const Point2D &point, int index=-1)
	Adds / inserts new control-points. More...

unsigned int	GetNumberOfControlPoints () const
	Returns the current number of 2D control points defining this figure. More...

virtual bool	SelectControlPoint (unsigned int index)
	Selects currently active control points. More...

virtual bool	DeselectControlPoint ()
	Deselect control point; no control point active. More...

virtual int	GetSelectedControlPoint () const
	Return currently selected control point. More...

Point2D	GetControlPoint (unsigned int index) const
	Returns specified control point in 2D world coordinates. More...

virtual int	GetControlPointForPolylinePoint (int indexOfPolylinePoint, int polyLineIndex) const
	Returns the id of the control-point that corresponds to the given polyline-point. More...

Point3D	GetWorldControlPoint (unsigned int index) const
	Returns specified control point in world coordinates. More...

PolyLineType &	GetPolyLine (unsigned int index)
	Returns the polyline representing the planar figure (mutable version). More...

const PolyLineType &	GetPolyLine (unsigned int index) const
	Returns the polyline representing the planar figure (const version). More...

const PolyLineType &	GetHelperPolyLine (unsigned int index, double mmPerDisplayUnit, unsigned int displayHeight)
	Returns a helper polyline that should be drawn at a fixed size regardless of zoom. More...

void	SetPreviewControlPoint (const Point2D &point)
	Sets the position of the PreviewControlPoint. Automatically sets it visible. More...

void	ResetPreviewContolPoint ()
	Marks the PreviewControlPoint as invisible. More...

bool	IsPreviewControlPointVisible () const
	Returns whether or not the PreviewControlPoint is visible. More...

Point2D	GetPreviewControlPoint () const
	Returns the coordinates of the PreviewControlPoint. More...

virtual unsigned int	GetNumberOfFeatures () const
	Returns the number of features available for this PlanarFigure. More...

const char *	GetFeatureName (unsigned int index) const
	Returns the name (identifier) of the specified feature. More...

const char *	GetFeatureUnit (unsigned int index) const
	Returns the physical unit of the specified feature. More...

double	GetQuantity (unsigned int index) const
	Returns the quantity of the specified feature. More...

bool	IsFeatureActive (unsigned int index) const
	Returns whether the specified feature is active. More...

bool	IsFeatureVisible (unsigned int index) const
	Returns whether the specified feature is set to visible. More...

void	SetFeatureVisible (unsigned int index, bool visible)
	Sets the visibility of the specified feature for annotation display. More...

virtual void	EvaluateFeatures ()
	Calculates quantities of all features of this planar figure. More...

void	UpdateOutputInformation () override
	Inherited from BaseData. Updates geometry information. More...

void	SetRequestedRegionToLargestPossibleRegion () override
	Inherited from BaseData. Sets the requested region to the largest possible. More...

bool	RequestedRegionIsOutsideOfTheBufferedRegion () override
	Inherited from BaseData. Checks if the requested region is outside the buffered region. More...

bool	VerifyRequestedRegion () override
	Inherited from BaseData. Verifies the requested region. More...

void	SetRequestedRegion (const itk::DataObject *data) override
	Inherited from BaseData. Sets the requested region from another data object. More...

virtual unsigned short	GetPolyLinesSize ()
	Returns the current number of polylines More...

virtual unsigned short	GetHelperPolyLinesSize () const
	Returns the current number of helperpolylines More...

virtual bool	IsHelperToBePainted (unsigned int index) const
	Returns whether a helper polyline should be painted or not. More...

virtual bool	ResetOnPointSelect ()
	Returns true if the planar figure is reset to "add points" mode when a point is selected. More...

virtual bool	ResetOnPointSelectNeeded () const

virtual void	RemoveControlPoint (unsigned int index)
	Removes the control point at the given index. More...

virtual void	RemoveLastControlPoint ()
	Removes the last control point from the figure. More...

void	ResetNumberOfControlPoints (int numberOfControlPoints)
	Resets the number of control points to the specified count. More...

Public Member Functions inherited from mitk::BaseData
	mitkClassMacroItkParent (BaseData, itk::DataObject)

BaseProperty::ConstPointer	GetConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) const override
	Get a const property by its key. More...

std::vector< std::string >	GetPropertyKeys (const std::string &contextName="", bool includeDefaultContext=false) const override
	Get all property keys stored in the property list. More...

std::vector< std::string >	GetPropertyContextNames () const override
	Get the names of all property contexts. More...

BaseProperty *	GetNonConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) override
	Get a non-const property by its key. More...

void	SetProperty (const std::string &propertyKey, BaseProperty *property, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
	Set a property in the property list. More...

void	RemoveProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
	Remove a property from the property list. More...

const mitk::TimeGeometry *	GetTimeGeometry () const
	Return the TimeGeometry of the data as const pointer. More...

mitk::TimeGeometry *	GetTimeGeometry ()
	Return the TimeGeometry of the data as non-const pointer. More...

const mitk::TimeGeometry *	GetUpdatedTimeGeometry ()
	Return the TimeGeometry of the data after ensuring it is up-to-date. More...

virtual void	Expand (unsigned int timeSteps)
	Expand the TimeGeometry to a number of time steps. More...

const mitk::BaseGeometry *	GetUpdatedGeometry (int t=0)
	Return the BaseGeometry of the data at time step t after ensuring it is up-to-date. More...

mitk::BaseGeometry *	GetGeometry (int t=0) const
	Return the BaseGeometry of the data at time step t as a non-const pointer. More...

void	UpdateOutputInformation () override
	Update the information for this BaseData 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. More...

virtual void	Clear ()
	Reset the data object by calling ClearData() and InitializeEmpty(). More...

virtual bool	IsEmptyTimeStep (unsigned int t) const
	Check whether the object contains data at the specified time step. More...

virtual bool	IsEmpty () const
	Check whether the object contains data at any time step. More...

void	ExecuteOperation (Operation *operation) override
	Execute an operation on this data object. More...

virtual void	SetGeometry (BaseGeometry *aGeometry3D)
	Set the BaseGeometry of the data, which will be referenced (not copied!). 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 the BaseGeometry of the data. More...

virtual void	SetClonedTimeGeometry (const TimeGeometry *geometry)
	Set a clone of the provided TimeGeometry as the TimeGeometry of the data. More...

virtual void	SetClonedGeometry (const BaseGeometry *aGeometry3D, unsigned int time)
	Set a clone of the provided geometry as the 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, replacing the existing one. More...

mitk::BaseProperty::Pointer	GetProperty (const char *propertyKey) const
	Get a property by its key from the PropertyList. More...

void	SetProperty (const char propertyKey, BaseProperty property)
	Set a property in the PropertyList. More...

virtual void	SetOrigin (const Point3D &origin)
	Convenience method for setting the origin of the BaseGeometry instances of all time steps. More...

itk::SmartPointer< mitk::BaseDataSource >	GetSource () const
	Get the process object that generated this data object. More...

unsigned int	GetTimeSteps () const
	Get the number of time steps from the TimeGeometry. More...

itk::ModifiedTimeType	GetMTime () const override
	Get the modification time of this data object or its geometry, whichever was modified most recently. More...

void	Graft (const DataObject *) override
	Graft data and information from another data object. More...

Public Member Functions inherited from mitk::OperationActor
	itkTypeMacroNoParent (OperationActor) virtual ~OperationActor()

Public Member Functions inherited from mitk::Identifiable
	Identifiable ()
	Default constructor. Generates a new random UID. More...

	Identifiable (const UIDType &uid)
	Construct with a pre-existing UID. More...

	Identifiable (const Identifiable &)=delete
	Copy construction is deleted to prevent UID duplication. More...

	Identifiable (Identifiable &&) noexcept
	Move constructor. Transfers ownership of the UID. More...

virtual	~Identifiable ()
	Virtual destructor. More...

Identifiable &	operator= (const Identifiable &)=delete
	Copy assignment is deleted to prevent UID duplication. More...

Identifiable &	operator= (Identifiable &&other) noexcept
	Move assignment operator. Transfers ownership of the UID. More...

virtual UIDType	GetUID () const
	Get the unique identifier of this object. More...

UIDType	GetRuntimeUID () const noexcept
	Get a runtime-unique ID for this object instance. More...

Public Member Functions inherited from mitk::IPropertyOwner
	~IPropertyOwner () override

virtual bool	PropertyIsOwned (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) const
	Checks if a certain property exists. More...

Public Member Functions inherited from mitk::IPropertyProvider
virtual	~IPropertyProvider ()
	Virtual destructor. More...

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	PlanarCircle ()

	PlanarCircle (double fixedRadius)

	PlanarCircle (const Self &other)

	mitkCloneMacro (Self)

void	GeneratePolyLine () override
	Generates the poly-line representation of the planar figure. More...

void	GenerateHelperPolyLine (double mmPerDisplayUnit, unsigned int displayHeight) override
	Generates the poly-lines that should be drawn the same size regardless of zoom. More...

Point2D	ApplyControlPointConstraints (unsigned int index, const Point2D &point) override
	Spatially constrain control points of second (orthogonal) line. More...

void	EvaluateFeaturesInternal () override
	Calculates feature quantities of the planar figure. More...

void	PrintSelf (std::ostream &os, itk::Indent indent) const override

Protected Member Functions inherited from mitk::PlanarFigure
	PlanarFigure ()

	PlanarFigure (const Self &other)

virtual unsigned int	AddFeature (const char featureName, const char unitName)

void	SetFeatureName (unsigned int index, const char *featureName)

void	SetFeatureUnit (unsigned int index, const char *unitName)

void	SetQuantity (unsigned int index, double quantity)

void	ActivateFeature (unsigned int index)

void	DeactivateFeature (unsigned int index)

void	InitializeTimeGeometry (unsigned int timeSteps=1) override
	Initializes the TimeGeometry describing the (time-resolved) geometry of this figure. Note that each time step holds one PlaneGeometry. More...

void	SetNumberOfPolyLines (unsigned int numberOfPolyLines)
	defines the number of PolyLines that will be available More...

void	AppendPointToPolyLine (unsigned int index, PolyLineElement element)
	Append a point to the PolyLine # index. More...

void	ClearPolyLines ()
	clears the list of PolyLines. Call before re-calculating a new Polyline. More...

void	SetNumberOfHelperPolyLines (unsigned int numberOfHelperPolyLines)
	defines the number of HelperPolyLines that will be available More...

void	AppendPointToHelperPolyLine (unsigned int index, PolyLineElement element)
	Append a point to the HelperPolyLine # index. More...

void	ClearHelperPolyLines ()
	clears the list of HelperPolyLines. Call before re-calculating a new HelperPolyline. More...

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	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

Protected Member Functions inherited from mitk::Identifiable
virtual void	SetUID (const UIDType &uid)

Protected Attributes
const unsigned int	FEATURE_ID_RADIUS

const unsigned int	FEATURE_ID_DIAMETER

const unsigned int	FEATURE_ID_AREA

double	m_MinRadius

double	m_MaxRadius

bool	m_MinMaxRadiusContraintsActive

bool	m_RadiusFixed

Protected Attributes inherited from mitk::PlanarFigure
ControlPointListType	m_ControlPoints

unsigned int	m_NumberOfControlPoints

int	m_SelectedControlPoint

std::vector< PolyLineType >	m_PolyLines

std::vector< PolyLineType >	m_HelperPolyLines

BoolContainerType::Pointer	m_HelperPolyLinesToBePainted

Point2D	m_PreviewControlPoint

bool	m_PreviewControlPointVisible

bool	m_FigurePlaced

Protected Attributes inherited from mitk::BaseData
bool	m_LastRequestedRegionWasOutsideOfTheBufferedRegion

unsigned int	m_SourceOutputIndexDuplicate

bool	m_Initialized

Additional Inherited Members
Public Types inherited from mitk::PlanarFigure
typedef Point2D	PolyLineElement
	Type for individual elements of a polyline (2D points). More...

typedef itk::VectorContainer< unsigned long, bool >	BoolContainerType
	Container type for boolean values, used for helper polyline paint flags. More...

typedef std::deque< Point2D >	ControlPointListType
	Type for the list of control points defining the figure. More...

typedef std::vector< PolyLineElement >	PolyLineType
	Type for a polyline (vector of 2D points). More...

Public Types inherited from mitk::Identifiable
using	UIDType = std::string
	Type alias for unique identifiers. More...

Detailed Description

Implementation of PlanarFigure representing a circle.

The circle is defined either by two control points (center and a point on the circumference) in normal mode, or by a single control point (center) with a fixed radius. The mode is selected by the constructor used.

Provides three features:

FEATURE_ID_RADIUS: the circle radius
FEATURE_ID_DIAMETER: the circle diameter
FEATURE_ID_AREA: the circle area

Optional minimum/maximum radius constraints can be activated.

See also: PlanarFigure, PlanarEllipse, PlanarFigureMapper2D

Definition at line 39 of file mitkPlanarCircle.h.

Constructor & Destructor Documentation

◆ PlanarCircle() [1/3]

mitk::PlanarCircle::PlanarCircle ( )

protected

◆ PlanarCircle() [2/3]

mitk::PlanarCircle::PlanarCircle ( double fixedRadius )

protected

Constructor for fixed radius mode.

◆ PlanarCircle() [3/3]

mitk::PlanarCircle::PlanarCircle ( const Self & other )

protected

Member Function Documentation

◆ ActivateMinMaxRadiusContstraints()

void mitk::PlanarCircle::ActivateMinMaxRadiusContstraints ( bool active )

inline

Activates or deactivates minimum/maximum radius constraints.

Parameters

[in] active If true, radius constraints are enforced.

Definition at line 95 of file mitkPlanarCircle.h.

◆ ApplyControlPointConstraints()

Point2D mitk::PlanarCircle::ApplyControlPointConstraints	(	unsigned int	index,
		const Point2D &	point
	)

overrideprotectedvirtual

Spatially constrain control points of second (orthogonal) line.

Reimplemented from mitk::PlanarFigure.

◆ Clone()

Pointer mitk::PlanarCircle::Clone ( ) const

◆ Equals()

bool mitk::PlanarCircle::Equals ( const mitk::PlanarFigure & other ) const

overridevirtual

Compares this PlanarCircle with another PlanarFigure for equality.

Parameters

[in] other The PlanarFigure to compare with.

Returns: True if both figures are considered equal.

Reimplemented from mitk::PlanarFigure.

◆ EvaluateFeaturesInternal()

void mitk::PlanarCircle::EvaluateFeaturesInternal ( )

overrideprotectedvirtual

Calculates feature quantities of the planar figure.

Implements mitk::PlanarFigure.

◆ GenerateHelperPolyLine()

void mitk::PlanarCircle::GenerateHelperPolyLine	(	double	mmPerDisplayUnit,
		unsigned int	displayHeight
	)

overrideprotectedvirtual

Generates the poly-lines that should be drawn the same size regardless of zoom.

Implements mitk::PlanarFigure.

◆ GeneratePolyLine()

void mitk::PlanarCircle::GeneratePolyLine ( )

overrideprotectedvirtual

Generates the poly-line representation of the planar figure.

Implements mitk::PlanarFigure.

◆ GetMaximumNumberOfControlPoints()

unsigned int mitk::PlanarCircle::GetMaximumNumberOfControlPoints ( ) const

inlineoverridevirtual

Returns 1 in fixed-radius mode, 2 otherwise.

Returns: The maximum number of control points.

Implements mitk::PlanarFigure.

Definition at line 68 of file mitkPlanarCircle.h.

◆ GetMaximumRadius()

double mitk::PlanarCircle::GetMaximumRadius ( )

inline

Returns the maximum allowed radius.

Returns: The maximum radius value.

Definition at line 89 of file mitkPlanarCircle.h.

◆ GetMinimumNumberOfControlPoints()

unsigned int mitk::PlanarCircle::GetMinimumNumberOfControlPoints ( ) const

inlineoverridevirtual

Returns 1 in fixed-radius mode, 2 otherwise.

Returns: The minimum number of control points.

Implements mitk::PlanarFigure.

Definition at line 63 of file mitkPlanarCircle.h.

◆ GetMinimumRadius()

double mitk::PlanarCircle::GetMinimumRadius ( )

inline

Returns the minimum allowed radius.

Returns: The minimum radius value.

Definition at line 79 of file mitkPlanarCircle.h.

◆ mitkClassMacro()

mitk::PlanarCircle::mitkClassMacro	(	PlanarCircle	,
		PlanarFigure
	)

◆ mitkCloneMacro()

mitk::PlanarCircle::mitkCloneMacro ( Self )

protected

◆ mitkNewMacro1Param()

mitk::PlanarCircle::mitkNewMacro1Param	(	PlanarCircle	,
		double
	)

Creates a PlanarCircle with a fixed radius.

◆ New()

static Pointer mitk::PlanarCircle::New ( )

static

◆ PrintSelf()

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

overrideprotected

◆ SetControlPoint()

bool mitk::PlanarCircle::SetControlPoint	(	unsigned int	index,
		const Point2D &	point,
		bool	createIfDoesNotExist = `false`
	)

overridevirtual

Sets a control point position with optional radius constraints.

Parameters

[in]	index	Zero-based index of the control point.
[in]	point	New 2D coordinates.
[in]	createIfDoesNotExist	If true, creates the point if it does not exist.

Returns: True if the control point was set successfully.

Reimplemented from mitk::PlanarFigure.

◆ SetCurrentControlPoint()

bool mitk::PlanarCircle::SetCurrentControlPoint ( const Point2D & point )

overridevirtual

Sets the currently selected control point, applying radius constraints if active.

Parameters

[in] point New 2D coordinates.

Returns: True if the point was set successfully.

Reimplemented from mitk::PlanarFigure.

◆ SetMaximumRadius()

void mitk::PlanarCircle::SetMaximumRadius ( double radius )

inline

Sets the maximum allowed radius.

Parameters

[in] radius The maximum radius value.

Definition at line 84 of file mitkPlanarCircle.h.

◆ SetMinimumRadius()

void mitk::PlanarCircle::SetMinimumRadius ( double radius )

inline

Sets the minimum allowed radius.

Parameters

[in] radius The minimum radius value.

Definition at line 74 of file mitkPlanarCircle.h.

Member Data Documentation

◆ FEATURE_ID_AREA

const unsigned int mitk::PlanarCircle::FEATURE_ID_AREA

protected

Definition at line 136 of file mitkPlanarCircle.h.

◆ FEATURE_ID_DIAMETER

const unsigned int mitk::PlanarCircle::FEATURE_ID_DIAMETER

protected

Definition at line 135 of file mitkPlanarCircle.h.

◆ FEATURE_ID_RADIUS

const unsigned int mitk::PlanarCircle::FEATURE_ID_RADIUS

protected

Definition at line 134 of file mitkPlanarCircle.h.

◆ m_MaxRadius

double mitk::PlanarCircle::m_MaxRadius

protected

Definition at line 140 of file mitkPlanarCircle.h.

◆ m_MinMaxRadiusContraintsActive

bool mitk::PlanarCircle::m_MinMaxRadiusContraintsActive

protected

Definition at line 141 of file mitkPlanarCircle.h.

◆ m_MinRadius

double mitk::PlanarCircle::m_MinRadius

protected

Definition at line 139 of file mitkPlanarCircle.h.

◆ m_RadiusFixed

bool mitk::PlanarCircle::m_RadiusFixed

protected

Definition at line 143 of file mitkPlanarCircle.h.

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

mitkPlanarCircle.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PlanarCircle() [1/3]

◆ PlanarCircle() [2/3]

◆ PlanarCircle() [3/3]

Member Function Documentation

◆ ActivateMinMaxRadiusContstraints()

◆ ApplyControlPointConstraints()

◆ Clone()

◆ Equals()

◆ EvaluateFeaturesInternal()

◆ GenerateHelperPolyLine()

◆ GeneratePolyLine()

◆ GetMaximumNumberOfControlPoints()

◆ GetMaximumRadius()

◆ GetMinimumNumberOfControlPoints()

◆ GetMinimumRadius()

◆ mitkClassMacro()

◆ mitkCloneMacro()

◆ mitkNewMacro1Param()

◆ New()

◆ PrintSelf()

◆ SetControlPoint()

◆ SetCurrentControlPoint()

◆ SetMaximumRadius()

◆ SetMinimumRadius()

Member Data Documentation

◆ FEATURE_ID_AREA

◆ FEATURE_ID_DIAMETER

◆ FEATURE_ID_RADIUS

◆ m_MaxRadius

◆ m_MinMaxRadiusContraintsActive

◆ m_MinRadius

◆ m_RadiusFixed