Medical Imaging Interaction Toolkit  2023.04.00
Medical Imaging Interaction Toolkit
mitk::ExtrudedContour Class Reference

Data class containing a bounding-object created by extruding a Contour along a vector. More...

#include <mitkExtrudedContour.h>

Inheritance diagram for mitk::ExtrudedContour:
Collaboration diagram for mitk::ExtrudedContour:

Public Member Functions

 mitkClassMacro (ExtrudedContour, BoundingObject)
 
Pointer Clone () const
 
mitk::ScalarType GetVolume () override
 
bool IsInside (const Point3D &p) const override
 
void UpdateOutputInformation () override
 
virtual const mitk::ContourGetContour ()
 Contour to extrude. More...
 
virtual void SetContour (mitk::Contour *_arg)
 
 mitkGetVectorMacro (Vector, mitk::Vector3D)
 Vector to specify the direction of the extrusion. More...
 
 mitkSetVectorMacro (Vector, mitk::Vector3D)
 
virtual bool GetAutomaticVectorGeneration () const
 
virtual void SetAutomaticVectorGeneration (bool _arg)
 
virtual void AutomaticVectorGenerationOn ()
 
virtual void AutomaticVectorGenerationOff ()
 
 mitkGetVectorMacro (RightVector, mitk::Vector3D)
 Optional vector to specify the orientation of the bounding-box. More...
 
 mitkSetVectorMacro (RightVector, mitk::Vector3D)
 
virtual const mitk::BaseGeometryGetClippingGeometry ()
 Optional geometry for clipping the extruded contour. More...
 
virtual void SetClippingGeometry (mitk::BaseGeometry *_arg)
 
itk::ModifiedTimeType GetMTime () const override
 
- Public Member Functions inherited from mitk::BoundingObject
 mitkClassMacro (BoundingObject, mitk::Surface)
 
virtual bool GetPositive ()
 
virtual void SetPositive (bool _arg)
 
virtual void PositiveOn ()
 
virtual void PositiveOff ()
 
virtual void FitGeometry (BaseGeometry *aGeometry3D)
 Sets the Geometry3D of the bounding object to fit the given geometry. More...
 
- Public Member Functions inherited from mitk::Surface
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
void CalculateBoundingBox ()
 
void CopyInformation (const itk::DataObject *data) override
 
void ExecuteOperation (Operation *operation) override
 overwrite if the Data can be called by an Interactor (StateMachine). More...
 
void Expand (unsigned int timeSteps=1) override
 Expands the TimeGeometry to a number of TimeSteps. More...
 
const RegionTypeGetLargestPossibleRegion () const
 
virtual const RegionTypeGetRequestedRegion () const
 
unsigned int GetSizeOfPolyDataSeries () const
 
virtual vtkPolyData * GetVtkPolyData (unsigned int t=0) const
 
void Graft (const DataObject *data) override
 
bool IsEmptyTimeStep (unsigned int t) const override
 Check whether object contains data (at a specified time), e.g., a set of points may be empty. More...
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 Determine whether the RequestedRegion is outside of the BufferedRegion. More...
 
void SetRequestedRegion (const itk::DataObject *data) override
 Set the requested region from this data object to match the requested region of the data object passed in as a parameter. More...
 
virtual void SetRequestedRegion (Surface::RegionType *region)
 
void SetRequestedRegionToLargestPossibleRegion () override
 Set the RequestedRegion to the LargestPossibleRegion. More...
 
virtual void SetVtkPolyData (vtkPolyData *polydata, unsigned int t=0)
 
virtual void Swap (Surface &other)
 
void Update () override
 
void UpdateOutputInformation () override
 
bool VerifyRequestedRegion () override
 Verify that the RequestedRegion is within the LargestPossibleRegion. More...
 
- Public Member Functions inherited from mitk::BaseData
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...
 
mitk::TimeGeometryGetTimeGeometry ()
 Return the TimeGeometry of the data as pointer. More...
 
const mitk::TimeGeometryGetUpdatedTimeGeometry ()
 Return the TimeGeometry of the data. 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 IsEmpty () const
 Check whether object contains data (at least at one point in time), e.g., a set of points may be empty. 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...
 
itk::ModifiedTimeType 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
 
virtual 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::Surface
static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from mitk::BaseData
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 ExtrudedContour ()
 
 ~ExtrudedContour () override
 
void BuildSurface ()
 
void BuildGeometry ()
 
- Protected Member Functions inherited from mitk::BoundingObject
 BoundingObject ()
 
 ~BoundingObject () override
 
bool WriteXMLData (XMLWriter &xmlWriter)
 
- Protected Member Functions inherited from mitk::Surface
virtual itk::LightObject::Pointer InternalClone () const override
 
 Surface ()
 
 ~Surface () override
 
 Surface (const Surface &other)
 
Surfaceoperator= (Surface other)
 
void ClearData () override
 reset to non-initialized state, release memory More...
 
void InitializeEmpty () override
 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...
 
- 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...
 
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

mitk::Contour::Pointer m_Contour
 
mitk::Vector3D m_Vector
 
mitk::Vector3D m_RightVector
 
mitk::BaseGeometry::Pointer m_ClippingGeometry
 
bool m_AutomaticVectorGeneration
 
vtkPolygon * m_Polygon
 
float m_ProjectedContourBounds [6]
 
mitk::PlaneGeometry::Pointer m_ProjectionPlane
 
float m_Right [3]
 For fast projection on plane. More...
 
float m_Down [3]
 
float m_Normal [3]
 
float m_Origin [3]
 
vtkLinearExtrusionFilter * m_ExtrusionFilter
 
vtkTriangleFilter * m_TriangleFilter
 
vtkDecimatePro * m_Decimate
 
vtkLinearSubdivisionFilter * m_SubdivisionFilter
 
vtkPlanes * m_ClippingBox
 
vtkClipPolyData * m_ClipPolyDataFilter
 
itk::TimeStamp m_LastCalculateExtrusionTime
 
- Protected Attributes inherited from mitk::BoundingObject
bool m_Positive
 If true, the Boundingobject describes a positive volume, if false a negative volume. More...
 
- Protected Attributes inherited from mitk::BaseData
bool m_LastRequestedRegionWasOutsideOfTheBufferedRegion
 
unsigned int m_SourceOutputIndexDuplicate
 
bool m_Initialized
 

Additional Inherited Members

- Public Types inherited from mitk::Surface
typedef itk::ImageRegion< 5 > RegionType
 
typedef Surface Self
 
typedef BaseData Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- 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
 

Detailed Description

Data class containing a bounding-object created by extruding a Contour along a vector.

The m_Contour is extruded in the direction m_Vector until reaching m_ClippingGeometry.

Deprecated:
(as of 2015_05) ExtrudedContour is deprecated. It will be removed in the next release. Becomes obsolete. Refer to https://docs.mitk.org/nightly/InteractionMigration.html .

Definition at line 45 of file mitkExtrudedContour.h.

Constructor & Destructor Documentation

◆ ExtrudedContour()

mitk::ExtrudedContour::ExtrudedContour ( )
protected

◆ ~ExtrudedContour()

mitk::ExtrudedContour::~ExtrudedContour ( )
overrideprotected

Member Function Documentation

◆ AutomaticVectorGenerationOff()

virtual void mitk::ExtrudedContour::AutomaticVectorGenerationOff ( )
virtual

◆ AutomaticVectorGenerationOn()

virtual void mitk::ExtrudedContour::AutomaticVectorGenerationOn ( )
virtual

◆ BuildGeometry()

void mitk::ExtrudedContour::BuildGeometry ( )
protected

◆ BuildSurface()

void mitk::ExtrudedContour::BuildSurface ( )
protected

◆ Clone()

Pointer mitk::ExtrudedContour::Clone ( ) const

◆ GetAutomaticVectorGeneration()

virtual bool mitk::ExtrudedContour::GetAutomaticVectorGeneration ( ) const
virtual

◆ GetClippingGeometry()

virtual const mitk::BaseGeometry* mitk::ExtrudedContour::GetClippingGeometry ( )
virtual

Optional geometry for clipping the extruded contour.

◆ GetContour()

virtual const mitk::Contour* mitk::ExtrudedContour::GetContour ( )
virtual

Contour to extrude.

◆ GetMTime()

itk::ModifiedTimeType mitk::ExtrudedContour::GetMTime ( ) const
override

◆ GetVolume()

mitk::ScalarType mitk::ExtrudedContour::GetVolume ( )
overridevirtual

Reimplemented from mitk::BoundingObject.

◆ IsInside()

bool mitk::ExtrudedContour::IsInside ( const Point3D p) const
overridevirtual

Implements mitk::BoundingObject.

◆ mitkClassMacro()

mitk::ExtrudedContour::mitkClassMacro ( ExtrudedContour  ,
BoundingObject   
)

◆ mitkGetVectorMacro() [1/2]

mitk::ExtrudedContour::mitkGetVectorMacro ( RightVector  ,
mitk::Vector3D   
)

Optional vector to specify the orientation of the bounding-box.

◆ mitkGetVectorMacro() [2/2]

mitk::ExtrudedContour::mitkGetVectorMacro ( Vector  ,
mitk::Vector3D   
)

Vector to specify the direction of the extrusion.

◆ mitkSetVectorMacro() [1/2]

mitk::ExtrudedContour::mitkSetVectorMacro ( RightVector  ,
mitk::Vector3D   
)

◆ mitkSetVectorMacro() [2/2]

mitk::ExtrudedContour::mitkSetVectorMacro ( Vector  ,
mitk::Vector3D   
)

◆ New()

static Pointer mitk::ExtrudedContour::New ( )
static

◆ SetAutomaticVectorGeneration()

virtual void mitk::ExtrudedContour::SetAutomaticVectorGeneration ( bool  _arg)
virtual

◆ SetClippingGeometry()

virtual void mitk::ExtrudedContour::SetClippingGeometry ( mitk::BaseGeometry _arg)
virtual

◆ SetContour()

virtual void mitk::ExtrudedContour::SetContour ( mitk::Contour _arg)
virtual

◆ UpdateOutputInformation()

void mitk::ExtrudedContour::UpdateOutputInformation ( )
override

Member Data Documentation

◆ m_AutomaticVectorGeneration

bool mitk::ExtrudedContour::m_AutomaticVectorGeneration
protected

Definition at line 93 of file mitkExtrudedContour.h.

◆ m_ClippingBox

vtkPlanes* mitk::ExtrudedContour::m_ClippingBox
protected

Definition at line 120 of file mitkExtrudedContour.h.

◆ m_ClippingGeometry

mitk::BaseGeometry::Pointer mitk::ExtrudedContour::m_ClippingGeometry
protected

Definition at line 91 of file mitkExtrudedContour.h.

◆ m_ClipPolyDataFilter

vtkClipPolyData* mitk::ExtrudedContour::m_ClipPolyDataFilter
protected

Definition at line 121 of file mitkExtrudedContour.h.

◆ m_Contour

mitk::Contour::Pointer mitk::ExtrudedContour::m_Contour
protected

Definition at line 88 of file mitkExtrudedContour.h.

◆ m_Decimate

vtkDecimatePro* mitk::ExtrudedContour::m_Decimate
protected

Definition at line 118 of file mitkExtrudedContour.h.

◆ m_Down

float mitk::ExtrudedContour::m_Down[3]
protected

Definition at line 107 of file mitkExtrudedContour.h.

◆ m_ExtrusionFilter

vtkLinearExtrusionFilter* mitk::ExtrudedContour::m_ExtrusionFilter
protected

Definition at line 116 of file mitkExtrudedContour.h.

◆ m_LastCalculateExtrusionTime

itk::TimeStamp mitk::ExtrudedContour::m_LastCalculateExtrusionTime
protected

Definition at line 123 of file mitkExtrudedContour.h.

◆ m_Normal

float mitk::ExtrudedContour::m_Normal[3]
protected

Definition at line 112 of file mitkExtrudedContour.h.

◆ m_Origin

float mitk::ExtrudedContour::m_Origin[3]
protected

Definition at line 114 of file mitkExtrudedContour.h.

◆ m_Polygon

vtkPolygon* mitk::ExtrudedContour::m_Polygon
protected

Definition at line 95 of file mitkExtrudedContour.h.

◆ m_ProjectedContourBounds

float mitk::ExtrudedContour::m_ProjectedContourBounds[6]
protected

Definition at line 100 of file mitkExtrudedContour.h.

◆ m_ProjectionPlane

mitk::PlaneGeometry::Pointer mitk::ExtrudedContour::m_ProjectionPlane
protected

Definition at line 103 of file mitkExtrudedContour.h.

◆ m_Right

float mitk::ExtrudedContour::m_Right[3]
protected

For fast projection on plane.

Definition at line 106 of file mitkExtrudedContour.h.

◆ m_RightVector

mitk::Vector3D mitk::ExtrudedContour::m_RightVector
protected

Definition at line 90 of file mitkExtrudedContour.h.

◆ m_SubdivisionFilter

vtkLinearSubdivisionFilter* mitk::ExtrudedContour::m_SubdivisionFilter
protected

Definition at line 119 of file mitkExtrudedContour.h.

◆ m_TriangleFilter

vtkTriangleFilter* mitk::ExtrudedContour::m_TriangleFilter
protected

Definition at line 117 of file mitkExtrudedContour.h.

◆ m_Vector

mitk::Vector3D mitk::ExtrudedContour::m_Vector
protected

Definition at line 89 of file mitkExtrudedContour.h.


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