DCMTK

https://support.dcmtk.org/docs-snapshot
Admin
DCMTK is a collection of software libraries and applications that implement the DICOM/MEDICOM...
Tokens:7,242,932
Snippets:52,383
Trust Score:8.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Configuration File Syntax Example

Source: https://support.dcmtk.org/docs-snapshot/file_asconfig.html

Illustrates the basic syntax for configuration files, including key-value pairs, section headings, and supersections. Lines starting with '#' are comments and are ignored.

```ini
[Section]
Key = Value
[[Supersection]]
```

--------------------------------

### Get Application Setup Attributes

Source: https://support.dcmtk.org/docs-snapshot/classDRTApplicationSetupSequence_1_1Item.html

Retrieves various attributes related to the Application Setup.

```APIDOC
## Get Application Setup Attributes

### Description
Provides methods to retrieve specific attributes of the Application Setup, including manufacturer, name, number, and type.

### Methods
- **OFCondition getApplicationSetupManufacturer (OFString &value, const signed long pos=0) const**: Gets ApplicationSetupManufacturer (300a,0238).
- **OFCondition getApplicationSetupName (OFString &value, const signed long pos=0) const**: Gets ApplicationSetupName (300a,0236).
- **OFCondition getApplicationSetupNumber (OFString &value, const signed long pos=0) const**: Gets ApplicationSetupNumber (300a,0234).
- **OFCondition getApplicationSetupNumber (Sint32 &value, const unsigned long pos=0) const**: Gets ApplicationSetupNumber (300a,0234) as Sint32.
- **OFCondition getApplicationSetupType (OFString &value, const signed long pos=0) const**: Gets ApplicationSetupType (300a,0232).
```

--------------------------------

### Basic oflog Configuration

Source: https://support.dcmtk.org/docs-snapshot/file_logger.html

This is a sample configuration file for oflog, demonstrating basic setup with log4cplus. It shows how to define loggers, appenders, and layouts for file logging. Lines starting with '#' are comments.

```properties
#
#  Copyright (C) 2009-2011, OFFIS e.V.
#  All rights reserved.  See COPYRIGHT file for details.
#
#  This software and supporting documentation were developed by
#
#    OFFIS e.V.
#    R&D Division Health
#    Escherweg 2
#    D-26121 Oldenburg, Germany
#
#
#  Module:  oflog
#
#  Author:  Uli Schlachter
#
#  Purpose: oflog sample configuration file
#

# This is an example config file for oflog. It's here to give an insight into
# some of the possibilities that oflog provides together with log4cplus.
#
# As you see, all lines that start with a '#' are comments.
#
# At any place in this file, you can use variables. They are expanded into
# settings from this file, e.g. ${log4cplus.rootLogger} would expand to the
# current value of this logger (see a few lines below). In addition, the
# following variables are predefined by oflog:
#
#  ${appname}        The name of the running application
#  ${date}, ${time}  The date and time at which this file was read
#  ${pid}            The process ID of the application which read this file
#  ${hostname}       The hostname of the machine on which we are running
#
# If no such setting exists, environment variables are tried. On most systems
# e.g. ${USER} would expand to the user name of the currently logged in user.
#
# Loggers are organized into hierarchies. If a log message is sent to the logger
# named dcmtk.dcmdata.libi2d, by default it will also be sent to dcmtk.dcmdata,
# dcmtk and the special "root logger" which is the base of the hierarchy.
#
# So, if you want to to catch all log messages, just configure the root logger:
log4cplus.rootLogger = DEBUG, console, logfile

# This line configures the root logger to sent all log events of level DEBUG or
# higher to the appenders "console" and "logfile" (see below).
#
# These are the available log levels, in ascending order:
# TRACE, DEBUG, INFO, WARN, ERROR, FATAL
#
# Now let's configure the above-mentioned appender called "console". Appenders
# take log events and send them somewhere. Since we want to see what's going on, 
# our console appender shows the message on the console (who would have
# thought). But since "debug" is a little verbose, we only display warnings and
# higher levels.
# You can use arbitrary names as the name for an appender.
log4cplus.appender.console = log4cplus::ConsoleAppender
log4cplus.appender.console.Threshold = INFO
log4cplus.appender.console.logToStderr = true
log4cplus.appender.console.ImmediateFlush = true

# As you can see, we are saying that console is of type "ConsoleAppender". Then
# we set some appender-specific properties. Each appender got different ones.

# Now let's configure the "logfile" appender which will write a logfile for us.
log4cplus.appender.logfile = log4cplus::FileAppender
log4cplus.appender.logfile.File = ${appname}.log
log4cplus.appender.logfile.Append = true
log4cplus.appender.logfile.ImmediateFlush = true

# One thing that all appenders need is a layout. It tells the appender how the
# log messages should be formated. The simple layout should be enough for
# starters, but the PatternLayout is way more flexible.
log4cplus.appender.console.layout = log4cplus::PatternLayout
log4cplus.appender.logfile.layout = log4cplus::PatternLayout

# The pattern layout can be told how the message should look like. Some of the
# available variables include:
# %n  A line ending
# %m  The actual log message
# %p  The log level of that message (TRACE, DEBUG, INFO, WARN, ERROR, FATAL)
# %P  The first character of the log level (T, D, I, W, E, F) - added to log4cplus
# %i  The process ID of the process generating the log entry
# %h  The hostname of the system generating the log entry
# %H  The full qualified domain name of the system generating the log entry
# %M  The function in which this log event was generated
# %F  The full filename of the source code file where this log event was generated
# %b  The basename of the source code file where this log event was generated
# %L  The line number where this log event was generated
# %l  This is equivalent to %F:%L
# %D{%m/%d/%y %H:%M:%S} The time when this log event was generated. %D is local
#     time, %d GMT. The available "time flags" are those from strftime() plus
#     %q and %Q (milliseconds and fractional milliseconds).
# A more complete list can be found here (if installed):
#     <htmldir>/classlog4cplus_1_1PatternLayout.html#_details
#
# The line below creates a PatternLayout which looks like a "standard"
# SimpleLayout, but which also includes the current time.
log4cplus.appender.console.layout.ConversionPattern = %D{%H:%M:%S} %5p: %m%n
log4cplus.appender.logfile.layout.ConversionPattern = %D{%Y-%m-%d %H:%M:%S.%q} %5p: %m%n

```

--------------------------------

### DCMTK Configuration File Example Path

Source: https://support.dcmtk.org/docs-snapshot/dcmpsrcv.html

Example path to a sample configuration file for DCMTK utilities.

```bash
_< etcdir>/dcmpstat.cfg_
```

--------------------------------

### Get Application Setup Sequence (Const)

Source: https://support.dcmtk.org/docs-snapshot/classDRTPlanIOD.html

Retrieves the Application Setup Sequence (300a,0230) from the DRT plan (const version).

```APIDOC
## getApplicationSetupSequence (Const)

### Description
Retrieves the Application Setup Sequence (300a,0230) from the DRT plan (const version).

### Signature
const DRTApplicationSetupSequence & getApplicationSetupSequence() const
```

--------------------------------

### Get Application Setup Sequence (Non-const)

Source: https://support.dcmtk.org/docs-snapshot/classDRTPlanIOD.html

Retrieves the Application Setup Sequence (300a,0230) from the DRT plan (non-const version).

```APIDOC
## getApplicationSetupSequence (Non-const)

### Description
Retrieves the Application Setup Sequence (300a,0230) from the DRT plan (non-const version).

### Signature
DRTApplicationSetupSequence & getApplicationSetupSequence()
```

--------------------------------

### Install DCMTK HTML Documentation

Source: https://support.dcmtk.org/docs-snapshot/file_install.html

Command to install the HTML documentation generated by Doxygen. Ensure Doxygen is installed prior to running this command.

```bash
make install-html
```

--------------------------------

### Example Appender Configuration

Source: https://support.dcmtk.org/docs-snapshot/classdcmtk_1_1log4cplus_1_1PropertyConfigurator.html

An example demonstrating the configuration of a SyslogAppender named 'A1', including its SyslogHost and layout.

```text
# Set options for appender named "A1".
# Appender "A1" will be a SyslogAppender
log4cplus.appender.A1=log4cplus::SyslogAppender

```

```text
# The syslog daemon resides on www.abc.net
log4cplus.appender.A1.SyslogHost=www.abc.net

```

```text
# A1's layout is a PatternLayout, using the conversion pattern
# **r %-5p c{2} M.L x - m  

**. Thus, the log output will

```

--------------------------------

### Get Setup Image Comment

Source: https://support.dcmtk.org/docs-snapshot/classDRTReferencedSetupImageSequence_1_1Item.html

Retrieves the Setup Image Comment (300a,0402) from the item.

```APIDOC
## Get Setup Image Comment

### OFCondition getSetupImageComment (OFString &value, const signed long pos=0) const
* get SetupImageComment (300a,0402)
```

--------------------------------

### getApplicationSetupSequence

Source: https://support.dcmtk.org/docs-snapshot/classDRTPlan.html

Retrieves the Application Setup Sequence. This function provides access to the sequence detailing application setup parameters.

```APIDOC
## getApplicationSetupSequence

### Description
Retrieves the Application Setup Sequence (DICOM tag 300a,0230).

### Method
DRTApplicationSetupSequence & getApplicationSetupSequence ()
const DRTApplicationSetupSequence & getApplicationSetupSequence () const

### Return Value
DRTApplicationSetupSequence& or const DRTApplicationSetupSequence& - A reference to the Application Setup Sequence.
```

--------------------------------

### Basic DCMTK Build and Install

Source: https://support.dcmtk.org/docs-snapshot/file_install.html

Standard commands to compile all DCMTK modules and install the resulting libraries and executables. Use 'make install-lib' to include libraries and include files.

```bash
make all
make install
```

--------------------------------

### Install All DCMTK Components

Source: https://support.dcmtk.org/docs-snapshot/file_install.html

Command to install all components of DCMTK, including executables, support files, libraries, include files, and HTML documentation.

```bash
make install-all
```

--------------------------------

### Install DCMTK Libraries and Include Files

Source: https://support.dcmtk.org/docs-snapshot/file_install.html

Command to specifically install the libraries and include files for DCMTK, in addition to the executables and support files.

```bash
make install-lib
```

--------------------------------

### SetupImageComment

Source: https://support.dcmtk.org/docs-snapshot/functions_s.html

Sets the comment for a setup image in the DRT Referenced Setup Image Sequence.

```APIDOC
## SetupImageComment

### Description
Sets the comment associated with a referenced setup image in the DRT Referenced Setup Image Sequence.

### Method
`SetupImageComment` (likely a setter method)

### Parameters
None explicitly documented.

### Return Value
`DRTReferencedSetupImageSequence::Item` object.
```

--------------------------------

### Set Application Setup Attributes

Source: https://support.dcmtk.org/docs-snapshot/classDRTApplicationSetupSequence_1_1Item.html

Sets various attributes related to the Application Setup.

```APIDOC
## Set Application Setup Attributes

### Description
Provides methods to set specific attributes of the Application Setup, including manufacturer, name, number, and type.

### Methods
- **OFCondition setApplicationSetupManufacturer (const OFString &value, const OFBool check=OFTrue)**: Sets ApplicationSetupManufacturer (300a,0238).
- **OFCondition setApplicationSetupName (const OFString &value, const OFBool check=OFTrue)**: Sets ApplicationSetupName (300a,0236).
- **OFCondition setApplicationSetupNumber (const OFString &value, const OFBool check=OFTrue)**: Sets ApplicationSetupNumber (300a,0234).
- **OFCondition setApplicationSetupType (const OFString &value, const OFBool check=OFTrue)**: Sets ApplicationSetupType (300a,0232).
```

--------------------------------

### getSetupReferenceDescription

Source: https://support.dcmtk.org/docs-snapshot/functions_g.html

Retrieves the Setup Reference Description.

```APIDOC
## getSetupReferenceDescription()

### Description
Retrieves the Setup Reference Description.

### Method
GET

### Endpoint
Not applicable (SDK method)

### Parameters
None

### Response
#### Success Response
- **Item** (DRTSetupDeviceSequence::Item) - The retrieved Setup Reference Description.
```

--------------------------------

### Basic PatternLayout Usage Example

Source: https://support.dcmtk.org/docs-snapshot/classdcmtk_1_1log4cplus_1_1PatternLayout.html

Demonstrates how to use PatternLayout with a simple conversion pattern to format log messages. This example shows the expected output for specific log statements.

```cpp
Logger root = Logger.getRoot();
DCMTK_LOG4CPLUS_DEBUG(root, "Message 1");
DCMTK_LOG4CPLUS_WARN(root, "Message 2");
```

```text
DEBUG [main]: Message 1
WARN  [main]: Message 2  
```

--------------------------------

### getSetupReferenceDescription

Source: https://support.dcmtk.org/docs-snapshot/functions_func_g.html

Retrieves the Setup Reference Description item.

```APIDOC
## getSetupReferenceDescription()

### Description
Retrieves the Setup Reference Description item.

### Method
```
DRTSetupDeviceSequence::Item getSetupReferenceDescription()
```
```

--------------------------------

### Get Referenced Patient Setup Number

Source: https://support.dcmtk.org/docs-snapshot/classDRTIonBeamSequence_1_1Item-members.html

Retrieves the referenced patient setup number. Overloaded for OFString and Sint32.

```APIDOC
## getReferencedPatientSetupNumber

### Description
Retrieves the referenced patient setup number.

### Method Signature
- `getReferencedPatientSetupNumber(OFString &value, const signed long pos=0) const`
- `getReferencedPatientSetupNumber(Sint32 &value, const unsigned long pos=0) const`
```

--------------------------------

### Get Range Modulator Gating Start Value

Source: https://support.dcmtk.org/docs-snapshot/classDRTRangeModulatorSettingsSequenceInRTIonBeamsModule_1_1Item.html

Retrieves the Range Modulator Gating Start Value from the sequence item.

```APIDOC
## getRangeModulatorGatingStartValue

### Description
Retrieves the Range Modulator Gating Start Value (300a,0382) from the sequence item.

### Method Signature
OFCondition DRTRangeModulatorSettingsSequenceInRTIonBeamsModule::Item::getRangeModulatorGatingStartValue(Float32 & _value, const unsigned long _pos = 0) const

### Parameters
*   **_value** (Float32 &) - Reference to a variable to store the retrieved value.
*   **_pos** (const unsigned long) - Index of the value to retrieve (default is 0).

### Returns
OFCondition - EC_Normal if successful, an error code otherwise.
```

--------------------------------

### getSetupDeviceDescription

Source: https://support.dcmtk.org/docs-snapshot/functions_func_g.html

Retrieves the description of the setup device.

```APIDOC
## getSetupDeviceDescription()

### Description
Retrieves the description of the setup device.

### Method
`getSetupDeviceDescription()`

### Returns
Returns the description of the setup device. Applicable to DRTSetupDeviceSequence::Item.
```

--------------------------------

### getApplicationSetup

Source: https://support.dcmtk.org/docs-snapshot/functions_func_g.html

Retrieves the application setup.

```APIDOC
## getApplicationSetup()

### Description
Retrieves the application setup.

### Method
```
getApplicationSetup()
```

### Returns
- DRTPlan: The application setup.
```

--------------------------------

### Init()

Source: https://support.dcmtk.org/docs-snapshot/classDiYBRPart422Image-members.html

Protected method to initialize the DiYBRPart422Image.

```APIDOC
## Init()

### Description
Protected method to initialize the DiYBRPart422Image.

### Method
Init
```

--------------------------------

### Get Referenced Patient Setup Number

Source: https://support.dcmtk.org/docs-snapshot/classDRTIonBeamSequence_1_1Item.html

Retrieves the referenced patient setup number, with overloads for different return types.

```APIDOC
## getReferencedPatientSetupNumber

### Description
Retrieves the referenced patient setup number.

### Method
OFCondition

### Parameters
- **value** (OFString &) - Output string for the setup number.
- **pos** (signed long) - Optional position parameter.

### Response
- **ReferencedPatientSetupNumber** (300c,006a) - The referenced patient setup number.
```

```APIDOC
## getReferencedPatientSetupNumber

### Description
Retrieves the referenced patient setup number.

### Method
OFCondition

### Parameters
- **value** (Sint32 &) - Output integer for the setup number.
- **pos** (unsigned long) - Optional position parameter.

### Response
- **ReferencedPatientSetupNumber** (300c,006a) - The referenced patient setup number.
```

--------------------------------

### Get Referenced Brachy Application Setup Sequence

Source: https://support.dcmtk.org/docs-snapshot/classDRTFractionGroupSequence_1_1Item.html

Retrieves the DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule.

```APIDOC
## DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule & getReferencedBrachyApplicationSetupSequence ()

### Description
Gets the Referenced Brachy Application Setup Sequence (300c,000a) as a modifiable reference.

### Returns
* **DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule &** - Reference to the sequence.

## const DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule & getReferencedBrachyApplicationSetupSequence () const

### Description
Gets the Referenced Brachy Application Setup Sequence (300c,000a) as a constant reference.

### Returns
* **const DRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModule &** - Constant reference to the sequence.
```

--------------------------------

### Logging Configuration Example

Source: https://support.dcmtk.org/docs-snapshot/dcmp2pgm.html

Illustrates how to configure logging levels and output streams for DCMTK command-line tools using a configuration file.

```text
An example configuration file is provided in _< etcdir>/logger.cfg_.
```

--------------------------------

### Get Range Modulator Gating Start Water Equivalent Thickness

Source: https://support.dcmtk.org/docs-snapshot/classDRTRangeModulatorSettingsSequenceInRTIonBeamsModule_1_1Item.html

Retrieves the Range Modulator Gating Start Water Equivalent Thickness from the sequence item.

```APIDOC
## getRangeModulatorGatingStartWaterEquivalentThickness

### Description
Retrieves the Range Modulator Gating Start Water Equivalent Thickness (300a,0386) from the sequence item.

### Method Signature
OFCondition DRTRangeModulatorSettingsSequenceInRTIonBeamsModule::Item::getRangeModulatorGatingStartWaterEquivalentThickness(Float32 & _value, const unsigned long _pos = 0) const

### Parameters
*   **_value** (Float32 &) - Reference to a variable to store the retrieved value.
*   **_pos** (const unsigned long) - Index of the value to retrieve (default is 0).

### Returns
OFCondition - EC_Normal if successful, an error code otherwise.
```

--------------------------------

### Example: Managing Sign Comparison Warnings

Source: https://support.dcmtk.org/docs-snapshot/ofdiag_8h.html

This example demonstrates how to use DCMTK_DIAGNOSTIC_PUSH, DCMTK_DIAGNOSTIC_IGNORE_SIGN_COMPARE, and DCMTK_DIAGNOSTIC_POP to temporarily suppress warnings related to comparing signed and unsigned integers. The macros are intended for use with #include.

```cpp
int i = 3;
unsigned ui = 8;
// will potentially emit a warning, although perfectly safe
if( i < ui )
doStuff();
// create a new diagnostic scope
#include DCMTK_DIAGNOSTIC_PUSH
// disable the sign mismatch warning
#include DCMTK_DIAGNOSTIC_IGNORE_SIGN_COMPARE
// the warning is omitted!
if( i < ui )
doStuff();
// restore the parent diagnostic scope potentially enabling
// the sign mismatch warning again
#include DCMTK_DIAGNOSTIC_POP
```

--------------------------------

### Init Method

Source: https://support.dcmtk.org/docs-snapshot/classDiYBR422Image-members.html

Initializes the DiYBR422Image object.

```APIDOC
## Init()

### Description
Protected method to initialize the DiYBR422Image.

### Method
Init

### Scope
protected
```

--------------------------------

### Get Referenced Patient Setup Number (Sint32)

Source: https://support.dcmtk.org/docs-snapshot/classDRTTreatmentSessionIonBeamSequence_1_1Item.html

Retrieves the referenced patient setup number as a Sint32. It takes a reference to a Sint32 to store the value and an optional position.

```APIDOC
## getReferencedPatientSetupNumber (Sint32)

### Description
Retrieves the number of the referenced patient setup, returned as a 32-bit integer.

### Method
`OFCondition getReferencedPatientSetupNumber(Sint32 &value, const unsigned long pos = 0) const`

### Parameters
*   **value** (Sint32&) - Output parameter to store the referenced patient setup number as a Sint32.
*   **pos** (unsigned long) - Optional position index (defaults to 0).
```

--------------------------------

### Get Referenced Patient Setup Number (String)

Source: https://support.dcmtk.org/docs-snapshot/classDRTTreatmentSessionIonBeamSequence_1_1Item.html

Retrieves the referenced patient setup number as a string. It takes a reference to an OFString to store the value and an optional position.

```APIDOC
## getReferencedPatientSetupNumber (String)

### Description
Retrieves the number of the referenced patient setup, returned as a string.

### Method
`OFCondition getReferencedPatientSetupNumber(OFString &value, const signed long pos = 0) const`

### Parameters
*   **value** (OFString&) - Output parameter to store the referenced patient setup number as a string.
*   **pos** (signed long) - Optional position index (defaults to 0).
```

--------------------------------

### getSetupDeviceSequence

Source: https://support.dcmtk.org/docs-snapshot/functions_g.html

Retrieves the Setup Device Sequence item.

```APIDOC
## getSetupDeviceSequence()

### Description
Retrieves the Setup Device Sequence item.

### Method
GET

### Endpoint
Not applicable (SDK method)

### Parameters
None

### Response
#### Success Response
- **Item** (DRTPatientSetupSequence::Item) - The retrieved Setup Device Sequence item.
```

--------------------------------

### OFTimer::getDiff

Source: https://support.dcmtk.org/docs-snapshot/classOFTimer.html

Gets the elapsed time since the timer was started or last reset.

```APIDOC
## double getDiff () const

### Description
Gets the elapsed time since the timer was started or last reset. This is the difference between the current time and the start time.

### Method
double

### Parameters
None

### Returns
elapsed time in seconds
```

--------------------------------

### Get Range Modulator Gating Start Value

Source: https://support.dcmtk.org/docs-snapshot/classDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule_1_1Item.html

Retrieves the Range Modulator Gating Start Value (300a,0382) from the DICOM item. The value is stored in the provided Float32 reference. An optional position index can be specified.

```APIDOC
## getRangeModulatorGatingStartValue

### Description
Retrieves the Range Modulator Gating Start Value (300a,0382).

### Method Signature
OFCondition DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule::Item::getRangeModulatorGatingStartValue(Float32 & _value, const unsigned long _pos = 0) const

### Parameters
*   **_value** (Float32&) - Reference to a variable where the value will be stored.
*   **_pos** (unsigned long, optional) - Index of the value to retrieve (defaults to 0).

### Returns
OFCondition - EC_Normal if successful, an error code otherwise.
```

--------------------------------

### startProvidingService

Source: https://support.dcmtk.org/docs-snapshot/classMdfConsoleEngine.html

Parses command-line options and executes the corresponding operations.

```APIDOC
## startProvidingService()

### Description
This function looks at commandline options and decides what to do.

### Returns
- int - An integer indicating the status of the operation.
```

--------------------------------

### Get Referenced Patient Setup Number

Source: https://support.dcmtk.org/docs-snapshot/classDRTBeamSequence_1_1Item-members.html

Retrieves the referenced patient setup number for this beam item. This method has two overloads, one for OFString and one for Sint32 output. An optional position `pos` can be specified.

```APIDOC
## getReferencedPatientSetupNumber

### Description
Retrieves the referenced patient setup number for this beam item.

### Method Signature
`getReferencedPatientSetupNumber(OFString &value, const signed long pos=0) const` or `getReferencedPatientSetupNumber(Sint32 &value, const unsigned long pos=0) const`

### Parameters
- **value** (OFString & or Sint32 &) - Output parameter to store the referenced patient setup number.
- **pos** (signed long or unsigned long) - Optional position index (defaults to 0).
```

--------------------------------

### getSetupImageComment

Source: https://support.dcmtk.org/docs-snapshot/functions_g.html

Retrieves the Setup Image Comment.

```APIDOC
## getSetupImageComment()

### Description
Retrieves the Setup Image Comment.

### Method
GET

### Endpoint
Not applicable (SDK method)

### Parameters
None

### Response
#### Success Response
- **Item** (DRTReferencedSetupImageSequence::Item) - The retrieved Setup Image Comment.
```

--------------------------------

### TTCCLayout Example Output

Source: https://support.dcmtk.org/docs-snapshot/classdcmtk_1_1log4cplus_1_1TTCCLayout.html

This example demonstrates the typical output format of the TTCCLayout, showing timestamps, thread names, log levels, logger names, nested diagnostic context, and the log message.

```text
176 [main] INFO  org.apache.log4j.examples.Sort - Populating an array of 2 elements in reverse order.
225 [main] INFO  org.apache.log4j.examples.SortAlgo - Entered the sort method.
262 [main] DEBUG org.apache.log4j.examples.SortAlgo.OUTER i=1 - Outer loop.
276 [main] DEBUG org.apache.log4j.examples.SortAlgo.SWAP i=1 j=0 - Swapping intArray[0] = 1 and intArray[1] = 0
290 [main] DEBUG org.apache.log4j.examples.SortAlgo.OUTER i=0 - Outer loop.
304 [main] INFO  org.apache.log4j.examples.SortAlgo.DUMP - Dump of interger array:
317 [main] INFO  org.apache.log4j.examples.SortAlgo.DUMP - Element [0] = 0
331 [main] INFO  org.apache.log4j.examples.SortAlgo.DUMP - Element [1] = 1
343 [main] INFO  org.apache.log4j.examples.Sort - The next log statement should be an error message.
346 [main] ERROR org.apache.log4j.examples.SortAlgo.DUMP - Tried to dump an uninitialized array.
467 [main] INFO  org.apache.log4j.examples.Sort - Exiting main method.

```

--------------------------------

### getSetupDeviceSequence

Source: https://support.dcmtk.org/docs-snapshot/classDRTPatientSetupSequence_1_1Item.html

Retrieves the Setup Device Sequence (300a,01b4).

```APIDOC
## getSetupDeviceSequence

### Description
Retrieves the Setup Device Sequence (300a,01b4).

### Method
`DRTSetupDeviceSequence& getSetupDeviceSequence()`

### Returns
Reference to the SetupDeviceSequence element.
```

```APIDOC
## getSetupDeviceSequence (const)

### Description
Retrieves the Setup Device Sequence (300a,01b4) as a const reference.

### Method
`const DRTSetupDeviceSequence& getSetupDeviceSequence() const`

### Returns
Const reference to the SetupDeviceSequence element.
```

--------------------------------

### getReferencedBrachyApplicationSetupSequence

Source: https://support.dcmtk.org/docs-snapshot/functions_func_g.html

Retrieves the referenced Brachy Application Setup sequence.

```APIDOC
## getReferencedBrachyApplicationSetupSequence()

### Description
Retrieves the referenced Brachy Application Setup sequence from Fraction Group Sequence and Referenced Fraction Group Sequence.

### Method
```
getReferencedBrachyApplicationSetupSequence() : DRTFractionGroupSequence::Item , DRTReferencedFractionGroupSequence::Item
```
```

--------------------------------

### Get Output Plane

Source: https://support.dcmtk.org/docs-snapshot/classDiMono1Image.html

Gets the pixel data of a specified plane.

```APIDOC
## getOutputPlane

### Description
Gets the pixel data of a specified plane.

### Signature
const void * getOutputPlane(const int dummy) const

### Parameters
- **dummy** (int) - Placeholder parameter, its exact usage might depend on context.

### Returns
- const void * - A pointer to the pixel data of the specified plane.
```

--------------------------------

### Usage Example for OFvisit with Different Visitors

Source: https://support.dcmtk.org/docs-snapshot/group__ofvisit__variant.html

Demonstrates using OFvisit with PowerVisitor, PrintVisitor, and AssignVisitor. Shows type conversion behavior and potential errors.

```cpp
struct PowerVisitor
{
template<typename Number>
Number operator()( Number number )
{
return number * number;
}
};
struct PrintVisitor
{
template<typename Number>
void operator()( Number number )
{
COUT << number << OFendl;
}
};
struct AssignVisitor
{
template<typename Number>
void operator()( Number& number )
{
number *= number;
}
};
// ...
OFvariant<int,float,double> v( 3.14 );
OFvariant<int,float,double> result = OFvisit<OFvariant<int,float,double> >( PowerVisitor(), v );
switch( result.index() )
{
case 0: COUT << "int "; break;
case 1: COUT << "float "; break;
case 2: COUT << "double "; break;
}
OFvisit<void>( PrintVisitor(), result );
COUT << "double " << OFvisit<double>( PowerVisitor(), v ) << OFendl; // OK, every alternative fits inside double
COUT << "int " << OFvisit<int>( PowerVisitor(), v ) << OFendl; // OK, value will be truncated!
COUT << "string " << OFvisit<OFString>( PowerVisitor(), v ) << OFendl; // ERROR!
OFvisit<void>( AssignVisitor(), v );
OFvisit<void>( PrintVisitor(), v );
```

--------------------------------

### Get String Value

Source: https://support.dcmtk.org/docs-snapshot/classDcmPixelData.html

Gets a pointer to the element value as a string.

```APIDOC
## getString (char *&val)

### Description
Gets a pointer to the element value of the current element as type string.

### Method
virtual OFCondition getString (char *&val)

### Parameters
- **val** (char*&) - Output parameter to store the pointer to the string value.

### Returns
An OFCondition object indicating success or failure.
```

--------------------------------

### Get Curve

Source: https://support.dcmtk.org/docs-snapshot/classDVPresentationState.html

Gets the curve with the specified index on the given layer.

```APIDOC
## getCurve

### Description
Gets the curve with the given index on the given layer.

### Method
DVPSCurve *

### Parameters
- **layer** (size_t) - The index of the graphic layer.
- **idx** (size_t) - The index of the curve.
```

--------------------------------

### DcmByteString Get String (char*&)

Source: https://support.dcmtk.org/docs-snapshot/classDcmTime.html

Gets a pointer to the current string value.

```APIDOC
## DcmByteString Get String (char*&)

### Description
Provides a direct pointer to the current string value stored in the DcmByteString element.

### Method
virtual OFCondition getString(char *&stringVal)

### Parameters
#### Path Parameters
- **stringVal** (char *&) - Output parameter that will point to the current string value.

### Description
Get a pointer to the current string value.
```

--------------------------------

### StartProvidingService

Source: https://support.dcmtk.org/docs-snapshot/classWlmConsoleEngineFileSystem.html

Starts providing the implemented service for calling SCUs. After having created an instance of this class, this function shall be called from main.

```APIDOC
## StartProvidingService

### Description
Starts providing the implemented service for calling SCUs. After having created an instance of this class, this function shall be called from main.

### Method
(Implicitly a member function call)

### Parameters
None

### Returns
Return value that is supposed to be returned from main().
```

--------------------------------

### DCMTK Command File Usage Example

Source: https://support.dcmtk.org/docs-snapshot/dcmpschk.html

Demonstrates the use of command files (prefixed with '@') to specify command line arguments. This helps in managing complex option combinations.

```text
@command.txt
```

```text
<datadir>/dumppat.txt
```

--------------------------------

### DcmByteString Get Length Method

Source: https://support.dcmtk.org/docs-snapshot/classDcmTime.html

Gets the DICOM length of the stored value.

```APIDOC
## DcmByteString Get Length Method

### Description
Calculates and returns the DICOM-compliant length of the stored byte string value, considering transfer syntax and encoding type.

### Method
virtual Uint32 getLength(const E_TransferSyntax xfer=EXS_LittleEndianImplicit, const E_EncodingType enctype=EET_UndefinedLength)

### Parameters
#### Query Parameters
- **xfer** (E_TransferSyntax) - Optional - The transfer syntax to consider for length calculation. Defaults to EXS_LittleEndianImplicit.
- **enctype** (E_EncodingType) - Optional - The encoding type to consider. Defaults to EET_UndefinedLength.

### Description
Get DICOM length of the stored value.
```

--------------------------------

### getApplicationSetup

Source: https://support.dcmtk.org/docs-snapshot/functions_g.html

Retrieves the application setup. Applicable to DRTPlan.

```APIDOC
## getApplicationSetup()

### Description
Retrieves the application setup details from a treatment plan.

### Method
N/A (Function Signature)

### Parameters
None

### Response
- **DRTPlan**: The application setup object.
```

--------------------------------

### DcmByteString Get Real Length Method

Source: https://support.dcmtk.org/docs-snapshot/classDcmTime.html

Gets the length of the stored value.

```APIDOC
## DcmByteString Get Real Length Method

### Description
Returns the actual length of the stored byte string value.

### Method
Uint32 getRealLength()

### Description
Get length of the stored value.
```

--------------------------------

### SimpleLayout Example

Source: https://support.dcmtk.org/docs-snapshot/classdcmtk_1_1log4cplus_1_1SimpleLayout.html

Demonstrates the output format of the SimpleLayout, which includes the log level and the message.

```text
        DEBUG - Hello world

```

--------------------------------

### Get Uint32 Array

Source: https://support.dcmtk.org/docs-snapshot/classDcmPixelData.html

Gets a pointer to the element value as a Uint32 array.

```APIDOC
## getUint32Array (Uint32 *&val)

### Description
Gets a pointer to the element value of the current element as type Uint32 array.

### Method
virtual OFCondition getUint32Array (Uint32 *&val)

### Parameters
- **val** (Uint32*&) - Output parameter to store the pointer to the Uint32 array.

### Returns
An OFCondition object indicating success or failure.
```

--------------------------------

### Get Sint32 Array

Source: https://support.dcmtk.org/docs-snapshot/classDcmPixelData.html

Gets a pointer to the element value as a Sint32 array.

```APIDOC
## getSint32Array (Sint32 *&val)

### Description
Gets a pointer to the element value of the current element as type Sint32 array.

### Method
virtual OFCondition getSint32Array (Sint32 *&val)

### Parameters
- **val** (Sint32*&) - Output parameter to store the pointer to the Sint32 array.

### Returns
An OFCondition object indicating success or failure.
```

--------------------------------

### getSetupImageComment

Source: https://support.dcmtk.org/docs-snapshot/functions_func_g.html

Retrieves the Setup Image Comment item.

```APIDOC
## getSetupImageComment()

### Description
Retrieves the Setup Image Comment item.

### Method
```
DRTReferencedSetupImageSequence::Item getSetupImageComment()
```
```

--------------------------------

### Item Class - getReferencedBrachyApplicationSetupSequence

Source: https://support.dcmtk.org/docs-snapshot/classDRTReferencedFractionGroupSequence_1_1Item.html

Retrieves the Referenced Brachy Application Setup Sequence associated with the item.

```APIDOC
## getReferencedBrachyApplicationSetupSequence

### Description
Retrieves the DICOM attribute 'Referenced Brachy Application Setup Sequence' (300c,000a).

### Methods
- **DRTReferencedBrachyApplicationSetupSequenceInRTDoseModule & getReferencedBrachyApplicationSetupSequence()**: Returns a modifiable reference to the Referenced Brachy Application Setup Sequence.
- **const DRTReferencedBrachyApplicationSetupSequenceInRTDoseModule & getReferencedBrachyApplicationSetupSequence() const**: Returns a constant reference to the Referenced Brachy Application Setup Sequence.
```

--------------------------------

### DcmOtherByteOtherWord Get Uint16 Array

Source: https://support.dcmtk.org/docs-snapshot/classDcmPixelItem.html

Gets a reference to the stored 16-bit data.

```APIDOC
## DcmOtherByteOtherWord Get Uint16 Array

### Description
Provides direct access to the underlying array of 16-bit data.

### Method
`virtual OFCondition getUint16Array(Uint16 *&wordVals)`: Sets `wordVals` to point to the stored 16-bit data.
```

--------------------------------

### DRTPlan::getApplicationSetup

Source: https://support.dcmtk.org/docs-snapshot/classDRTPlan.html

Finds and returns an application setup item by its number.

```APIDOC
## DRTPlan::getApplicationSetup

### Description
Finds an application setup by its application setup number.

### Parameters
#### Path Parameters
- **_setupNumber** (Sint32) - Required - The setup number to find.

### Returns
- DRTApplicationSetupSequence::Item& - The item representing the setup or the EmptyDefaultItem of the DRTApplicationSetupSequence.
```

--------------------------------

### DcmOtherByteOtherWord Get Uint8 Array

Source: https://support.dcmtk.org/docs-snapshot/classDcmPixelItem.html

Gets a reference to the stored 8-bit data.

```APIDOC
## DcmOtherByteOtherWord Get Uint8 Array

### Description
Provides direct access to the underlying array of 8-bit data.

### Method
`virtual OFCondition getUint8Array(Uint8 *&byteVals)`: Sets `byteVals` to point to the stored 8-bit data.
```

--------------------------------

### Get Curve in Image

Source: https://support.dcmtk.org/docs-snapshot/classDVPresentationState.html

Gets the curve with the specified index from the attached image.

```APIDOC
## getCurveInImage

### Description
Gets the curve with the given index from the attached image.

### Method
DVPSCurve *

### Parameters
- **idx** (size_t) - The index of the curve in the image.
```

--------------------------------

### getSetupDeviceSequence

Source: https://support.dcmtk.org/docs-snapshot/classDRTPatientSetupSequence_1_1Item.html

Retrieves the SetupDeviceSequence (300a,01b4).

```APIDOC
## getSetupDeviceSequence

### Description
Gets the SetupDeviceSequence (300a,01b4).

### Method
DRTSetupDeviceSequence & getSetupDeviceSequence()
const DRTSetupDeviceSequence & getSetupDeviceSequence() const

### Parameters
None

### Returns
A reference to the DRTSetupDeviceSequence.
```

--------------------------------

### New Instance

Source: https://support.dcmtk.org/docs-snapshot/classDJLSEncoderBase.html

Creates a new SOP instance UID and Source Image Sequence.

```APIDOC
## newInstance

### Description
Create new SOP instance UID and Source Image Sequence referencing the old SOP instance (if present).

### Method
`static OFCondition newInstance(DcmItem *dataset, const char *purposeOfReferenceCodingScheme=NULL, const char *purposeOfReferenceCodeValue=NULL, const char *purposeOfReferenceCodeMeaning=NULL)`
```

--------------------------------

### Get Uint8 Array

Source: https://support.dcmtk.org/docs-snapshot/classDcmDateTime.html

Gets a pointer to the element value as a Uint8 array.

```APIDOC
## getUint8Array

### Description
Gets a pointer to the element value of the current element as type string.

### Signature
`virtual OFCondition getUint8Array(Uint8 *&val)`
```

--------------------------------

### Contrast Bolus Start Time

Source: https://support.dcmtk.org/docs-snapshot/classDRTImageIOD-members.html

Retrieves the Contrast Bolus Start Time.

```APIDOC
## getContrastBolusStartTime(OFString &value, const signed long pos=0)

### Description
Retrieves the Contrast Bolus Start Time.

### Method
virtual

### Endpoint
N/A (Method Call)
```

--------------------------------

### CDRTSetupDeviceSequence

Source: https://support.dcmtk.org/docs-snapshot/hierarchy.html

Interface class for SetupDeviceSequence (300a,01b4).

```APIDOC
## CDRTSetupDeviceSequence

### Description
Interface class for SetupDeviceSequence (300a,01b4).

### Item Class
CDRTSetupDeviceSequence::Item
```

--------------------------------

### DRTPlan::getPatientSetup

Source: https://support.dcmtk.org/docs-snapshot/classDRTPlan.html

Finds and returns a patient setup item by its setup number.

```APIDOC
## DRTPlan::getPatientSetup

### Description
Finds a patient setup by its patient setup number.

### Parameters
#### Path Parameters
- **_setupNumber** (Sint32) - Required - The setup number to find.

### Returns
- DRTPatientSetupSequence::Item& - The item representing the setup or the EmptyDefaultItem of the DRTPatientSetupSequence.
```

--------------------------------

### startQueryRetrieveServer

Source: https://support.dcmtk.org/docs-snapshot/classDVInterface-members.html

Starts the Query/Retrieve server.

```APIDOC
## startQueryRetrieveServer

### Description
Starts the Query/Retrieve server.

### Method
(Not specified, likely a C++ method call)
```

--------------------------------

### OFoptional_traits Example

Source: https://support.dcmtk.org/docs-snapshot/structOFoptional__traits.html

An example demonstrating how to implement custom OFoptional_traits for an enum type.

```APIDOC
## Example
```cpp
enum FILE_ACCESS
{
NONE = 0000,
READ = 0400,
WRITE = 0200,
INVALID_ACCESS_CODE = 01000
};
template<>
struct OFoptional_traits<FILE_ACCESS>
{
// Tell OFoptional that this is default-constructible
typedef OFtrue_type is_default_constructible;
// Initialize storage to the invalid state during construction
OFoptional_traits() : access( INVALID_ACCESS_CODE ) {}
// Constructors
void construct() { access = NONE; }
void construct( FILE_ACCESS fa ) { access = fa; }
// There is nothing to destroy, just set the state to "disengaged"
void destroy() { access = INVALID_ACCESS_CODE; }
// Tell OFoptional how to distinguish "engaged" and "disengaged" FILE_ACCESS objects
OFBool state() const { return access != INVALID_ACCESS_CODE; }
// Just return a pointer to the underlying object
void* content() const { return &access; }
// The actual object
mutable FILE_ACCESS access;
};
COUT << "This should now be the same: " << sizeof( FILE_ACCESS ) << ' ' << sizeof( OFoptional<FILE_ACCESS> ) << OFendl;
```
```

--------------------------------

### Get Bits Per Sample

Source: https://support.dcmtk.org/docs-snapshot/classDiMono1Image.html

Gets the number of bits per sample for the image.

```APIDOC
## getBits

### Description
Gets the number of bits per sample for the image.

### Signature
virtual int getBits(const int bits=0) const

### Parameters
- **bits** (int) - Optional parameter, typically 0.

### Returns
- int - The number of bits per sample.
```

--------------------------------

### DVInterface::startQueryRetrieveServer

Source: https://support.dcmtk.org/docs-snapshot/classDVInterface.html

Starts the query/retrieve server process (Query/Retrieve Service Class SCP). This process handles incoming DICOM associations, serves queries, and sends requested instances. Data is sourced from the local database. The configuration file is automatically created unless disabled. Note: A successful return does not guarantee the server has fully started, as some errors are only detected at runtime.

```APIDOC
## DVInterface::startQueryRetrieveServer

### Description
Starts the query/retrieve server process (Query/Retrieve Service Class SCP).

The query/retrieve process will wait for incoming DICOM associations, serve queries and send the requested instances to the specified destination. Data will be taken from the same local database used to store received instances and created presentation states, stored print objects and hardcopy grayscale images.

The configuration file which is required for the query/retrieve process will be created automatically from the 'global' configuration file each time this method is called, unless this automatical creation is disabled (entry: [QUERYRETIUEVE] AutoCreateConfigFile = false).

Attention: Successful return of this method is no guarantee that the query/retrieve server has successfully started, because certain errors (i.e. incorrect settings in the config file) will only be noted in the query/retrieve process when running. On Unix platform, successful return of this method means that the fork() used to start the receiver was successful. On Win32 platforms, it means that the CreateProcess() call was successful.

### Returns
EC_Normal if the query/retrieve process could be started, an error code otherwise.
```

--------------------------------

### Get Graphic Object

Source: https://support.dcmtk.org/docs-snapshot/classDVPresentationState.html

Gets the graphic object with the specified index on the given layer.

```APIDOC
## getGraphicObject

### Description
Gets the graphic object with the given index on the given layer.

### Method
DVPSGraphicObject *

### Parameters
- **layer** (size_t) - The index of the graphic layer.
- **idx** (size_t) - The index of the graphic object.
```

--------------------------------

### DCMTK Logging Configuration Example

Source: https://support.dcmtk.org/docs-snapshot/dcmpschk.html

Illustrates how to configure logging for DCMTK tools using a configuration file. This allows directing specific messages to different output streams or filtering them.

```text
<etcdir>/logger.cfg
```

--------------------------------

### Get Text Object

Source: https://support.dcmtk.org/docs-snapshot/classDVPresentationState.html

Gets the text object with the specified index on the given layer.

```APIDOC
## getTextObject

### Description
Gets the text object with the given index on the given layer.

### Method
DVPSTextObject *

### Parameters
- **layer** (size_t) - The index of the graphic layer.
- **idx** (size_t) - The index of the text object.
```

--------------------------------

### DSRCompositeReferenceValue Get and Set Value

Source: https://support.dcmtk.org/docs-snapshot/classDSRCompositeTreeNode.html

Methods for getting and setting the composite reference value.

```APIDOC
## getValue

### Description
Gets a reference to the composite reference value.

### Method
const DSRCompositeReferenceValue& getValue() const

## getValue

### Description
Gets a copy of the composite reference value.

### Method
OFCondition getValue(DSRCompositeReferenceValue &referenceValue) const

## setValue

### Description
Sets the composite reference value. Optionally checks the provided value.

### Method
OFCondition setValue(const DSRCompositeReferenceValue &referenceValue, const OFBool check = OFTrue)
```

--------------------------------

### startProvidingService

Source: https://support.dcmtk.org/docs-snapshot/classMdfConsoleEngine-members.html

Starts the service provision of the MdfConsoleEngine.

```APIDOC
## startProvidingService()

### Description
Starts the service provision of the MdfConsoleEngine.
```

--------------------------------

### Init Method

Source: https://support.dcmtk.org/docs-snapshot/classDiYBRImage.html

Initializes internal data structures and member variables of the DiYBRImage object.

```APIDOC
## void Init ()

### Description
Initializes internal data structures and member variables.

### Method
void
```

--------------------------------

### Writing XML Start Tag

Source: https://support.dcmtk.org/docs-snapshot/classDcmSequenceOfItems.html

Writes the start tag of an element in XML format.

```APIDOC
## virtual void writeXMLStartTag (STD_NAMESPACE ostream &out, const size_t flags, const char *attrText=NULL)

### Description
Writes the element start tag in XML format.

### Parameters
- **out** (STD_NAMESPACE ostream &) - The output stream to write to.
- **flags** (const size_t) - Formatting flags.
- **attrText** (const char *NULL) - Optional additional attribute text.
```

--------------------------------

### getApplicationSetupName

Source: https://support.dcmtk.org/docs-snapshot/functions_func_g.html

Retrieves the name of the application setup.

```APIDOC
## getApplicationSetupName()

### Description
Retrieves the name of the application setup.

### Method
```
getApplicationSetupName()
```

### Returns
- DRTApplicationSetupSequence::Item: The name of the application setup.
```

--------------------------------

### SetupDeviceSequence

Source: https://support.dcmtk.org/docs-snapshot/functions_s.html

Sets the Setup Device Sequence within the DRT Patient Setup Sequence.

```APIDOC
## SetupDeviceSequence

### Description
Sets the Setup Device Sequence, which contains information about devices used in patient setup, within the DRT Patient Setup Sequence.

### Method
`SetupDeviceSequence` (likely a setter method)

### Parameters
None explicitly documented.

### Return Value
`DRTPatientSetupSequence::Item` object.
```

--------------------------------

### getSetupTechniqueDescription

Source: https://support.dcmtk.org/docs-snapshot/classDRTPatientSetupSequence_1_1Item.html

Retrieves the SetupTechniqueDescription (300a,01b2) value.

```APIDOC
## getSetupTechniqueDescription

### Description
Gets the SetupTechniqueDescription (300a,01b2) value.

### Method
OFCondition getSetupTechniqueDescription(OFString &value, const signed long pos=0) const

### Parameters
- **value** (OFString&) - The string to store the value in.
- **pos** (signed long) - Optional: The position of the element to retrieve (default is 0).

### Returns
An OFCondition indicating success or failure.
```

--------------------------------

### Set Setup Image Comment

Source: https://support.dcmtk.org/docs-snapshot/classDRTReferencedSetupImageSequence_1_1Item.html

Sets the Setup Image Comment (300a,0402) in the item.

```APIDOC
## Set Setup Image Comment

### OFCondition setSetupImageComment (const OFString &value, const OFBool check=OFTrue)
* set SetupImageComment (300a,0402)
```

--------------------------------

### Init Method

Source: https://support.dcmtk.org/docs-snapshot/classDiHSVImage-members.html

Initializes the DiHSVImage object.

```APIDOC
## Init()

### Description
Initializes the DiHSVImage object.

### Method
Init

### Parameters
None
```
Tokens:
Raw