dvpsda.h

/*
 *
 *  Copyright (C) 1998-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: dcmpstat
 *
 *  Author: Marco Eichelberg
 *
 *  Purpose:
 *    classes: DVPSDisplayedArea
 *
 *  Last Update:      $Author: meichel $
 *  Update Date:      $Date: 2005/12/08 16:03:39 $
 *  CVS/RCS Revision: $Revision: 1.7 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */

#ifndef __DVPSDA_H__
#define __DVPSDA_H__

#include "dcmtk/config/osconfig.h"    /* make sure OS specific configuration is included first */
#include "dcmtk/dcmdata/dctk.h"
#include "dcmtk/dcmpstat/dvpsril.h"     /* for DVPSReferencedImage_PList */
#include "dcmtk/dcmpstat/dvpstyp.h"     /* for enum types */

class DVPSReferencedSeries_PList;

class DVPSDisplayedArea
{
public:
  DVPSDisplayedArea();
  
  DVPSDisplayedArea(const DVPSDisplayedArea& copy);

  DVPSDisplayedArea *clone() { return new DVPSDisplayedArea(*this); }

  virtual ~DVPSDisplayedArea();

  OFCondition read(DcmItem &dset);
  
  OFCondition write(DcmItem &dset);

  OFBool isApplicable(const char *instanceUID, unsigned long frame);

  OFBool matchesApplicability(const char *instanceUID, unsigned long frame, DVPSObjectApplicability applicability);

  DVPSPresentationSizeMode getPresentationSizeMode();
  
  double getPresentationPixelAspectRatio();
  
  void getDisplayedArea(Sint32& tlhcX, Sint32& tlhcY, Sint32& brhcX, Sint32& brhcY);

  OFCondition getPresentationPixelSpacing(double& x, double& y);
  
  OFCondition getPresentationPixelMagnificationRatio(double& magnification);

  OFCondition addImageReference(
    const char *sopclassUID,
    const char *instanceUID, 
    unsigned long frame,
    DVPSObjectApplicability applicability);

  void removeImageReference(
    DVPSReferencedSeries_PList& allReferences,
    const char *instanceUID,
    unsigned long frame, 
    unsigned long numberOfFrames, 
    DVPSObjectApplicability applicability);

  void clearImageReferences() { referencedImageList.clear(); }
  
  OFBool imageReferencesEmpty() { if (referencedImageList.size()==0) return OFTrue; else return OFFalse; }
    
  OFBool canUseTrueSize();
  
  OFCondition setDisplayedAreaPixelSpacing(double spacingX, double spacingY);

  OFCondition setDisplayedAreaPixelSpacing(const char *spacing);
  
  OFCondition setDisplayedAreaPixelAspectRatio(double ratio);

  OFCondition setDisplayedAreaPixelAspectRatio(const char *ratio);
 
  OFCondition setDisplayedArea(
    DVPSPresentationSizeMode sizeMode,
    Sint32 tlhcX, Sint32 tlhcY, 
    Sint32 brhcX, Sint32 brhcY,
    double magnification=1.0);

  void setLog(OFConsole *stream, OFBool verbMode, OFBool dbgMode);

  void rotateAndFlip(
    DVPSRotationType rotationFrom, 
    OFBool isFlippedFrom,
    DVPSRotationType rotationTo, 
    OFBool isFlippedTo);

private:
  DVPSDisplayedArea& operator=(const DVPSDisplayedArea& source);

  void switchHorizontalCorners();

  void switchVerticalCorners();

  void rotateAndFlipFromOrTo(DVPSRotationType rotation, OFBool isFlipped);

  DVPSReferencedImage_PList referencedImageList;
  DcmSignedLong            displayedAreaTopLeftHandCorner;
  DcmSignedLong            displayedAreaBottomRightHandCorner;
  DcmCodeString            presentationSizeMode;
  DcmDecimalString         presentationPixelSpacing;
  DcmIntegerString         presentationPixelAspectRatio;
  DcmFloatingPointSingle   presentationPixelMagnificationRatio;

  OFConsole *logstream;

  OFBool verboseMode;
   
  OFBool debugMode;

};

#endif

/*
 *  $Log: dvpsda.h,v $
 *  Revision 1.7  2005/12/08 16:03:39  meichel
 *  Changed include path schema for all DCMTK header files
 *
 *  Revision 1.6  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.5  2001/09/26 15:36:09  meichel
 *  Adapted dcmpstat to class OFCondition
 *
 *  Revision 1.4  2001/06/01 15:50:14  meichel
 *  Updated copyright header
 *
 *  Revision 1.3  2000/06/02 16:00:44  meichel
 *  Adapted all dcmpstat classes to use OFConsole for log and error output
 *
 *  Revision 1.2  2000/03/08 16:28:50  meichel
 *  Updated copyright header.
 *
 *  Revision 1.1  1999/07/22 16:39:05  meichel
 *  Adapted dcmpstat data structures and API to supplement 33 letter ballot text.
 *
 *
 */

---

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