dcmpstat/include/dcmtk/dcmpstat/dcmpstat.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: DcmPresentationState
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2010-10-14 13:16:35 $
 *  CVS/RCS Revision: $Revision: 1.7 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */

#ifndef DCMPSTAT_H
#define DCMPSTAT_H

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

#include "dcmtk/ofstd/ofstring.h"     /* for class OFString */
#include "dcmtk/dcmpstat/dvpstyp.h"   /* for enum types */
#include "dcmtk/dcmpstat/dvpsovl.h"   /* for DVPSOverlay_PList */
#include "dcmtk/dcmpstat/dvpsgll.h"   /* for DVPSGraphicLayer_PList */
#include "dcmtk/dcmpstat/dvpsrsl.h"   /* for DVPSReferencedSeries_PList */
#include "dcmtk/dcmpstat/dvpsall.h"   /* for DVPSOverlayCurveActivationLayer_PList */
#include "dcmtk/dcmpstat/dvpsgal.h"   /* for DVPSGraphicObject_PList */
#include "dcmtk/dcmpstat/dvpscul.h"   /* for DVPSCurve_PList */
#include "dcmtk/dcmpstat/dvpsvll.h"   /* for DVPSVOILUT_PList */
#include "dcmtk/dcmpstat/dvpsvwl.h"   /* for DVPSVOIWindow_PList */
#include "dcmtk/dcmpstat/dvpsdal.h"   /* for DVPSDisplayedArea_PList */
#include "dcmtk/dcmpstat/dvpssvl.h"   /* for DVPSSoftcopyVOI_PList */
#include "dcmtk/dcmpstat/dvpspl.h"    /* for DVPSPresentationLUT */

class DVPSTextObject;
class DVPSGraphicObject;
class DVPSCurve;
class DVPSDisplayedArea;
class DVPSSoftcopyVOI;

class DcmPresentationState
{
public:
  DcmPresentationState();

  virtual ~DcmPresentationState();

  OFCondition read(DcmItem &dset);

  OFCondition write(DcmItem &dset, OFBool replaceSOPInstanceUID);

  const char *createInstanceUID();

  const char *getInstanceUID();

  const char *getSOPClassUID();

  const char *getPatientID();

  const char *getStudyUID();

  OFCondition addImageReference(
    const char *studyUID,
    const char *seriesUID,
    const char *sopclassUID,
    const char *instanceUID,
    const char *frames=NULL,
    const char *aetitle=NULL,
    const char *filesetID=NULL,
    const char *filesetUID=NULL);

  OFCondition addImageReference(
    DcmItem &dset,
    const char *aetitle=NULL,
    const char *filesetID=NULL,
    const char *filesetUID=NULL);

  OFCondition removeImageReference(
    const char *studyUID,
    const char *seriesUID,
    const char *instanceUID);

  OFCondition removeImageReference(DcmItem &dset);

  size_t numberOfImageReferences();

  OFCondition getImageReference(
    size_t idx,
    OFString& studyUID,
    OFString& seriesUID,
    OFString& sopclassUID,
    OFString& instanceUID,
    OFString& frames,
    OFString& aetitle,
    OFString& filesetID,
    OFString& filesetUID);


  void clear();

  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);


  /* Presentation LUT Interface */

  DVPSPresentationLUTType getPresentationLUT() { return presentationLUT.getType(); }

  OFBool havePresentationLookupTable() { return presentationLUT.haveTable(); }

  const char *getCurrentPresentationLUTExplanation() { return presentationLUT.getCurrentExplanation(); }

  const char *getPresentationLUTExplanation() { return presentationLUT.getLUTExplanation(); }

  DVPSPresentationLUT *getPresentationLUTData() { return &presentationLUT; }

  /* Rotate/Flip Interface */

  DVPSRotationType getRotation();

  OFBool getFlip();

  OFCondition setRotation(DVPSRotationType rotation);

  OFCondition setFlip(OFBool isFlipped);


  /* VOI Transform Interface */

  /* Displayed Area Interface */


  /* shutter Interface */

  OFBool haveShutter(DVPSShutterType type);

  /* rectangular shutter Interface */

  Sint32 getRectShutterLV();

  Sint32 getRectShutterRV();

  Sint32 getRectShutterUH();

  Sint32 getRectShutterLH();


  /* circular shutter Interface */

  Sint32 getCenterOfCircularShutter_x();

  Sint32 getCenterOfCircularShutter_y();

  Sint32 getRadiusOfCircularShutter();

  /* polygonal shutter Interface */

  size_t getNumberOfPolyShutterVertices();

  OFCondition getPolyShutterVertex(size_t idx, Sint32& x, Sint32& y);

  OFCondition setPolyShutterOrigin(Sint32 x, Sint32 y);

  /* bitmap shutter Interface
   *
   * see methods:
   *    overlayIsBitmapShutter(),
   *    overlayIsSuitableAsBitmapShutter(),
   *    activateOverlayAsBitmapShutter()
   * in overlay interface definitions.
   */

  /* shutter presentation value Interface */

  Uint16 getShutterPresentationValue();

  OFCondition setShutterPresentationValue(Uint16 pvalue);

  /* Presentation State Label, Description and Name Interface */

  const char *getPresentationLabel();

  const char *getPresentationDescription();

  const char *getPresentationCreatorsName();

  OFCondition setPresentationLabel(const char *label);

  OFCondition setPresentationDescription(const char *descr);

  OFCondition setPresentationCreatorsName(const char *name);

  /* specific character set */

  OFCondition setCharset(DVPScharacterSet charset);

  DVPScharacterSet getCharset();

  const char *getCharsetString();

  /* graphic layers */

  void sortGraphicLayers();

  size_t getNumberOfGraphicLayers();

  const char *getGraphicLayerName(size_t idx);

  size_t getGraphicLayerIndex(const char *name);


  const char *getGraphicLayerDescription(size_t idx);

  OFBool haveGraphicLayerRecommendedDisplayValue(size_t idx);

  OFCondition getGraphicLayerRecommendedDisplayValueGray(size_t idx, Uint16& gray);

  OFCondition getGraphicLayerRecommendedDisplayValueRGB(size_t idx, Uint16& r, Uint16& g, Uint16& b);

  OFCondition setGraphicLayerRecommendedDisplayValueGray(size_t idx, Uint16 gray);

  OFCondition setGraphicLayerRecommendedDisplayValueRGB(size_t idx, Uint16 r, Uint16 g, Uint16 b);

  void removeGraphicLayerRecommendedDisplayValue(size_t idx, OFBool rgb, OFBool monochrome);

  OFCondition setGraphicLayerName(size_t idx, const char *name);

  OFCondition setGraphicLayerDescription(size_t idx, const char *descr);

  OFCondition toFrontGraphicLayer(size_t idx);

  OFCondition toBackGraphicLayer(size_t idx);

  OFCondition exchangeGraphicLayers(size_t idx1, size_t idx2);

  OFCondition addGraphicLayer(
     const char *gLayer,
     const char *gLayerDescription=NULL);


  /* text objects */

  /* graphic objects */

  /* curves */

  size_t getNumberOfCurves(size_t layer);

  OFCondition removeCurve(size_t layer, size_t idx);

  OFCondition moveCurve(size_t old_layer, size_t idx, size_t new_layer);


  /* overlays */

  size_t getNumberOfActiveOverlays(size_t layer);

  Uint16 getActiveOverlayGroup(size_t layer, size_t idx);

  size_t getNumberOfOverlaysInPresentationState();

  Uint16 getOverlayInPresentationStateGroup(size_t idx);

  const char *getOverlayInPresentationStateLabel(size_t idx);

  const char *getOverlayInPresentationStateDescription(size_t idx);

  size_t getOverlayInPresentationStateActivationLayer(size_t idx);

  OFBool overlayIsBitmapShutter(size_t idx);

  OFBool overlayInPresentationStateIsROI(size_t idx);

  OFCondition moveOverlay(size_t old_layer, size_t idx, size_t new_layer);

  /* attached image */

   /* Display transform */

  /* print related methods */

private:

  DcmPresentationState(const DcmPresentationState& copy);

  DcmPresentationState& operator=(const DcmPresentationState& obj);

  OFCondition createDummyValues(OFBool replaceSOPInstanceUID);

  void cleanupLayers();

protected:

  OFCondition createDefaultDisplayedArea(DcmItem &dset);

  /* Module: Patient (M)
   */
  DcmPersonName            patientName;
  DcmLongString            patientID;
  DcmDate                  patientBirthDate;
  DcmCodeString            patientSex;

  /* Module: General Study (M)
   */
  DcmUniqueIdentifier      studyInstanceUID;
  DcmDate                  studyDate;
  DcmTime                  studyTime;
  DcmPersonName            referringPhysicianName;
  DcmShortString           studyID;
  DcmShortString           accessionNumber;

  /* Module: General Series (M)
   */
  DcmUniqueIdentifier      seriesInstanceUID;
  DcmIntegerString         seriesNumber;

  /* Module: Presentation Series (M) - specializes general series
   */
  // modality; see General Series

  /* Module: General Equipment (M)
   */
  DcmLongString            manufacturer;

  /* Module: Displayed Area (M)
   */
  DVPSDisplayedArea_PList  displayedAreaSelectionList;

  /* Module: Softcopy Presentation LUT (M)
   * There must never be more that one Presentation LUT for one Presentation State,
   * therefore we need not save a list of LUTs.
   */
  DVPSPresentationLUT      presentationLUT;

  /* Module: Presentation State (M)
   * specializes mask and display shutter
   */
  DcmIntegerString         imageNumber;
  DcmCodeString            presentationLabel;
  DcmLongString            presentationDescription;
  DcmDate                  presentationCreationDate;
  DcmTime                  presentationCreationTime;
  DcmPersonName            presentationCreatorsName;
  DVPSReferencedSeries_PList referencedSeriesList;
  // shutterPresentationValue; Type 1c. See Display Shutter module

  /* Module: SOP Common (M)
   * we don't store the SOP Class UID because it is well known.
   */
  DcmUniqueIdentifier      sOPInstanceUID;
  DcmCodeString            specificCharacterSet;
  DcmDate                  instanceCreationDate;
  DcmTime                  instanceCreationTime;
  DcmUniqueIdentifier      instanceCreatorUID;

  /* Module: Display Shutter (C)
   * "required if display shutter to be applied and BitmapDispShutter not present"
   */
  OFBool                   useShutterRectangular;
  OFBool                   useShutterCircular;
  OFBool                   useShutterPolygonal;
  OFBool                   useShutterBitmap;
  DcmCodeString            shutterShape;
  DcmIntegerString         shutterLeftVerticalEdge;
  DcmIntegerString         shutterRightVerticalEdge;
  DcmIntegerString         shutterUpperHorizontalEdge;
  DcmIntegerString         shutterLowerHorizontalEdge;
  DcmIntegerString         centerOfCircularShutter;
  DcmIntegerString         radiusOfCircularShutter;
  DcmIntegerString         verticesOfThePolygonalShutter;
  DcmUnsignedShort         shutterPresentationValue;

  /* Module: Bitmap Display Shutter (C)
   * "required if display shutter to be applied and DispShutter not present"
   */
  DcmUnsignedShort         shutterOverlayGroup;
  // shutterPresentationValue already defined in Display Shutter module
  // shutterShape already defined in Display Shutter module

  /* Module: Overlay Plane (C)
   * "required if overlay to be applied or BitmapDispShutter present"
   */
  DVPSOverlay_PList        overlayList;

  /* Module: Overlay/Curve Activation (C)
   * "required if ref. image contains overlay or curve to be displayed"
   */
  DVPSOverlayCurveActivationLayer_PList activationLayerList;

  /* Module: Graphic Annotation (C)
   * "required if graphical annotation to be applied"
   */
  DVPSGraphicAnnotation_PList graphicAnnotationList;

  /* Module: Spatial Transformation (C)
   * "required if rotation/flipping/magnification to be applied"
   */
  DcmUnsignedShort         imageRotation;
  DcmCodeString            imageHorizontalFlip;

  /* Module: Graphic Layer (C)
   * "required if graphic annotation, overlays or curves to be applied"
   */
  DVPSGraphicLayer_PList graphicLayerList;

  /* Module: Modality LUT (C)
   * "required if modality LUT to be applied"
   * There must never be more that one Modality LUT for one Presentation State,
   * therefore we need not save a list of LUTs.
   */
  OFBool                   useModalityRescale;
  OFBool                   useModalityLUT;
  DcmUnsignedShort         modalityLUTDescriptor;
  DcmLongString            modalityLUTExplanation;
  DcmLongString            modalityLUTType;
  DcmUnsignedShort         modalityLUTData;
  DcmDecimalString         rescaleIntercept;
  DcmDecimalString         rescaleSlope;
  DcmLongString            rescaleType;

  /* Module: Softcopy VOI LUT (C)
   * "required if VOI LUT to be applied"
   */
  DVPSSoftcopyVOI_PList    softcopyVOIList;

};

#endif

/*
 *  $Log: dcmpstat.h,v $
 *  Revision 1.7  2010-10-14 13:16:35  joergr
 *  Updated copyright header. Added reference to COPYRIGHT file.
 *
 *  Revision 1.6  2010-10-07 14:31:35  joergr
 *  Removed leading underscore characters from preprocessor symbols (reserved).
 *
 *  Revision 1.5  2010-08-09 13:20:50  joergr
 *  Updated data dictionary to 2009 edition of the DICOM standard. From now on,
 *  the official "keyword" is used for the attribute name which results in a
 *  number of minor changes (e.g. "PatientsName" is now called "PatientName").
 *
 *  Revision 1.4  2009-11-24 14:12:57  uli
 *  Switched to logging mechanism provided by the "new" oflog module.
 *
 *  Revision 1.3  2009-05-28 10:40:20  joergr
 *  Fixed various Doxygen API documentation issues.
 *
 *  Revision 1.2  2005/12/08 16:03:29  meichel
 *  Changed include path schema for all DCMTK header files
 *
 *  Revision 1.1  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.
 *
 *
 */

---

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