MeVisLab Toolbox Reference
ml::ContributingEquipmentSettings Struct Reference

Helper class to inherit, buffer and set an entry of a Contributing Equipment Sequence (0018,A001), see C.12.1 SOP Common Module. More...

#include <mlDicomContributingEquipmentSettings.h>

Public Member Functions

 ContributingEquipmentSettings (DCMTree::Const_TreePtr inputTree)
 Constructor initializing all members from inputTree as far as possible, all others are set to nullptr. More...
 
void appendTo (DCMTree::TreePtr dcmTree, const std::string &purposeOfReferenceCodeSequenceCodeValue="109106", const std::string &purposeOfReferenceCodeSequenceCodingScheme="DCM", const std::string &purposeOfReferenceCodeSequenceCodeMeaning="Enhanced Multi-frame Conversion Equipment", const std::string &contributionDescriptionValue="Legacy Enhanced Image created from Classic Images")
 Ignore call if dcmTree is nullptr; otherwise copy (or if nullptr create) a contributingEquipmentSequence from in dcmTree and append a new item which is filled as far as possible with members, PurposeOfReferenceCodeSequence and ContributionDescription are set up with given arguments, respectively; throws DCMTree::Exceptions on any failure. More...
 

Static Public Member Functions

static DCMTree::TagPtr copyFrom (DCMTree::Const_TreePtr inputTree, DCMTree::RawTagId tagId)
 Helper to copy tags from inputTree if possible or return nullptr if not available. More...
 
static void copyTo (DCMTree::Const_TagPtr tagPtr, DCMTree::TreePtr outTree)
 Helper to copy tagPtr to outTree if tagPtr and outTree are valid otherwise it does nothing. More...
 

Public Attributes

DCMTree::TagPtr contributingEquipmentSequence
 Type 3 but "The new Composite Instance shall contain the Contributing Equipment Sequence (0018,A001)" e.g. More...
 
DCMTree::TreePtr recentlyAddedContributingEquipmentSequenceItem
 Stores the most recently added item to the ContributingEquipmentSequence. More...
 
DCMTree::TagPtr purposeOfReferenceCodeSequence
 Tag(s) of an item of Contributing Equipment Sequence (0018,A001), see C.12.1 SOP Common Module. More...
 
DCMTree::TagPtr manufacturer
 
DCMTree::TagPtr institutionName
 
DCMTree::TagPtr institutionAddress
 
DCMTree::TagPtr stationName
 
DCMTree::TagPtr institutionalDepartmentName
 
DCMTree::TagPtr institutionalDepartmentTypeCodeSequence
 
DCMTree::TagPtr operatorsName
 
DCMTree::TagPtr operatorIdentificationSequence
 
DCMTree::TagPtr manufacturersModelName
 
DCMTree::TagPtr deviceSerialNumber
 
DCMTree::TagPtr softwareVersions
 
DCMTree::TagPtr spatialResolution
 
DCMTree::TagPtr dateOfLastCalibration
 
DCMTree::TagPtr timeOfLastCalibration
 
DCMTree::TagPtr contributionDateTime
 
DCMTree::TagPtr contributionDescription
 

Detailed Description

Helper class to inherit, buffer and set an entry of a Contributing Equipment Sequence (0018,A001), see C.12.1 SOP Common Module.

Definition at line 21 of file mlDicomContributingEquipmentSettings.h.

Constructor & Destructor Documentation

◆ ContributingEquipmentSettings()

ml::ContributingEquipmentSettings::ContributingEquipmentSettings ( DCMTree::Const_TreePtr  inputTree)

Constructor initializing all members from inputTree as far as possible, all others are set to nullptr.

Member Function Documentation

◆ appendTo()

void ml::ContributingEquipmentSettings::appendTo ( DCMTree::TreePtr  dcmTree,
const std::string &  purposeOfReferenceCodeSequenceCodeValue = "109106",
const std::string &  purposeOfReferenceCodeSequenceCodingScheme = "DCM",
const std::string &  purposeOfReferenceCodeSequenceCodeMeaning = "Enhanced Multi-frame Conversion Equipment",
const std::string &  contributionDescriptionValue = "Legacy Enhanced Image created from Classic Images" 
)

Ignore call if dcmTree is nullptr; otherwise copy (or if nullptr create) a contributingEquipmentSequence from in dcmTree and append a new item which is filled as far as possible with members, PurposeOfReferenceCodeSequence and ContributionDescription are set up with given arguments, respectively; throws DCMTree::Exceptions on any failure.

The newly created item is stored in recentlyAddedContributingEquipmentSequenceItem to allow later access.

◆ copyFrom()

static DCMTree::TagPtr ml::ContributingEquipmentSettings::copyFrom ( DCMTree::Const_TreePtr  inputTree,
DCMTree::RawTagId  tagId 
)
static

Helper to copy tags from inputTree if possible or return nullptr if not available.

◆ copyTo()

static void ml::ContributingEquipmentSettings::copyTo ( DCMTree::Const_TagPtr  tagPtr,
DCMTree::TreePtr  outTree 
)
static

Helper to copy tagPtr to outTree if tagPtr and outTree are valid otherwise it does nothing.

Member Data Documentation

◆ contributingEquipmentSequence

DCMTree::TagPtr ml::ContributingEquipmentSettings::contributingEquipmentSequence

Type 3 but "The new Composite Instance shall contain the Contributing Equipment Sequence (0018,A001)" e.g.

on LegacyEnhanced creation according to PS3.4 "C.3.5 New Instance Creation for Enhanced Multi-Frame Image Conversion".

Definition at line 48 of file mlDicomContributingEquipmentSettings.h.

◆ contributionDateTime

DCMTree::TagPtr ml::ContributingEquipmentSettings::contributionDateTime

Definition at line 69 of file mlDicomContributingEquipmentSettings.h.

◆ contributionDescription

DCMTree::TagPtr ml::ContributingEquipmentSettings::contributionDescription

Definition at line 70 of file mlDicomContributingEquipmentSettings.h.

◆ dateOfLastCalibration

DCMTree::TagPtr ml::ContributingEquipmentSettings::dateOfLastCalibration

Definition at line 67 of file mlDicomContributingEquipmentSettings.h.

◆ deviceSerialNumber

DCMTree::TagPtr ml::ContributingEquipmentSettings::deviceSerialNumber

Definition at line 64 of file mlDicomContributingEquipmentSettings.h.

◆ institutionAddress

DCMTree::TagPtr ml::ContributingEquipmentSettings::institutionAddress

Definition at line 57 of file mlDicomContributingEquipmentSettings.h.

◆ institutionalDepartmentName

DCMTree::TagPtr ml::ContributingEquipmentSettings::institutionalDepartmentName

Definition at line 59 of file mlDicomContributingEquipmentSettings.h.

◆ institutionalDepartmentTypeCodeSequence

DCMTree::TagPtr ml::ContributingEquipmentSettings::institutionalDepartmentTypeCodeSequence

Definition at line 60 of file mlDicomContributingEquipmentSettings.h.

◆ institutionName

DCMTree::TagPtr ml::ContributingEquipmentSettings::institutionName

Definition at line 56 of file mlDicomContributingEquipmentSettings.h.

◆ manufacturer

DCMTree::TagPtr ml::ContributingEquipmentSettings::manufacturer

Definition at line 55 of file mlDicomContributingEquipmentSettings.h.

◆ manufacturersModelName

DCMTree::TagPtr ml::ContributingEquipmentSettings::manufacturersModelName

Definition at line 63 of file mlDicomContributingEquipmentSettings.h.

◆ operatorIdentificationSequence

DCMTree::TagPtr ml::ContributingEquipmentSettings::operatorIdentificationSequence

Definition at line 62 of file mlDicomContributingEquipmentSettings.h.

◆ operatorsName

DCMTree::TagPtr ml::ContributingEquipmentSettings::operatorsName

Definition at line 61 of file mlDicomContributingEquipmentSettings.h.

◆ purposeOfReferenceCodeSequence

DCMTree::TagPtr ml::ContributingEquipmentSettings::purposeOfReferenceCodeSequence

Tag(s) of an item of Contributing Equipment Sequence (0018,A001), see C.12.1 SOP Common Module.

Definition at line 54 of file mlDicomContributingEquipmentSettings.h.

◆ recentlyAddedContributingEquipmentSequenceItem

DCMTree::TreePtr ml::ContributingEquipmentSettings::recentlyAddedContributingEquipmentSequenceItem

Stores the most recently added item to the ContributingEquipmentSequence.

Definition at line 51 of file mlDicomContributingEquipmentSettings.h.

◆ softwareVersions

DCMTree::TagPtr ml::ContributingEquipmentSettings::softwareVersions

Definition at line 65 of file mlDicomContributingEquipmentSettings.h.

◆ spatialResolution

DCMTree::TagPtr ml::ContributingEquipmentSettings::spatialResolution

Definition at line 66 of file mlDicomContributingEquipmentSettings.h.

◆ stationName

DCMTree::TagPtr ml::ContributingEquipmentSettings::stationName

Definition at line 58 of file mlDicomContributingEquipmentSettings.h.

◆ timeOfLastCalibration

DCMTree::TagPtr ml::ContributingEquipmentSettings::timeOfLastCalibration

Definition at line 68 of file mlDicomContributingEquipmentSettings.h.


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