Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
Protected Attributes |
List of all members
mitk::Plane Class Reference
Plane surface representation. More...
#include <mitkPlane.h>
Inheritance diagram for mitk::Plane:
Collaboration diagram for mitk::Plane:
Public Member Functions | |
| mitkClassMacro (Plane, BoundingObject) | |
| Pointer | Clone () const |
| void | SetExtent (const double x, const double y) |
| void | GetExtent (double &x, double &y) const |
| void | SetResolution (const int xR, const int yR) |
| void | GetResolution (int &xR, int &yR) const |
| mitk::ScalarType | GetVolume () override |
| bool | IsInside (const Point3D &p) 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 RegionType & | GetLargestPossibleRegion () const |
| virtual const RegionType & | GetRequestedRegion () 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... | |
| BaseProperty * | GetNonConstProperty (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::TimeGeometry * | GetTimeGeometry () const |
| Return the TimeGeometry of the data as const pointer. More... | |
| const mitk::TimeGeometry * | GetTimeSlicedGeometry () const |
| Return the TimeGeometry of the data as const pointer. More... | |
| mitk::TimeGeometry * | GetTimeGeometry () |
| Return the TimeGeometry of the data as pointer. More... | |
| const mitk::TimeGeometry * | GetUpdatedTimeGeometry () |
| Return the TimeGeometry of the data. More... | |
| const mitk::TimeGeometry * | GetUpdatedTimeSliceGeometry () |
| Return the TimeGeometry of the data. More... | |
| const mitk::BaseGeometry * | GetUpdatedGeometry (int t=0) |
| Return the BaseGeometry of the data at time t. More... | |
| mitk::BaseGeometry * | GetGeometry (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::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 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 () |
| Identifiable & | operator= (const Identifiable &)=delete |
| Identifiable & | operator= (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::Surface | |
| static const char * | GetStaticNameOfClass () |
| static Pointer | New () |
| Static Public Member Functions inherited from mitk::BaseData | |
| static const char * | GetStaticNameOfClass () |
Protected Member Functions | |
| Plane () | |
| ~Plane () override | |
| 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) | |
| 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... | |
| 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... | |
| void | PrintSelf (std::ostream &os, itk::Indent indent) const override |
Protected Attributes | |
| vtkPlaneSource * | m_PlaneSource |
| vtkPolyData * | m_Plane |
| vtkDoubleArray * | m_PlaneNormal |
| 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< Self > | Pointer |
| typedef itk::SmartPointer< const Self > | ConstPointer |
| Public Types inherited from mitk::BaseData | |
| typedef BaseData | Self |
| typedef itk::DataObject | Superclass |
| typedef itk::SmartPointer< Self > | Pointer |
| typedef itk::SmartPointer< const Self > | ConstPointer |
| Public Types inherited from mitk::Identifiable | |
| using | UIDType = std::string |
Detailed Description
Plane surface representation.
Encapsulates vtkPlaneSource.
Definition at line 31 of file mitkPlane.h.
Constructor & Destructor Documentation
◆ Plane()
|
protected |
Definition at line 23 of file mitkPlane.cpp.
References m_Plane, m_PlaneNormal, m_PlaneSource, and mitk::Surface::SetVtkPolyData().
◆ ~Plane()
|
overrideprotected |
Definition at line 46 of file mitkPlane.cpp.
References m_Plane, m_PlaneNormal, and m_PlaneSource.
Member Function Documentation
◆ Clone()
| Pointer mitk::Plane::Clone | ( | ) | const |
◆ GetExtent()
| void mitk::Plane::GetExtent | ( | double & | x, |
| double & | y | ||
| ) | const |
Definition at line 66 of file mitkPlane.cpp.
References m_PlaneSource.
◆ GetResolution()
| void mitk::Plane::GetResolution | ( | int & | xR, |
| int & | yR | ||
| ) | const |
Definition at line 83 of file mitkPlane.cpp.
References m_PlaneSource.
◆ GetVolume()
|
overridevirtual |
Reimplemented from mitk::BoundingObject.
Definition at line 90 of file mitkPlane.cpp.
◆ IsInside()
|
overridevirtual |
Implements mitk::BoundingObject.
Definition at line 84 of file mitkPlane.cpp.
◆ mitkClassMacro()
| mitk::Plane::mitkClassMacro | ( | Plane | , |
| BoundingObject | |||
| ) |
◆ New()
|
static |
◆ SetExtent()
| void mitk::Plane::SetExtent | ( | const double | x, |
| const double | y | ||
| ) |
Definition at line 53 of file mitkPlane.cpp.
References m_Plane, m_PlaneNormal, and m_PlaneSource.
◆ SetResolution()
| void mitk::Plane::SetResolution | ( | const int | xR, |
| const int | yR | ||
| ) |
Definition at line 72 of file mitkPlane.cpp.
References m_Plane, m_PlaneNormal, and m_PlaneSource.
Member Data Documentation
◆ m_Plane
|
protected |
Definition at line 53 of file mitkPlane.h.
Referenced by Plane(), SetExtent(), SetResolution(), and ~Plane().
◆ m_PlaneNormal
|
protected |
Definition at line 55 of file mitkPlane.h.
Referenced by Plane(), SetExtent(), SetResolution(), and ~Plane().
◆ m_PlaneSource
|
protected |
Definition at line 51 of file mitkPlane.h.
Referenced by GetExtent(), GetResolution(), Plane(), SetExtent(), SetResolution(), and ~Plane().
The documentation for this class was generated from the following files:
