ImFusion SDK 4.3
DicomPacsConfiguration Struct Reference

#include <ImFusion/Dicom/DicomPacsCommunication.h>

Structure encapsulating all information needed to connect to a PACS instance. More...

Detailed Description

Structure encapsulating all information needed to connect to a PACS instance.

Also provides some utility methods to read/write the configuration from/to the global settings and generate/parse distinct URI describing series/images on the PACS.

Examples
DicomWorklist.cpp, and PacsExample.cpp.

Public Types

using Url = Filesystem::Url
 

Public Member Functions

 DicomPacsConfiguration (const std::string &serverHostname, int serverPort, const std::string &serverAeTitle)
 Creates a new PacsConfiguration struct with the given server information.
 
 DicomPacsConfiguration ()
 Default constructor, creates invalid (empty) configuration.
 
bool isValid () const
 Returns true if the configuration is valid, e.g.
 
Url generateUri (const Dicom::Utils::UrlQueries &queries) const
 Converts a DICOM image located on a PACS server to a distinct URI in the form "pacs://<Hostname>:<Port>/<HostAE>?series=<seriesUID>&study=<studyUID>#<sopInstanceUID>".
 
Url generateUri (DcmDataset &dataset) const
 Convenient method that extracts the required UIDs and calls the generateUri above.
 
bool operator== (const DicomPacsConfiguration &rhs) const
 
std::string toString (bool includeClientConfig=false) const
 Returns a string representation that can be used for logging.
 

Static Public Member Functions

static DicomPacsConfiguration fromUri (const Url &uri)
 Converts a URI to a DICOM image located on a PACS server into its separate parts.
 

Public Attributes

std::string serverHostname
 Hostname/IP of the PACS server.
 
unsigned int serverPort
 Port of the PACS server.
 
std::string serverAETitle
 Application Entity of the PACS server.
 
unsigned int clientPort
 Port to use by the DICOM SCP server for receiving images.
 
std::string clientAETitle
 Application Entity to use by the DICOM SCP server for receiving images.
 
std::string cfgFilePath
 Path to a association config file to be used by the DICOM SCP server. May be empty for default configuration. See https://support.dcmtk.org/docs/file_asconfig.html for details.
 
int connectionTimeout
 Connection Timeout (seconds)
 
Dicom::AnonymizationProfile anonymisePatients
 Anonymise patient information on receive.
 

Constructor & Destructor Documentation

◆ DicomPacsConfiguration()

DicomPacsConfiguration ( const std::string & serverHostname,
int serverPort,
const std::string & serverAeTitle )

Creates a new PacsConfiguration struct with the given server information.

Client information is taken from the global settings (DicomIOAlgorithm's user options).

Member Function Documentation

◆ fromUri()

static DicomPacsConfiguration fromUri ( const Url & uri)
static

Converts a URI to a DICOM image located on a PACS server into its separate parts.

URI must be of the form "pacs://<Hostname>:<Port>/<HostAE>?<seriesUID>#<sopInstanceUID>".

See also
generateUri()

◆ isValid()

bool isValid ( ) const

Returns true if the configuration is valid, e.g.

if the hostname and AE are not empty. Does NOT check if the hostname exists or a connection can be established.

Examples
PacsExample.cpp.

◆ generateUri()

Url generateUri ( const Dicom::Utils::UrlQueries & queries) const

Converts a DICOM image located on a PACS server to a distinct URI in the form "pacs://<Hostname>:<Port>/<HostAE>?series=<seriesUID>&study=<studyUID>#<sopInstanceUID>".

See also
parseUri()

The documentation for this struct was generated from the following file:
Search Tab / S to search, Esc to close