|
| mitkClassMacro (ROI, BaseData) static Pointer New() |
|
Pointer | Clone () const |
|
size_t | GetNumberOfElements () const |
|
void | AddElement (const Element &element) |
| Add a ROI::Element to the collection. More...
|
|
const Element & | GetElement (unsigned int id) const |
|
Element & | GetElement (unsigned int id) |
|
ConstIterator | begin () const |
|
ConstIterator | end () const |
|
Iterator | begin () |
|
Iterator | end () |
|
void | SetRequestedRegionToLargestPossibleRegion () override |
| Set the RequestedRegion to the LargestPossibleRegion. More...
|
|
bool | RequestedRegionIsOutsideOfTheBufferedRegion () override |
| Determine whether the RequestedRegion is outside of the BufferedRegion. More...
|
|
bool | VerifyRequestedRegion () override |
| Verify that the RequestedRegion is within the LargestPossibleRegion. 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 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...
|
|
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...
|
|
mitk::TimeGeometry * | GetTimeGeometry () |
| Return the TimeGeometry of the data as pointer. More...
|
|
const mitk::TimeGeometry * | GetUpdatedTimeGeometry () |
| Return the TimeGeometry of the data. More...
|
|
virtual void | Expand (unsigned int timeSteps) |
| Expands the TimeGeometry to a number of TimeSteps. 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 | 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::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...
|
|
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 |
|
| itkTypeMacroNoParent (OperationActor) virtual ~OperationActor() |
|
| Identifiable () |
|
| Identifiable (const UIDType &uid) |
|
| Identifiable (const Identifiable &)=delete |
|
| Identifiable (Identifiable &&) noexcept |
|
virtual | ~Identifiable () |
|
Identifiable & | operator= (const Identifiable &)=delete |
|
Identifiable & | operator= (Identifiable &&other) noexcept |
|
virtual UIDType | GetUID () const |
| Get unique ID of an object. More...
|
|
| ~IPropertyOwner () override |
|
virtual | ~IPropertyProvider () |
|
A collection of region of interests (ROIs).
- Note
- This class is considered experimental and subject to substational change. We mean it.
ROIs, essentially defined by the minimum and maximum index coordinates of an axis-aligned box, are represented by the nested ROI::Element class. These index coordinates are relative to a common TimeGeometry.
All ROIs are required to have a unique ID by which they can be accessed.
ROIs can optionally have properties (PropertyList), also called default properties. In case of time-resolved ROIs, each time step can optionally have properties, too. These properties have precedence over the default properties. In other words, the default properties may contain fallback properties which are queried when a property is not defined at a certain time step. This allows for an opt-in dynamic appearance of ROIs over time, for example by changing color or opacity.
ROIs are rendered both in 3-d and 2-d views as cubes, resp. cutting slices of these cubes. They support the following ROI::Element properties:
ROIs display a customizable caption at their bottom-left corner. It is defined by the base data property caption
(StringProperty). By default it is set to "{name} ({ID})"
. Braces are used to define placeholders which are replaced by their corresponding ROI::Element properties. {ID}
is a special placeholder which will be replaced by the ID of the ROI::Element instead. The caption is allowed to include line breaks. Rendering of captions can be customized through the following data node properties:
See MITK ROI for details on the JSON-based MITK ROI file format.
Definition at line 58 of file mitkROI.h.