Class representing the Plane Position (Volume) Functional Group that identifies the position of the plane of this frame.
More...
|
|
| FGPlanePositionVolume () |
| | Constructor, creates empty functional group.
|
| |
|
virtual | ~FGPlanePositionVolume () |
| | Virtual destructor, frees memory.
|
| |
| virtual FGBase * | clone () const |
| | Returns a deep copy of this object. More...
|
| |
| virtual DcmFGTypes::E_FGSharedType | getSharedType () const |
| | Returns shared type of this functional group (can be shared or per-frame, i.e. both) More...
|
| |
|
virtual void | clearData () |
| | Clears all data.
|
| |
| virtual OFCondition | check () const |
| | Check whether data of this functional group is valid. More...
|
| |
| virtual OFCondition | read (DcmItem &item) |
| | Read functional group from item, must contain the Plane Position (Volume) Sequence. More...
|
| |
| virtual OFCondition | write (DcmItem &item) |
| | Writes functional group to item, i.e. writes the Plane Position (Volume) Sequence. More...
|
| |
| virtual OFCondition | getImagePositionVolume (Float64 &value, const unsigned long pos=0) |
| | Get Image Position Volume. More...
|
| |
| virtual OFCondition | getImagePositionVolume (Float64 &valueX, Float64 &valueY, Float64 &valueZ) |
| | Retrieve all values of Image Position Volume at the same time. More...
|
| |
| virtual OFCondition | setImagePositionVolume (const Float64 &value, const unsigned long pos=0, const OFBool checkValue=OFTrue) |
| | Set Image Position Volume, i.e. the x/y/z coordinates of the upper left hand corner (center of the first voxel transmitted) of the frame, in mm. More...
|
| |
| virtual OFCondition | setImagePositionVolume (const Float64 &valueX, const Float64 &valueY, const Float64 &valueZ, const OFBool checkValue=OFTrue) |
| | Set Image Position Volume, i.e. the x/y/z coordinates of the upper left hand corner (center of the first voxel transmitted) of the frame, in mm. 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...
|
| |
| | 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.
|
| |
Class representing the Plane Position (Volume) Functional Group that identifies the position of the plane of this frame.
◆ check()
| virtual OFCondition FGPlanePositionVolume::check |
( |
| ) |
const |
|
virtual |
Check whether data of this functional group is valid.
- Returns
- EC_Normal if data is valid, error otherwise
Implements FGBase.
◆ clone()
| virtual FGBase* FGPlanePositionVolume::clone |
( |
| ) |
const |
|
virtual |
Returns a deep copy of this object.
- Returns
- Deep copy of this object
Implements FGBase.
◆ compare()
| virtual int FGPlanePositionVolume::compare |
( |
const FGBase & |
rhs | ) |
const |
|
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.
- Parameters
-
| rhs | the right hand side of the comparison |
- Returns
- 0 if the object values are equal. -1 if either the value of the first component that does not match is lower in the this object, or all compared components match but this component is shorter. Also returned if this type and rhs type (DcmFGTypes::E_FGType) do not match. 1 if either the value of the first component that does not match is greater in this object, or all compared components match but this component is longer.
Implements FGBase.
◆ getImagePositionVolume() [1/2]
| virtual OFCondition FGPlanePositionVolume::getImagePositionVolume |
( |
Float64 & |
value, |
|
|
const unsigned long |
pos = 0 |
|
) |
| |
|
virtual |
Get Image Position Volume.
- Parameters
-
| value | Reference to variable in which the value should be stored |
| pos | Index of the value to get (0..vm-1) |
- Returns
- EC_Normal if successful, an error code otherwise
◆ getImagePositionVolume() [2/2]
| virtual OFCondition FGPlanePositionVolume::getImagePositionVolume |
( |
Float64 & |
valueX, |
|
|
Float64 & |
valueY, |
|
|
Float64 & |
valueZ |
|
) |
| |
|
virtual |
Retrieve all values of Image Position Volume at the same time.
- Parameters
-
| valueX | X coordinate of upper left hand corner voxel in mm |
| valueY | Y coordinate of upper left hand corner voxel in mm |
| valueZ | Z coordinate of upper left hand corner voxel in mm |
- Returns
- EC_Normal if successful, an error code otherwise
◆ getSharedType()
◆ read()
Read functional group from item, must contain the Plane Position (Volume) Sequence.
- Parameters
-
| item | The item to read from |
- Returns
- EC_Normal if reading was successful, error otherwise
Implements FGBase.
◆ setImagePositionVolume() [1/2]
| virtual OFCondition FGPlanePositionVolume::setImagePositionVolume |
( |
const Float64 & |
value, |
|
|
const unsigned long |
pos = 0, |
|
|
const OFBool |
checkValue = OFTrue |
|
) |
| |
|
virtual |
Set Image Position Volume, i.e. the x/y/z coordinates of the upper left hand corner (center of the first voxel transmitted) of the frame, in mm.
- Parameters
-
| value | X,Y or Z coordinate of upper left hand corner voxel in mm |
| pos | pos 0 is x, pos 1 is Y, pos 2 addresses Z coordinate |
| checkValue | Check 'value'. Not evaluated (here for consistency with other setter functions). |
- Returns
- EC_Normal if successful, an error code otherwise
◆ setImagePositionVolume() [2/2]
| virtual OFCondition FGPlanePositionVolume::setImagePositionVolume |
( |
const Float64 & |
valueX, |
|
|
const Float64 & |
valueY, |
|
|
const Float64 & |
valueZ, |
|
|
const OFBool |
checkValue = OFTrue |
|
) |
| |
|
virtual |
Set Image Position Volume, i.e. the x/y/z coordinates of the upper left hand corner (center of the first voxel transmitted) of the frame, in mm.
- Parameters
-
| valueX | X coordinate of upper left hand corner voxel in mm |
| valueY | coordinate of upper left hand corner voxel in mm |
| valueZ | coordinate of upper left hand corner voxel in mm |
| checkValue | Check 'value'. Not evaluated (here for consistency with other setter functions). |
- Returns
- EC_Normal if successful, an error code otherwise
◆ write()
Writes functional group to item, i.e. writes the Plane Position (Volume) Sequence.
- Parameters
-
- Returns
- EC_Normal if writing was successful, error otherwise
Implements FGBase.
The documentation for this class was generated from the following file:
- dcmfg/include/dcmtk/dcmfg/fgplanposvol.h
Inheritance diagram for FGPlanePositionVolume: