CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
Public Member Functions | Protected Attributes | Properties | List of all members
ctkDICOMImage Class Reference

Wrapper around a DCMTK DicomImage. More...

#include <Libs/DICOM/Widgets/ctkDICOMImage.h>

Inheritance diagram for ctkDICOMImage:
Inheritance graph
[legend]
Collaboration diagram for ctkDICOMImage:
Collaboration graph
[legend]

Public Member Functions

 ctkDICOMImage (DicomImage *dicomImage, QObject *parent=0)
 Construct a ctkDICOMImage The dicomImage pointer must remain valid during all the life of the constructed ctkDICOMImage. More...
 
DicomImage * dicomImage () const
 Returns the pointer on the dicom image given in the constructor. More...
 
QImage frame (int frame=0) const
 Returns a specific frame of the dicom image. More...
 
unsigned long frameCount () const
 Returns the number of frames contained in the dicom image. More...
 
virtual ~ctkDICOMImage ()
 

Protected Attributes

QScopedPointer< ctkDICOMImagePrivate > d_ptr
 

Properties

unsigned long frameCount
 

Detailed Description

Wrapper around a DCMTK DicomImage.

This class wraps a DicomImage object and exposes it as a Qt class.

Definition at line 40 of file ctkDICOMImage.h.

Constructor & Destructor Documentation

◆ ctkDICOMImage()

ctkDICOMImage::ctkDICOMImage ( DicomImage *  dicomImage,
QObject *  parent = 0 
)
explicit

Construct a ctkDICOMImage The dicomImage pointer must remain valid during all the life of the constructed ctkDICOMImage.

◆ ~ctkDICOMImage()

virtual ctkDICOMImage::~ctkDICOMImage ( )
virtual

Member Function Documentation

◆ dicomImage()

DicomImage* ctkDICOMImage::dicomImage ( ) const

Returns the pointer on the dicom image given in the constructor.

This is provided as a utility function. Do not delete the returned pointer. TBD: Return a "const DicomImage*" instead?

◆ frame()

QImage ctkDICOMImage::frame ( int  frame = 0) const

Returns a specific frame of the dicom image.

◆ frameCount()

unsigned long ctkDICOMImage::frameCount ( ) const

Returns the number of frames contained in the dicom image.

See also
DicomImage::getFrameCount()

Please note that this function does not return the number of frames stored in the DICOM file/dataset. It rather refers to the number of frames processed by this class.

Member Data Documentation

◆ d_ptr

QScopedPointer<ctkDICOMImagePrivate> ctkDICOMImage::d_ptr
protected

Definition at line 77 of file ctkDICOMImage.h.

Property Documentation

◆ frameCount

unsigned long ctkDICOMImage::frameCount
read

Definition at line 1 of file ctkDICOMImage.h.


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