Fraxinus  17.12-rc2
An IGT application
cxRegionOfInterestMetric.h
Go to the documentation of this file.
1 /*=========================================================================
2 This file is part of CustusX, an Image Guided Therapy Application.
3 
4 Copyright (c) 2008-2014, SINTEF Department of Medical Technology
5 All rights reserved.
6 
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
9 
10 1. Redistributions of source code must retain the above copyright notice,
11  this list of conditions and the following disclaimer.
12 
13 2. Redistributions in binary form must reproduce the above copyright notice,
14  this list of conditions and the following disclaimer in the documentation
15  and/or other materials provided with the distribution.
16 
17 3. Neither the name of the copyright holder nor the names of its contributors
18  may be used to endorse or promote products derived from this software
19  without specific prior written permission.
20 
21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 =========================================================================*/
32 
33 #ifndef CXREGIONOFINTERESTMETRIC_H
34 #define CXREGIONOFINTERESTMETRIC_H
35 
36 #include "cxResourceExport.h"
37 #include "cxPrecompiledHeader.h"
38 
39 #include "cxDataMetric.h"
41 #include "cxOptionalValue.h"
42 
43 namespace cx
44 {
59 class cxResource_EXPORT RegionOfInterest
60 {
61 public:
63  bool isValid() const { return !mPoints.empty(); }
68  DoubleBoundingBox3D getBox(Transform3D qMd = Transform3D::Identity());
69 
70  double mMargin;
71  std::vector<Vector3D> mPoints;
72  std::vector<Vector3D> mMaxBoundsPoints;
73 
74 private:
75  DoubleBoundingBox3D generateROIFromPointsAndMargin(const std::vector<Vector3D> &points, double margin) const;
76  std::vector<Vector3D> transform(const std::vector<Vector3D> &points, Transform3D M) const;
77 };
78 
79 typedef boost::shared_ptr<class RegionOfInterestMetric> RegionOfInterestMetricPtr;
80 
85 class cxResource_EXPORT RegionOfInterestMetric: public DataMetric
86 {
87 Q_OBJECT
88 public:
89  virtual ~RegionOfInterestMetric();
90  static RegionOfInterestMetricPtr create(QString uid, QString name, PatientModelServicePtr dataManager, SpaceProviderPtr spaceProvider);
91 
92  virtual Vector3D getRefCoord() const;
93  virtual QString getAsSingleLineString() const;
94 
95  virtual bool isValid() const;
96 
97  virtual void addXml(QDomNode& dataNode);
98  virtual void parseXml(QDomNode& dataNode);
99  virtual DoubleBoundingBox3D boundingBox() const;
100  virtual QString getType() const
101  {
102  return getTypeName();
103  }
104  static QString getTypeName()
105  {
106  return "roiMetric";
107  }
108 
109  virtual QString getValueAsString() const;
110  virtual bool showValueInGraphics() const { return false; }
111 
112  QStringList getDataList() { return mContainedData; }
113  void setDataList(QStringList val);
114 
115  bool getUseActiveTooltip() { return mUseActiveTooltip; }
116  void setUseActiveTooltip(bool val);
117 
118  double getMargin() { return mMargin; }
119  void setMargin(double val);
120 
121  QString getMaxBoundsData() { return mMaxBoundsData; }
122  void setMaxBoundsData(QString val);
123 
124  RegionOfInterest getROI() const; // return a ROI in ref space.
125 
126 private:
127  RegionOfInterestMetric(const QString& uid, const QString& name, PatientModelServicePtr dataManager, SpaceProviderPtr spaceProvider);
128 
129  QString mMaxBoundsData;
130  QStringList mContainedData;
131  bool mUseActiveTooltip;
132  double mMargin;
133 
134  std::vector<SpaceListenerPtr> mListeners;
135  void listenTo(CoordinateSystem space);
136  void onContentTransformsChanged();
137  void onContentChanged();
138  Vector3D getToolTip_r() const;
139 };
140 
144 }
145 
146 #endif // CXREGIONOFINTERESTMETRIC_H
boost::shared_ptr< class SpaceProvider > SpaceProviderPtr
DoubleBoundingBox3D transform(const Transform3D &m, const DoubleBoundingBox3D &bb)
virtual QString getType() const
virtual bool showValueInGraphics() const
Transform3D Transform3D
Transform3D is a representation of an affine 3D transform.
boost::shared_ptr< class PatientModelService > PatientModelServicePtr
Identification of a Coordinate system.
boost::shared_ptr< class RegionOfInterestMetric > RegionOfInterestMetricPtr
Representation of a floating-point bounding box in 3D. The data are stored as {xmin,xmax,ymin,ymax,zmin,zmax}, in order to simplify communication with vtk.
std::vector< Vector3D > mPoints
Eigen::Vector3d Vector3D
Vector3D is a representation of a point or vector in 3D.
Definition: cxVector3D.h:63
Base class for all Data Metrics.
Definition: cxDataMetric.h:64
std::vector< Vector3D > mMaxBoundsPoints
Namespace for all CustusX production code.