RZDCX - Fast Strike DICOM Toolkit  Release 2.0.8.7
rzdcx.idl File Reference

RZDCX IDL file defines the SDK's public Interface. More...

Classes

struct  ENCAPSULATED_VIDEO_PROPS
 
interface  IDCXELM
 This inteface is used to get and set DICOM Elements and their value. More...
 
interface  IDCXELMIterator
 used for iterating over a collection of elements. More...
 
interface  IDCXOBJ
 A DICOM Object Interface. More...
 
interface  IDCXKIN
 Create Key Object Selection Document (Structured Report) More...
 
interface  IDCXOBJIterator
 This class is used to iterate over a collection of objects. More...
 
interface  IDCXPrintImageBox
 This interface is used for setting attributes of an image box on a printed film. More...
 
interface  IDCXPrintPage
 This interface is used for printing a film (page) using a DICOM printer. More...
 
interface  IDCXPrintSession
 This interface is used for managing print sessions. More...
 
interface  IDCXACC
 Use this interface to build a DICOM Service SCP (Server). More...
 
interface  IDCXREQ
 Use this interface to perfrom tasks of a DICOM Service SCU. More...
 
interface  IDCXDICOMDIR
 A DICOMDIR file reader. Use the IDCXDICOMDIR Interface to read a DICOMDIR file and read the fileset records in it. Each method return a IDCXOBJIterator that can be used to go over the record of the specific type. If a matching string (or strings) is provided, then the records of that level that match the string a returned. If the matching string is empty, then all the records of that type are returned. For example, to get the complete list of all DICOM files in the fileset, simply use getSeriesLeafIterator with empty matching strings. More...
 
interface  IDCXAPP
 Do not use this interface while other threads may be using the toolkit functionality. More...
 
interface  IDCXDIC
 Lookup tags in the dictionary either by their name or by the number. More...
 
interface  IDCXUID
 Create Unique Identifiers (UID) More...
 
interface  IDCXIMG
 Use The DICOM Image Interface to manipulate, display and convert DICOM images to other formats. For an example of using this class see DICOMImageExample.cs. More...
 
interface  IDCXSR
 The DCXSR Interface is used for quickly creating DICOM Structured Reports. More...
 
interface  rzdcxLib::IDCXREQEvents
 Requester interface events (callbacks). Implement this interface to recireve events from the IDCXREQ Interface. More...
 
interface  rzdcxLib::IDCXACCEvents
 Accepter interface events (callbacks). Implement this interface to recireve events from the IDCXACC Interface. More...
 

Typedefs

typedef long DICOM_TAG
 

Enumerations

enum  VR_CODE {
  VR_CODE_AE, VR_CODE_AS, VR_CODE_AT, VR_CODE_CS,
  VR_CODE_DA, VR_CODE_DS, VR_CODE_DT, VR_CODE_FL,
  VR_CODE_FD, VR_CODE_IS, VR_CODE_LO, VR_CODE_LONGTEXT,
  VR_CODE_OB, VR_CODE_OF, VR_CODE_OW, VR_CODE_PN,
  VR_CODE_SH, VR_CODE_SL, VR_CODE_SQ, VR_CODE_SS,
  VR_CODE_ST, VR_CODE_TM, VR_CODE_UI, VR_CODE_UL,
  VR_CODE_US, VR_CODE_UT, VR_CODE_ox, VR_CODE_xs,
  VR_CODE_lt, VR_CODE_na, VR_CODE_up, VR_CODE_item,
  VR_CODE_metainfo, VR_CODE_dataset, VR_CODE_fileFormat, VR_CODE_dicomDir,
  VR_CODE_dirRecord, VR_CODE_pixelSQ, VR_CODE_pixelItem, VR_CODE_UNKNOWN,
  VR_CODE_UN, VR_CODE_PixelData, VR_CODE_OverlayData, VR_CODE_UNKNOWN2B
}
 Value Representations - DICOM's data types. More...
 
enum  PRINT_COLOR_SPACE { PCS_GRAY, PCS_COLOR }
 
enum  PRINT_JOB_STATUS { PJS_PENDING, PJS_PRINTING, PJS_DONE, PJS_FAILURE }
 
enum  PRINT_PAGE_ORIENTATION { PPO_PORTRAIT, PPO_LANDSACPE }
 
enum  IMAGE_SAMPLES_PER_PIXEL { ISPP_1 = 1, ISPP_3 = 3 }
 
enum  IMAGE_PHOTOMETRIC_INTERPRETATION { IPI_MONOCHROME1, IPI_MONOCHROME2, IPI_RGB }
 
enum  IMAGE_BITS_ALLOCATED { IBA_8 = 8, IBA_16 = 16 }
 
enum  IMAGE_BITS_STORED
 
enum  IMAGE_HIGH_BIT
 
enum  IMAGE_PIXEL_REPRESENTATION { IPR_UNSIGNED = 0, IPR_SIGNED = 1 }
 
enum  IMAGE_PLANAR_CONFIGURATION { IPC_INTERLEAVE = 0, IPC_SEPARATED = 1 }
 
enum  UID_TYPE {
  UID_TYPE_OTHER = 0, UID_TYPE_STUDY = 1, UID_TYPE_SERIES = 2, UID_TYPE_INSTANCE = 3,
  UID_TYPE_SCM_TRANSACTION = 4, UID_TYPE_MPPS = 5
}
 
enum  APPLICATION_PROFILE {
  AP_GENERAL_PURPOSE, AP_DEFAULT = AP_GENERAL_PURPOSE, AP_GENERAL_PURPOSE_DVD, AP_GENERAL_PURPOSE_MIME,
  AP_USB_AND_FLASH, AP_MPEG2_MPATML, AP_BASIC_CARDIAC, AP_XRAY_ANGIOGRAPHIC,
  AP_XRAY_ANGIOGRAPHIC_DVD, AP_DENTAL_RADIOGRAPH, AP_CT_AND_MR, AP_ULTRASOUND_ID_SF,
  AP_ULTRASOUND_SC_SF, AP_ULTRASOUND_CC_SF, AP_ULTRASOUND_ID_MF, AP_ULTRASOUND_SC_MF,
  AP_ULTRASOUND_CC_MF, AP_TWELVE_LEAD_ECG, AP_HEMODYNAMIC_WAVEFORM
}
 Application Profiles for Storage Media (DICOMDIR) More...
 
enum  TRANSFER_SYNTAX {
  TS_OTHER = 0, TS_LEI = 1, TS_LEE, TS_BEE,
  TS_LOSSLESS_JPEG_DEFAULT, TS_LOSSLESS_JPEG_ANY_PREDICTOR, TS_JPEG, TS_RLE,
  TS_JPEG_2000_LOSSLESS_ONLY, TS_JPEG_2000, TS_JPEG_2000_P2_LOSSLESS_ONLY, TS_JPEG_2000_P2,
  TS_MPEG2_MAIN_PROFILE_AT_MAIN_LEVEL, TS_MPEG2_MAIN_PROFILE_AT_HIGH_LEVEL, TS_MPEG4, TS_MPEG4_BD_COMP,
  TS_MPEG4_4_2_2D, TS_MPEG4_4_2_3D, TS_MPEG4_4_2_STEREO, TS_HEVC_MAIN_PROFILE,
  TS_HEVC_MAIN_10_PROFILE
}
 
enum  DUMP_OBJECT_OPTIONS { DO_DEFAULT = 0 }
 
enum  VIDEO_FORMAT {
  MPEG2_AT_MAIN_LEVEL = 1, MPEG2_AT_HIGH_LEVEL, MPEG4, MPEG4_BD_COMPATIBLE,
  MPEG4_4_2_2D, MPEG4_4_2_3D, MPEG4_4_2_STEREO, HEVC_MAIN_PROFILE,
  HEVC_MAIN_10_PROFILE
}
 
enum  NEW_INSTANCE_CREATION_POLICY { CNU_ONLOSSYCOMPRESSION, CNU_ALWAYS, CNU_NEVER }
 
enum  LOG_LEVEL {
  LOG_LEVEL_NONE = 0, LOG_LEVEL_FATAL = 1, LOG_LEVEL_ERROR = 2, LOG_LEVEL_WARNING = 3,
  LOG_LEVEL_INFO = 4, LOG_LEVEL_DEBUG = 5
}
 
enum  SR_CONTINUITY { SR_SEPARATE = 1, SR_CONTINUOUS = 2 }
 
enum  SR_GRAPHIC_TYPE {
  SR_GT_POINT = 1, SR_GT_MULTIPOINT = 2, SR_GT_POLYLINE = 3, SR_GT_CIRCLE = 4,
  SR_GT_ELLIPSE = 5
}
 SR Graphic Types to use for SCOORD nodes. More...
 
enum  SR_TEMPORAL_RANGE_TYPE {
  SR_TR_POINT = 1, SR_TR_MULTIPOINT = 2, SR_TR_SEGMENT = 3, SR_TR_MULTISEGMENT = 4,
  SR_TR_BEGIN = 5, SR_TR_END = 6
}
 SR Temporal Range Types to use for TCOORD nodes A TCOORD content item always have one or more children. More...
 
enum  SR_RELATIONSHIP_TYPE
 SR Relationship Types.
 

Detailed Description

RZDCX IDL file defines the SDK's public Interface.

Interface Definision

Enumeration Type Documentation

◆ APPLICATION_PROFILE

Application Profiles for Storage Media (DICOMDIR)

Enumerator
AP_GENERAL_PURPOSE 

General Purpose Interchange on CD-R or DVD-RAM Media (STD-GEN-CD/DVD-RAM)

AP_DEFAULT 

default application profile: GeneralPurpose

AP_GENERAL_PURPOSE_DVD 

General Purpose DVD with Compression Interchange (STD-GEN-DVD)

AP_GENERAL_PURPOSE_MIME 

General Purpose MIME Interchange Profile (STD-GEN-MIME)

AP_USB_AND_FLASH 

General Purpose USB and Flash Memory with Compression Interchange (STD-GEN-USB/MMC/CF/SD-JPEG/J2K)

AP_MPEG2_MPATML 

DVD Interchange with MPEG2 MP@ML (STD-DVD-MPEG2-MPML)

AP_BASIC_CARDIAC 

Basic Cardiac X-Ray Angiographic Studies on CD-R Media (STD-XABC-CD)

AP_XRAY_ANGIOGRAPHIC 

1024 X-Ray Angiographic Studies on CD-R Media (STD-XA1K-CD)

AP_XRAY_ANGIOGRAPHIC_DVD 

1024 X-Ray Angiographic Studies on DVD Media (STD-XA1K-DVD)

AP_DENTAL_RADIOGRAPH 

Dental Radiograph Interchange (STD-DEN-CD)

AP_CT_AND_MR 

CT/MR Studies (STD-CTMR-xxxx)

AP_ULTRASOUND_ID_SF 

Ultrasound Single Frame for Image Display (STD-US-ID-SF-xxxx)

AP_ULTRASOUND_SC_SF 

Ultrasound Single Frame with Spatial Calibration (STD-US-SC-SF-xxxx)

AP_ULTRASOUND_CC_SF 

Ultrasound Single Frame with Combined Calibration (STD-US-CC-SF-xxxx)

AP_ULTRASOUND_ID_MF 

Ultrasound Single & Multi-Frame for Image Display (STD-US-ID-MF-xxxx)

AP_ULTRASOUND_SC_MF 

Ultrasound Single & Multi-Frame with Spatial Calibration (STD-UD-SC-MF-xxxx)

AP_ULTRASOUND_CC_MF 

Ultrasound Single & Multi-Frame with Combined Calibration (STD-UD-CC-MF-xxxx)

AP_TWELVE_LEAD_ECG 

12-lead ECG Interchange on Diskette (STD-WVFM-ECG-FD)

AP_HEMODYNAMIC_WAVEFORM 

Hemodynamic Waveform Interchange on Diskette (STD-WVFM-HD-FD)

◆ NEW_INSTANCE_CREATION_POLICY

This enum is used to define when compressed or decompressed image receives a new SOP instance UID.

Note
For JPEG 2000 decoding, new UID is never created
Enumerator
CNU_ONLOSSYCOMPRESSION 

Assign new instance UID when compression is lossy.

CNU_ALWAYS 

always assign new SOP instance UID on compression and decompression This works for JPEG and RLE, not for JPEG 2000

CNU_NEVER 

never assign new SOP instance UID

◆ TRANSFER_SYNTAX

Subset of Transfer Syntaxes for saving files. The following transfer syntaxes are supported for decoding and encoding of pixel data.

See also
IDCXOBJ::Decode Other transfer syntaxes are supported as well but not for implicit conversion. For example JPEG 2000 is supported but currently only for decoding.
Enumerator
TS_OTHER 

Unknown or not supported.

TS_LEI 

Little Endian Implicit (1.2.840.10008.1.2)

TS_LEE 

Little Edian Explicit (1.2.840.10008.1.2.1)

TS_BEE 

Big Endian Explicit (1.2.840.10008.1.2.2)

TS_LOSSLESS_JPEG_DEFAULT 

Lossless Jpeg Process 14 1st order predictor (1.2.840.10008.1.2.4.70)

TS_LOSSLESS_JPEG_ANY_PREDICTOR 

Lossless Jpeg Process 14 (1.2.840.10008.1.2.4.57)

TS_JPEG 

Jpeg (Lossy) Process 1 (1.2.840.10008.1.2.4.50)

TS_RLE 

Run-Length (Lossless) Enoding (1.2.840.10008.1.2.5)

TS_JPEG_2000_LOSSLESS_ONLY 

JPEG 2000 Lossless Only (1.2.840.10008.1.2.4.90)

TS_JPEG_2000 

JPEG 2000 (Lossless or Lossy) (1.2.840.10008.1.2.4.91)

TS_JPEG_2000_P2_LOSSLESS_ONLY 

JPEG 2000 Part 2 Multi-component Image Compression (Lossless Only) (1.2.840.10008.1.2.4.92)

TS_JPEG_2000_P2 

JPEG 2000 Part 2 Multi-component Image Compression (Lossless or Lossy) (1.2.840.10008.1.2.4.93)

TS_MPEG2_MAIN_PROFILE_AT_MAIN_LEVEL 

User created (no conversion or validaion) MPEG2 Main Profile at Main Level (1.2.840.10008.1.2.4.100) Not fully implemented

TS_MPEG2_MAIN_PROFILE_AT_HIGH_LEVEL 

User created (no conversion or validaion) MPEG2 Main Profile at High Level (1.2.840.10008.1.2.4.101) Not fully implemented

TS_MPEG4 

User created (no conversion or validaion) MPEG-4 AVC/H.264 High Profile / Level 4.1 (1.2.840.10008.1.2.4.102) Not fully implemented

TS_MPEG4_BD_COMP 

User created (no conversion or validaion) MPEG-4 AVC/H.264 BD-compatible High Profile / Level 4.1 (1.2.840.10008.1.2.4.103) Not fully implemented

TS_MPEG4_4_2_2D 

User created (no conversion or validaion) MPEG-4 AVC/H.264 High Profile / Level 4.2 for 2D Video Compression (1.2.840.10008.1.2.4.104)

TS_MPEG4_4_2_3D 

User created (no conversion or validaion) MPEG-4 AVC/H.264 High Profile / Level 4.2 for 3D Video Compression (1.2.840.10008.1.2.4.105)

TS_MPEG4_4_2_STEREO 

User created (no conversion or validaion) MPEG-4 AVC/H.264 Stereo High Profile / Level 4.2 Video Compression (1.2.840.10008.1.2.4.106)

TS_HEVC_MAIN_PROFILE 

User created (no conversion or validaion) HEVC/H.265 Main Profile / Level 5.1 Video Compression (1.2.840.10008.1.2.4.107)

TS_HEVC_MAIN_10_PROFILE 

User created (no conversion or validaion) HEVC/H.265 Main 10 Profile / Level 5.1 Video Compression (1.2.840.10008.1.2.4.108)

◆ UID_TYPE

enum UID_TYPE

UID types enumeration.

See also
IDCXUID
Enumerator
UID_TYPE_OTHER 

Other (Invalid)

UID_TYPE_STUDY 

Study.

UID_TYPE_SERIES 

Series.

UID_TYPE_INSTANCE 

Instance (Image)

UID_TYPE_SCM_TRANSACTION 

Storage Commitment Transaction.

UID_TYPE_MPPS 

MPPS.