vtk-dicom  0.8.14
Public Member Functions | Protected Member Functions | List of all members
vtkDICOMMetaDataAdapter Class Reference

An adapter to make multi-frame data look like multi-file data. More...

#include <vtkDICOMMetaDataAdapter.h>

Public Member Functions

 vtkDICOMMetaDataAdapter (vtkDICOMMetaData *meta)
 Construct an adapter for the given meta data object. More...
 
 vtkDICOMMetaDataAdapter (vtkDICOMMetaData *meta, int i)
 Construct an adapter for one DICOM object instance. More...
 
 vtkDICOMMetaDataAdapter (const vtkDICOMMetaDataAdapter &)
 Copy constructor.
 
 ~vtkDICOMMetaDataAdapter ()
 Destructor release the reference to the meta data.
 
int GetNumberOfInstances () const
 Get the number of instances (i.e. files). More...
 
bool Has (vtkDICOMTag tag) const
 Check whether an attribute is present in the metadata. More...
 
bool HasAttribute (vtkDICOMTag tag) const
 
const vtkDICOMValueGet (vtkDICOMTag tag) const
 Get an attribute value. More...
 
const vtkDICOMValueGetAttributeValue (vtkDICOMTag tag) const
 
const vtkDICOMValueGet (int idx, vtkDICOMTag tag) const
 Get an attribute value for the specified file index. More...
 
const vtkDICOMValueGetAttributeValue (int idx, vtkDICOMTag tag) const
 
vtkDICOMTag ResolvePrivateTag (vtkDICOMTag ptag, const std::string &creator)
 Resolve a private tag. More...
 
vtkDICOMTag ResolvePrivateTag (int idx, vtkDICOMTag ptag, const std::string &creator)
 
const vtkDICOMMetaDataAdapteroperator-> () const
 Make the adapter look like a pointer (for convenience).
 
vtkDICOMMetaDataAdapteroperator-> ()
 
vtkDICOMMetaDataAdapteroperator= (const vtkDICOMMetaDataAdapter &)
 Copy constructor.
 

Protected Member Functions

void ConstructionHelper (vtkDICOMMetaData *meta, int i)
 Helper function for the constructors. Set all members.
 

Detailed Description

An adapter to make multi-frame data look like multi-file data.

The vtkDICOMMetaDataAdapter object makes an enhanced multi-frame DICOM data set appear to be a series of data sets. Whenever the caller requests and attribute from a specific instance, the attribute is instead pulled from the PerFrame item for a specific frame. If constructed from a metadata object that is not an enhanced multi-frame dataset, it simply acts as a pass-through.

Constructor & Destructor Documentation

◆ vtkDICOMMetaDataAdapter() [1/2]

vtkDICOMMetaDataAdapter::vtkDICOMMetaDataAdapter ( vtkDICOMMetaData meta)

Construct an adapter for the given meta data object.

If the provided meta-data is from an enhanced multi-frame data set, then the adapter will make it look like a series of data sets. If the provided meta-data is from a series of non-enhanced data sets, the adapter will act as a simple pass-through.

◆ vtkDICOMMetaDataAdapter() [2/2]

vtkDICOMMetaDataAdapter::vtkDICOMMetaDataAdapter ( vtkDICOMMetaData meta,
int  i 
)

Construct an adapter for one DICOM object instance.

If instance i of the provided meta-data is an enhanced multi-frame data set, make it look like a series.

Member Function Documentation

◆ Get() [1/2]

const vtkDICOMValue& vtkDICOMMetaDataAdapter::Get ( int  idx,
vtkDICOMTag  tag 
) const

Get an attribute value for the specified file index.

For an enhanced multi-frame data set, this will search the PerFrame attributes, then the Shared attributes, and finally the basic data set attributes.

◆ Get() [2/2]

const vtkDICOMValue& vtkDICOMMetaDataAdapter::Get ( vtkDICOMTag  tag) const

Get an attribute value.

For an enhanced multi-frame data set, this will first try to retrieve the attribute from the SharedFunctionalGroupSequence.

◆ GetNumberOfInstances()

int vtkDICOMMetaDataAdapter::GetNumberOfInstances ( ) const
inline

Get the number of instances (i.e. files).

For an enhanced multi-frame data set, this will return the number of frames. For a non-enhanced data set, it returns the number of instances in the series.

◆ Has()

bool vtkDICOMMetaDataAdapter::Has ( vtkDICOMTag  tag) const

Check whether an attribute is present in the metadata.

For an enhanced multi-frame data set, this will search the Shared and PerFrameFunctionGroupSequence in addition to searching the basic data set attributes.

◆ ResolvePrivateTag()

vtkDICOMTag vtkDICOMMetaDataAdapter::ResolvePrivateTag ( vtkDICOMTag  ptag,
const std::string &  creator 
)

Resolve a private tag.

For an enhanced multi-frame data set, this will search the PerFrame attributes, then the Shared attributes, and finally the basic data set attributes.


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