odil
Classes | Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
odil::BasicDirectoryCreator Class Reference

Write a Basic Directory (i.e. DICOMDIR) object to the disk. More...

#include <BasicDirectoryCreator.h>

Public Types

typedef std::pair< Tag, int > RecordKey
 The tag and its associated type in the record.
 
typedef std::map< std::string, std::vector< RecordKey > > RecordKeyMap
 Map from a record type to the extra keys.
 

Public Member Functions

 BasicDirectoryCreator (std::string const &root="", std::vector< std::string > const &files=std::vector< std::string >(), RecordKeyMap const &extra_record_keys=RecordKeyMap(), Writer::ItemEncoding item_encoding=Writer::ItemEncoding::ExplicitLength)
 
void operator() () const
 

Public Attributes

std::string root
 Root of the DICOM files and location of the output DICOMDIR file. More...
 
std::vector< std::string > files
 Path to the DICOM files, relative to root. More...
 
RecordKeyMap extra_record_keys
 User-defined record keys, classified by record type.
 
Writer::ItemEncoding item_encoding
 Encoding of sequence items, defaults to Writer::ItemEncoding::ExplicitLength.
 

Static Public Attributes

static RecordKeyMap const default_record_keys
 Default record keys, classified by record type. More...
 

Detailed Description

Write a Basic Directory (i.e. DICOMDIR) object to the disk.

Member Data Documentation

std::map< std::string, std::vector< BasicDirectoryCreator::RecordKey > > const odil::BasicDirectoryCreator::default_record_keys
static
Initial value:
= {
{ "PATIENT", {
{ registry::PatientName, 2},
{ registry::PatientID, 1 } } },
{ "STUDY", {
{ registry::StudyDate, 1 },
{ registry::StudyTime, 1 },
{ registry::StudyDescription, 2 },
{ registry::StudyInstanceUID, 1 },
{ registry::StudyID, 1 },
{ registry::AccessionNumber, 2 } } },
{ "SERIES", {
{ registry::Modality, 1 },
{ registry::SeriesInstanceUID, 1 },
{ registry::SeriesNumber, 1 },
} },
{ "IMAGE", {
{ registry::InstanceNumber, 1 },
} },
}

Default record keys, classified by record type.

std::vector<std::string> odil::BasicDirectoryCreator::files

Path to the DICOM files, relative to root.

The concatenation of root and each file must be a valid path.

std::string odil::BasicDirectoryCreator::root

Root of the DICOM files and location of the output DICOMDIR file.

The concatenation of root and each file, as well as of root and "DICOMDIR" must be a valid path.


The documentation for this class was generated from the following files: