DCMTK
Version 3.6.1 20170228
OFFIS DICOM Toolkit
|
Class representing the "Frame Content" Functional Group Macro. More...
Public Member Functions | |
FGFrameContent () | |
Constructor, creates empty functional group. | |
virtual | ~FGFrameContent () |
Virtual destructor. | |
virtual FGBase * | clone () const |
Returns a deep copy of this object. More... | |
virtual DcmFGTypes::E_FGSharedType | getSharedType () const |
Returns shared functional group type (always "per-frame") More... | |
virtual void | clearData () |
Clear all data. | |
virtual OFCondition | check () const |
Check whether the current content of this group is consistent and complete. More... | |
virtual OFCondition | read (DcmItem &item) |
Read Frame Content Sequence from given item. More... | |
virtual OFCondition | write (DcmItem &item) |
Writes the content of this class into Frame Content Sequence (newly cerated) into given item. More... | |
virtual int | compare (const FGBase &rhs) const |
Comparison operator that compares the normalized value of this object with a given object of the same type, i.e. the elements within both functional groups (this and rhs parameter) are compared by value! Both objects (this and rhs) need to have the same type (i.e. both FGUnknown) to be comparable. More... | |
virtual OFCondition | getFrameAcquisitionNumber (Uint16 &value, const signed long pos=0) |
Get Frame Acquisition Number. More... | |
virtual OFCondition | getFrameReferenceDateTime (OFString &value, const signed long pos=0) |
Get Frame Reference Date Time. More... | |
virtual OFCondition | getFrameAcquisitionDateTime (OFString &value, const signed long pos=0) |
Get Frame Acquisition Date Time. More... | |
virtual OFCondition | getFrameAcquisitionDuration (Float64 &value, const unsigned long pos=0) |
Get Frame Acquisition Duration. More... | |
virtual OFCondition | getCardiacCyclePosition (OFString &value, const signed long pos=0) |
Get Cardiac Cycle Position. More... | |
virtual OFCondition | getRespiratoryCyclePosition (OFString &value, const signed long pos=0) |
Get Respiratory Cycle Position. More... | |
virtual OFCondition | getDimensionIndexValues (Uint32 &value, const signed long pos=0) |
Get Dimension Index Value. More... | |
virtual OFCondition | getTemporalPositionIndex (Uint32 &value, const signed long pos=0) |
Get Temporal Position Index. More... | |
virtual OFCondition | getStackID (OFString &value, const signed long pos=0) |
Get Stack ID. More... | |
virtual OFCondition | getInStackPositionNumber (Uint32 &value, const signed long pos=0) |
Get In-Stack Position Number. More... | |
virtual OFCondition | getFrameComments (OFString &value, const signed long pos=0) |
Get Frame Comments. More... | |
virtual OFCondition | getFrameLabel (OFString &value, const signed long pos=0) |
Get Frame Label. More... | |
virtual OFCondition | setFrameAcquisitionNumber (const Uint16 &value, const OFBool checkValue=OFTrue) |
Set Frame Acquisition Number. More... | |
virtual OFCondition | setFrameReferenceDateTime (const OFString &value, const OFBool checkValue=OFTrue) |
Set Frame Frame Reference Date Time. More... | |
virtual OFCondition | setFrameAcquisitionDateTime (const OFString &value, const OFBool checkValue=OFTrue) |
Set Frame Acquisition Date Time. More... | |
virtual OFCondition | setFrameAcquisitionDuration (const Float64 &value, const OFBool checkValue=OFTrue) |
Set Frame Acquisition Duration. More... | |
virtual OFCondition | setCardiacCyclePosition (const OFString &value, const OFBool checkValue=OFTrue) |
Set Cardiac Cycle Position. More... | |
virtual OFCondition | setRespiratoryCyclePosition (const OFString &value, const OFBool checkValue=OFTrue) |
Set Respiratory Cycle Position. More... | |
virtual OFCondition | setDimensionIndexValues (const Uint32 &value, const unsigned int dim, const OFBool checkValue=OFTrue) |
Set one of the Dimension Index Values. More... | |
virtual OFCondition | setTemporalPositionIndex (const Uint32 &value, const OFBool checkValue=OFTrue) |
Set Temporal Position Index. More... | |
virtual OFCondition | setStackID (const OFString &value, const OFBool checkValue=OFTrue) |
Set Stack ID. More... | |
virtual OFCondition | setInStackPositionNumber (const Uint32 &value, const OFBool checkValue=OFTrue) |
Set In-Stack Position Number. More... | |
virtual OFCondition | setFrameComments (const OFString &value, const OFBool checkValue=OFTrue) |
Set Frame Comments. More... | |
virtual OFCondition | setFrameLabel (const OFString &value, const OFBool checkValue=OFTrue) |
Set Frame Label. More... | |
![]() | |
FGBase (const DcmFGTypes::E_FGType fgType) | |
Constructor, creates new functional group of given type. More... | |
virtual DcmFGTypes::E_FGType | getType () const |
Return the type of this functional group. More... | |
virtual | ~FGBase () |
Virtual destructor. | |
Private Attributes | |
DcmUnsignedShort | m_FrameAcquisitonNumber |
Frame Acquisition Number (US, VM 1, Required type 3) | |
DcmDateTime | m_FrameReferenceDateTime |
Frame Reference DateTime (DT, 1, 1C) | |
DcmDateTime | m_FrameAcquisitionDateTime |
Frame Acquisition DateTime (DT, 1, 1C) | |
DcmFloatingPointDouble | m_FrameAcquisitionDuration |
Frame Acquisition Duration (FD, 1, 1C) | |
DcmCodeString | m_CardiacCyclePosition |
Cardiac Cycle Position (CS, 1, 3) | |
DcmCodeString | m_RespiratoryCyclePosition |
Respiratory Cycle Position (CS, 1, 3) | |
DcmUnsignedLong | m_DimensionIndexValues |
Dimension Index Values (UL, 1-n, 1C) | |
DcmUnsignedLong | m_TemporalPositionIndex |
Temporal Position Index (UL, 1, 1C) | |
DcmShortString | m_StackID |
Stack ID (SH, 1, 1C) | |
DcmUnsignedLong | m_InStackPositionNumber |
In-Stack Position Number (UL, 1, 1C) | |
DcmLongText | m_FrameComments |
Frame Comments (LT, 1, 3) | |
DcmLongString | m_FrameLabel |
Frame Label (LO, 1, 3) | |
Additional Inherited Members | |
![]() | |
virtual OFCondition | getItemFromFGSequence (DcmItem &source, const DcmTagKey &seqKey, const unsigned long itemNum, DcmItem *&result) |
Get the item containing the payload of a functional group sequence, identified by the functional group's sequence key provided and the desired item number. More... | |
virtual OFCondition | createNewFGSequence (DcmItem &destination, const DcmTagKey &seqKey, const unsigned long numItems, DcmItem *&firstItem) |
Create functional group sequence specified by given sequence tag key. More... | |
Class representing the "Frame Content" Functional Group Macro.
Can only be used as per-frame functional group (never shared).
|
virtual |
Check whether the current content of this group is consistent and complete.
Implements FGBase.
|
virtual |
|
virtual |
Comparison operator that compares the normalized value of this object with a given object of the same type, i.e. the elements within both functional groups (this and rhs parameter) are compared by value! Both objects (this and rhs) need to have the same type (i.e. both FGUnknown) to be comparable.
This function is used in order to decide whether a functional group already exists, or is new. This is used in particular to find out whether a given functional group can be shared (i.e. the same information already exists as shared functional group) or is different from the same shared group. In that case the shared functional group must be distributed into per-frame functional groups, instead. The exact implementation for implementing the comparison is not relevant. However, it must be a comparison by value.
rhs | the right hand side of the comparison |
Implements FGBase.
|
virtual |
Get Cardiac Cycle Position.
value | Reference to variable that should hold the result |
pos | Position of the value inside the DICOM element. If 0, the first value is returned. If the no value at the given position exists, an error is returned. |
|
virtual |
Get Dimension Index Value.
value | Reference to variable that should hold the result |
pos | Position of the value inside the DICOM element. If 0, the first value is returned. If the no value at the given position exists, an error is returned. |
|
virtual |
Get Frame Acquisition Date Time.
value | Reference to variable that should hold the result |
pos | Position of the value inside the DICOM element. If 0, the first value is returned. If the no value at the given position exists, an error is returned. |
|
virtual |
Get Frame Acquisition Duration.
value | Reference to variable that should hold the result |
pos | Position of the value inside the DICOM element. If 0, the first value is returned. If the no value at the given position exists, an error is returned. |
|
virtual |
Get Frame Acquisition Number.
value | Reference to variable that should hold the result |
pos | Position of the value inside the DICOM element. If 0, the first value is returned. If the no value at the given position exists, an error is returned. |
|
virtual |
Get Frame Comments.
value | Reference to variable that should hold the result |
pos | Position of the value inside the DICOM element. If 0, the first value is returned. If the no value at the given position exists, an error is returned. |
|
virtual |
Get Frame Label.
value | Reference to variable that should hold the result |
pos | Position of the value inside the DICOM element. If 0, the first value is returned. If the no value at the given position exists, an error is returned. |
|
virtual |
Get Frame Reference Date Time.
value | Reference to variable that should hold the result |
pos | Position of the value inside the DICOM element. If 0, the first value is returned. If the no value at the given position exists, an error is returned. |
|
virtual |
Get In-Stack Position Number.
value | Reference to variable that should hold the result |
pos | Position of the value inside the DICOM element. If 0, the first value is returned. If the no value at the given position exists, an error is returned. |
|
virtual |
Get Respiratory Cycle Position.
value | Reference to variable that should hold the result |
pos | Position of the value inside the DICOM element. If 0, the first value is returned. If the no value at the given position exists, an error is returned. |
|
inlinevirtual |
Returns shared functional group type (always "per-frame")
Implements FGBase.
References DcmFGTypes::EFGS_ONLYPERFRAME.
|
virtual |
Get Stack ID.
value | Reference to variable that should hold the result |
pos | Position of the value inside the DICOM element. If 0, the first value is returned. If the no value at the given position exists, an error is returned. |
|
virtual |
Get Temporal Position Index.
value | Reference to variable that should hold the result |
pos | Position of the value inside the DICOM element. If 0, the first value is returned. If the no value at the given position exists, an error is returned. |
|
virtual |
Read Frame Content Sequence from given item.
item | The item to read from |
Implements FGBase.
|
virtual |
Set Cardiac Cycle Position.
value | Value that should be set |
checkValue | If OFTrue, basic checks are performed whether the value is valid for this attribute |
|
virtual |
Set one of the Dimension Index Values.
value | Value that should be set (lowest index starts with 1) |
dim | The position of the value that should be set (lowest index starts with 0), i.e. select the 1st, 2nd, ..nth dimension |
checkValue | Check 'value'. Not evaluated (here for consistency with other setter functions). |
|
virtual |
Set Frame Acquisition Date Time.
value | Value that should be set |
checkValue | If OFTrue, basic checks are performed whether the value is valid for this attribute |
|
virtual |
Set Frame Acquisition Duration.
value | Value that should be set |
checkValue | If OFTrue, basic checks are performed whether the value is valid for this attribute |
|
virtual |
Set Frame Acquisition Number.
value | Value that should be set |
checkValue | Check 'value'. Not evaluated (here for consistency with other setter functions). |
|
virtual |
Set Frame Comments.
value | Value that should be set |
checkValue | Check 'value'. Not evaluated (here for consistency with other setter functions). |
|
virtual |
Set Frame Label.
value | Value that should be set |
checkValue | If OFTrue, basic checks are performed whether the value is valid for this attribute |
|
virtual |
Set Frame Frame Reference Date Time.
value | Value that should be set |
checkValue | If OFTrue, basic checks are performed whether the value is valid for this attribute |
|
virtual |
Set In-Stack Position Number.
value | Value that should be set |
checkValue | Check 'value'. Not evaluated (here for consistency with other setter functions). |
|
virtual |
Set Respiratory Cycle Position.
value | Value that should be set |
checkValue | If OFTrue, basic checks are performed whether the value is valid for this attribute |
|
virtual |
Set Stack ID.
value | Value that should be set |
checkValue | If OFTrue, basic checks are performed whether the value is valid for this attribute |
|
virtual |
Set Temporal Position Index.
value | Value that should be set |
checkValue | Check 'value'. Not evaluated (here for consistency with other setter functions). |
|
virtual |
Writes the content of this class into Frame Content Sequence (newly cerated) into given item.
item | The item to write to |
Implements FGBase.