dcddirif.h

/*
 *
 *  Copyright (C) 2002-2005, OFFIS
 *
 *  This software and supporting documentation were developed by
 *
 *    Kuratorium OFFIS e.V.
 *    Healthcare Information and Communication Systems
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *  THIS SOFTWARE IS MADE AVAILABLE,  AS IS,  AND OFFIS MAKES NO  WARRANTY
 *  REGARDING  THE  SOFTWARE,  ITS  PERFORMANCE,  ITS  MERCHANTABILITY  OR
 *  FITNESS FOR ANY PARTICULAR USE, FREEDOM FROM ANY COMPUTER DISEASES  OR
 *  ITS CONFORMITY TO ANY SPECIFICATION. THE ENTIRE RISK AS TO QUALITY AND
 *  PERFORMANCE OF THE SOFTWARE IS WITH THE USER.
 *
 *  Module:  dcmdata
 *
 *  Author:  Joerg Riesmeier
 *
 *  Purpose: Interface class for simplified creation of a DICOMDIR
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2005/12/15 15:40:48 $
 *  CVS/RCS Revision: $Revision: 1.8 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */


#ifndef DCDDIRIF_H
#define DCDDIRIF_H

#include "dcmtk/config/osconfig.h"

#include "dcmtk/dcmdata/dcdicdir.h"


/*-----------------------------------*
 *  contant declarations and macros  *
 *-----------------------------------*/

// default fileset ID
#define DEFAULT_FILESETID "DCMTK_MEDIA_DEMO"
// default specific character set of fileset descriptor file
#define DEFAULT_DESCRIPTOR_CHARSET "ISO_IR 100"


/*----------------------*
 *  class declarations  *
 *----------------------*/

class DicomDirImagePlugin
{
  public:

    virtual ~DicomDirImagePlugin() {}

    virtual OFBool scaleData(const Uint8 *srcData,
                             const unsigned int srcWidth,
                             const unsigned int srcHeight,
                             Uint8 *dstData,
                             const unsigned int dstWidth,
                             const unsigned int dstHeight) const = 0;

    virtual OFBool scaleImage(DcmItem *dataset,
                              Uint8 *pixel,
                              const unsigned long count,
                              const unsigned long frame,
                              const unsigned int width,
                              const unsigned int height) const = 0;

  protected:

    DicomDirImagePlugin() {}
};


class DicomDirInterface
{

  public:

    enum E_ApplicationProfile
    {
        AP_GeneralPurpose,
        AP_Default = AP_GeneralPurpose,
        AP_GeneralPurposeDVD,
        AP_GeneralPurposeMIME,
        AP_USBandFlash,
        AP_MPEG2MPatML,
        AP_BasicCardiac,
        AP_XrayAngiographic,
        AP_XrayAngiographicDVD,
        AP_DentalRadiograph,
        AP_CTandMR,
        AP_UltrasoundIDSF,
        AP_UltrasoundSCSF,
        AP_UltrasoundCCSF,
        AP_UltrasoundIDMF,
        AP_UltrasoundSCMF,
        AP_UltrasoundCCMF,
        AP_TwelveLeadECG,
        AP_HemodynamicWaveform
    };

    DicomDirInterface();

    virtual ~DicomDirInterface();

    void cleanup();

    OFBool isDicomDirValid() const;

    OFCondition createNewDicomDir(const E_ApplicationProfile profile = AP_GeneralPurpose,
                                  const char *filename = DEFAULT_DICOMDIR_NAME,
                                  const char *filesetID = DEFAULT_FILESETID);

    OFCondition appendToDicomDir(const E_ApplicationProfile profile,
                                 const char *filename);

    OFCondition writeDicomDir(const E_EncodingType encodingType = EET_UndefinedLength,
                              const E_GrpLenEncoding groupLength = EGL_withoutGL);

    OFBool isFilenameValid(const char *filename,
                           const OFBool allowEmpty = OFFalse);

    OFBool isCharsetValid(const char *charset);

    OFCondition checkDicomFile(const char *filename,
                               const char *directory = NULL);

    OFCondition addDicomFile(const char *filename,
                             const char *directory = NULL);

    OFCondition setFilesetDescriptor(const char *filename,
                                     const char *charset = DEFAULT_DESCRIPTOR_CHARSET);

    OFCondition setIconSize(const unsigned int size);

    OFCondition setIconPrefix(const char *prefix);

    OFCondition setDefaultIcon(const char *filename);

    OFBool verboseMode() const
    {
        return VerboseMode;
    }

    OFBool abortMode() const
    {
        return AbortMode;
    }

    OFBool mapFilenamesMode() const
    {
        return MapFilenamesMode;
    }

    OFBool inventMode() const
    {
        return InventMode;
    }

    OFBool inventPatientIDMode() const
    {
        return InventPatientIDMode;
    }

    OFBool iconImageMode() const
    {
        return IconImageMode;
    }

    OFBool backupMode() const
    {
        return BackupMode;
    }

    OFBool encodingCheck() const
    {
        return EncodingCheck;
    }

    OFBool resolutionCheck() const
    {
        return ResolutionCheck;
    }

    OFBool transferSyntaxCheck() const
    {
        return TransferSyntaxCheck;
    }

    OFBool consistencyCheck() const
    {
        return ConsistencyCheck;
    }

    OFBool enableVerboseMode(const OFBool newMode = OFTrue);

    OFBool enableAbortMode(const OFBool newMode = OFTrue);

    OFBool enableMapFilenamesMode(const OFBool newMode = OFTrue);

    OFBool enableInventMode(const OFBool newMode = OFTrue);

    OFBool enableInventPatientIDMode(const OFBool newMode = OFTrue);

    OFBool enableIconImageMode(const OFBool newMode = OFTrue);

    OFBool disableBackupMode(const OFBool newMode = OFFalse);

    OFBool disableEncodingCheck(const OFBool newMode = OFFalse);

    OFBool disableResolutionCheck(const OFBool newMode = OFFalse);

    OFBool disableTransferSyntaxCheck(const OFBool newMode = OFFalse);

    OFBool disableConsistencyCheck(const OFBool newMode = OFFalse);

    OFBool addImageSupport(DicomDirImagePlugin *plugin);

    void setLogStream(OFConsole *stream);

    /* -- static function -- */

    static const char *getProfileName(const E_ApplicationProfile profile);


  protected:

    OFCondition selectApplicationProfile(const E_ApplicationProfile profile);

    OFCondition loadAndCheckDicomFile(const char *filename,
                                      const char *directory,
                                      DcmFileFormat &fileformat);

    OFCondition checkSOPClassAndXfer(DcmMetaInfo *metainfo,
                                     DcmItem *dataset,
                                     const char *filename);

    OFCondition checkBasicCardiacAttributes(DcmItem *dataset,
                                            const char *filename);

    OFCondition checkXrayAngiographicAttributes(DcmItem *dataset,
                                                const OFString &sopClass,
                                                const char *filename);

    OFCondition checkDentalRadiographAttributes(DcmItem *dataset,
                                                const char *filename);

    OFCondition checkCTandMRAttributes(DcmItem *dataset,
                                       const OFString &sopClass,
                                       const char *filename);

    OFCondition checkUltrasoundAttributes(DcmItem *dataset,
                                          const OFString &transferSyntax,
                                          const char *filename);

    OFCondition checkMandatoryAttributes(DcmMetaInfo *metainfo,
                                         DcmItem *dataset,
                                         const char *filename);

    OFBool recordMatchesDataset(DcmDirectoryRecord *record,
                                DcmItem *dataset);

    DcmDirectoryRecord *findExistingRecord(DcmDirectoryRecord *parent,
                                           const E_DirRecType recordType,
                                           DcmItem* dataset);

    DcmDirectoryRecord *buildPatientRecord(DcmItem *dataset,
                                           const OFString &sourceFilename);

    DcmDirectoryRecord *buildStudyRecord(DcmItem *dataset,
                                         const OFString &sourceFilename);

    DcmDirectoryRecord *buildSeriesRecord(DcmItem *dataset,
                                          const OFString &sourceFilename);

    DcmDirectoryRecord *buildOverlayRecord(DcmItem *dataset,
                                           const OFString &referencedFileID,
                                           const OFString &sourceFilename);

    DcmDirectoryRecord *buildModalityLutRecord(DcmItem *dataset,
                                               const OFString &referencedFileID,
                                               const OFString &sourceFilename);

    DcmDirectoryRecord *buildVoiLutRecord(DcmItem *dataset,
                                          const OFString &referencedFileID,
                                          const OFString &sourceFilename);

    DcmDirectoryRecord *buildCurveRecord(DcmItem *dataset,
                                         const OFString &referencedFileID,
                                         const OFString &sourceFilename);

    DcmDirectoryRecord *buildStructReportRecord(DcmItem *dataset,
                                                const OFString &referencedFileID,
                                                const OFString &sourceFilename);

    DcmDirectoryRecord *buildPresentationRecord(DcmItem *dataset,
                                                const OFString &referencedFileID,
                                                const OFString &sourceFilename);

    DcmDirectoryRecord *buildWaveformRecord(DcmItem *dataset,
                                            const OFString &referencedFileID,
                                            const OFString &sourceFilename);

    DcmDirectoryRecord *buildRTDoseRecord(DcmItem *dataset,
                                          const OFString &referencedFileID,
                                          const OFString &sourceFilename);

    DcmDirectoryRecord *buildRTStructureSetRecord(DcmItem *dataset,
                                                  const OFString &referencedFileID,
                                                  const OFString &sourceFilename);

    DcmDirectoryRecord *buildRTPlanRecord(DcmItem *dataset,
                                          const OFString &referencedFileID,
                                          const OFString &sourceFilename);

    DcmDirectoryRecord *buildRTTreatmentRecord(DcmItem *dataset,
                                               const OFString &referencedFileID,
                                               const OFString &sourceFilename);

    DcmDirectoryRecord *buildStoredPrintRecord(DcmItem *dataset,
                                               const OFString &referencedFileID,
                                               const OFString &sourceFilename);

    DcmDirectoryRecord *buildKeyObjectDocRecord(DcmItem *dataset,
                                                const OFString &referencedFileID,
                                                const OFString &sourceFilename);

    DcmDirectoryRecord *buildRegistrationRecord(DcmItem *dataset,
                                                const OFString &referencedFileID,
                                                const OFString &sourceFilename);

    DcmDirectoryRecord *buildFiducialRecord(DcmItem *dataset,
                                            const OFString &referencedFileID,
                                            const OFString &sourceFilename);

    DcmDirectoryRecord *buildRawDataRecord(DcmItem *dataset,
                                           const OFString &referencedFileID,
                                           const OFString &sourceFilename);

    DcmDirectoryRecord *buildSpectroscopyRecord(DcmItem *dataset,
                                                const OFString &referencedFileID,
                                                const OFString &sourceFilename);

    DcmDirectoryRecord *buildEncapDocRecord(DcmItem *dataset,
                                            const OFString &referencedFileID,
                                            const OFString &sourceFilename);

    DcmDirectoryRecord *buildValueMapRecord(DcmItem *dataset,
                                            const OFString &referencedFileID,
                                            const OFString &sourceFilename);

    DcmDirectoryRecord *buildImageRecord(DcmItem *dataset,
                                         const OFString &referencedFileID,
                                         const OFString &sourceFilename);

    DcmDirectoryRecord *buildHangingProtocolRecord(DcmItem *dataset,
                                                   const OFString &referencedFileID,
                                                   const OFString &sourceFilename);

    OFBool getIconFromFile(const OFString &filename,
                           Uint8 *pixel,
                           const unsigned long count,
                           const unsigned int width,
                           const unsigned int height);

    OFBool getIconFromDataset(DcmItem *dataset,
                              Uint8 *pixel,
                              const unsigned long count,
                              const unsigned int width,
                              const unsigned int height);

    OFCondition addIconImage(DcmDirectoryRecord *record,
                             DcmItem *dataset,
                             const unsigned int size,
                             const OFString &sourceFilename);

    DcmDirectoryRecord *addRecord(DcmDirectoryRecord *parent,
                                  const E_DirRecType recordType,
                                  DcmItem *dataset,
                                  const OFString &referencedFileID,
                                  const OFString &sourceFilename);

    void inventMissingAttributes(DcmDirectoryRecord *parent,
                                 const OFBool recurse = OFTrue);

    void inventMissingStudyLevelAttributes(DcmDirectoryRecord *parent);

    void inventMissingSeriesLevelAttributes(DcmDirectoryRecord *parent);

    void inventMissingInstanceLevelAttributes(DcmDirectoryRecord *parent);

    void createDicomDirBackup(const char *filename);

    void deleteDicomDirBackup();

    void printMessage(const char *message,
                      const char *suffix = NULL);

    void printWarningMessage(const char *message,
                             const char *suffix = NULL);

    void printErrorMessage(const char *message,
                           const char *suffix = NULL);

    void printUnexpectedValueMessage(const DcmTagKey &key,
                                     const char *filename = NULL,
                                     const OFBool errorMsg = OFTrue);

    void printRequiredAttributeMessage(const DcmTagKey &key,
                                       const char *filename = NULL,
                                       const OFBool emptyMsg = OFFalse);

    void printAttributeErrorMessage(const DcmTagKey &key,
                                    const OFCondition &error,
                                    const char *operation);

    void printRecordErrorMessage(const OFCondition &error,
                                 const E_DirRecType recordType,
                                 const char *operation);

    void printFileErrorMessage(const OFCondition &error,
                               const char *operation,
                               const char *filename);

    OFBool copyFile(const char *fromFilename,
                    const char *toFilename);

    OFBool warnAboutInconsistentAttributes(DcmDirectoryRecord *record,
                                           DcmItem *dataset,
                                           const OFString &sourceFilename,
                                           const OFBool abortCheck = OFFalse);

    OFBool checkFilesetID(const OFString &filesetID);

    OFBool checkExists(DcmItem *dataset,
                       const DcmTagKey &key,
                       const char *filename = NULL);

    OFBool checkExistsWithValue(DcmItem *dataset,
                                const DcmTagKey &key,
                                const char *filename = NULL);

    OFBool checkExistsWithStringValue(DcmItem *dataset,
                                      const DcmTagKey &key,
                                      const OFString &value,
                                      const char *filename = NULL);

    OFBool checkExistsWithIntegerValue(DcmItem *dataset,
                                       const DcmTagKey &key,
                                       const long value,
                                       const char *filename = NULL,
                                       const OFBool reject = OFTrue);

    OFBool checkExistsWithMinMaxValue(DcmItem *dataset,
                                      const DcmTagKey &key,
                                      const long min,
                                      const long max,
                                      const char *filename = NULL,
                                      const OFBool reject = OFTrue);

    OFString &getStringFromDataset(DcmItem *dataset,
                                   const DcmTagKey &key,
                                   OFString &result,
                                   OFBool searchIntoSub = OFFalse);

    OFString &getStringFromFile(const char *filename,
                                const DcmTagKey &key,
                                OFString &result,
                                OFBool searchIntoSub = OFFalse);

    void copyElement(DcmItem *dataset,
                     const DcmTagKey &key,
                     DcmDirectoryRecord *record,
                     const OFBool optional = OFFalse,
                     const OFBool copyEmpty = OFTrue);

    void copyStringWithDefault(DcmItem *dataset,
                               const DcmTagKey &key,
                               DcmDirectoryRecord *record,
                               const char *defaultValue = "",
                               const OFBool printWarning = OFFalse);

    OFBool compareStringAttributes(DcmItem *dataset,
                                   DcmTagKey &key,
                                   DcmDirectoryRecord *record,
                                   const OFString &sourceFilename);

    OFBool compareSequenceAttributes(DcmItem *dataset,
                                     DcmTagKey &key,
                                     DcmDirectoryRecord *record,
                                     const OFString &sourceFilename);

    void setDefaultValue(DcmDirectoryRecord *record,
                         const DcmTagKey &key,
                         const unsigned long number,
                         const char *prefix = NULL);


  private:

    OFConsole *LogStream;

    DcmDicomDir *DicomDir;

    DicomDirImagePlugin *ImagePlugin;

    E_ApplicationProfile ApplicationProfile;

    OFBool VerboseMode;
    OFBool BackupMode;
    OFBool AbortMode;
    OFBool MapFilenamesMode;
    OFBool InventMode;
    OFBool InventPatientIDMode;
    OFBool EncodingCheck;
    OFBool ResolutionCheck;
    OFBool TransferSyntaxCheck;
    OFBool ConsistencyCheck;
    OFBool IconImageMode;

    OFString BackupFilename;
    OFBool BackupCreated;

    unsigned int IconSize;
    OFString IconPrefix;
    OFString DefaultIcon;

    OFBool JPEGSupport;
    OFBool RLESupport;

    unsigned long AutoPatientNumber;
    unsigned long AutoStudyNumber;
    unsigned long AutoSeriesNumber;
    unsigned long AutoInstanceNumber;
    unsigned long AutoOverlayNumber;
    unsigned long AutoLutNumber;
    unsigned long AutoCurveNumber;

    DicomDirInterface(const DicomDirInterface &obj);

    DicomDirInterface &operator=(const DicomDirInterface &obj);
};


#endif


/*
 *
 * CVS/RCS Log:
 * $Log: dcddirif.h,v $
 * Revision 1.8  2005/12/15 15:40:48  joergr
 * Removed unsused parameter.
 *
 * Revision 1.7  2005/12/08 16:28:03  meichel
 * Changed include path schema for all DCMTK header files
 *
 * Revision 1.6  2005/10/27 13:31:21  joergr
 * Added support for Encapsulated Document, Real World Value Mapping and
 * Hanging Protocol objects to DICOMDIR tools.
 *
 * Revision 1.5  2005/06/13 14:36:41  joergr
 * Added new options to disable check on pixel encoding and transfer syntax.
 *
 * Revision 1.4  2005/03/09 17:53:34  joergr
 * Added support for new Media Storage Application Profiles according to DICOM
 * PS 3.12-2004. Removed support for non-standard conformant "No profile".
 * Added support for UTF-8 for the contents of the fileset descriptor file.
 *
 * Revision 1.3  2004/02/13 17:36:46  joergr
 * Added support for new directory records RAW DATA and SPECTROSCOPY introduced
 * with CP 343.
 *
 * Revision 1.2  2004/02/13 14:11:15  joergr
 * Added support for new directory records REGISTRATION and FIDUCIAL introduced
 * with supplement 73 (Spatial Registration Storage SOP Classes).
 *
 * Revision 1.1  2003/08/12 14:35:00  joergr
 * Added new interface class for simplified creation of a DICOMDIR.
 *
 *
 */

---

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5