MeVisLab Toolbox Reference
ml::DicomToMLTools::FrameSpecificValueTag< VALUE_TYPE > Struct Template Reference

A struct containing a information about a specific frame (position, tagId, tagPtr, and whether it's from tree root) as well as an associated value retrieved from the tag and the value validity. More...

#include <mlDicomSingleFrameSelectionTools.h>

Public Member Functions

 FrameSpecificValueTag ()
 Default constructor. More...
 
 FrameSpecificValueTag (const FrameSpecificValueTag &inputInfos)=default
 Default copy constructor. More...
 
FrameSpecificValueTagoperator= (const FrameSpecificValueTag &inputInfos)=default
 Default assignment operator. More...
 
 FrameSpecificValueTag (const FrameSpecificTag &frameSpecificTagIn, VALUE_TYPE valueIn, bool valueIsValidIn)
 Convenience constructor, initializing all members. More...
 
template<typename GET_VALUE_FUNC_TYPE >
void getFrameSpecificValueTag (const DCMTree::StructuredMF &smfTree, const unsigned int z, const unsigned int t, const unsigned int u, const DCMTree::RawTagId rawTagId, const GET_VALUE_FUNC_TYPE &getTagValueFunc)
 Get a tag with if tagId from a given subtree in smfTree at (z,t,u) by using the getTagValueFunc as access fucntion. More...
 

Public Attributes

FrameSpecificTag frameSpecificTag
 Tag information. More...
 
VALUE_TYPE value
 The possibly retrieved value. More...
 
bool valueIsValid = false
 Value is valid if true, otherwise not. More...
 

Detailed Description

template<typename VALUE_TYPE>
struct ml::DicomToMLTools::FrameSpecificValueTag< VALUE_TYPE >

A struct containing a information about a specific frame (position, tagId, tagPtr, and whether it's from tree root) as well as an associated value retrieved from the tag and the value validity.

Definition at line 187 of file mlDicomSingleFrameSelectionTools.h.

Constructor & Destructor Documentation

◆ FrameSpecificValueTag() [1/3]

template<typename VALUE_TYPE >
ml::DicomToMLTools::FrameSpecificValueTag< VALUE_TYPE >::FrameSpecificValueTag ( )
inline

Default constructor.

Definition at line 189 of file mlDicomSingleFrameSelectionTools.h.

◆ FrameSpecificValueTag() [2/3]

template<typename VALUE_TYPE >
ml::DicomToMLTools::FrameSpecificValueTag< VALUE_TYPE >::FrameSpecificValueTag ( const FrameSpecificValueTag< VALUE_TYPE > &  inputInfos)
inlinedefault

Default copy constructor.

◆ FrameSpecificValueTag() [3/3]

template<typename VALUE_TYPE >
ml::DicomToMLTools::FrameSpecificValueTag< VALUE_TYPE >::FrameSpecificValueTag ( const FrameSpecificTag frameSpecificTagIn,
VALUE_TYPE  valueIn,
bool  valueIsValidIn 
)
inline

Convenience constructor, initializing all members.

Definition at line 198 of file mlDicomSingleFrameSelectionTools.h.

Member Function Documentation

◆ getFrameSpecificValueTag()

template<typename VALUE_TYPE >
template<typename GET_VALUE_FUNC_TYPE >
void ml::DicomToMLTools::FrameSpecificValueTag< VALUE_TYPE >::getFrameSpecificValueTag ( const DCMTree::StructuredMF smfTree,
const unsigned int  z,
const unsigned int  t,
const unsigned int  u,
const DCMTree::RawTagId  rawTagId,
const GET_VALUE_FUNC_TYPE &  getTagValueFunc 
)
inline

Get a tag with if tagId from a given subtree in smfTree at (z,t,u) by using the getTagValueFunc as access fucntion.

Definition at line 205 of file mlDicomSingleFrameSelectionTools.h.

Referenced by ml::DicomToMLTools::getFrameSpecificDoubleTag(), and ml::DicomToMLTools::getFrameSpecificStringTag().

◆ operator=()

template<typename VALUE_TYPE >
FrameSpecificValueTag& ml::DicomToMLTools::FrameSpecificValueTag< VALUE_TYPE >::operator= ( const FrameSpecificValueTag< VALUE_TYPE > &  inputInfos)
inlinedefault

Default assignment operator.

Member Data Documentation

◆ frameSpecificTag

template<typename VALUE_TYPE >
FrameSpecificTag ml::DicomToMLTools::FrameSpecificValueTag< VALUE_TYPE >::frameSpecificTag

Tag information.

Definition at line 226 of file mlDicomSingleFrameSelectionTools.h.

◆ value

template<typename VALUE_TYPE >
VALUE_TYPE ml::DicomToMLTools::FrameSpecificValueTag< VALUE_TYPE >::value

The possibly retrieved value.

Definition at line 229 of file mlDicomSingleFrameSelectionTools.h.

◆ valueIsValid

template<typename VALUE_TYPE >
bool ml::DicomToMLTools::FrameSpecificValueTag< VALUE_TYPE >::valueIsValid = false

Value is valid if true, otherwise not.

Definition at line 232 of file mlDicomSingleFrameSelectionTools.h.


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