NorMIT-nav  2023.01.05-dev+develop.0da12
An IGT application
Public Slots | Signals | Public Member Functions | Static Public Member Functions | List of all members
cx::UsReconstructionService Class Referenceabstract
CustusX System » Plugins » Org_custusx_usreconstruction

#include <cxUsReconstructionService.h>

Inheritance diagram for cx::UsReconstructionService:
cx::UsReconstructionImplService cx::UsReconstructionServiceNull cx::UsReconstructionServiceProxy

Public Slots

virtual void newDataOnDisk (QString mhdFilename)=0
 

Signals

void paramsChanged ()
 
void algorithmChanged ()
 
void inputDataSelected (QString mhdFileName)
 
void reconstructAboutToStart ()
 
void reconstructStarted ()
 
void reconstructFinished ()
 
void newInputDataAvailable (QString mhdFileName)
 
void newInputDataPath (QString path)
 

Public Member Functions

virtual void selectData (QString filename, QString calFilesPath="")=0
 Set input data for reconstruction. More...
 
virtual void selectData (USReconstructInputData data)=0
 Set input data for reconstruction. More...
 
virtual QString getSelectedFilename () const =0
 Get the currently selected filename. More...
 
virtual USReconstructInputData getSelectedFileData ()=0
 Return the currently selected input data. More...
 
virtual PropertyPtr getParam (QString uid)=0
 Return one of the standard parameters. More...
 
virtual std::vector< PropertyPtr > getAlgoOptions ()=0
 Return control parameters for the currently selected algorithm, adjustable like getParams() More...
 
virtual XmlOptionFile getSettings ()=0
 Return the settings xml file where parameters are stored. More...
 
virtual OutputVolumeParams getOutputVolumeParams () const =0
 Return params controlling the output data. These are data-dependent. More...
 
virtual void setOutputVolumeParams (const OutputVolumeParams &par)=0
 Control the output volume. More...
 
virtual void startReconstruction ()=0
 
virtual std::set< cx::TimedAlgorithmPtr > getThreadedReconstruction ()=0
 Return the currently reconstructing thread object(s). More...
 
virtual ReconstructionMethodService * createAlgorithm ()=0
 
virtual ReconstructCore::InputParams createCoreParameters ()=0
 
virtual bool isNull ()=0
 

Static Public Member Functions

static UsReconstructionServicePtr getNullObject ()
 

Detailed Description

Definition at line 50 of file cxUsReconstructionService.h.

Member Function Documentation

◆ algorithmChanged

void cx::UsReconstructionService::algorithmChanged ( )
signal

◆ createAlgorithm()

virtual ReconstructionMethodService* cx::UsReconstructionService::createAlgorithm ( )
pure virtual

Create the reconstruct algorithm object. This is usually created internally during reconstruction, published for use in unit testing.

Implemented in cx::UsReconstructionImplService, cx::UsReconstructionServiceProxy, and cx::UsReconstructionServiceNull.

◆ createCoreParameters()

virtual ReconstructCore::InputParams cx::UsReconstructionService::createCoreParameters ( )
pure virtual

Implemented in cx::UsReconstructionImplService, cx::UsReconstructionServiceProxy, and cx::UsReconstructionServiceNull.

◆ getAlgoOptions()

virtual std::vector<PropertyPtr> cx::UsReconstructionService::getAlgoOptions ( )
pure virtual

Return control parameters for the currently selected algorithm, adjustable like getParams()

Implemented in cx::UsReconstructionImplService, cx::UsReconstructionServiceProxy, and cx::UsReconstructionServiceNull.

◆ getNullObject()

UsReconstructionServicePtr cx::UsReconstructionService::getNullObject ( )
static

Definition at line 19 of file cxUsReconstructionService.cpp.

◆ getOutputVolumeParams()

virtual OutputVolumeParams cx::UsReconstructionService::getOutputVolumeParams ( ) const
pure virtual

Return params controlling the output data. These are data-dependent.

Implemented in cx::UsReconstructionImplService, cx::UsReconstructionServiceProxy, and cx::UsReconstructionServiceNull.

◆ getParam()

virtual PropertyPtr cx::UsReconstructionService::getParam ( QString  uid)
pure virtual

Return one of the standard parameters.

Implemented in cx::UsReconstructionImplService, cx::UsReconstructionServiceProxy, and cx::UsReconstructionServiceNull.

◆ getSelectedFileData()

virtual USReconstructInputData cx::UsReconstructionService::getSelectedFileData ( )
pure virtual

Return the currently selected input data.

Implemented in cx::UsReconstructionImplService, cx::UsReconstructionServiceProxy, and cx::UsReconstructionServiceNull.

◆ getSelectedFilename()

virtual QString cx::UsReconstructionService::getSelectedFilename ( ) const
pure virtual

Get the currently selected filename.

Implemented in cx::UsReconstructionImplService, cx::UsReconstructionServiceProxy, and cx::UsReconstructionServiceNull.

◆ getSettings()

virtual XmlOptionFile cx::UsReconstructionService::getSettings ( )
pure virtual

Return the settings xml file where parameters are stored.

Implemented in cx::UsReconstructionImplService, cx::UsReconstructionServiceProxy, and cx::UsReconstructionServiceNull.

◆ getThreadedReconstruction()

virtual std::set<cx::TimedAlgorithmPtr> cx::UsReconstructionService::getThreadedReconstruction ( )
pure virtual

Return the currently reconstructing thread object(s).

Implemented in cx::UsReconstructionImplService, cx::UsReconstructionServiceProxy, and cx::UsReconstructionServiceNull.

◆ inputDataSelected

void cx::UsReconstructionService::inputDataSelected ( QString  mhdFileName)
signal

◆ isNull()

virtual bool cx::UsReconstructionService::isNull ( )
pure virtual

Implemented in cx::UsReconstructionImplService, cx::UsReconstructionServiceProxy, and cx::UsReconstructionServiceNull.

◆ newDataOnDisk

virtual void cx::UsReconstructionService::newDataOnDisk ( QString  mhdFilename)
pure virtualslot

◆ newInputDataAvailable

void cx::UsReconstructionService::newInputDataAvailable ( QString  mhdFileName)
signal

◆ newInputDataPath

void cx::UsReconstructionService::newInputDataPath ( QString  path)
signal

◆ paramsChanged

void cx::UsReconstructionService::paramsChanged ( )
signal

◆ reconstructAboutToStart

void cx::UsReconstructionService::reconstructAboutToStart ( )
signal

◆ reconstructFinished

void cx::UsReconstructionService::reconstructFinished ( )
signal

◆ reconstructStarted

void cx::UsReconstructionService::reconstructStarted ( )
signal

◆ selectData() [1/2]

virtual void cx::UsReconstructionService::selectData ( QString  filename,
QString  calFilesPath = "" 
)
pure virtual

Set input data for reconstruction.

Implemented in cx::UsReconstructionImplService, cx::UsReconstructionServiceProxy, and cx::UsReconstructionServiceNull.

◆ selectData() [2/2]

virtual void cx::UsReconstructionService::selectData ( USReconstructInputData  data)
pure virtual

Set input data for reconstruction.

Implemented in cx::UsReconstructionImplService, cx::UsReconstructionServiceProxy, and cx::UsReconstructionServiceNull.

◆ setOutputVolumeParams()

virtual void cx::UsReconstructionService::setOutputVolumeParams ( const OutputVolumeParams &  par)
pure virtual

Control the output volume.

Implemented in cx::UsReconstructionImplService, cx::UsReconstructionServiceProxy, and cx::UsReconstructionServiceNull.

◆ startReconstruction()

virtual void cx::UsReconstructionService::startReconstruction ( )
pure virtual

Execute the reconstruction in another thread.

The returned cores can be used to retrieve output, but this must be done AFTER the threads have completed. In general, dont use the retval, it is for unit testing.

Implemented in cx::UsReconstructionImplService, cx::UsReconstructionServiceProxy, and cx::UsReconstructionServiceNull.

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