Medical Imaging Interaction Toolkit  2018.4.99-b7f3afaa
Medical Imaging Interaction Toolkit
mitk::PlanarDoubleEllipse Class Reference

Planar representing a double ellipse. The double ellipse is either represented by 4 control points (center, outer major axis, outer minor axis and inner major axis) or be one control point (center, fixed size mode). The mode is selected via the constructor. More...

#include <mitkPlanarDoubleEllipse.h>

Inheritance diagram for mitk::PlanarDoubleEllipse:
Collaboration diagram for mitk::PlanarDoubleEllipse:

Public Member Functions

 mitkClassMacro (PlanarDoubleEllipse, PlanarFigure)
 
 mitkNewMacro2Param (PlanarDoubleEllipse, double, double) static Pointer New()
 
Pointer Clone () const
 
unsigned int GetNumberOfSegments () const
 
void SetNumberOfSegments (unsigned int numSegments)
 
unsigned int GetMaximumNumberOfControlPoints () const override
 Returns the maximum number of control points allowed for this figure (e.g. 3 for triangles). More...
 
unsigned int GetMinimumNumberOfControlPoints () const override
 Returns the minimum number of control points needed to represent this figure. More...
 
bool SetControlPoint (unsigned int index, const Point2D &point, bool createIfDoesNotExist=true) override
 
bool Equals (const mitk::PlanarFigure &other) const override
 Compare two PlanarFigure objects Note: all subclasses have to implement the method on their own. 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 PlaneGeometryGetPlaneGeometry () 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...
 
virtual bool SetCurrentControlPoint (const Point2D &point)
 
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...
 
const PolyLineType GetPolyLine (unsigned int index)
 Returns the polyline representing the planar figure (for rendering, measurements, etc.). More...
 
const PolyLineType GetPolyLine (unsigned int index) const
 Returns the polyline representing the planar figure (for rendering, measurments, etc.). More...
 
const PolyLineType GetHelperPolyLine (unsigned int index, double mmPerDisplayUnit, unsigned int displayHeight)
 Returns the polyline that should be drawn the same size at every scale (for text, angles, etc.). 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 (such as, radius, area, ...). More...
 
const char * GetFeatureName (unsigned int index) const
 Returns the name (identifier) of the specified features. More...
 
const char * GetFeatureUnit (unsigned int index) const
 Returns the physical unit of the specified features. More...
 
double GetQuantity (unsigned int index) const
 
bool IsFeatureActive (unsigned int index) const
 Returns true if the feature with the specified index exists and is active (an inactive feature may e.g. be the area of a non-closed polygon. More...
 
bool IsFeatureVisible (unsigned int index) const
 Returns true if the feature with the specified index exists and is set visible. More...
 
void SetFeatureVisible (unsigned int index, bool visible)
 Defines if the feature with the specified index will be shown as an Annotation in the RenderWindow. More...
 
virtual void EvaluateFeatures ()
 Calculates quantities of all features of this planar figure. More...
 
void UpdateOutputInformation () override
 Intherited from parent. More...
 
void SetRequestedRegionToLargestPossibleRegion () override
 Intherited from parent. More...
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 Intherited from parent. More...
 
bool VerifyRequestedRegion () override
 Intherited from parent. More...
 
void SetRequestedRegion (const itk::DataObject *data) override
 Intherited from parent. 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 point with the given index from the list of controlpoints. More...
 
virtual void RemoveLastControlPoint ()
 Removes last control point. More...
 
void ResetNumberOfControlPoints (int numberOfControlPoints)
 Set the initial number of control points of the planar figure. More...
 
- 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 ()
 

Public Attributes

const unsigned int FEATURE_ID_MAJOR_AXIS
 
const unsigned int FEATURE_ID_MINOR_AXIS
 
const unsigned int FEATURE_ID_THICKNESS
 

Static Public Attributes

static const unsigned int CP_CENTER
 
static const unsigned int CP_OUTER_MAJOR_AXIS
 
static const unsigned int CP_OUTER_MINOR_AXIS
 
static const unsigned int CP_INNER_MAJOR_AXIS
 

Protected Member Functions

 PlanarDoubleEllipse ()
 
 PlanarDoubleEllipse (double fixedRadius, double fixedThickness)
 
 mitkCloneMacro (Self)
 
mitk::Point2D ApplyControlPointConstraints (unsigned int index, const Point2D &point) override
 Allow sub-classes to apply constraints on control points. More...
 
void EvaluateFeaturesInternal () override
 Calculates quantities of all features of this planar figure. Must be implemented in sub-classes. More...
 
void GenerateHelperPolyLine (double, unsigned int) override
 Generates the poly-lines that should be drawn the same size regardless of zoom. Must be implemented in sub-classes. More...
 
void GeneratePolyLine () override
 Generates the poly-line representation of the planar figure. Must be implemented in sub-classes. More...
 
- 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 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

- Public Types inherited from mitk::PlanarFigure
typedef Point2D PolyLineElement
 
typedef itk::VectorContainer< unsigned long, bool > BoolContainerType
 
typedef std::deque< Point2DControlPointListType
 
typedef std::vector< PolyLineElementPolyLineType
 
- 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
 
- Static Public Member Functions inherited from mitk::BaseData
static const char * GetStaticNameOfClass ()
 
- Protected Attributes inherited from mitk::PlanarFigure
ControlPointListType m_ControlPoints
 
unsigned int m_NumberOfControlPoints
 
int m_SelectedControlPoint
 
std::vector< PolyLineTypem_PolyLines
 
std::vector< PolyLineTypem_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
 

Detailed Description

Planar representing a double ellipse. The double ellipse is either represented by 4 control points (center, outer major axis, outer minor axis and inner major axis) or be one control point (center, fixed size mode). The mode is selected via the constructor.

Definition at line 25 of file mitkPlanarDoubleEllipse.h.

Constructor & Destructor Documentation

◆ PlanarDoubleEllipse() [1/2]

◆ PlanarDoubleEllipse() [2/2]

mitk::PlanarDoubleEllipse::PlanarDoubleEllipse ( double  fixedRadius,
double  fixedThickness 
)
protected

Member Function Documentation

◆ ApplyControlPointConstraints()

mitk::Point2D mitk::PlanarDoubleEllipse::ApplyControlPointConstraints ( unsigned int  ,
const Point2D point 
)
overrideprotectedvirtual

Allow sub-classes to apply constraints on control points.

Sub-classes can define spatial constraints to certain control points by overwriting this method and returning a constrained point. By default, the points are constrained by the image bounds.

Reimplemented from mitk::PlanarFigure.

Definition at line 52 of file mitkPlanarDoubleEllipse.cpp.

References CP_CENTER, CP_INNER_MAJOR_AXIS, CP_OUTER_MAJOR_AXIS, CP_OUTER_MINOR_AXIS, mitk::PlanarFigure::GetControlPoint(), max(), and min().

◆ Clone()

Pointer mitk::PlanarDoubleEllipse::Clone ( ) const

◆ Equals()

bool mitk::PlanarDoubleEllipse::Equals ( const mitk::PlanarFigure other) const
overridevirtual

Compare two PlanarFigure objects Note: all subclasses have to implement the method on their own.

Reimplemented from mitk::PlanarFigure.

Definition at line 277 of file mitkPlanarDoubleEllipse.cpp.

◆ EvaluateFeaturesInternal()

void mitk::PlanarDoubleEllipse::EvaluateFeaturesInternal ( )
overrideprotectedvirtual

Calculates quantities of all features of this planar figure. Must be implemented in sub-classes.

Implements mitk::PlanarFigure.

Definition at line 89 of file mitkPlanarDoubleEllipse.cpp.

References CP_CENTER, CP_INNER_MAJOR_AXIS, CP_OUTER_MAJOR_AXIS, CP_OUTER_MINOR_AXIS, FEATURE_ID_MAJOR_AXIS, FEATURE_ID_MINOR_AXIS, FEATURE_ID_THICKNESS, mitk::PlanarFigure::GetControlPoint(), and mitk::PlanarFigure::SetQuantity().

◆ GenerateHelperPolyLine()

void mitk::PlanarDoubleEllipse::GenerateHelperPolyLine ( double  mmPerDisplayUnit,
unsigned  displayHeight 
)
overrideprotectedvirtual

Generates the poly-lines that should be drawn the same size regardless of zoom. Must be implemented in sub-classes.

Implements mitk::PlanarFigure.

Definition at line 101 of file mitkPlanarDoubleEllipse.cpp.

◆ GeneratePolyLine()

void mitk::PlanarDoubleEllipse::GeneratePolyLine ( )
overrideprotectedvirtual

Generates the poly-line representation of the planar figure. Must be implemented in sub-classes.

Implements mitk::PlanarFigure.

Definition at line 105 of file mitkPlanarDoubleEllipse.cpp.

References mitk::PlanarFigure::AppendPointToPolyLine(), mitk::PlanarFigure::ClearPolyLines(), CP_CENTER, CP_INNER_MAJOR_AXIS, CP_OUTER_MAJOR_AXIS, CP_OUTER_MINOR_AXIS, mitk::PlanarFigure::GetControlPoint(), and rotation.

Referenced by SetNumberOfSegments().

◆ GetMaximumNumberOfControlPoints()

unsigned int mitk::PlanarDoubleEllipse::GetMaximumNumberOfControlPoints ( ) const
overridevirtual

Returns the maximum number of control points allowed for this figure (e.g. 3 for triangles).

Must be implemented in sub-classes.

Implements mitk::PlanarFigure.

Definition at line 190 of file mitkPlanarDoubleEllipse.cpp.

◆ GetMinimumNumberOfControlPoints()

unsigned int mitk::PlanarDoubleEllipse::GetMinimumNumberOfControlPoints ( ) const
overridevirtual

Returns the minimum number of control points needed to represent this figure.

Must be implemented in sub-classes.

Implements mitk::PlanarFigure.

Definition at line 195 of file mitkPlanarDoubleEllipse.cpp.

◆ GetNumberOfSegments()

unsigned int mitk::PlanarDoubleEllipse::GetNumberOfSegments ( ) const

Definition at line 174 of file mitkPlanarDoubleEllipse.cpp.

◆ mitkClassMacro()

mitk::PlanarDoubleEllipse::mitkClassMacro ( PlanarDoubleEllipse  ,
PlanarFigure   
)

◆ mitkCloneMacro()

mitk::PlanarDoubleEllipse::mitkCloneMacro ( Self  )
protected

◆ mitkNewMacro2Param()

mitk::PlanarDoubleEllipse::mitkNewMacro2Param ( PlanarDoubleEllipse  ,
double  ,
double   
)

◆ SetControlPoint()

bool mitk::PlanarDoubleEllipse::SetControlPoint ( unsigned int  index,
const Point2D point,
bool  createIfDoesNotExist = true 
)
overridevirtual

◆ SetNumberOfSegments()

void mitk::PlanarDoubleEllipse::SetNumberOfSegments ( unsigned int  numSegments)

Member Data Documentation

◆ CP_CENTER

const unsigned int mitk::PlanarDoubleEllipse::CP_CENTER
static

◆ CP_INNER_MAJOR_AXIS

const unsigned int mitk::PlanarDoubleEllipse::CP_INNER_MAJOR_AXIS
static

◆ CP_OUTER_MAJOR_AXIS

const unsigned int mitk::PlanarDoubleEllipse::CP_OUTER_MAJOR_AXIS
static

◆ CP_OUTER_MINOR_AXIS

const unsigned int mitk::PlanarDoubleEllipse::CP_OUTER_MINOR_AXIS
static

◆ FEATURE_ID_MAJOR_AXIS

const unsigned int mitk::PlanarDoubleEllipse::FEATURE_ID_MAJOR_AXIS

Definition at line 41 of file mitkPlanarDoubleEllipse.h.

Referenced by EvaluateFeaturesInternal().

◆ FEATURE_ID_MINOR_AXIS

const unsigned int mitk::PlanarDoubleEllipse::FEATURE_ID_MINOR_AXIS

Definition at line 42 of file mitkPlanarDoubleEllipse.h.

Referenced by EvaluateFeaturesInternal().

◆ FEATURE_ID_THICKNESS

const unsigned int mitk::PlanarDoubleEllipse::FEATURE_ID_THICKNESS

Definition at line 43 of file mitkPlanarDoubleEllipse.h.

Referenced by EvaluateFeaturesInternal().


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