mitk::Ellipsoid Class Reference

Bounding object shaped as an ellipsoid. More...

#include <mitkEllipsoid.h>

Inheritance diagram for mitk::Ellipsoid:

Collaboration diagram for mitk::Ellipsoid:

Public Member Functions
	mitkClassMacro (Ellipsoid, BoundingObject)
Pointer	Clone () const
mitk::ScalarType	GetVolume () override
	Calculate the ellipsoid volume from the geometry extents. More...
bool	IsInside (const Point3D &p) const override
	Test whether a world-coordinate point lies inside the ellipsoid. More...
Public Member Functions inherited from mitk::BoundingObject
	mitkClassMacro (BoundingObject, mitk::Surface)
virtual bool	GetPositive ()
	Get whether this bounding object defines a positive volume. More...
virtual void	SetPositive (bool _arg)
	Set whether this bounding object defines a positive volume. More...
virtual void	PositiveOn ()
	Toggle the Positive flag. More...
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
	mitkClassMacro (Surface, BaseData)
Pointer	Clone () const
void	CalculateBoundingBox ()
	Compute the bounding box from all vtkPolyData objects across time steps. More...
void	CopyInformation (const itk::DataObject *data) override
	Copy information (geometry, region) from another data object. More...
void	ExecuteOperation (Operation *operation) override
	Execute an operation on this surface (e.g., OpSURFACECHANGED). More...
void	Expand (unsigned int timeSteps=1) override
	Expand the data to the given number of time steps. More...
const RegionType &	GetLargestPossibleRegion () const
	Get the largest possible region. More...
virtual const RegionType &	GetRequestedRegion () const
	Get the requested region. More...
unsigned int	GetSizeOfPolyDataSeries () const
	Get the number of vtkPolyData objects in the time series. More...
virtual vtkPolyData *	GetVtkPolyData (unsigned int t=0) const
	Get the vtkPolyData at time step t. More...
void	Graft (const DataObject *data) override
	Graft data and information from another data object. More...
bool	IsEmptyTimeStep (unsigned int t) const override
	Check whether time step t is empty (has no vtkPolyData). More...
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
	Print the surface information to the output stream. More...
bool	RequestedRegionIsOutsideOfTheBufferedRegion () override
	Determine whether the requested region is outside the buffered region. More...
void	SetRequestedRegion (const itk::DataObject *data) override
	Set the requested region to match another data object's requested region. More...
virtual void	SetRequestedRegion (Surface::RegionType *region)
	Set the requested region from a RegionType pointer. More...
void	SetRequestedRegionToLargestPossibleRegion () override
	Set the requested region to the largest possible region. More...
virtual void	SetVtkPolyData (vtkPolyData *polydata, unsigned int t=0)
	Set the vtkPolyData for time step t. More...
virtual void	Swap (Surface &other)
	Swap the contents of this surface with another surface. More...
void	Update () override
	Trigger an update of all vtkPolyData objects in the pipeline. More...
void	UpdateOutputInformation () override
	Update the output information (bounding box, geometry). More...
bool	VerifyRequestedRegion () override
	Verify that the requested region is within the largest possible region. 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...
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	IsEmpty () const
	Check whether the object contains data at any time step. 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 ()
Static Public Member Functions inherited from mitk::Surface
static Pointer	New ()

Protected Member Functions
	Ellipsoid ()
	~Ellipsoid () override
Protected Member Functions inherited from mitk::BoundingObject
	BoundingObject ()
	~BoundingObject () override
Protected Member Functions inherited from mitk::Surface
	mitkCloneMacro (Self)
	Surface ()
	~Surface () override
	Surface (const Surface &other)
Surface &	operator= (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)

Additional Inherited Members
Public Types inherited from mitk::Surface
typedef itk::ImageRegion< 5 >	RegionType
	Region type used for pipeline region negotiation (5-dimensional). More...
Public Types inherited from mitk::Identifiable
using	UIDType = std::string
	Type alias for unique identifiers. More...
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

Detailed Description

Bounding object shaped as an ellipsoid.

The ellipsoid has unit radius in all axes in object coordinates and is centered at the origin. Its surface is generated by vtkSphereSource. Volume is calculated as (4/3) * pi * rx * ry * rz from the geometry extents.

See also

BoundingObject, Cone, Cuboid, Cylinder

Definition at line 31 of file mitkEllipsoid.h.

Constructor & Destructor Documentation

Ellipsoid()

mitk::Ellipsoid::Ellipsoid ( )

protected

~Ellipsoid()

mitk::Ellipsoid::~Ellipsoid ( )

overrideprotected

Member Function Documentation

Clone()

Pointer mitk::Ellipsoid::Clone

(

)

const

GetVolume()

mitk::ScalarType mitk::Ellipsoid::GetVolume ( )

overridevirtual

Calculate the ellipsoid volume from the geometry extents.

Returns

The volume in world-coordinate units cubed.

Reimplemented from mitk::BoundingObject.

IsInside()

bool mitk::Ellipsoid::IsInside ( const Point3D &  p ) const

overridevirtual

Test whether a world-coordinate point lies inside the ellipsoid.

The point is transformed to object coordinates and checked against the unit sphere equation x^2 + y^2 + z^2 <= 1.

Parameters

[in]

p

The point in world coordinates.

Returns

true if the point is inside.

Implements mitk::BoundingObject.

mitkClassMacro()

mitk::Ellipsoid::mitkClassMacro	(	Ellipsoid	,
		BoundingObject
	)

New()

static Pointer mitk::Ellipsoid::New ( )

static

---

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

• mitkEllipsoid.h