A struct containing a information about a specific frame (position, tagId, tagPtr, and whether it's from tree root). More...

#include <mlDicomSingleFrameSelectionTools.h>

Public Member Functions
	FrameSpecificTag ()
	Default constructor. More...

	FrameSpecificTag (const DCMTree::StructuredMF::IndexVector &posIn, DCMTree::RawTagId rawTagIdIn=0, DCMTree::Const_TagPtr tagPtrIn=DCMTree::Const_TagPtr(), bool isFromRootIn=false)
	Convenience constructor, posIn must have three entries. More...

	FrameSpecificTag (const FrameSpecificTag &inputInfos)=default
	Default copy constructor. More...

FrameSpecificTag &	operator= (const FrameSpecificTag &inputInfos)=default
	Default assignment operator. More...

void	setPos (unsigned int z, unsigned int t, unsigned int u)
	Sets pos to the three components z, t, and u. More...

void	setUpFrameSpecificTagInfos (const DCMTree::StructuredMF &smfTree, bool doFrameExistsAtPosCheck=true, bool frameExistsAtPosIn=false)
	Sets up tagPtr and isFromRoot by using corresponding information from smfTree, pos, and rawTagId in this; if doFrameExistsAtPosCheck is true then smfTree.frameExists(pos) is calculated to determine whether framne at pos exists in smfTree, otherwise frameExistsAtPosIn is used trusting in its validity to optimize multiple frame accesses on same frames. More...

Public Attributes
DCMTree::StructuredMF::IndexVector	pos
	The position of the tag in the frame tree; must always be scaled to 3 components. More...

DCMTree::RawTagId	tagId = 0
	The RawId (unsigned 32 bit) of the tag. More...

DCMTree::Const_TagPtr	tagPtr
	The ConstTagPtr to the tag. More...

bool	isFromRoot = false
	A flag indicating that the tag was retrieved from root of tree if true. More...

Detailed Description

A struct containing a information about a specific frame (position, tagId, tagPtr, and whether it's from tree root).

Definition at line 31 of file mlDicomSingleFrameSelectionTools.h.

Constructor & Destructor Documentation

◆ FrameSpecificTag() [1/3]

ml::DicomToMLTools::FrameSpecificTag::FrameSpecificTag ( )

inline

Default constructor.

Definition at line 33 of file mlDicomSingleFrameSelectionTools.h.

◆ FrameSpecificTag() [2/3]

ml::DicomToMLTools::FrameSpecificTag::FrameSpecificTag	(	const DCMTree::StructuredMF::IndexVector &	posIn,
		DCMTree::RawTagId	rawTagIdIn = `0`,
		DCMTree::Const_TagPtr	tagPtrIn = `DCMTree::Const_TagPtr()`,
		bool	isFromRootIn = `false`
	)

inline

Convenience constructor, posIn must have three entries.

Definition at line 42 of file mlDicomSingleFrameSelectionTools.h.

◆ FrameSpecificTag() [3/3]

ml::DicomToMLTools::FrameSpecificTag::FrameSpecificTag ( const FrameSpecificTag & inputInfos )

inlinedefault

Default copy constructor.

Member Function Documentation

◆ operator=()

FrameSpecificTag& ml::DicomToMLTools::FrameSpecificTag::operator= ( const FrameSpecificTag & inputInfos )

inlinedefault

Default assignment operator.

◆ setPos()

void ml::DicomToMLTools::FrameSpecificTag::setPos	(	unsigned int	z,
		unsigned int	t,
		unsigned int	u
	)

inline

Sets pos to the three components z, t, and u.

Definition at line 61 of file mlDicomSingleFrameSelectionTools.h.

◆ setUpFrameSpecificTagInfos()

void ml::DicomToMLTools::FrameSpecificTag::setUpFrameSpecificTagInfos	(	const DCMTree::StructuredMF &	smfTree,
		bool	doFrameExistsAtPosCheck = `true`,
		bool	frameExistsAtPosIn = `false`
	)

inline

Sets up tagPtr and isFromRoot by using corresponding information from smfTree, pos, and rawTagId in this; if doFrameExistsAtPosCheck is true then smfTree.frameExists(pos) is calculated to determine whether framne at pos exists in smfTree, otherwise frameExistsAtPosIn is used trusting in its validity to optimize multiple frame accesses on same frames.

possible exceptions are caught and ignored; IMPORTANT: only works for SMFTrees with constant tagTree since non-const frame access does not work with frame copies which would be extremely expensive.

Definition at line 75 of file mlDicomSingleFrameSelectionTools.h.

References DCMTree::StructuredMF::getGridDimension(), DCMTree::StructuredMF::getGridExtent(), DCMTree::StructuredMF::tagForGridPosition(), and DCMTree::StructuredMF::tagTree().