CustusX  2020.10.01-dev+develop.ab728
An IGT application
cx::Data Class Referenceabstract

Superclass for all data objects. More...

#include <cxData.h>

Inheritance diagram for cx::Data:
cx::DataMetric cx::Image cx::Mesh cx::TrackedStream cx::AngleMetric cx::CustomMetric cx::DistanceMetric cx::DonutMetric cx::FrameMetricBase cx::PlaneMetric cx::PointMetric cx::RegionOfInterestMetric cx::SphereMetric cx::NavigatedVideoImage cx::UnsignedDerivedImage

Signals

void transformChanged ()
 emitted when transform is changed More...
 
void propertiesChanged ()
 emitted when one of the metadata properties (uid, name etc) changes More...
 
void clipPlanesChanged ()
 

Public Member Functions

 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 QString getType () const
 
virtual QIcon getIcon ()
 
virtual bool isEqual (DataPtr metric)
 
virtual QString getFilename () const
 
virtual void setFilename (QString val)
 
virtual QString getSpace ()
 
virtual QString getParentSpace ()
 
virtual DoubleBoundingBox3D boundingBox () const =0
 
virtual std::vector< Vector3DgetPointCloud () const
 
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 bool load (QString path, FileManagerServicePtr port)=0
 
virtual void save (const QString &basePath, FileManagerServicePtr port)=0
 
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)
 

Protected Slots

virtual void transformChangedSlot ()
 

Protected Attributes

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

Superclass for all data objects.

Example suclasses: Image and Mesh.

Definition at line 89 of file cxData.h.

Constructor & Destructor Documentation

cx::Data::Data ( const QString &  uid,
const QString &  name = "" 
)

Definition at line 31 of file cxData.cpp.

cx::Data::~Data ( )
virtual

Definition at line 49 of file cxData.cpp.

Member Function Documentation

void cx::Data::addInteractiveClipPlane ( vtkPlanePtr  plane)

Definition at line 259 of file cxData.cpp.

void cx::Data::addPersistentClipPlane ( vtkPlanePtr  plane)
virtual

Definition at line 222 of file cxData.cpp.

void cx::Data::addXml ( QDomNode &  dataNode)
virtual
void cx::Data::clearPersistentClipPlanes ( )
virtual

Definition at line 247 of file cxData.cpp.

void cx::Data::clipPlanesChanged ( )
signal
Transform3D cx::Data::get_rMd ( ) const
virtual
Returns
a descriptive name for this instance
the transform M_rd from the data object's space (d) to the reference space (r).
Transform from local data space to (data-)ref space

Reimplemented in cx::UnsignedDerivedImage, and cx::NavigatedVideoImage.

Definition at line 86 of file cxData.cpp.

RegistrationHistoryPtr cx::Data::get_rMd_History ( )
virtual

Reimplemented in cx::UnsignedDerivedImage.

Definition at line 91 of file cxData.cpp.

QDateTime cx::Data::getAcquisitionTime ( ) const
virtual

Get the time the data was created from a data source.

Reimplemented in cx::UnsignedDerivedImage.

Definition at line 168 of file cxData.cpp.

TimeInfo cx::Data::getAdvancedTimeInfo ( ) const
virtual

Definition at line 184 of file cxData.cpp.

std::vector< vtkPlanePtr > cx::Data::getAllClipPlanes ( )
virtual

Definition at line 234 of file cxData.cpp.

CoordinateSystem cx::Data::getCoordinateSystem ( )
virtual

Reimplemented in cx::UnsignedDerivedImage.

Definition at line 215 of file cxData.cpp.

QString cx::Data::getFilename ( ) const
virtual

Reimplemented in cx::UnsignedDerivedImage.

Definition at line 74 of file cxData.cpp.

virtual QIcon cx::Data::getIcon ( )
inlinevirtual
LandmarksPtr cx::Data::getLandmarks ( )

Definition at line 209 of file cxData.cpp.

QString cx::Data::getName ( ) const
virtual

Reimplemented in cx::UnsignedDerivedImage.

Definition at line 69 of file cxData.cpp.

QString cx::Data::getParentSpace ( )
virtual

Reimplemented in cx::UnsignedDerivedImage, cx::FrameMetricBase, and cx::PointMetric.

Definition at line 101 of file cxData.cpp.

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

Reimplemented in cx::CustomMetric.

Definition at line 106 of file cxData.cpp.

QString cx::Data::getSpace ( )
virtual

Reimplemented in cx::UnsignedDerivedImage, and cx::DataMetric.

Definition at line 96 of file cxData.cpp.

QString cx::Data::getUid ( ) const
virtual
Returns
unique id for this instance

Definition at line 64 of file cxData.cpp.

bool cx::Data::isEqual ( DataPtr  metric)
virtual

Definition at line 189 of file cxData.cpp.

virtual bool cx::Data::load ( QString  path,
FileManagerServicePtr  port 
)
pure virtual
void cx::Data::parseXml ( QDomNode &  dataNode)
virtual

Use a XML node to load data.

Parameters
dataNodeA XML data representation of this object.

Reimplemented in cx::Image, cx::RegionOfInterestMetric, cx::PlaneMetric, cx::CustomMetric, cx::PointMetric, cx::DonutMetric, cx::DistanceMetric, cx::DataMetric, cx::Mesh, cx::AngleMetric, cx::ToolMetric, cx::SphereMetric, cx::FrameMetric, and cx::TrackedStream.

Definition at line 149 of file cxData.cpp.

void cx::Data::propertiesChanged ( )
signal

emitted when one of the metadata properties (uid, name etc) changes

void cx::Data::removeInteractiveClipPlane ( vtkPlanePtr  plane)

Definition at line 264 of file cxData.cpp.

virtual void cx::Data::save ( const QString &  basePath,
FileManagerServicePtr  port 
)
pure virtual
void cx::Data::setAcquisitionTime ( QDateTime  time)

Definition at line 194 of file cxData.cpp.

void cx::Data::setFilename ( QString  val)
virtual

Definition at line 78 of file cxData.cpp.

void cx::Data::setInteractiveClipPlane ( vtkPlanePtr  plane)
virtual

set a plane that is not saved

Definition at line 253 of file cxData.cpp.

void cx::Data::setName ( const QString &  name)

Definition at line 58 of file cxData.cpp.

void cx::Data::setOriginalAcquisitionTime ( QDateTime  time)

Definition at line 204 of file cxData.cpp.

void cx::Data::setSoftwareAcquisitionTime ( QDateTime  time)

Definition at line 199 of file cxData.cpp.

void cx::Data::setUid ( const QString &  uid)

Definition at line 52 of file cxData.cpp.

void cx::Data::transformChanged ( )
signal

emitted when transform is changed

virtual void cx::Data::transformChangedSlot ( )
inlineprotectedvirtualslot

Definition at line 148 of file cxData.h.

Member Data Documentation

RegistrationHistoryPtr cx::Data::m_rMd_History
protected

Definition at line 160 of file cxData.h.

QString cx::Data::mFilename
protected

Definition at line 155 of file cxData.h.

vtkPlanePtr cx::Data::mInteractiveClipPlane
protected

Definition at line 163 of file cxData.h.

std::vector<vtkPlanePtr> cx::Data::mInteractiveClipPlanes
protected

Definition at line 162 of file cxData.h.

LandmarksPtr cx::Data::mLandmarks
protected

Definition at line 157 of file cxData.h.

QString cx::Data::mName
protected

Definition at line 154 of file cxData.h.

std::vector<vtkPlanePtr> cx::Data::mPersistentClipPlanes
protected

Definition at line 161 of file cxData.h.

REGISTRATION_STATUS cx::Data::mRegistrationStatus
protected

Definition at line 159 of file cxData.h.

TimeInfo cx::Data::mTimeInfo
protected

Definition at line 156 of file cxData.h.

QString cx::Data::mUid
protected

Definition at line 153 of file cxData.h.


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