Interface class to DICOM data management (dcmdata). More...
Public Member Functions | |
DiDocument (const char *filename, const unsigned long flags=0, const unsigned long fstart=0, const unsigned long fcount=0) | |
constructor, open a DICOM file | |
DiDocument (DcmObject *object, const E_TransferSyntax xfer, const unsigned long flags=0, const unsigned long fstart=0, const unsigned long fcount=0) | |
constructor, use a given DcmObject | |
virtual | ~DiDocument () |
destructor | |
int | good () const |
check whether current document is valid | |
DcmObject * | getDicomObject () const |
get current DICOM object (dataset) | |
unsigned long | getFrameStart () const |
get first frame to be processed | |
unsigned long | getFrameCount () const |
get number of frames to be processed | |
unsigned long | getFlags () const |
get configuration flags | |
E_TransferSyntax | getTransferSyntax () const |
get transfer syntax of the DICOM dataset | |
DcmElement * | search (const DcmTagKey &tag, DcmObject *obj=NULL) const |
search for given tag | |
int | search (const DcmTagKey &tag, DcmStack &stack) const |
search for given tag and put result(s) on a stack | |
unsigned long | getVM (const DcmTagKey &tag) const |
get value multiplicity (VM) of given tag | |
unsigned long | getValue (const DcmTagKey &tag, Uint16 &returnVal, const unsigned long pos=0, DcmObject *item=NULL) const |
get value of given tag (Uint16) | |
unsigned long | getValue (const DcmTagKey &tag, Sint16 &returnVal, const unsigned long pos=0) const |
get value of given tag (Sint16) | |
unsigned long | getValue (const DcmTagKey &tag, Uint32 &returnVal, const unsigned long pos=0) const |
get value of given tag (Uint32) | |
unsigned long | getValue (const DcmTagKey &tag, Sint32 &returnVal, const unsigned long pos=0) const |
get value of given tag (Sint32) | |
unsigned long | getValue (const DcmTagKey &tag, double &returnVal, const unsigned long pos=0) const |
get value of given tag (double) | |
unsigned long | getValue (const DcmTagKey &tag, const Uint16 *&returnVal, DcmObject *item=NULL) const |
get value of given tag (Uint16 array) | |
unsigned long | getValue (const DcmTagKey &tag, const char *&returnVal, DcmObject *item=NULL) const |
get value of given tag (const char *) | |
unsigned long | getValue (const DcmTagKey &tag, OFString &returnVal, const unsigned long pos=0, DcmObject *item=NULL) const |
get value of given tag (OFString) | |
unsigned long | getSequence (const DcmTagKey &tag, DcmSequenceOfItems *&seq) const |
get sequence of given tag | |
Static Public Member Functions | |
static unsigned long | getElemValue (const DcmElement *elem, Uint16 &returnVal, const unsigned long pos=0) |
get value of given element (Uint16) | |
static unsigned long | getElemValue (const DcmElement *elem, const Uint16 *&returnVal) |
get value of given element (Uint16 array) | |
static unsigned long | getElemValue (const DcmElement *elem, const char *&returnVal) |
get value of given element (const char *) | |
static unsigned long | getElemValue (const DcmElement *elem, OFString &returnVal, const unsigned long pos=0) |
get value of given element (OFString) | |
Protected Member Functions | |
void | convertPixelData () |
convert pixel data to uncompressed representation (if required) | |
Private Member Functions | |
DiDocument (const DiDocument &) | |
DiDocument & | operator= (const DiDocument &) |
Private Attributes | |
DcmObject * | Object |
reference to DICOM dataset (in memory) | |
DcmFileFormat * | FileFormat |
reference to DICOM fileformat (read from file, maybe NULL) | |
E_TransferSyntax | Xfer |
transfer syntax used for reading the dataset | |
unsigned long | FrameStart |
first frame to be processed | |
unsigned long | FrameCount |
number of frames to be processed | |
unsigned long | Flags |
configuration flags |
Interface class to DICOM data management (dcmdata).
NB: This is an internal class of module dcmimgle/dcmimage. Please do not use it for accessing DICOM data structures. Instead use the classes and functions provided by dcmdata (e.g. class DcmFileFormat, DcmItem).
Definition at line 68 of file didocu.h.
DiDocument::DiDocument | ( | const char * | filename, | |
const unsigned long | flags = 0 , |
|||
const unsigned long | fstart = 0 , |
|||
const unsigned long | fcount = 0 | |||
) |
constructor, open a DICOM file
filename | the DICOM file | |
flags | configuration flags (only stored for later use) | |
fstart | first frame to be processed (only stored for later use) | |
fcount | number of frames (only stored for later use) |
DiDocument::DiDocument | ( | DcmObject * | object, | |
const E_TransferSyntax | xfer, | |||
const unsigned long | flags = 0 , |
|||
const unsigned long | fstart = 0 , |
|||
const unsigned long | fcount = 0 | |||
) |
constructor, use a given DcmObject
object | pointer to dicom data structures | |
xfer | transfer syntax | |
flags | configuration flags (only stored for later use) | |
fstart | first frame to be processed (only stored for later use) | |
fcount | number of frames (only stored for later use) |
DcmObject* DiDocument::getDicomObject | ( | ) | const [inline] |
static unsigned long DiDocument::getElemValue | ( | const DcmElement * | elem, | |
OFString & | returnVal, | |||
const unsigned long | pos = 0 | |||
) | [static] |
get value of given element (OFString)
elem | element where the value is stored | |
returnVal | reference to the storage area for the resulting value | |
pos | position in muti-valued elements (starting with 0) |
static unsigned long DiDocument::getElemValue | ( | const DcmElement * | elem, | |
const char *& | returnVal | |||
) | [static] |
get value of given element (const char *)
elem | element where the value is stored | |
returnVal | reference to the storage area for the resulting value |
static unsigned long DiDocument::getElemValue | ( | const DcmElement * | elem, | |
const Uint16 *& | returnVal | |||
) | [static] |
get value of given element (Uint16 array)
elem | element where the value is stored | |
returnVal | reference to the storage area for the resulting value |
static unsigned long DiDocument::getElemValue | ( | const DcmElement * | elem, | |
Uint16 & | returnVal, | |||
const unsigned long | pos = 0 | |||
) | [static] |
get value of given element (Uint16)
elem | element where the value is stored | |
returnVal | reference to the storage area for the resulting value | |
pos | position in muti-valued elements (starting with 0) |
unsigned long DiDocument::getFlags | ( | ) | const [inline] |
unsigned long DiDocument::getFrameCount | ( | ) | const [inline] |
get number of frames to be processed
Definition at line 135 of file didocu.h.
References FrameCount.
unsigned long DiDocument::getFrameStart | ( | ) | const [inline] |
get first frame to be processed
Definition at line 126 of file didocu.h.
References FrameStart.
unsigned long DiDocument::getSequence | ( | const DcmTagKey & | tag, | |
DcmSequenceOfItems *& | seq | |||
) | const |
get sequence of given tag
tag | tag to search for | |
seq | reference to the storage area for the resulting value |
E_TransferSyntax DiDocument::getTransferSyntax | ( | ) | const [inline] |
unsigned long DiDocument::getValue | ( | const DcmTagKey & | tag, | |
OFString & | returnVal, | |||
const unsigned long | pos = 0 , |
|||
DcmObject * | item = NULL | |||
) | const |
get value of given tag (OFString)
tag | tag to search for | |
returnVal | reference to the storage area for the resulting value | |
pos | position in muti-valued elements (starting with 0) | |
item | element in the dataset where the search should start (default: root) |
unsigned long DiDocument::getValue | ( | const DcmTagKey & | tag, | |
const char *& | returnVal, | |||
DcmObject * | item = NULL | |||
) | const |
get value of given tag (const char *)
tag | tag to search for | |
returnVal | reference to the storage area for the resulting value | |
item | element in the dataset where the search should start (default: root) |
unsigned long DiDocument::getValue | ( | const DcmTagKey & | tag, | |
const Uint16 *& | returnVal, | |||
DcmObject * | item = NULL | |||
) | const |
get value of given tag (Uint16 array)
tag | tag to search for | |
returnVal | reference to the storage area for the resulting value | |
item | element in the dataset where the search should start (default: root) |
unsigned long DiDocument::getValue | ( | const DcmTagKey & | tag, | |
double & | returnVal, | |||
const unsigned long | pos = 0 | |||
) | const |
get value of given tag (double)
tag | tag to search for | |
returnVal | reference to the storage area for the resulting value | |
pos | position in muti-valued elements (starting with 0) |
unsigned long DiDocument::getValue | ( | const DcmTagKey & | tag, | |
Sint32 & | returnVal, | |||
const unsigned long | pos = 0 | |||
) | const |
get value of given tag (Sint32)
tag | tag to search for | |
returnVal | reference to the storage area for the resulting value | |
pos | position in muti-valued elements (starting with 0) |
unsigned long DiDocument::getValue | ( | const DcmTagKey & | tag, | |
Uint32 & | returnVal, | |||
const unsigned long | pos = 0 | |||
) | const |
get value of given tag (Uint32)
tag | tag to search for | |
returnVal | reference to the storage area for the resulting value | |
pos | position in muti-valued elements (starting with 0) |
unsigned long DiDocument::getValue | ( | const DcmTagKey & | tag, | |
Sint16 & | returnVal, | |||
const unsigned long | pos = 0 | |||
) | const |
get value of given tag (Sint16)
tag | tag to search for | |
returnVal | reference to the storage area for the resulting value | |
pos | position in muti-valued elements (starting with 0) |
unsigned long DiDocument::getValue | ( | const DcmTagKey & | tag, | |
Uint16 & | returnVal, | |||
const unsigned long | pos = 0 , |
|||
DcmObject * | item = NULL | |||
) | const |
get value of given tag (Uint16)
tag | tag to search for | |
returnVal | reference to the storage area for the resulting value | |
pos | position in muti-valued elements (starting with 0) | |
item | element in the dataset where the search should start (default: root) |
unsigned long DiDocument::getVM | ( | const DcmTagKey & | tag | ) | const |
get value multiplicity (VM) of given tag
tag | tag to be searched |
int DiDocument::good | ( | ) | const [inline] |
search for given tag and put result(s) on a stack
tag | tag to search for | |
stack | stack where the result(s) should be stored |
DcmElement* DiDocument::search | ( | const DcmTagKey & | tag, | |
DcmObject * | obj = NULL | |||
) | const |
search for given tag
tag | tag to search for | |
obj | element in the dataset where the search should start (default: root) |