CustusX  2023.01.05-dev+develop.0da12
An IGT application
cx::CustomMetric Class Reference

Data class that represents a custom. More...

#include <cxCustomMetric.h>

Inheritance diagram for cx::CustomMetric:
cx::DataMetric cx::Data

Public Member Functions

virtual ~CustomMetric ()
 
virtual bool isValid () const
 
virtual QIcon getIcon ()
 
QString getDefineVectorUpMethod () const
 
void setDefineVectorUpMethod (QString defineVectorUpMethod)
 
void setModelUid (QString val)
 
QString getModelUid () const
 
DataPtr getModel () const
 
void setScaleToP1 (bool val)
 
bool getScaleToP1 () const
 
void setOffsetFromP0 (double val)
 
double getOffsetFromP0 () const
 
void setOffsetFromP1 (double val)
 
double getOffsetFromP1 () const
 
void setRepeatDistance (double val)
 
double getRepeatDistance () const
 
void setTranslationOnly (bool val)
 
bool getTranslationOnly () const
 
void setTextureFollowTool (bool val)
 
bool getTextureFollowTool () const
 
MetricReferenceArgumentListPtr getArguments ()
 
virtual void addXml (QDomNode &dataNode)
 adds xml information about the data and its variabels More...
 
virtual void parseXml (QDomNode &dataNode)
 Use a XML node to load data. More...
 
virtual DoubleBoundingBox3D boundingBox () const
 
virtual Vector3D getRefCoord () const
 
virtual QString getType () const
 
virtual QString getValueAsString () const
 
virtual bool showValueInGraphics () const
 
CustomMetric::DefineVectorUpMethods getDefineVectorUpMethods () const
 
std::vector< Transform3DcalculateOrientations () const
 
int getRepeatCount () const
 
std::vector< Vector3DgetPointCloud () const
 
bool modelIsImage () const
 
void setShowDistanceMarkers (bool show)
 
bool getShowDistanceMarkers () const
 
Vector3D getZeroPosition () const
 
void setDistanceMarkerVisibility (double val)
 
double getDistanceMarkerVisibility () const
 
void updateTexture (MeshPtr model, Transform3D rMrr)
 
- Public Member Functions inherited from cx::DataMetric
 DataMetric (const QString &uid, const QString &name, PatientModelServicePtr dataManager, SpaceProviderPtr spaceProvider)
 
virtual ~DataMetric ()
 
virtual QString getSpace ()
 
virtual Transform3D getRefFrame () const
 
void setColor (const QColor &color)
 
QColor getColor ()
 
void addXml (QDomNode &dataNode)
 adds xml information about the data and its variabels More...
 
void parseXml (QDomNode &dataNode)
 Use a XML node to load data. More...
 
virtual bool load (QString path, FileManagerServicePtr filemanager)
 metrics don't store info in file, xml only. More...
 
virtual void save (const QString &basePath, FileManagerServicePtr filemanager)
 metrics don't store info in file, xml only. More...
 
- Public Member Functions inherited from cx::Data
 Data (const QString &uid, const QString &name="")
 
virtual ~Data ()
 
void setUid (const QString &uid)
 
void setName (const QString &name)
 
void setAcquisitionTime (QDateTime time)
 
void setSoftwareAcquisitionTime (QDateTime time)
 
void setOriginalAcquisitionTime (QDateTime time)
 
virtual RegistrationHistoryPtr get_rMd_History ()
 
LandmarksPtr getLandmarks ()
 
virtual QString getUid () const
 
virtual QString getName () const
 
virtual Transform3D get_rMd () const
 
virtual QDateTime getAcquisitionTime () const
 
virtual TimeInfo getAdvancedTimeInfo () const
 
virtual bool isEqual (DataPtr metric)
 
virtual QString getFilename () const
 
virtual void setFilename (QString val)
 
virtual QString getParentSpace ()
 
virtual CoordinateSystem getCoordinateSystem ()
 
virtual void addPersistentClipPlane (vtkPlanePtr plane)
 
virtual std::vector< vtkPlanePtrgetAllClipPlanes ()
 
virtual void clearPersistentClipPlanes ()
 
virtual void setInteractiveClipPlane (vtkPlanePtr plane)
 set a plane that is not saved More...
 
void addInteractiveClipPlane (vtkPlanePtr plane)
 
void removeInteractiveClipPlane (vtkPlanePtr plane)
 

Static Public Member Functions

static CustomMetricPtr create (QString uid, QString name, PatientModelServicePtr dataManager, SpaceProviderPtr spaceProvider)
 
static QString getTypeName ()
 

Additional Inherited Members

- Signals inherited from cx::Data
void transformChanged ()
 emitted when transform is changed More...
 
void propertiesChanged ()
 emitted when one of the metadata properties (uid, name etc) changes More...
 
void clipPlanesChanged ()
 
- Protected Slots inherited from cx::Data
virtual void transformChangedSlot ()
 
- Protected Attributes inherited from cx::DataMetric
PatientModelServicePtr mDataManager
 
SpaceProviderPtr mSpaceProvider
 
QColor mColor
 
- Protected Attributes inherited from cx::Data
QString mUid
 
QString mName
 
QString mFilename
 
TimeInfo mTimeInfo
 
LandmarksPtr mLandmarks
 
REGISTRATION_STATUS mRegistrationStatus
 
RegistrationHistoryPtr m_rMd_History
 
std::vector< vtkPlanePtrmPersistentClipPlanes
 
std::vector< vtkPlanePtrmInteractiveClipPlanes
 
vtkPlanePtr mInteractiveClipPlane
 

Detailed Description

Data class that represents a custom.

The custom can be used as a targeting device, for example using needle injection. Use a point metric and a custom metric in a line, and target by visually placing the point inside the custom to aim along the line.

Date
2014-02-11
Author
Christian Askeland, SINTEF

Definition at line 40 of file cxCustomMetric.h.

Constructor & Destructor Documentation

cx::CustomMetric::~CustomMetric ( )
virtual

Definition at line 93 of file cxCustomMetric.cpp.

Member Function Documentation

void cx::CustomMetric::addXml ( QDomNode &  dataNode)
virtual

adds xml information about the data and its variabels

Reimplemented from cx::Data.

Definition at line 97 of file cxCustomMetric.cpp.

DoubleBoundingBox3D cx::CustomMetric::boundingBox ( ) const
virtual

Implements cx::Data.

Definition at line 148 of file cxCustomMetric.cpp.

std::vector< Transform3D > cx::CustomMetric::calculateOrientations ( ) const

Definition at line 493 of file cxCustomMetric.cpp.

CustomMetricPtr cx::CustomMetric::create ( QString  uid,
QString  name,
PatientModelServicePtr  dataManager,
SpaceProviderPtr  spaceProvider 
)
static

Definition at line 88 of file cxCustomMetric.cpp.

MetricReferenceArgumentListPtr cx::CustomMetric::getArguments ( )
inline

Definition at line 69 of file cxCustomMetric.h.

QString cx::CustomMetric::getDefineVectorUpMethod ( ) const

Definition at line 345 of file cxCustomMetric.cpp.

CustomMetric::DefineVectorUpMethods cx::CustomMetric::getDefineVectorUpMethods ( ) const

Definition at line 82 of file cxCustomMetric.cpp.

double cx::CustomMetric::getDistanceMarkerVisibility ( ) const

Definition at line 451 of file cxCustomMetric.cpp.

virtual QIcon cx::CustomMetric::getIcon ( )
inlinevirtual

Reimplemented from cx::DataMetric.

Definition at line 48 of file cxCustomMetric.h.

DataPtr cx::CustomMetric::getModel ( ) const

Definition at line 366 of file cxCustomMetric.cpp.

QString cx::CustomMetric::getModelUid ( ) const

Definition at line 361 of file cxCustomMetric.cpp.

double cx::CustomMetric::getOffsetFromP0 ( ) const

Definition at line 392 of file cxCustomMetric.cpp.

double cx::CustomMetric::getOffsetFromP1 ( ) const

Definition at line 405 of file cxCustomMetric.cpp.

std::vector< Vector3D > cx::CustomMetric::getPointCloud ( ) const
virtual

Reimplemented from cx::Data.

Definition at line 153 of file cxCustomMetric.cpp.

Vector3D cx::CustomMetric::getRefCoord ( ) const
virtual

Implements cx::DataMetric.

Definition at line 143 of file cxCustomMetric.cpp.

int cx::CustomMetric::getRepeatCount ( ) const

Definition at line 228 of file cxCustomMetric.cpp.

double cx::CustomMetric::getRepeatDistance ( ) const

Definition at line 418 of file cxCustomMetric.cpp.

bool cx::CustomMetric::getScaleToP1 ( ) const

Definition at line 379 of file cxCustomMetric.cpp.

bool cx::CustomMetric::getShowDistanceMarkers ( ) const

Definition at line 431 of file cxCustomMetric.cpp.

bool cx::CustomMetric::getTextureFollowTool ( ) const

Definition at line 469 of file cxCustomMetric.cpp.

bool cx::CustomMetric::getTranslationOnly ( ) const

Definition at line 456 of file cxCustomMetric.cpp.

virtual QString cx::CustomMetric::getType ( ) const
inlinevirtual

Reimplemented from cx::Data.

Definition at line 74 of file cxCustomMetric.h.

static QString cx::CustomMetric::getTypeName ( )
inlinestatic

Definition at line 78 of file cxCustomMetric.h.

virtual QString cx::CustomMetric::getValueAsString ( ) const
inlinevirtual

Implements cx::DataMetric.

Definition at line 82 of file cxCustomMetric.h.

Vector3D cx::CustomMetric::getZeroPosition ( ) const

Definition at line 188 of file cxCustomMetric.cpp.

bool cx::CustomMetric::isValid ( ) const
virtual

Reimplemented from cx::DataMetric.

Definition at line 138 of file cxCustomMetric.cpp.

bool cx::CustomMetric::modelIsImage ( ) const

Definition at line 549 of file cxCustomMetric.cpp.

void cx::CustomMetric::parseXml ( QDomNode &  dataNode)
virtual

Use a XML node to load data.

Parameters
dataNodeA XML data representation of this object.

Reimplemented from cx::Data.

Definition at line 117 of file cxCustomMetric.cpp.

void cx::CustomMetric::setDefineVectorUpMethod ( QString  defineVectorUpMethod)

Definition at line 350 of file cxCustomMetric.cpp.

void cx::CustomMetric::setDistanceMarkerVisibility ( double  val)

Definition at line 443 of file cxCustomMetric.cpp.

void cx::CustomMetric::setModelUid ( QString  val)

Definition at line 355 of file cxCustomMetric.cpp.

void cx::CustomMetric::setOffsetFromP0 ( double  val)

Definition at line 384 of file cxCustomMetric.cpp.

void cx::CustomMetric::setOffsetFromP1 ( double  val)

Definition at line 397 of file cxCustomMetric.cpp.

void cx::CustomMetric::setRepeatDistance ( double  val)

Definition at line 410 of file cxCustomMetric.cpp.

void cx::CustomMetric::setScaleToP1 ( bool  val)

Definition at line 371 of file cxCustomMetric.cpp.

void cx::CustomMetric::setShowDistanceMarkers ( bool  show)

Definition at line 423 of file cxCustomMetric.cpp.

void cx::CustomMetric::setTextureFollowTool ( bool  val)

Definition at line 461 of file cxCustomMetric.cpp.

void cx::CustomMetric::setTranslationOnly ( bool  val)

Definition at line 435 of file cxCustomMetric.cpp.

virtual bool cx::CustomMetric::showValueInGraphics ( ) const
inlinevirtual

Reimplemented from cx::DataMetric.

Definition at line 83 of file cxCustomMetric.h.

void cx::CustomMetric::updateTexture ( MeshPtr  model,
Transform3D  rMrr 
)

Definition at line 285 of file cxCustomMetric.cpp.


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