dcmpstat/include/dcmtk/dcmpstat/dvpstat.h

/*
 *
 *  Copyright (C) 1998-2010, OFFIS e.V.
 *  All rights reserved.  See COPYRIGHT file for details.
 *
 *  This software and supporting documentation were developed by
 *
 *    OFFIS e.V.
 *    R&D Division Health
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *
 *  Module: dcmpstat
 *
 *  Author: Marco Eichelberg
 *
 *  Purpose:
 *    classes: DVPresentationState
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2010-10-14 13:16:37 $
 *  CVS/RCS Revision: $Revision: 1.47 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */

#ifndef DVPSTAT_H
#define DVPSTAT_H

#include "dcmtk/config/osconfig.h"    /* make sure OS specific configuration is included first */
#include "dcmtk/dcmpstat/dcmpstat.h"

class DicomImage;
class DiDisplayFunction;

class DVPresentationState: public DcmPresentationState
{
public:
  DVPresentationState(
    DiDisplayFunction **dispFunction=NULL,
    unsigned long minPrintBitmapX=0,
    unsigned long minPrintBitmapY=0,
    unsigned long maxPrintBitmapX=0,
    unsigned long maxPrintBitmapY=0,
    unsigned long maxPreviewImageX=0,
    unsigned long maxPreviewImageY=0);

  virtual ~DVPresentationState();

  void clear();

  OFCondition read(DcmItem &dset);

  OFCondition createFromImage(DcmItem &dset,
    DVPSoverlayActivation overlayActivation      = DVPSO_copyOverlays,
    DVPSVOIActivation     voiActivation          = DVPSV_preferVOILUT,
    OFBool                curveActivation        = OFTrue,
    OFBool                shutterActivation      = OFTrue,
    OFBool                presentationActivation = OFTrue,
    DVPSGraphicLayering   layering               = DVPSG_twoLayers,
    const char *          aetitle                = NULL,
    const char *          filesetID              = NULL,
    const char *          filesetUID             = NULL);

   OFCondition addImageReferenceAttached(
     const char *aetitle=NULL,
     const char *filesetID=NULL,
     const char *filesetUID=NULL);

   OFCondition removeImageReferenceAttached();

   OFCondition setCurrentPresentationLUT(DVPSPresentationLUTType newType);

   OFCondition setDefaultPresentationLUTShape();

   OFCondition setPresentationLookupTable(
     DcmUnsignedShort& lutDescriptor,
     DcmUnsignedShort& lutData,
     DcmLongString& lutExplanation);

   OFCondition setPresentationLookupTable(DcmItem &dset);

   OFCondition writePresentationLUTforPrint(DcmItem &dset);

   OFBool isMonochrome1Image() { return currentImageMonochrome1; }

   OFBool haveActiveVOIWindow();

   OFBool haveActiveVOILUT();

   const char *getCurrentVOIDescription();

   OFCondition getCurrentWindowWidth(double &w);

   OFCondition getCurrentWindowCenter(double &c);

   size_t getNumberOfVOILUTsInImage();

   size_t getNumberOfVOIWindowsInImage();

   const char *getDescriptionOfVOILUTsInImage(size_t idx);

   const char *getDescriptionOfVOIWindowsInImage(size_t idx);

   OFCondition setVOILUTFromImage(size_t idx,
     DVPSObjectApplicability applicability=DVPSB_currentImage);

   OFCondition setVOIWindowFromImage(size_t idx,
     DVPSObjectApplicability applicability=DVPSB_currentImage);

   OFCondition setVOIWindow(double wCenter, double wWidth, const char *description=NULL,
     DVPSObjectApplicability applicability=DVPSB_currentImage);

   OFCondition setVOILUT(
     DcmUnsignedShort& lutDescriptor,
     DcmUnsignedShort& lutData,
     DcmLongString& lutExplanation,
     DVPSObjectApplicability applicability=DVPSB_currentImage);

   void deactivateVOI(DVPSObjectApplicability applicability=DVPSB_currentImage);

   OFCondition setGammaVOILUT(double gammaValue, DVPSObjectApplicability applicability=DVPSB_currentImage);

   DVPSPresentationSizeMode getDisplayedAreaPresentationSizeMode();

   double getDisplayedAreaPresentationPixelAspectRatio();

   OFCondition getStandardDisplayedArea(Sint32& tlhcX, Sint32& tlhcY, Sint32& brhcX, Sint32& brhcY);

   OFCondition getImageRelativeDisplayedArea(Sint32& tlhcX, Sint32& tlhcY, Sint32& brhcX, Sint32& brhcY);

   OFCondition getDisplayedAreaPresentationPixelSpacing(double& x, double& y);

   OFCondition getDisplayedAreaPresentationPixelMagnificationRatio(double& magnification);

   OFBool canUseDisplayedAreaTrueSize();

   OFCondition setStandardDisplayedArea(
     DVPSPresentationSizeMode sizeMode,
     Sint32 tlhcX, Sint32 tlhcY,
     Sint32 brhcX, Sint32 brhcY,
     double magnification=1.0,
     DVPSObjectApplicability applicability=DVPSB_currentImage);

   OFCondition setImageRelativeDisplayedArea(
     DVPSPresentationSizeMode sizeMode,
     Sint32 tlhcX, Sint32 tlhcY,
     Sint32 brhcX, Sint32 brhcY,
     double magnification=1.0,
     DVPSObjectApplicability applicability=DVPSB_currentImage);

   void removeShutter(DVPSShutterType type);

   OFCondition setRectShutter(Sint32 lv, Sint32 rv, Sint32 uh, Sint32 lh);
   OFCondition setCircularShutter(Sint32 centerX, Sint32 centerY, Sint32 radius);

   OFCondition addPolyShutterVertex(Sint32 x, Sint32 y);

   OFCondition removeGraphicLayer(size_t idx);

   size_t getNumberOfTextObjects(size_t layer);

   DVPSTextObject *getTextObject(size_t layer, size_t idx);

   DVPSTextObject *addTextObject(size_t layer,
     DVPSObjectApplicability applicability=DVPSB_allImages);

   OFCondition removeTextObject(size_t layer, size_t idx);

   OFCondition moveTextObject(size_t old_layer, size_t idx, size_t new_layer,
     DVPSObjectApplicability applicability=DVPSB_allImages);

   size_t getNumberOfGraphicObjects(size_t layer);

   DVPSGraphicObject *getGraphicObject(size_t layer, size_t idx);

   DVPSGraphicObject *addGraphicObject(size_t layer,
     DVPSObjectApplicability applicability=DVPSB_allImages);

   OFCondition removeGraphicObject(size_t layer, size_t idx);

   OFCondition moveGraphicObject(size_t old_layer, size_t idx, size_t new_layer,
     DVPSObjectApplicability applicability=DVPSB_allImages);

   DVPSCurve *getCurve(size_t layer, size_t idx);

   size_t getNumberOfCurvesInImage();

   DVPSCurve *getCurveInImage(size_t idx);

   OFCondition addCurve(size_t layer, size_t curveidxinimage);

   const char *getActiveOverlayLabel(size_t layer, size_t idx);

   const char *getActiveOverlayDescription(size_t layer, size_t idx);

   OFBool activeOverlayIsROI(size_t layer, size_t idx);

   OFCondition getOverlayData(
      size_t layer,
      size_t idx,
      const void *&overlayData,
      unsigned int &width,
      unsigned int &height,
      unsigned int &left_pos,
      unsigned int &top_pos,
      OFBool &isROI,
      Uint16 &fore,
      unsigned int bits = 8);

   size_t getNumberOfOverlaysInImage();

   Uint16 getOverlayInImageGroup(size_t idx);

   const char *getOverlayInImageLabel(size_t idx);

   const char *getOverlayInImageDescription(size_t idx);

   size_t getOverlayInImageActivationLayer(size_t idx);

   OFBool overlayInImageIsROI(size_t idx);

   OFCondition removeOverlayFromPresentationState(size_t idx);

   OFCondition changeOverlayGroupInPresentationState(size_t idx, Uint16 newGroup=0);

   OFCondition addOverlayToPresentationState(DcmItem& overlayIOD, Uint16 groupInItem, Uint16 newGroup=0);

   OFBool overlayIsSuitableAsBitmapShutter(size_t idx);

   OFCondition activateOverlayInImage(size_t layer, size_t idx);

   OFCondition activateOverlayInPresentationState(size_t layer, size_t idx);

   OFCondition activateOverlayAsBitmapShutter(size_t idx);

   OFCondition deactivateOverlay(size_t layer, size_t idx);

   OFCondition attachImage(DcmDataset *dataset, OFBool transferOwnership);

   OFCondition attachImage(DcmFileFormat *fileformat, OFBool transferOwnership);

   void detachImage();

   OFBool isInverse();

   OFCondition invertImage();

    OFCondition getPixelData(
      const void *&pixelData,
      unsigned long &width,
      unsigned long &height);

    OFCondition getPixelData(
      void *pixelData,
      unsigned long size);

    const char *getAttachedImageSOPClassUID();

    const char *getAttachedImageSOPInstanceUID();

    OFCondition getImageWidth(unsigned long &width);

    OFCondition getImageHeight(unsigned long &height);

    unsigned long getPrintBitmapSize();

    OFCondition setMinimumPrintBitmapWidthHeight(unsigned long width,
                                                 unsigned long height);

    OFCondition setMaximumPrintBitmapWidthHeight(unsigned long width,
                                                 unsigned long height);

    OFCondition getPrintBitmapWidthHeight(unsigned long &width,
                                          unsigned long &height);

    OFCondition getPrintBitmapWidth(unsigned long &width);

    OFCondition getPrintBitmapHeight(unsigned long &height);

    double getPrintBitmapPixelAspectRatio();

    OFCondition getPrintBitmapRequestedImageSize(OFString& requestedImageSize);

    OFCondition getPrintBitmap(void *bitmap,
                               unsigned long size,
                               OFBool inversePLUT = OFFalse);

    OFCondition createPreviewImage(unsigned long maxWidth,
                                   unsigned long maxHeight,
                                   OFBool clipMode = OFFalse);

    void deletePreviewImage();

    unsigned long getPreviewImageSize();

    OFCondition getPreviewImageWidthHeight(unsigned long &width,
                                           unsigned long &height);

    OFCondition getPreviewImageWidth(unsigned long &width);

    OFCondition getPreviewImageHeight(unsigned long &height);

    OFCondition getPreviewImageBitmap(void *bitmap,
                                      unsigned long size);

    OFCondition getImageMinMaxPixelRange(double &minValue, double& maxValue);

    OFCondition getImageMinMaxPixelValue(double &minValue, double& maxValue);

    OFCondition getImageNumberOfFrames(unsigned long &frames);

    OFCondition selectImageFrameNumber(unsigned long frame);

    unsigned long getSelectedImageFrameNumber();

    DVPSDisplayTransform getDisplayTransform() { return displayTransform; }

    void setDisplayTransform(DVPSDisplayTransform transform) { displayTransform = transform; }

    Uint16 convertPValueToDDL(Uint16 pvalue, unsigned int bits = 8);

   OFCondition writeHardcopyImageAttributes(DcmItem &dset);

   const char *getCurrentImageModality();

   Uint16 findOverlayGroup(Uint16 currentGroup=0);

   void renderPixelData(OFBool display = OFTrue);

   DVPSDisplayedArea *getDisplayedAreaSelection();

   DVPSSoftcopyVOI *getCurrentSoftcopyVOI();

private:

   static OFCondition activateOverlayHelper(
     DVPSOverlay& ovl,
     DicomImage &image,
     OFBool asShutter = OFFalse,
     Uint16 pvalue = 0);

   /* connection with dcmimage */

   DcmDataset *currentImageDataset;
   DcmFileFormat *currentImageFileformat;
   DicomImage *currentImage;
   DicomImage *previewImage;
   unsigned long currentImageWidth;
   unsigned long currentImageHeight;
   unsigned long renderedImageWidth;
   unsigned long renderedImageHeight;
   signed long renderedImageTop;
   signed long renderedImageLeft;
   signed long renderedImageBottom;
   signed long renderedImageRight;
   char *currentImageSOPClassUID;
   char *currentImageSOPInstanceUID;
   unsigned long currentImageSelectedFrame;
   OFBool currentImageOwned;
   OFBool currentImageVOIValid;
   OFBool currentImagePLUTValid;
   OFBool currentImageFlip;
   DVPSRotationType currentImageRotation;
   int currentImageOverlaysValid;

   DVPSCurve_PList currentImageCurveList;
   DVPSVOILUT_PList currentImageVOILUTList;
   DVPSVOIWindow_PList currentImageVOIWindowList;

   DcmCodeString currentImageModality;

   OFBool currentImageMonochrome1;

   DVPSDisplayTransform displayTransform;

   OFBool imageInverse;

   DiDisplayFunction **displayFunction;

   unsigned long minimumPrintBitmapWidth;

   unsigned long minimumPrintBitmapHeight;

   unsigned long maximumPrintBitmapWidth;

   unsigned long maximumPrintBitmapHeight;

   unsigned long maximumPreviewImageWidth;

   unsigned long maximumPreviewImageHeight;

};

#endif

/*
 *  $Log: dvpstat.h,v $
 *  Revision 1.47  2010-10-14 13:16:37  joergr
 *  Updated copyright header. Added reference to COPYRIGHT file.
 *
 *  Revision 1.46  2009-11-24 14:12:58  uli
 *  Switched to logging mechanism provided by the "new" oflog module.
 *
 *  Revision 1.45  2009-05-28 10:55:38  joergr
 *  Fixed various Doxygen API documentation issues.
 *
 *  Revision 1.44  2005/12/08 16:04:07  meichel
 *  Changed include path schema for all DCMTK header files
 *
 *  Revision 1.43  2003/09/05 14:30:06  meichel
 *  Introduced new API methods that allow Displayed Areas to be queried
 *    and set either relative to the image (ignoring rotation and flip) or
 *    in absolute values as defined in the standard.  Rotate and flip methods
 *    now adjust displayed areas in the presentation state.
 *
 *  Revision 1.42  2003/08/27 14:57:19  meichel
 *  Splitted class DVPresentationState into a base class DcmPresentationState
 *    that does not depend on module dcmimgle and current derived class with
 *    public API identical to the previous version.
 *
 *  Revision 1.41  2002/12/09 13:29:49  joergr
 *  Renamed parameter/local variable to avoid name clashes with global
 *  declaration left and/or right (used for as iostream manipulators).
 *
 *  Revision 1.40  2001/09/26 15:36:17  meichel
 *  Adapted dcmpstat to class OFCondition
 *
 *  Revision 1.39  2001/06/01 15:50:23  meichel
 *  Updated copyright header
 *
 *  Revision 1.38  2000/11/13 15:50:43  meichel
 *  Added dcmpstat support methods for creating image references
 *    in SR documents.
 *
 *  Revision 1.37  2000/07/04 15:58:03  joergr
 *  Added support for overriding the presentation LUT settings made for the
 *  image boxes.
 *
 *  Revision 1.36  2000/06/09 10:14:12  joergr
 *  Added support for rendering inverse presentation LUT into print bitmaps.
 *
 *  Revision 1.35  2000/06/08 17:36:51  joergr
 *  Corrected bug in addImageReferenceToPState().
 *
 *  Revision 1.34  2000/06/02 16:00:53  meichel
 *  Adapted all dcmpstat classes to use OFConsole for log and error output
 *
 *  Revision 1.33  2000/05/30 14:21:24  joergr
 *  Renamed some variables to avoid compiler warnings (reported by gcc 2.9x with
 *  additional compiler flags).
 *
 *  Revision 1.32  2000/05/30 13:47:03  joergr
 *  Added support for multi-frame images and multiple references from a single
 *  presentation to a number of images.
 *  Removed methods which were already marked as "retired".
 *  Added new function allowing to set a VOILUT created from a given gamma
 *  value.
 *
 *  Revision 1.31  2000/03/08 16:28:57  meichel
 *  Updated copyright header.
 *
 *  Revision 1.30  2000/02/29 12:16:16  meichel
 *  Fixed bug in dcmpstat library that caused Monochrome1 images
 *    to be printed inverse if a Presentation LUT was applied.
 *
 *  Revision 1.29  1999/11/15 19:02:16  joergr
 *  Changed behaviour of method getOverlayData(): parameter 'transp' replaced by
 *  'fore' to specify the foreground color used for the overlay plane.
 *
 *  Revision 1.28  1999/11/03 10:36:32  joergr
 *  Enhanced comments for methods dealing with arrays of pixel data.
 *
 *  Revision 1.27  1999/10/20 10:49:20  joergr
 *  Enhanced method getOverlayData to support 12 bit data for print.
 *  Enhanced method convertPValueToDDL to support 12 bit data for print.
 *  Added support for a down-scaled preview image of the current DICOM image
 *  (e.g. useful for online-windowing or print preview).
 *
 *  Revision 1.26  1999/10/19 16:24:50  meichel
 *  Corrected handling of MONOCHROME1 images when used with P-LUTs
 *
 *  Revision 1.25  1999/10/13 14:11:57  meichel
 *  Added config file entries and access methods
 *    for user-defined VOI presets, log directory, verbatim logging
 *    and an explicit list of image display formats for each printer.
 *
 *  Revision 1.24  1999/10/07 17:21:51  meichel
 *  Reworked management of Presentation LUTs in order to create tighter
 *    coupling between Softcopy and Print.
 *
 *  Revision 1.23  1999/09/10 12:46:48  meichel
 *  Added implementations for a number of print API methods.
 *
 *  Revision 1.22  1999/09/10 09:02:32  joergr
 *  Added support for CIELAB display function. New methods to handle display
 *  functions. Old methods are marked as retired and should be removed asap.
 *
 *  Revision 1.21  1999/09/07 09:04:37  joergr
 *  Completed support for getting a print bitmap out of a pstate object.
 *
 *  Revision 1.20  1999/09/01 16:14:42  meichel
 *  Added support for requested image size to print routines
 *
 *  Revision 1.19  1999/08/27 15:57:58  meichel
 *  Added methods for saving hardcopy images and stored print objects
 *    either in file or in the local database.
 *
 *  Revision 1.18  1999/08/25 16:48:01  joergr
 *  Added minimal support to get a print bitmap out of a pstate object.
 *
 *  Revision 1.17  1999/07/30 13:34:51  meichel
 *  Added new classes managing Stored Print objects
 *
 *  Revision 1.16  1999/07/22 16:39:13  meichel
 *  Adapted dcmpstat data structures and API to supplement 33 letter ballot text.
 *
 *  Revision 1.15  1999/05/04 12:28:11  meichel
 *  Removed carriage returns
 *
 *  Revision 1.14  1999/04/27 11:23:57  joergr
 *  Added method to check whether current image is inverse or not.
 *
 *  Revision 1.13  1999/03/22 09:05:35  joergr
 *  Added parameter to get value of (transparent) background color for method
 *  getOverlayData.
 *
 *  Revision 1.12  1999/03/03 13:26:06  joergr
 *  Added method to invert an image by changing the presentation state LUT or
 *  shape.
 *  Moved method 'isBartenTransformPossible()' from presentation state class to
 *  interface class.
 *
 *  Revision 1.11  1999/03/02 13:01:02  joergr
 *  Added method to presentation state class that checks whether Barten
 *  transformation is possible or not.
 *
 *  Revision 1.10  1999/02/25 18:40:08  joergr
 *  Added method to fill pixel data into an externally handled storage area.
 *
 *  Revision 1.9  1999/02/18 11:36:38  meichel
 *  Added new method convertPValueToDDL() to DVPresentationState
 *    that maps P-Values to DDLs.
 *
 *  Revision 1.8  1999/02/17 10:05:32  meichel
 *  Moved creation of Display Function object from DVPresentationState to
 *    DVInterface to avoid unnecessary re-reads.
 *
 *  Revision 1.7  1999/02/09 15:58:57  meichel
 *  Implemented bitmap shutter activation amd method for
 *    exchanging graphic layers.
 *
 *  Revision 1.6  1999/02/05 17:45:36  meichel
 *  Added config file entry for monitor characteristics file.  Monitor charac-
 *    teristics are passed to dcmimage if present to activate Barten transform.
 *
 *  Revision 1.5  1999/01/15 17:33:05  meichel
 *  added methods to DVPresentationState allowing to access the image
 *    references in the presentation state.  Also added methods allowing to
 *    get the width and height of the attached image.
 *
 *  Revision 1.4  1999/01/11 13:35:49  meichel
 *  added new methods getImageAspectRatio, getImageMinMaxPixelRange and
 *    getImageMinMaxPixelValue to class DVPresentationState.
 *
 *  Revision 1.3  1998/12/22 17:57:07  meichel
 *  Implemented Presentation State interface for overlays,
 *    VOI LUTs, VOI windows, curves. Added test program that
 *    allows to add curve data to DICOM images.
 *
 *  Revision 1.2  1998/12/14 16:10:35  meichel
 *  Implemented Presentation State interface for graphic layers,
 *    text and graphic annotations, presentation LUTs.
 *
 *  Revision 1.1  1998/11/27 14:50:34  meichel
 *  Initial Release.
 *
 *
 */

---

Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1