class to dump a DCMTree dicom message into a human readable file this class could be used as a starter to write a DCMTree::Writer subclass More...

Classes
class	Dict
class	DLLInit
	This class is responsible for initializing the dll when it is loaded. More...
class	Dump
class	EnhancedMF
	Support for structured multi-frame (SMF) DICOM objects, not to be used. More...
class	Exception
	Exception class for DCMTree. More...
class	FileCache
class	IOParameter
	base class to wrap parameters to be used for reading/writing messages this is needed because the toolkits have different capabilities (merge needs file-names, offis seems to work with streams too etc.) More...
struct	Date
	Date class for DCMTree library. More...
struct	Time
	Time class for DCMTree library. More...
class	Message
	class to hold data of an DICOM message, which is not part of the message itself. More...
class	MFPixelTag
class	Reader
class	StructuredMF
	Support for structured multi-frame (SMF) DICOM objects. More...
class	Tag
	Class to represent one dicom tag. More...
class	TagId
	Class to wrap a tag-id. More...
class	TagInfo
	Class to carry meta-information about a specific tag. More...
class	Tree
class	Value
	Class to store tag-values. More...
class	Writer
Typedefs
typedef boost::shared_ptr< Dict >	DictPtr
	shared-pointer to a DCMTree::Dict
typedef boost::shared_ptr < const Dict >	Const_DictPtr
typedef boost::shared_ptr < IOParameter >	IOParameterPtr
typedef boost::shared_ptr < const IOParameter >	Const_IOParameterPtr
typedef boost::shared_ptr< Tag >	TagPtr
	shared-pointer to tag
typedef boost::shared_ptr < const Tag >	Const_TagPtr
typedef boost::shared_ptr < MFPixelTag >	MFPixelTagPtr
	shared-pointer to multi-frame tag
typedef boost::shared_ptr < const MFPixelTag >	Const_MFPixelTagPtr
typedef boost::shared_ptr< Tree >	TreePtr
	shared pointer to a DCMTree::Tree
typedef boost::shared_ptr < const Tree >	Const_TreePtr
typedef boost::shared_ptr < Message >	MessagePtr
typedef boost::shared_ptr < const Message >	Const_MessagePtr
typedef boost::shared_ptr < TagInfo >	TagInfoPtr
	shared pointer to a DCMTree::TagInfo
typedef boost::shared_ptr < const TagInfo >	Const_TagInfoPtr
typedef std::vector< TreePtr >	TreePtrVector
	a vector of TreePtr - used for sequences
typedef boost::shared_ptr< Value >	ValuePtr
	shared-pointer to a tag-value
typedef boost::shared_ptr < const Value >	Const_ValuePtr
typedef boost::shared_ptr < Exception >	ExceptionPtr
	shared-pointer to a DCMTree::Exception
typedef boost::shared_ptr < const Exception >	Const_ExceptionPtr
typedef boost::shared_ptr< TagId >	TagIdPtr
typedef std::pair< TagIdPtr, TagIdPtr >	TagIdPtrPair
typedef unsigned int	RawTagId
typedef std::vector< TagId >	TagIdVector
	a vector of TagIds
typedef boost::shared_ptr < TagIdVector >	TagIdVectorPtr
	a shared-pointer to a vector of TagIds
typedef boost::shared_ptr < const TagIdVector >	Const_TagIdVectorPtr
typedef std::map< TagId, TagPtr >	TagPtrMap
	a map from tag-id to TagPtr
typedef std::map< TagId, Const_TagPtr >	Const_TagPtrMap
typedef boost::shared_ptr < Const_TagPtrMap >	Const_TagPtrMapPtr
typedef boost::shared_ptr< Reader >	ReaderPtr
	a shared-pointer to DCMTree::Reader
typedef boost::shared_ptr < const Reader >	Const_ReaderPtr
typedef boost::shared_ptr < StructuredMF >	StructuredMFPtr
typedef boost::shared_ptr < const StructuredMF >	Const_StructuredMFPtr
typedef std::pair< unsigned, unsigned >	TagValueMultiplicity
	the multiplicity of a tag, first=min second=max
typedef std::pair< Date, Time >	DateTime
	DateTime.
typedef std::vector< Vr >	VrVector
typedef std::vector< Value >	ValueVector
typedef boost::shared_ptr< Writer >	WriterPtr
typedef boost::shared_ptr < const Writer >	Const_WriterPtr
Enumerations
enum	Vr { AE, AS, CS, DA, DS, DT, IS, LO, LT, PN, SH, ST, TM, UT, UI, SS, US, AT, SL, UL, FL, FD, OB, OW, OL, OF, SQ, UN, VRCOUNT }
	DICOM VR. More...
enum	VRCType { TY_String, TY_Date, TY_DateTime, TY_Time, TY_Float, TY_Double, TY_Seq, TY_Int, TY_UInt, TY_Short, TY_UShort, TY_Bin, TY_Att }
	vr interpretation in C++ More...
enum	TransferSyntax { INVALID_TRANSFER_SYNTAX, IMPLICIT_LITTLE_ENDIAN, EXPLICIT_LITTLE_ENDIAN, EXPLICIT_BIG_ENDIAN, IMPLICIT_BIG_ENDIAN, DEFLATED_EXPLICIT_LITTLE_ENDIAN, RLE, JPEG_BASELINE, JPEG_EXTENDED_2_4, JPEG_EXTENDED_3_5, JPEG_SPEC_NON_HIER_6_8, JPEG_SPEC_NON_HIER_7_9, JPEG_FULL_PROG_NON_HIER_10_12, JPEG_FULL_PROG_NON_HIER_11_13, JPEG_LOSSLESS_NON_HIER_14, JPEG_LOSSLESS_NON_HIER_15, JPEG_EXTENDED_HIER_16_18, JPEG_EXTENDED_HIER_17_19, JPEG_SPEC_HIER_20_22, JPEG_SPEC_HIER_21_23, JPEG_FULL_PROG_HIER_24_26, JPEG_FULL_PROG_HIER_25_27, JPEG_LOSSLESS_HIER_28, JPEG_LOSSLESS_HIER_29, JPEG_LOSSLESS_HIER_14, JPEG_2000_LOSSLESS_ONLY, JPEG_2000, JPEG_LS_LOSSLESS, JPEG_LS_LOSSY, MPEG2_MPML, JPEG_2000_MC_LOSSLESS_ONLY, JPEG_2000_MC }
	DICOM transfer syntaxes. More...
enum	TagSelector { AllTags, NonRoot, Owned }
	constants selecting a tag subset in a chain of incrementally modified DICOM trees. More...
Functions
DCMTREE_EXPORT bool	isType (Vr vr, VRCType vrctype)
	defines the mapping of vr to VRCType
TransferSyntax	defaultTransferSyntax ()
DCMTREE_EXPORT std::string	toString (const Vr vr)
	convert a vr to a readable string
DCMTREE_EXPORT Vr	toVr (const std::string &vrstr)
	convert a string to a vr
DCMTREE_EXPORT bool	isValidVrStr (const std::string &vrstr)
	check if the given string could be a valid/known vr
DCMTREE_EXPORT std::string	toString (const TransferSyntax syntax)
	convert a transfer-syntax to a readable string JPEG_LOSSLESS_NON_HIER_14 -> "JPEG_LOSSLESS_NON_HIER_14"
DCMTREE_EXPORT std::string	toString (const TagValueMultiplicity &mult)
	convert a multiplicity into a readable string
std::ostream &	operator<< (std::ostream &out, const Message &m)
std::istream &	operator>> (std::istream &in, Message &m)
std::ostream &	operator<< (std::ostream &out, const Tag &t)
std::istream &	operator>> (std::istream &in, Tag &t)
std::ostream &	operator<< (std::ostream &out, const TagId &t)
std::istream &	operator>> (std::istream &in, TagId &t)
std::ostream &	operator<< (std::ostream &out, const TagInfo &t)
std::istream &	operator>> (std::istream &in, TagInfo &t)
std::ostream &	operator<< (std::ostream &out, const Tree &t)
	output operator
std::istream &	operator>> (std::istream &in, Tree &t)
	input operator
std::ostream &	operator<< (std::ostream &out, const Value &v)
std::istream &	operator>> (std::istream &in, Value &v)

Detailed Description

class to dump a DCMTree dicom message into a human readable file this class could be used as a starter to write a DCMTree::Writer subclass

this class represents a complete DICOM-message, including sequences etc.

base class of reader-implementations for DCMTree

Author: Sascha Bohnenkamp development@mevisbreastcare.de
Copyright 2006 All Rights Reserved MeVis BreastCare GmbH & Co.KG Universitaetsallee 29 D-28359 Bremen phone +49 (0)421 330 74 0 fax +49 (0)421 330 74 50.

Author: Sascha Bohnenkamp development@mevisbreastcare.de
Copyright 2006 All Rights Reserved MeVis BreastCare GmbH & Co.KG Universitaetsallee 29 D-28359 Bremen phone +49 (0)421 330 74 0 fax +49 (0)421 330 74 50

Change history: 20060523 : SB initial version

Change history: 20060718 : SB initial version

Author: Sascha Bohnenkamp development@mevisbreastcare.de
Copyright 2006 All Rights Reserved MeVis BreastCare GmbH & Co.KG Universitaetsallee 29 D-28359 Bremen phone +49 (0)421 330 74 0 fax +49 (0)421 330 74 50

Change history: 20060519 : SB initial version

implementations of this class have to convert from the specific character set to UTF8

Author: Sascha Bohnenkamp development@mevisbreastcare.de
Copyright 2006 All Rights Reserved MeVis BreastCare GmbH & Co.KG Universitaetsallee 29 D-28359 Bremen phone +49 (0)421 330 74 0 fax +49 (0)421 330 74 50

Change history: 20060519 : SB initial version

Typedef Documentation

typedef boost::shared_ptr< const Dict > DCMTree::Const_DictPtr

Definition at line 50 of file DCMTree_Dict.h.

typedef boost::shared_ptr<const Exception> DCMTree::Const_ExceptionPtr

Definition at line 98 of file DCMTree_Lib.h.

typedef boost::shared_ptr<const IOParameter> DCMTree::Const_IOParameterPtr

Definition at line 39 of file DCMTree_IOParameter.h.

typedef boost::shared_ptr<const Message> DCMTree::Const_MessagePtr

Definition at line 72 of file DCMTree_Lib.h.

typedef boost::shared_ptr<const MFPixelTag> DCMTree::Const_MFPixelTagPtr

Definition at line 63 of file DCMTree_Lib.h.

typedef boost::shared_ptr< const Reader > DCMTree::Const_ReaderPtr

Definition at line 122 of file DCMTree_Lib.h.

typedef boost::shared_ptr<const StructuredMF> DCMTree::Const_StructuredMFPtr

Definition at line 127 of file DCMTree_Lib.h.

typedef boost::shared_ptr<const TagIdVector> DCMTree::Const_TagIdVectorPtr

Definition at line 111 of file DCMTree_Lib.h.

typedef boost::shared_ptr<const TagInfo> DCMTree::Const_TagInfoPtr

Definition at line 77 of file DCMTree_Lib.h.

typedef boost::shared_ptr<const Tag> DCMTree::Const_TagPtr

Definition at line 58 of file DCMTree_Lib.h.

typedef std::map<TagId,Const_TagPtr> DCMTree::Const_TagPtrMap

Definition at line 115 of file DCMTree_Lib.h.

typedef boost::shared_ptr<Const_TagPtrMap> DCMTree::Const_TagPtrMapPtr

Definition at line 116 of file DCMTree_Lib.h.

typedef boost::shared_ptr<const Tree> DCMTree::Const_TreePtr

Definition at line 68 of file DCMTree_Lib.h.

typedef boost::shared_ptr<const Value> DCMTree::Const_ValuePtr

Definition at line 86 of file DCMTree_Lib.h.

typedef boost::shared_ptr<const Writer> DCMTree::Const_WriterPtr

Definition at line 41 of file DCMTree_Writer.h.

typedef std::pair<Date,Time> DCMTree::DateTime

DateTime.

Definition at line 158 of file DCMTree_Lib.h.

typedef boost::shared_ptr< Dict > DCMTree::DictPtr

shared-pointer to a DCMTree::Dict

Definition at line 48 of file DCMTree_Dict.h.

typedef boost::shared_ptr<Exception> DCMTree::ExceptionPtr

shared-pointer to a DCMTree::Exception

Definition at line 94 of file DCMTree_Lib.h.

typedef boost::shared_ptr< IOParameter > DCMTree::IOParameterPtr

Definition at line 37 of file DCMTree_IOParameter.h.

typedef boost::shared_ptr<Message> DCMTree::MessagePtr

Definition at line 70 of file DCMTree_Lib.h.

typedef boost::shared_ptr<MFPixelTag> DCMTree::MFPixelTagPtr

shared-pointer to multi-frame tag

Definition at line 60 of file DCMTree_Lib.h.

typedef unsigned int DCMTree::RawTagId

Definition at line 104 of file DCMTree_Lib.h.

typedef boost::shared_ptr< Reader > DCMTree::ReaderPtr

a shared-pointer to DCMTree::Reader

Definition at line 118 of file DCMTree_Lib.h.

typedef boost::shared_ptr<StructuredMF> DCMTree::StructuredMFPtr

Definition at line 125 of file DCMTree_Lib.h.

typedef boost::shared_ptr<TagId> DCMTree::TagIdPtr

Definition at line 101 of file DCMTree_Lib.h.

typedef std::pair<TagIdPtr,TagIdPtr> DCMTree::TagIdPtrPair

Definition at line 103 of file DCMTree_Lib.h.

typedef std::vector<TagId> DCMTree::TagIdVector

a vector of TagIds

Definition at line 107 of file DCMTree_Lib.h.

typedef boost::shared_ptr<TagIdVector> DCMTree::TagIdVectorPtr

a shared-pointer to a vector of TagIds

Definition at line 110 of file DCMTree_Lib.h.

typedef boost::shared_ptr<TagInfo> DCMTree::TagInfoPtr

shared pointer to a DCMTree::TagInfo

Definition at line 74 of file DCMTree_Lib.h.

typedef boost::shared_ptr<Tag> DCMTree::TagPtr

shared-pointer to tag

Definition at line 54 of file DCMTree_Lib.h.

typedef std::map<TagId,TagPtr> DCMTree::TagPtrMap

a map from tag-id to TagPtr

Definition at line 114 of file DCMTree_Lib.h.

typedef std::pair<unsigned,unsigned> DCMTree::TagValueMultiplicity

the multiplicity of a tag, first=min second=max

Definition at line 130 of file DCMTree_Lib.h.

typedef boost::shared_ptr<Tree> DCMTree::TreePtr

shared pointer to a DCMTree::Tree

Definition at line 65 of file DCMTree_Lib.h.

typedef std::vector<TreePtr> DCMTree::TreePtrVector

a vector of TreePtr - used for sequences

Definition at line 80 of file DCMTree_Lib.h.

typedef boost::shared_ptr<Value> DCMTree::ValuePtr

shared-pointer to a tag-value

Definition at line 82 of file DCMTree_Lib.h.

typedef std::vector<Value> DCMTree::ValueVector

Definition at line 161 of file DCMTree_Value.h.

typedef std::vector<Vr> DCMTree::VrVector

Definition at line 170 of file DCMTree_Lib.h.

typedef boost::shared_ptr<Writer> DCMTree::WriterPtr

Definition at line 39 of file DCMTree_Writer.h.

Enumeration Type Documentation

enum DCMTree::TagSelector

constants selecting a tag subset in a chain of incrementally modified DICOM trees.

in such a chain, an incremental tree is linked to its parent tree, from which it inherits all tags that are not overwritten or deleted in the incremental tree. the root tree is the first parent in this chain, i.e. a tree that has no parent.

Enumerator:

AllTags	Select all tags from all trees in the chain that are not deleted in a successor.
NonRoot	Same as AllTags, except tags that are only contained in the root tree.
Owned	Only tags contained in the front most tree, omitting all inherited tags.

Definition at line 227 of file DCMTree_Lib.h.

enum DCMTree::TransferSyntax

DICOM transfer syntaxes.

Enumerator:

INVALID_TRANSFER_SYNTAX
IMPLICIT_LITTLE_ENDIAN
EXPLICIT_LITTLE_ENDIAN
EXPLICIT_BIG_ENDIAN
IMPLICIT_BIG_ENDIAN
DEFLATED_EXPLICIT_LITTLE_ENDIAN
RLE
JPEG_BASELINE
JPEG_EXTENDED_2_4
JPEG_EXTENDED_3_5
JPEG_SPEC_NON_HIER_6_8
JPEG_SPEC_NON_HIER_7_9
JPEG_FULL_PROG_NON_HIER_10_12
JPEG_FULL_PROG_NON_HIER_11_13
JPEG_LOSSLESS_NON_HIER_14
JPEG_LOSSLESS_NON_HIER_15
JPEG_EXTENDED_HIER_16_18
JPEG_EXTENDED_HIER_17_19
JPEG_SPEC_HIER_20_22
JPEG_SPEC_HIER_21_23
JPEG_FULL_PROG_HIER_24_26
JPEG_FULL_PROG_HIER_25_27
JPEG_LOSSLESS_HIER_28
JPEG_LOSSLESS_HIER_29
JPEG_LOSSLESS_HIER_14
JPEG_2000_LOSSLESS_ONLY
JPEG_2000
JPEG_LS_LOSSLESS
JPEG_LS_LOSSY
MPEG2_MPML
JPEG_2000_MC_LOSSLESS_ONLY
JPEG_2000_MC

Definition at line 185 of file DCMTree_Lib.h.

enum DCMTree::Vr

DICOM VR.

NOTE: Make sure that you never reorder/change these enums except for adding new VRs at the end. The enum values are used for persistent storage of the DICOM tags.

Enumerator:

AE
AS
CS
DA
DS
DT
IS
LO
LT
PN
SH
ST
TM
UT
UI
SS
US
AT
SL
UL
FL
FD
OB
OW
OL
OF
SQ
UN
VRCOUNT

Definition at line 164 of file DCMTree_Lib.h.

enum DCMTree::VRCType

vr interpretation in C++

Enumerator:

TY_String
TY_Date
TY_DateTime
TY_Time
TY_Float
TY_Double
TY_Seq
TY_Int
TY_UInt
TY_Short
TY_UShort
TY_Bin
TY_Att

Definition at line 173 of file DCMTree_Lib.h.

Function Documentation

TransferSyntax DCMTree::defaultTransferSyntax ( )

DCMTREE_EXPORT bool DCMTree::isType	(	Vr	vr,
		VRCType	vrctype
	)

defines the mapping of vr to VRCType

DCMTREE_EXPORT bool DCMTree::isValidVrStr ( const std::string & vrstr )

check if the given string could be a valid/known vr

std::ostream& DCMTree::operator<<	(	std::ostream &	out,
		const Message &	m
	)		`[inline]`

Definition at line 127 of file DCMTree_Message.h.

References DCMTree::Message::toStream().

std::ostream& DCMTree::operator<<	(	std::ostream &	out,
		const Tree &	t
	)		`[inline]`

output operator

Definition at line 336 of file DCMTree_Tree.h.

References DCMTree::Tree::toStream().

std::ostream& DCMTree::operator<<	(	std::ostream &	out,
		const Value &	v
	)		`[inline]`

Definition at line 163 of file DCMTree_Value.h.

References DCMTree::Value::toStream().

std::ostream& DCMTree::operator<<	(	std::ostream &	out,
		const Tag &	t
	)		`[inline]`

Definition at line 508 of file DCMTree_Tag.h.

References DCMTree::Tag::toStream().

std::ostream& DCMTree::operator<<	(	std::ostream &	out,
		const TagId &	t
	)		`[inline]`

Definition at line 142 of file DCMTree_TagId.h.

References DCMTree::TagId::toStream().

std::ostream& DCMTree::operator<<	(	std::ostream &	out,
		const TagInfo &	t
	)		`[inline]`

Definition at line 121 of file DCMTree_TagInfo.h.

References DCMTree::TagInfo::toStream().

std::istream& DCMTree::operator>>	(	std::istream &	in,
		Tag &	t
	)		`[inline]`

Definition at line 514 of file DCMTree_Tag.h.

References DCMTree::Tag::fromStream().

std::istream& DCMTree::operator>>	(	std::istream &	in,
		Value &	v
	)		`[inline]`

Definition at line 169 of file DCMTree_Value.h.

References DCMTree::Value::fromStream().

std::istream& DCMTree::operator>>	(	std::istream &	in,
		Message &	m
	)		`[inline]`

Definition at line 133 of file DCMTree_Message.h.

References DCMTree::Message::fromStream().

std::istream& DCMTree::operator>>	(	std::istream &	in,
		Tree &	t
	)		`[inline]`

input operator

Definition at line 344 of file DCMTree_Tree.h.

References DCMTree::Tree::fromStream().

std::istream& DCMTree::operator>>	(	std::istream &	in,
		TagInfo &	t
	)		`[inline]`

Definition at line 127 of file DCMTree_TagInfo.h.

References DCMTree::TagInfo::fromStream().

std::istream& DCMTree::operator>>	(	std::istream &	in,
		TagId &	t
	)		`[inline]`

Definition at line 148 of file DCMTree_TagId.h.

References DCMTree::TagId::fromStream().

DCMTREE_EXPORT std::string DCMTree::toString ( const Vr vr )

convert a vr to a readable string

DCMTREE_EXPORT std::string DCMTree::toString ( const TagValueMultiplicity & mult )

convert a multiplicity into a readable string

DCMTREE_EXPORT std::string DCMTree::toString ( const TransferSyntax syntax )

convert a transfer-syntax to a readable string JPEG_LOSSLESS_NON_HIER_14 -> "JPEG_LOSSLESS_NON_HIER_14"

DCMTREE_EXPORT Vr DCMTree::toVr ( const std::string & vrstr )

convert a string to a vr

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation