Medical Imaging Interaction Toolkit  2022.04.99-b2814023
Medical Imaging Interaction Toolkit
mitk::DICOMweb Class Reference

#include <mitkDICOMweb.h>

Public Types

typedef web::http::uri_builder MitkUriBuilder
 
typedef web::http::http_request MitkRequest
 
typedef web::http::http_response MitkResponse
 
typedef web::http::methods MitkRESTMethods
 

Public Member Functions

 DICOMweb ()
 
 DICOMweb (utility::string_t baseURI)
 Creates a DICOMweb service instance which allow basic DICOM operations on the given base URI. More...
 
pplx::task< void > SendSTOW (utility::string_t filePath, utility::string_t studyUID)
 Sends a STOW request with the file in the given path to the study given bei its UID. More...
 
pplx::task< void > SendWADO (utility::string_t filePath, utility::string_t studyUID, utility::string_t seriesUID, utility::string_t instanceUID)
 Sends a WADO request for an DICOM object instance matching the given uid parameters and stores it at the given file path. More...
 
pplx::task< std::string > SendWADO (utility::string_t folderPath, utility::string_t studyUID, utility::string_t seriesUID)
 Sends a WADO request for an DICOM object series matching the given uid parameters and stores all the containing instances at the given folder path. More...
 
pplx::task< web::json::value > SendQIDO (mitk::RESTUtil::ParamMap map)
 Sends a QIDO request containing the given parameters to filter the query. More...
 

Detailed Description

Definition at line 39 of file mitkDICOMweb.h.

Member Typedef Documentation

◆ MitkRequest

typedef web::http::http_request mitk::DICOMweb::MitkRequest

Definition at line 43 of file mitkDICOMweb.h.

◆ MitkResponse

typedef web::http::http_response mitk::DICOMweb::MitkResponse

Definition at line 44 of file mitkDICOMweb.h.

◆ MitkRESTMethods

typedef web::http::methods mitk::DICOMweb::MitkRESTMethods

Definition at line 45 of file mitkDICOMweb.h.

◆ MitkUriBuilder

typedef web::http::uri_builder mitk::DICOMweb::MitkUriBuilder

Definition at line 42 of file mitkDICOMweb.h.

Constructor & Destructor Documentation

◆ DICOMweb() [1/2]

mitk::DICOMweb::DICOMweb ( )

◆ DICOMweb() [2/2]

mitk::DICOMweb::DICOMweb ( utility::string_t  baseURI)

Creates a DICOMweb service instance which allow basic DICOM operations on the given base URI.

Parameters
baseURIthe uri for the PACS server: for example a dcm4chee http://<ip:port>/dcm4chee-arc/aets/DCM4CHEE/

Member Function Documentation

◆ SendQIDO()

pplx::task<web::json::value> mitk::DICOMweb::SendQIDO ( mitk::RESTUtil::ParamMap  map)

Sends a QIDO request containing the given parameters to filter the query.

Example Map: mitk::RESTUtil::ParamMap seriesInstancesParams; seriesInstancesParams.insert(mitk::RESTUtil::ParamMap::value_type(U("limit"), U("1")));

Parameters
mapthe map of parameters to filter the query
Returns
the task to wait for, which unfolds the result JSON response for the request when finished

◆ SendSTOW()

pplx::task<void> mitk::DICOMweb::SendSTOW ( utility::string_t  filePath,
utility::string_t  studyUID 
)

Sends a STOW request with the file in the given path to the study given bei its UID.

Parameters
filePaththe path to a valid DICOM file which should be send
studyUIDthe DICOM study uid
Returns
the task to wait for

◆ SendWADO() [1/2]

pplx::task<void> mitk::DICOMweb::SendWADO ( utility::string_t  filePath,
utility::string_t  studyUID,
utility::string_t  seriesUID,
utility::string_t  instanceUID 
)

Sends a WADO request for an DICOM object instance matching the given uid parameters and stores it at the given file path.

Parameters
filePaththe path at which the retrieved DICOM object instance will be stored
studyUIDthe DICOM study uid
seriesUIDthe DICOM series uid
instanceUIDthe DICOM instance uid
Returns
the task to wait for, which unfolds no value when finished

◆ SendWADO() [2/2]

pplx::task<std::string> mitk::DICOMweb::SendWADO ( utility::string_t  folderPath,
utility::string_t  studyUID,
utility::string_t  seriesUID 
)

Sends a WADO request for an DICOM object series matching the given uid parameters and stores all the containing instances at the given folder path.

Parameters
folderPaththe path at which the retrieved DICOM object instances of the retrieved series will be stored
studyUIDthe DICOM study uid
seriesUIDthe DICOM series uid
Returns
the task to wait for, which unfolds the name of the first DICOM object file within the folder path

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