MeVisLab Toolbox Reference
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
ml::SourceFrameReference Struct Reference

Structure to collect important information of input frames. More...

#include <mlEnhancedMultiFrameTools.h>

Public Member Functions

 SourceFrameReference ()=default
 Default constructor.
 
 ~SourceFrameReference ()
 Default constructor.
 
 SourceFrameReference (DCMTree::Const_TreePtr dcmTree)
 Constructor with initialization from a DCMTree.
 
 SourceFrameReference (const SourceFrameReference &)=default
 Default copy constructor.
 
SourceFrameReference & operator= (const SourceFrameReference &)=default
 Default copy constructor.
 
void getRawTopLevelSourceFrameReferences (DCMTree::Const_TreePtr inputDcmTree, std::vector< std::string > &rawTopLevelSourceFrameInfos) const
 Return tag values given in rawTagIds from tree root and append four empty entries for non-available frame count and coordinates.
 
void setUpFromTagValueVector (const std::vector< std::string > &rawTopLevelSourceFrameReferences)
 Assigns the values of rawTopLevelSourceFrameReferences to all members of srcFrameRef in given order.
 
void getFromDCMTree (DCMTree::Const_TreePtr inputDcmTree)
 Tries to read the srcFrameRef.rawTagIds tags from inputDcmTree and to set up all members of srcFrameRef appropriately.
 

Public Attributes

std::string sopClassUID
 SOPClassUID of an input frame or image.
 
std::string fmeSOPClassUID
 If available the SOPClassUID of an input frame or image from private FME tag.
 
std::string sopInstanceUID
 SOPInstanceUID of an input frame or image.
 
std::string fmeSOPInstanceUID
 If available the SOPInstanceUID of an input frame or image from private FME tag.
 
std::string fmeIndexOfDecomposedFrame
 If available the index of decomposed frame from private FME tag.
 
std::string referencedFrameNumber
 ReferencedFrameNumber.
 
std::string referencedSegmentNumber
 ReferencedSegmentNumber.
 
std::string segmentNumber
 SegmentNumber.
 
std::string frameCounter
 Frame Counter.
 
std::string zCoord
 zCoord
 
std::string tCoord
 tCoord
 
std::string uCoord
 uCoord
 

Static Public Attributes

static const std::vector< MLuint64 > rawTagIds
 Raw tag ids matching to the order of the first seven fields which contain tag values.
 

Detailed Description

Structure to collect important information of input frames.

Definition at line 26 of file mlEnhancedMultiFrameTools.h.

Constructor & Destructor Documentation

◆ SourceFrameReference() [1/3]

ml::SourceFrameReference::SourceFrameReference ( )
default

Default constructor.

◆ ~SourceFrameReference()

ml::SourceFrameReference::~SourceFrameReference ( )
inline

Default constructor.

Definition at line 31 of file mlEnhancedMultiFrameTools.h.

◆ SourceFrameReference() [2/3]

ml::SourceFrameReference::SourceFrameReference ( DCMTree::Const_TreePtr  dcmTree)
inline

Constructor with initialization from a DCMTree.

Definition at line 34 of file mlEnhancedMultiFrameTools.h.

◆ SourceFrameReference() [3/3]

ml::SourceFrameReference::SourceFrameReference ( const SourceFrameReference &  )
default

Default copy constructor.

Member Function Documentation

◆ getFromDCMTree()

void ml::SourceFrameReference::getFromDCMTree ( DCMTree::Const_TreePtr  inputDcmTree)

Tries to read the srcFrameRef.rawTagIds tags from inputDcmTree and to set up all members of srcFrameRef appropriately.

◆ getRawTopLevelSourceFrameReferences()

void ml::SourceFrameReference::getRawTopLevelSourceFrameReferences ( DCMTree::Const_TreePtr  inputDcmTree,
std::vector< std::string > &  rawTopLevelSourceFrameInfos 
) const

Return tag values given in rawTagIds from tree root and append four empty entries for non-available frame count and coordinates.

◆ operator=()

SourceFrameReference & ml::SourceFrameReference::operator= ( const SourceFrameReference &  )
default

Default copy constructor.

◆ setUpFromTagValueVector()

void ml::SourceFrameReference::setUpFromTagValueVector ( const std::vector< std::string > &  rawTopLevelSourceFrameReferences)

Assigns the values of rawTopLevelSourceFrameReferences to all members of srcFrameRef in given order.

rawTopLevelSourceFrameReferences must have at least the number of members srcFrameRef has (except of rawTagIds).

Member Data Documentation

◆ fmeIndexOfDecomposedFrame

std::string ml::SourceFrameReference::fmeIndexOfDecomposedFrame

If available the index of decomposed frame from private FME tag.

Definition at line 53 of file mlEnhancedMultiFrameTools.h.

◆ fmeSOPClassUID

std::string ml::SourceFrameReference::fmeSOPClassUID

If available the SOPClassUID of an input frame or image from private FME tag.

Definition at line 45 of file mlEnhancedMultiFrameTools.h.

◆ fmeSOPInstanceUID

std::string ml::SourceFrameReference::fmeSOPInstanceUID

If available the SOPInstanceUID of an input frame or image from private FME tag.

Definition at line 50 of file mlEnhancedMultiFrameTools.h.

◆ frameCounter

std::string ml::SourceFrameReference::frameCounter

Frame Counter.

Definition at line 63 of file mlEnhancedMultiFrameTools.h.

◆ rawTagIds

const std::vector<MLuint64> ml::SourceFrameReference::rawTagIds
static

Raw tag ids matching to the order of the first seven fields which contain tag values.

Definition at line 72 of file mlEnhancedMultiFrameTools.h.

◆ referencedFrameNumber

std::string ml::SourceFrameReference::referencedFrameNumber

ReferencedFrameNumber.

Definition at line 56 of file mlEnhancedMultiFrameTools.h.

◆ referencedSegmentNumber

std::string ml::SourceFrameReference::referencedSegmentNumber

ReferencedSegmentNumber.

Definition at line 58 of file mlEnhancedMultiFrameTools.h.

◆ segmentNumber

std::string ml::SourceFrameReference::segmentNumber

SegmentNumber.

Definition at line 60 of file mlEnhancedMultiFrameTools.h.

◆ sopClassUID

std::string ml::SourceFrameReference::sopClassUID

SOPClassUID of an input frame or image.

Definition at line 43 of file mlEnhancedMultiFrameTools.h.

◆ sopInstanceUID

std::string ml::SourceFrameReference::sopInstanceUID

SOPInstanceUID of an input frame or image.

Definition at line 48 of file mlEnhancedMultiFrameTools.h.

◆ tCoord

std::string ml::SourceFrameReference::tCoord

tCoord

Definition at line 67 of file mlEnhancedMultiFrameTools.h.

◆ uCoord

std::string ml::SourceFrameReference::uCoord

uCoord

Definition at line 69 of file mlEnhancedMultiFrameTools.h.

◆ zCoord

std::string ml::SourceFrameReference::zCoord

zCoord

Definition at line 65 of file mlEnhancedMultiFrameTools.h.

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