Definitions

ageUnit_t

enum imebra::ageUnit_t

Used by setAge() and getAge() to specify the unit of the age value.

Values:

days = 'D'

the age value is in days

weeks = 'W'

the age value is in weeks

months = 'M'

the age value is in months

years = 'Y'

the age value is in years

imageQuality_t

enum imebra::imageQuality_t

This enumeration specifies the quality of the compressed image when a lossy compression format is used.

Values:

veryHigh = 0

the image is saved with very high quality. No subsampling is performed and no quantization

high = 100

the image is saved with high quality. No subsampling is performed. Quantization ratios are low

aboveMedium = 200

the image is saved in medium quality. Horizontal subsampling is applied. Quantization ratios are low

medium = 300

the image is saved in medium quality. Horizontal subsampling is applied. Quantization ratios are medium

belowMedium = 400

the image is saved in medium quality. Horizontal and vertical subsampling are applied. Quantization ratios are medium

low = 500

the image is saved in low quality. Horizontal and vertical subsampling are applied. Quantization ratios are higher than the ratios used in the belowMedium quality

veryLow = 600

the image is saved in low quality. Horizontal and vertical subsampling are applied. Quantization ratios are high

bitDepth_t

enum imebra::bitDepth_t

Defines the size (in bytes) of the memory allocated for each pixel’s color component and its representation (signed/unsigned).

This enumeration does not specify the highest bit used: in order to retrieve the highest used bit call Image::getHighBit().

The lower bit of the enumerations is 1 if it represents a signed depth, 0 if it represents an unsigned depth,

Values:

depthU8 = 0

Unsigned byte.

depthS8 = 1

Signed byte.

depthU16 = 2

Unsigned word (2 bytes)

depthS16 = 3

Signed word (2 bytes)

depthU32 = 4

Unsigned double word (4 bytes)

depthS32 = 5

Signed double word (4 bytes)

directoryRecordType_t

enum imebra::directoryRecordType_t

Specifies the directory item’s type.

Values:

patient
study
series
image
overlay
modality_lut
voi_lut
curve
topic
visit
results
interpretation
study_component
stored_print
rt_dose
rt_structure_set
rt_plan
rt_treat_record
presentation
waveform
sr_document
key_object_doc
spectroscopy
raw_data
registration
fiducial
mrdr
endOfDirectoryRecordTypes

codecType_t

enum imebra::codecType_t

Defines the data stream & images codec.

Values:

dicom

DICOM codec.

jpeg

JPEG codec.

tagVR_t

enum imebra::tagVR_t

Enumerates the DICOM VRs (data types).

Values:

AE = 0x4145

Application Entity.

AS = 0x4153

Age String.

AT = 0x4154

Attribute Tag.

CS = 0x4353

Code String.

DA = 0x4441

Date.

DS = 0x4453

Decimal String.

DT = 0x4454

Date Time.

FL = 0x464c

Floating Point Single.

FD = 0x4644

Floating Point Double.

IS = 0x4953

Integer String.

LO = 0x4c4f

Long String.

LT = 0x4c54

Long Text.

OB = 0x4f42

Other Byte String.

SB = 0x5342

Non standard. Used internally for signed bytes.

OD = 0x4f44

Other Double String.

OF = 0x4f46

Other Float String.

OL = 0x4f4c

Other Long String.

OW = 0x4f57

Other Word String.

PN = 0x504e

Person Name.

SH = 0x5348

Short String.

SL = 0x534c

Signed Long.

SQ = 0x5351

Sequence of Items.

SS = 0x5353

Signed Short.

ST = 0x5354

Short Text.

TM = 0x544d

Time.

UC = 0x5543

Unlimited characters.

UI = 0x5549

Unique Identifier.

UL = 0x554c

Unsigned Long.

UN = 0x554e

Unknown.

UR = 0x5552

Unified Resource Identifier.

US = 0x5553

Unsigned Short.

UT = 0x5554

Unlimited Text.

fileParts_t

typedef std::vector<std::string> imebra::fileParts_t

drawBitmapType_t

enum imebra::drawBitmapType_t

Defines the type of the bitmap generated by DrawBitmap.

Values:

drawBitmapRGB = 0

Generates a BMP image where each pixel contains 3 bytes (R, G and B)

drawBitmapBGR = 1

Generates a BMP image where each pixel contains 3 bytes (B, G and R)

drawBitmapRGBA = 2

Generates a BMP image where each pixel contains 4 bytes (R, G, B and A)

drawBitmapBGRA = 3

Generates a BMP image where each pixel contains 4 bytes (B, G, R and A)

Age

struct Age

Specifies an age, in days, weeks, months or years.

Public Functions

Age(std::uint32_t initialAge, ageUnit_t initialUnits)

Constructor.

Parameters
  • initialAge: the initial age to assign to the object, in days, weeks, months or years, depending on the parameter initialUnits
  • initialUnits: the units of the value in initialAge

double years() const

Return the age in years.

Return
the stored age converted to years.

Public Members

std::uint32_t age

The age, in days, weeks, months or years according to units.

ageUnit_t units

The units of the value in age.

Date

struct Date

Stores a Date, Time or Date/Time value.

Public Functions

Date(const std::uint32_t initialYear, const std::uint32_t initialMonth, const std::uint32_t initialDay, const std::uint32_t initialHour, const std::uint32_t initialMinutes, const std::uint32_t initialSeconds, const std::uint32_t initialNanoseconds, const std::int32_t initialOffsetHours, const std::int32_t initialOffsetMinutes)

Constructor.

Initialize the Date structure with the specified values.

Parameters
  • initialYear: year (0 = unused)
  • initialMonth: month (1…12, 0 = unused)
  • initialDay: day of the month (1…31, 0 = unused)
  • initialHour: hour (0…23)
  • initialMinutes: minutes (0…59)
  • initialSeconds: seconds (0…59)
  • initialNanoseconds: nanoseconds
  • initialOffsetHours: hours offset from UTC
  • initialOffsetMinutes: minutes offset from UTC

Public Members

std::uint32_t year

Year (0 = unused)

std::uint32_t month

Month (1…12, 0 = unused)

std::uint32_t day

Day (1…12, 0 = unused)

std::uint32_t hour

Hours.

std::uint32_t minutes

Minutes.

std::uint32_t seconds

Seconds.

std::uint32_t nanoseconds

Nanoseconds.

std::int32_t offsetHours

Offset hours from UTC.

std::int32_t offsetMinutes

Offset minutes from UTC.

VOIDescription

struct VOIDescription

Stores a VOI Description and Settings.

The VOI settings can be retrieved from a DataSet with DataSet::getVOIs(), which returns all the VOI settings registered in the DataSet.

Once retrieved, the VOI center and width can be passed to the VOILUT transform that apply the VOI settings to an Image.

Public Members

double center

The VOI center.

double width

The VOI width.

std::wstring description

The VOI’s description.

vois_t

typedef std::vector<VOIDescription> imebra::vois_t

A collection of VOI settings.

The VOI settings registered in the dataset can be retrieved with DataSet::getVOIs().

dimseCommandType_t

enum imebra::dimseCommandType_t

DIMSE command types.

Values:

cStore = 0x1

C-STORE.

cGet = 0x10

C-GET.

cFind = 0x20

C-FIND.

cMove = 0x21

C-MOVE.

cCancel = 0xfff

C-CANCEL.

cEcho = 0x30

C-ECHO.

nEventReport = 0x100

N-EVENT_REPORT.

nGet = 0x110

N-GET.

nSet = 0x120

N-SET.

nAction = 0x130

N-ACTION.

nCreate = 0x140

N-CREATE.

nDelete = 0x150

N-DELETE.

response = 0x8000

Bit set for response messages.

dimseCommandPriority_t

enum imebra::dimseCommandPriority_t

DIMSE command priorities.

Values:

low = 0x2

Low priority.

medium = 0

Medium priority.

high = 0x1

High priority.

dimseStatusCode_t

enum imebra::dimseStatusCode_t

The DICOM response status code.

Values:

success = 0

Success.

unsupportedOptionalAttributes = 0x0001

Requested optional Attributes are not supported.

cannotUpdateperformedProcedureStepObject = 0x0110

Performed Procedure Step Object may no longer be updated.

unsupportedSOPClass = 0x0122

SOP Class not Supported.

outOfResources = 0xa700

Refused: Out of resources.

outOfResourcesCannotCalculateNumberOfMatches = 0xa701

Refused: Out of Resources - Unable to calculate number of matches.

outOfResourcesCannotPerformSubOperations = 0xa702

Refused: Out of Resources - Unable to perform sub-operations.

moveDestinationUnknown = 0xa801

Refused: Move Destination unknown.

identifierDoesNotMatchSOPClass = 0xa900

Identifier does not match SOP Class.

subOperationCompletedWithErrors = 0xb000

Sub-operations Complete - One or more Failures.

elementDiscarded = 0xb006

Element discarded.

datasetDoesNotMatchSOPClass = 0xb007

Data Set does not match SOP Class.

UPSAlreadyCanceled = 0xb304

The UPS is already in the requested state of CANCELED.

coercedInvalidValuesToValidValues = 0xb305

Coerced invalid values to valid values.

UPSStateAlreadyCompleted = 0xb306

The UPS is already in the requested state of COMPLETED.

unableToProcess = 0xc000

Unable to process.

moreThanOneMatchFound = 0xc100

More than one match found,.

CannotSupportRequestedTemplate = 0xc200

Unable to support requested template.

UPSNotUpdated = 0xc300

Refused: The UPS may no longer be updated.

transactionUIDNotProvided = 0xc301

Refused: The correct Transaction UID was not provided.

UPSAlreadyInProgress = 0xc302

Refused: The UPS is already IN PROGRESS.

canScheduleOnlyWithNCreate = 0xc303

Refused: The UPS may only become SCHEDULED via N-CREATE, not N-SET or N-ACTION.

UPSCannotChangeState = 0xc304

Refused: The UPS has not met final state requirements for the requested state change.

instanceUIDDoesNotExist = 0xc307

Specified SOP Instance UID does not exist or is not a UPS Instance managed by this SCP.

unknownAETitle = 0xc308

Receiving AE-TITLE is Unknown to this SCP.

UPSNotSchedule = 0xc309

Refused: The provided value of UPS State was not SCHEDULED.

UPSNotInProgress = 0xc310

Refused: The UPS is not yet in the “IN PROGRESS” state.

UPSAlreadyCompleted = 0xc311

Refused: The UPS is already COMPLETED.

performerCannotBeContacted = 0xc312

Refused: The performer cannot be contacted.

performerDoesNotCancel = 0xc313

Refused: Performer chooses not to cancel.

unappropriateActionForInstance = 0xc314

Refused: Specified action not appropriate for specified instance.

SCPDoesNotSupportEventReports = 0xc315

Refused: SCP does not support Event Reports.

canceled = 0xfe00

Terminated due to Cancel request.

pending = 0xff00

Pending.

pendingWithWarnings = 0xff01

Pending with warnings.

dimseStatus_t

enum imebra::dimseStatus_t

Simplified DIMSE response status code, derived from dimseStatusCode_t.

Values:

success

The operation was completed succesfully.

warning

The operation was completed with warnings.

failure

The operation failed.

cancel

The operation was canceled.

pending

The operation is still running.

attributeIdentifierList_t

typedef std::vector<tagId_t> imebra::attributeIdentifierList_t

List of tag ids.