MeVisLab Toolbox Reference
|
Class to dump a DCMTree DICOM message into a human-readable file. More...
Classes | |
class | CharacterSetConverter |
The class CharacterSetConverter is used for converting string values from one DICOM character set to another; character set names are those specified for the SpecificCharacterSet DICOM tag. More... | |
class | Dict |
class | DLLInit |
This class is responsible for initializing the DLL when it is loaded. More... | |
class | Dump |
class | Exception |
Exception class for DCMTree. More... | |
class | FileCache |
class | IOParameter |
Base class to wrap parameters to be used for reading/writing messages. More... | |
struct | PixelData |
Contains pixel data that is either shared/ref-counted or a direct pointer. 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 that is not part of the message itself. More... | |
class | MFPixelTag |
class | PixelDataTag |
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< CharacterSetConverter > | CharacterSetConverterPtr |
Shared pointer to a DCMTree::CharacterSetConverter. More... | |
typedef boost::shared_ptr< const CharacterSetConverter > | Const_CharacterSetConverterPtr |
typedef boost::shared_ptr< Dict > | DictPtr |
Shared pointer to a DCMTree::Dict. More... | |
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. More... | |
typedef boost::shared_ptr< const Tag > | Const_TagPtr |
typedef boost::shared_ptr< MFPixelTag > | MFPixelTagPtr |
Shared pointer to multi-frame tag. More... | |
typedef boost::shared_ptr< const MFPixelTag > | Const_MFPixelTagPtr |
typedef boost::shared_ptr< Tree > | TreePtr |
Shared pointer to a DCMTree::Tree. More... | |
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. More... | |
typedef boost::shared_ptr< const TagInfo > | Const_TagInfoPtr |
typedef std::vector< TreePtr > | TreePtrVector |
A vector of TreePtr - used for sequences. More... | |
typedef boost::shared_ptr< Value > | ValuePtr |
Shared pointer to a tag value. More... | |
typedef boost::shared_ptr< const Value > | Const_ValuePtr |
typedef boost::shared_array< unsigned char > | pixel_cont_t |
typedef boost::shared_ptr< Exception > | ExceptionPtr |
Shared pointer to a DCMTree::Exception. More... | |
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. More... | |
typedef boost::shared_ptr< TagIdVector > | TagIdVectorPtr |
A shared pointer to a vector of TagIds. More... | |
typedef boost::shared_ptr< const TagIdVector > | Const_TagIdVectorPtr |
typedef std::map< TagId, TagPtr > | TagPtrMap |
A map from tag ID to TagPtr. More... | |
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. More... | |
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. More... | |
typedef std::pair< Date, Time > | DateTime |
DateTime. More... | |
typedef std::vector< Vr > | VrVector |
typedef std::vector< Value > | ValueVector |
typedef boost::shared_ptr< Writer > | WriterPtr |
typedef boost::shared_ptr< const Writer > | Const_WriterPtr |
Functions | |
DCMTREE_EXPORT bool | isType (Vr vr, VRCType vrctype) |
Defines the mapping of VR to VRCType. More... | |
TransferSyntax | defaultTransferSyntax () |
DCMTREE_EXPORT std::string | toString (const Vr vr) |
Converts a VR to a readable string. More... | |
DCMTREE_EXPORT Vr | toVr (const std::string &vrstr) |
Converts a string to a VR. More... | |
DCMTREE_EXPORT bool | isValidVrStr (const std::string &vrstr) |
Check whether the given string could be a valid/known VR. More... | |
DCMTREE_EXPORT std::string | toString (const TransferSyntax syntax) |
Converts a transfer syntax to a readable string. More... | |
DCMTREE_EXPORT std::string | toString (const TagValueMultiplicity &mult) |
Converts a multiplicity into a readable string. More... | |
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. More... | |
std::istream & | operator>> (std::istream &in, Tree &t) |
Input operator. More... | |
template<typename T , T(Tag::*)(unsigned) const Access> | |
T | value_or (const Tree &tree, TagId id, unsigned index, T alternative) |
DCMTREE_EXPORT int | value_or (const Tree &tree, TagId id, unsigned index, int alternative) |
DCMTREE_EXPORT unsigned int | value_or (const Tree &tree, TagId id, unsigned index, unsigned int alternative) |
DCMTREE_EXPORT signed short | value_or (const Tree &tree, TagId id, unsigned index, signed short alternative) |
DCMTREE_EXPORT unsigned short | value_or (const Tree &tree, TagId id, unsigned index, unsigned short alternative) |
DCMTREE_EXPORT double | value_or (const Tree &tree, TagId id, unsigned index, double alternative) |
DCMTREE_EXPORT std::string | value_or (const Tree &tree, TagId id, unsigned index, std::string alternative) |
template<typename T > | |
T | value_or (const Tree &tree, TagId id, T alternative) |
std::ostream & | operator<< (std::ostream &out, const Value &v) |
std::istream & | operator>> (std::istream &in, Value &v) |
Class to dump a DCMTree DICOM message into a human-readable file.
This class represents a complete DICOM message, including sequences, etc.
Base class of reader implementations for DCMTree.
This class could be used as a starter to write a DCMTree::Writer subclass.
Implementations of this class have to convert from the specific character set to UTF-8.
typedef boost::shared_ptr< CharacterSetConverter > DCMTree::CharacterSetConverterPtr |
Shared pointer to a DCMTree::CharacterSetConverter.
Definition at line 34 of file DCMTree_CharacterSetConverter.h.
typedef boost::shared_ptr< const CharacterSetConverter > DCMTree::Const_CharacterSetConverterPtr |
Definition at line 35 of file DCMTree_CharacterSetConverter.h.
typedef boost::shared_ptr< const Dict > DCMTree::Const_DictPtr |
Definition at line 41 of file DCMTree_Dict.h.
typedef boost::shared_ptr<const Exception> DCMTree::Const_ExceptionPtr |
Definition at line 135 of file DCMTree_Lib.h.
typedef boost::shared_ptr<const IOParameter> DCMTree::Const_IOParameterPtr |
Definition at line 28 of file DCMTree_IOParameter.h.
typedef boost::shared_ptr<const Message> DCMTree::Const_MessagePtr |
Definition at line 71 of file DCMTree_Lib.h.
typedef boost::shared_ptr<const MFPixelTag> DCMTree::Const_MFPixelTagPtr |
Definition at line 62 of file DCMTree_Lib.h.
typedef boost::shared_ptr< const Reader > DCMTree::Const_ReaderPtr |
Definition at line 159 of file DCMTree_Lib.h.
typedef boost::shared_ptr<const StructuredMF> DCMTree::Const_StructuredMFPtr |
Definition at line 164 of file DCMTree_Lib.h.
typedef boost::shared_ptr<const TagIdVector> DCMTree::Const_TagIdVectorPtr |
Definition at line 148 of file DCMTree_Lib.h.
typedef boost::shared_ptr<const TagInfo> DCMTree::Const_TagInfoPtr |
Definition at line 76 of file DCMTree_Lib.h.
typedef boost::shared_ptr<const Tag> DCMTree::Const_TagPtr |
Definition at line 57 of file DCMTree_Lib.h.
typedef std::map<TagId,Const_TagPtr> DCMTree::Const_TagPtrMap |
Definition at line 152 of file DCMTree_Lib.h.
typedef boost::shared_ptr<Const_TagPtrMap> DCMTree::Const_TagPtrMapPtr |
Definition at line 153 of file DCMTree_Lib.h.
typedef boost::shared_ptr<const Tree> DCMTree::Const_TreePtr |
Definition at line 67 of file DCMTree_Lib.h.
typedef boost::shared_ptr<const Value> DCMTree::Const_ValuePtr |
Definition at line 85 of file DCMTree_Lib.h.
typedef boost::shared_ptr<const Writer> DCMTree::Const_WriterPtr |
Definition at line 30 of file DCMTree_Writer.h.
typedef std::pair<Date,Time> DCMTree::DateTime |
DateTime.
Definition at line 195 of file DCMTree_Lib.h.
typedef boost::shared_ptr< Dict > DCMTree::DictPtr |
Shared pointer to a DCMTree::Dict.
Definition at line 40 of file DCMTree_Dict.h.
typedef boost::shared_ptr<Exception> DCMTree::ExceptionPtr |
Shared pointer to a DCMTree::Exception.
Definition at line 134 of file DCMTree_Lib.h.
typedef boost::shared_ptr< IOParameter > DCMTree::IOParameterPtr |
Definition at line 27 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 61 of file DCMTree_Lib.h.
typedef boost::shared_array<unsigned char> DCMTree::pixel_cont_t |
Definition at line 93 of file DCMTree_Lib.h.
typedef unsigned int DCMTree::RawTagId |
Definition at line 141 of file DCMTree_Lib.h.
typedef boost::shared_ptr< Reader > DCMTree::ReaderPtr |
A shared pointer to DCMTree::Reader.
Definition at line 158 of file DCMTree_Lib.h.
typedef boost::shared_ptr<StructuredMF> DCMTree::StructuredMFPtr |
Definition at line 163 of file DCMTree_Lib.h.
typedef boost::shared_ptr<TagId> DCMTree::TagIdPtr |
Definition at line 139 of file DCMTree_Lib.h.
typedef std::pair<TagIdPtr,TagIdPtr> DCMTree::TagIdPtrPair |
Definition at line 140 of file DCMTree_Lib.h.
typedef std::vector<TagId> DCMTree::TagIdVector |
A vector of TagIds.
Definition at line 144 of file DCMTree_Lib.h.
typedef boost::shared_ptr<TagIdVector> DCMTree::TagIdVectorPtr |
A shared pointer to a vector of TagIds.
Definition at line 147 of file DCMTree_Lib.h.
typedef boost::shared_ptr<TagInfo> DCMTree::TagInfoPtr |
Shared pointer to a DCMTree::TagInfo.
Definition at line 75 of file DCMTree_Lib.h.
typedef boost::shared_ptr<Tag> DCMTree::TagPtr |
typedef std::map<TagId,TagPtr> DCMTree::TagPtrMap |
A map from tag ID to TagPtr.
Definition at line 151 of file DCMTree_Lib.h.
typedef std::pair<unsigned,unsigned> DCMTree::TagValueMultiplicity |
The multiplicity of a tag, first=min second=max.
Definition at line 167 of file DCMTree_Lib.h.
typedef boost::shared_ptr<Tree> DCMTree::TreePtr |
Shared pointer to a DCMTree::Tree.
Definition at line 66 of file DCMTree_Lib.h.
typedef std::vector<TreePtr> DCMTree::TreePtrVector |
A vector of TreePtr - used for sequences.
Definition at line 79 of file DCMTree_Lib.h.
typedef boost::shared_ptr<Value> DCMTree::ValuePtr |
Shared pointer to a tag value.
Definition at line 84 of file DCMTree_Lib.h.
typedef std::vector<Value> DCMTree::ValueVector |
Definition at line 176 of file DCMTree_Value.h.
typedef std::vector<Vr> DCMTree::VrVector |
Definition at line 207 of file DCMTree_Lib.h.
typedef boost::shared_ptr<Writer> DCMTree::WriterPtr |
Definition at line 29 of file DCMTree_Writer.h.
enum DCMTree::ErrorCode |
Error codes used for logging warnings and errors.
Enumerator | |
---|---|
NoError | |
MissingTag | |
InvalidData | |
WritingDataFailed |
Definition at line 219 of file DCMTree_Lib.h.
Enumerator | |
---|---|
TRIM_STRING | |
DO_NOT_TRIM |
Definition at line 39 of file DCMTree_Tag.h.
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.
Definition at line 273 of file DCMTree_Lib.h.
DICOM transfer syntaxes.
Definition at line 231 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 | |
UR | |
OD | |
UC | |
VRCOUNT |
Definition at line 201 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 210 of file DCMTree_Lib.h.
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 whether the given string could be a valid/known VR.
|
inline |
Definition at line 128 of file DCMTree_Message.h.
References DCMTree::Message::toStream().
|
inline |
Definition at line 514 of file DCMTree_Tag.h.
References DCMTree::Tag::toStream().
|
inline |
Definition at line 152 of file DCMTree_TagId.h.
References DCMTree::TagId::toStream().
|
inline |
Definition at line 123 of file DCMTree_TagInfo.h.
References DCMTree::TagInfo::toStream().
|
inline |
Output operator.
Definition at line 346 of file DCMTree_Tree.h.
References DCMTree::Tree::toStream().
|
inline |
Definition at line 178 of file DCMTree_Value.h.
References DCMTree::Value::toStream().
|
inline |
Definition at line 134 of file DCMTree_Message.h.
References DCMTree::Message::fromStream().
|
inline |
Definition at line 520 of file DCMTree_Tag.h.
References DCMTree::Tag::fromStream().
|
inline |
Definition at line 158 of file DCMTree_TagId.h.
References DCMTree::TagId::fromStream().
|
inline |
Definition at line 129 of file DCMTree_TagInfo.h.
References DCMTree::TagInfo::fromStream().
|
inline |
Input operator.
Definition at line 354 of file DCMTree_Tree.h.
References DCMTree::Tree::fromStream().
|
inline |
Definition at line 184 of file DCMTree_Value.h.
References DCMTree::Value::fromStream().
DCMTREE_EXPORT std::string DCMTree::toString | ( | const TagValueMultiplicity & | mult | ) |
Converts a multiplicity into a readable string.
DCMTREE_EXPORT std::string DCMTree::toString | ( | const TransferSyntax | syntax | ) |
Converts a transfer syntax to a readable string.
JPEG_LOSSLESS_NON_HIER_14 -> "JPEG_LOSSLESS_NON_HIER_14"
DCMTREE_EXPORT std::string DCMTree::toString | ( | const Vr | vr | ) |
Converts a VR to a readable string.
Referenced by ml::ConstantString::operator<().
DCMTREE_EXPORT Vr DCMTree::toVr | ( | const std::string & | vrstr | ) |
Converts a string to a VR.
Definition at line 388 of file DCMTree_Tree.h.
References value_or().
DCMTREE_EXPORT double DCMTree::value_or | ( | const Tree & | tree, |
TagId | id, | ||
unsigned | index, | ||
double | alternative | ||
) |
DCMTREE_EXPORT int DCMTree::value_or | ( | const Tree & | tree, |
TagId | id, | ||
unsigned | index, | ||
int | alternative | ||
) |
DCMTREE_EXPORT signed short DCMTree::value_or | ( | const Tree & | tree, |
TagId | id, | ||
unsigned | index, | ||
signed short | alternative | ||
) |
DCMTREE_EXPORT std::string DCMTree::value_or | ( | const Tree & | tree, |
TagId | id, | ||
unsigned | index, | ||
std::string | alternative | ||
) |
T DCMTree::value_or | ( | const Tree & | tree, |
TagId | id, | ||
unsigned | index, | ||
T | alternative | ||
) |
Definition at line 361 of file DCMTree_Tree.h.
References DCMTree::Tree::getTag(), and T.
Referenced by value_or().
DCMTREE_EXPORT unsigned int DCMTree::value_or | ( | const Tree & | tree, |
TagId | id, | ||
unsigned | index, | ||
unsigned int | alternative | ||
) |
DCMTREE_EXPORT unsigned short DCMTree::value_or | ( | const Tree & | tree, |
TagId | id, | ||
unsigned | index, | ||
unsigned short | alternative | ||
) |