MeVisLab Toolbox Reference
ml::GDCMPrivateDICOMTagDecoders Class Reference

Class decoding private Siemens CSA header information with the help of an adapted gdcm::CSADecoder tool class. More...

#include <mlGDCMPrivateDICOMTagDecoders.h>

Inheritance diagram for ml::GDCMPrivateDICOMTagDecoders:
ml::PrivateDICOMTagDecoderPluginBase ml::Base

Public Member Functions

 GDCMPrivateDICOMTagDecoders ()
 Constructor doing nothing. More...
 
PrivateDICOMTagDecoderPluginBase::DecodeStates decodePrivateTag (const std::string &privateCreator, DCMTree::Const_TagPtr tagPtr, PrivateDICOMTagValueFields &resultFields) override
 If a CSA header tag is passed then this routine converts its data elements to fields in resultFields container. More...
 
- Public Member Functions inherited from ml::PrivateDICOMTagDecoderPluginBase
 PrivateDICOMTagDecoderPluginBase (PrivateCreatorIdMap *privateCreatorMap=nullptr)
 Default constructor implementation creating a link symbol to make this base class always linked. More...
 
 ~PrivateDICOMTagDecoderPluginBase () override
 Virtual destructor. More...
 
PrivateCreatorIdMapgetPrivateCreatorMap () const
 Returns the map which stores a set of known private creators, typically from the currently traversed DICOM tree. More...
 
void setPrivateCreatorMap (PrivateCreatorIdMap *pcm)
 Sets the map which stores a set of known private creators, typically from the currently traversed DICOM tree. More...
 
- Public Member Functions inherited from ml::Base
 Base ()
 Constructor. More...
 
virtual ~Base ()
 Destructor. More...
 
virtual BasedeepCopy () const
 Set addStateToTree version number that can be accessed via getAddStateVersion() More...
 
bool isOfAllowedType (const std::vector< const RuntimeType * > &types) const
 Check if this object's type is equal to or derived from one of the types given in the argument. More...
 
virtual bool isRefCountedBase () const
 Returns if the instance is derived from RefCountedBase. More...
 
virtual std::string detailString () const
 Return a string describing this object. More...
 
virtual bool implementsPersistence (PersistenceInterface) const
 Override this method to declare which persistence interfaces are implemented by your derived class. More...
 
virtual std::string persistentState () const
 Returns a string describing the object's internal state. More...
 
virtual void setPersistentState (const std::string &state)
 Restores the object's internal state from a string that had been previously generated using persistentState(). More...
 
virtual void addStateToTree (TreeNode *) const
 Attaches the object state as children of the given parent node. More...
 
virtual void readStateFromTree (TreeNode *)
 Reads the object state from the children of the given parent node. More...
 
virtual void writeTo (AbstractPersistenceOutputStream *) const
 Write the objects state to the data stream object. More...
 
virtual void readFrom (AbstractPersistenceInputStream *, int)
 Read the objects state from the data stream object. More...
 

Additional Inherited Members

- Public Types inherited from ml::PrivateDICOMTagDecoderPluginBase
enum  DecodeStates { NOT_DECODED = 0 , PARTIALLY_DECODED , FULLY_DECODED }
 Return states of decoding. More...
 
typedef std::map< DCMTree::RawTagId, std::string > PrivateCreatorIdMap
 A type storing tag group ids for strings found in private tags (tags with odd numbers and id 0x10-0xFF). More...
 
- Public Types inherited from ml::Base
enum  PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
 This enum describes the different persistence interfaces available. More...
 
- Protected Member Functions inherited from ml::Base
virtual char * getPersistentState () const
 Returns a C string describing the object's internal state. More...
 
virtual void setPersistentState (const char *)
 Restores the object's internal state from a string that had been previously generated using getPersistentState(). More...
 
virtual void clearPersistentState (char *) const
 Disposes a string previously allocated by getPersistentState(). More...
 

Detailed Description

Class decoding private Siemens CSA header information with the help of an adapted gdcm::CSADecoder tool class.

Definition at line 22 of file mlGDCMPrivateDICOMTagDecoders.h.

Constructor & Destructor Documentation

◆ GDCMPrivateDICOMTagDecoders()

ml::GDCMPrivateDICOMTagDecoders::GDCMPrivateDICOMTagDecoders ( )

Constructor doing nothing.

Member Function Documentation

◆ decodePrivateTag()

PrivateDICOMTagDecoderPluginBase::DecodeStates ml::GDCMPrivateDICOMTagDecoders::decodePrivateTag ( const std::string &  privateCreator,
DCMTree::Const_TagPtr  tagPtr,
PrivateDICOMTagValueFields resultFields 
)
overridevirtual

If a CSA header tag is passed then this routine converts its data elements to fields in resultFields container.

The privateCreator must be a "SIEMENS CSA HEADER" one.

Parameters
privateCreatorA string with the name of the private creator this tags belongs to.
tagPtrThe tag whose value shall be decoded.
resultFieldsThe field container to be filled with extracted information from tagPtr or returned empty if no data could be decoded.
Returns
PrivateDICOMTagDecoderPluginBase::NOT_DECODED if the tag could not be decoded, PrivateDICOMTagDecoderPluginBase::PARTIALLY_DECODED if some of the tag value components were decoded or PrivateDICOMTagDecoderPluginBase::FULLY_DECODED if entire tag value could be decoded.

Implements ml::PrivateDICOMTagDecoderPluginBase.


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