dcmimgle/include/dcmtk/dcmimgle/diimage.h

/*
 *
 *  Copyright (C) 1996-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:  dcmimgle
 *
 *  Author:  Joerg Riesmeier
 *
 *  Purpose: DicomImage (Header)
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2010-10-14 13:16:26 $
 *  CVS/RCS Revision: $Revision: 1.47 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */


#ifndef DIIMAGE_H
#define DIIMAGE_H

#include "dcmtk/config/osconfig.h"

#include "dcmtk/dcmdata/dcitem.h"
#include "dcmtk/dcmdata/dcfcache.h"

#ifdef SUNCC
#include "dcmtk/dcmimgle/didocu.h"
#endif

#include "dcmtk/dcmimgle/diovlay.h"
#include "dcmtk/dcmimgle/diutils.h"

#define INCLUDE_CSTDIO
#include "dcmtk/ofstd/ofstdinc.h"

#include "dcmtk/ofstd/ofstream.h"


/*------------------------*
 *  forward declarations  *
 *------------------------*/

class DcmPixelData;
class DcmUnsignedShort;

#ifndef SUNCC
 class DiDocument;
#endif

class DiPixel;
class DiMonoImage;
class DiInputPixel;


/*---------------------*
 *  class declaration  *
 *---------------------*/

class DiImage
{

 public:

    DiImage(const DiDocument *docu,
            const EI_Status status,
            const int spp);

    virtual ~DiImage();

    virtual int processNextFrames(const unsigned long fcount);

    inline EI_Status getStatus() const
    {
        return ImageStatus;
    }

    inline Uint32 getNumberOfFrames() const
    {
        return NumberOfFrames;
    }

    inline Uint32 getFirstFrame() const
    {
        return FirstFrame;
    }

    inline Uint32 getRepresentativeFrame() const
    {
        return RepresentativeFrame;
    }

    inline Uint16 getRows() const
    {
        return Rows;
    }

    inline Uint16 getColumns() const
    {
         return Columns;
    }

    inline double getPixelWidth() const
    {
        return (PixelWidth > 0) ? PixelWidth : 1;
    }

    inline double getPixelHeight() const
    {
        return (PixelHeight > 0) ? PixelHeight : 1;
    }

    inline double getRowColumnRatio() const
    {
        return getPixelHeight() / getPixelWidth();
    }

    inline double getColumnRowRatio() const
    {
        return getPixelWidth() / getPixelHeight();
    }

    int setRowColumnRatio(const double ratio);

    int setColumnRowRatio(const double ratio);

    inline EP_Polarity getPolarity() const
    {
        return Polarity;
    }

    int setPolarity(const EP_Polarity polarity);

    virtual int getBits(const int bits = 0) const
    {
        return ((bits < 1) || (bits > MAX_BITS)) ? BitsPerSample : bits;
    }

    virtual EP_Interpretation getInternalColorModel() const = 0;

    virtual const DiPixel *getInterData() const = 0;

    virtual unsigned long getOutputDataSize(const int bits = 0) const = 0;

    virtual const void *getOutputData(const unsigned long frame,
                                      const int bits,
                                      const int planar) = 0;

    virtual int getOutputData(void *buffer,
                              const unsigned long size,
                              const unsigned long frame,
                              const int bits,
                              const int planar) = 0;

    virtual const void *getOutputPlane(const int plane) const = 0;

    virtual void deleteOutputData() = 0;

    virtual DiOverlay *getOverlayPtr(const unsigned int /*idx*/)
    {
        return NULL;
    }

    virtual DiMonoImage *getMonoImagePtr()
    {
        return NULL;
    }

    virtual DiImage *createImage(const unsigned long fstart,
                                 const unsigned long fcount) const = 0;

    virtual DiImage *createScale(const signed long left_pos,
                                 const signed long top_pos,
                                 const unsigned long clip_width,
                                 const unsigned long clip_height,
                                 const unsigned long scale_width,
                                 const unsigned long scale_height,
                                 const int interpolate,
                                 const int aspect,
                                 const Uint16 pvalue) const = 0;

    virtual int flip(const int horz,
                     const int vert) = 0;

    virtual DiImage *createFlip(const int horz,
                                const int vert) const = 0;

    virtual int rotate(const int degree);

    virtual DiImage *createRotate(const int degree) const = 0;

    virtual DiImage *createMono(const double red,
                                const double green,
                                const double blue) const = 0;

    virtual unsigned long createDIB(void *&data,
                                    const unsigned long size,
                                    const unsigned long frame,
                                    const int bits,
                                    const int upsideDown,
                                    const int padding = 1) = 0;

    virtual unsigned long createAWTBitmap(void *&data,
                                          const unsigned long frame,
                                          const int bits) = 0;

    int writeFrameToDataset(DcmItem &dataset,
                            const unsigned long frame = 0,
                            const int bits = 0,
                            const int planar = 0);

    virtual int writeImageToDataset(DcmItem &dataset,
                                    const int mode = 0,
                                    const int planar = 2) = 0;

    virtual int writePPM(STD_NAMESPACE ostream& stream,
                         const unsigned long frame,
                         const int bits) = 0;

    virtual int writePPM(FILE *stream,
                         const unsigned long frame,
                         const int bits) = 0;

    virtual int writeRawPPM(FILE *stream,
                            const unsigned long frame,
                            const int bits) = 0;

    virtual int writeBMP(FILE *stream,
                         const unsigned long frame,
                         const int bits);


 protected:

    DiImage(const DiDocument *docu,
            const EI_Status status);

    DiImage(const DiImage *image,
            const unsigned long fstart,
            const unsigned long fcount);

    DiImage(const DiImage *image,
            const Uint16 width,
            const Uint16 height,
            const int aspect = 0);

    DiImage(const DiImage *image,
            const int degree = 0);

    DiImage(const DiImage *image,
            const unsigned long frame,
            const int stored,
            const int alloc);

    void deleteInputData();

    void checkPixelExtension();

    void convertPixelData();

    virtual void updateImagePixelModuleAttributes(DcmItem &dataset);

    int detachPixelData();

    EI_Status ImageStatus;
    const DiDocument *Document;

    Uint32 FirstFrame;
    Uint32 NumberOfFrames;
    Uint32 TotalNumberOfFrames;
    Uint32 RepresentativeFrame;
    Uint16 Rows;
    Uint16 Columns;
    double PixelWidth;
    double PixelHeight;
    Uint16 BitsAllocated;
    Uint16 BitsStored;
    Uint16 HighBit;

    int BitsPerSample;
    int SamplesPerPixel;

    EP_Polarity Polarity;

    int hasSignedRepresentation;
    int hasPixelSpacing;
    int hasImagerPixelSpacing;
    int hasNominalScannedPixelSpacing;
    int hasPixelAspectRatio;
    int isOriginal;

    DiInputPixel *InputData;
    DcmFileCache FileCache;
    Uint32 CurrentFragment;

 // --- declarations to avoid compiler warnings

    DiImage(const DiImage &);
    DiImage &operator=(const DiImage &);
};


#endif


/*
 *
 * CVS/RCS Log:
 * $Log: diimage.h,v $
 * Revision 1.47  2010-10-14 13:16:26  joergr
 * Updated copyright header. Added reference to COPYRIGHT file.
 *
 * Revision 1.46  2010-10-05 15:26:28  joergr
 * Fixed various Doxygen API documentation issues.
 *
 * Revision 1.45  2010-03-01 09:08:46  uli
 * Removed some unnecessary include directives in the headers.
 *
 * Revision 1.44  2009-11-25 15:59:10  joergr
 * Adapted code for new approach to access individual frames of a DICOM image.
 *
 * Revision 1.43  2009-02-12 12:01:17  joergr
 * Added support for NominalScannedPixelSpacing in order to determine the pixel
 * aspect ratio (used for the new SC image IODs).
 *
 * Revision 1.42  2008-05-20 10:03:53  joergr
 * Added new bilinear and bicubic scaling algorithms for image magnification.
 *
 * Revision 1.41  2008-05-13 09:54:40  joergr
 * Added new parameter to writeImageToDataset() in order to affect the planar
 * configuration of the output image/dataset. Changed behaviour: By default,
 * the output now uses the same planar configuration as the "original" image
 * (previously: always color-by-plane).
 *
 * Revision 1.40  2006/08/15 16:30:11  meichel
 * Updated the code in module dcmimgle to correctly compile when
 *   all standard C++ classes remain in namespace std.
 *
 * Revision 1.39  2006/07/10 10:52:27  joergr
 * Added support for 32-bit BMP images.
 *
 * Revision 1.38  2005/12/08 16:47:42  meichel
 * Changed include path schema for all DCMTK header files
 *
 * Revision 1.37  2005/03/09 17:32:35  joergr
 * Added mode to writeImageToDataset() which allows the value of BitsStored to
 * be determined either from 'used' or from 'possible' pixel values.
 *
 * Revision 1.36  2004/09/22 11:33:14  joergr
 * Introduced new member variable "TotalNumberOfFrames".
 *
 * Revision 1.35  2004/07/20 18:12:16  joergr
 * Added API method to "officially" access the internal intermediate pixel data
 * representation (e.g. to get Hounsfield Units for CT images).
 *
 * Revision 1.34  2004/02/06 11:07:50  joergr
 * Distinguish more clearly between const and non-const access to pixel data.
 *
 * Revision 1.33  2004/01/05 14:52:20  joergr
 * Removed acknowledgements with e-mail addresses from CVS log.
 *
 * Revision 1.32  2003/12/08 18:22:26  joergr
 * Removed leading underscore characters from preprocessor symbols (reserved
 * symbols). Updated CVS header.
 *
 * Revision 1.31  2003/06/12 15:08:34  joergr
 * Fixed inconsistent API documentation reported by Doxygen.
 *
 * Revision 1.30  2003/05/20 09:20:41  joergr
 * Added method returning the number of bytes required to store a single
 * rendered frame: getOutputDataSize().
 *
 * Revision 1.29  2002/12/09 13:32:51  joergr
 * Renamed parameter/local variable to avoid name clashes with global
 * declaration left and/or right (used for as iostream manipulators).
 *
 * Revision 1.28  2002/11/27 14:08:04  meichel
 * Adapted module dcmimgle to use of new header file ofstdinc.h
 *
 * Revision 1.27  2002/11/26 14:48:32  joergr
 * Added Smallest/LargestImagePixelValue to the list of attributes to be
 * removed from a newly created dataset.
 *
 * Revision 1.26  2002/08/02 15:03:20  joergr
 * Enhanced writeFrameToDataset() routine (remove out-data DICOM attributes
 * from the dataset).
 * Added function to write the current image (not only a selected frame) to a
 * DICOM dataset.
 *
 * Revision 1.25  2002/06/26 16:01:55  joergr
 * Added support for polarity flag to color images.
 * Added new method to write a selected frame to a DICOM dataset (incl. required
 * attributes from the "Image Pixel Module").
 *
 * Revision 1.24  2002/04/16 13:53:11  joergr
 * Added configurable support for C++ ANSI standard includes (e.g. streams).
 *
 * Revision 1.23  2002/01/29 17:05:50  joergr
 * Added optional flag to the "Windows DIB" methods allowing to switch off the
 * scanline padding.
 *
 * Revision 1.22  2001/11/27 18:18:22  joergr
 * Added support for plugable output formats in class DicomImage. First
 * implementation is JPEG.
 *
 * Revision 1.21  2001/11/09 16:26:37  joergr
 * Added support for Window BMP file format.
 * Enhanced and renamed createTrueColorDIB() method.
 *
 * Revision 1.20  2001/06/20 15:12:49  joergr
 * Enhanced multi-frame support for command line tool 'dcm2pnm': extract all
 * or a range of frames with one call.
 *
 * Revision 1.19  2001/06/01 15:49:42  meichel
 * Updated copyright header
 *
 * Revision 1.18  2000/03/08 16:24:16  meichel
 * Updated copyright header.
 *
 * Revision 1.17  2000/02/02 11:02:38  joergr
 * Removed space characters before preprocessor directives.
 *
 * Revision 1.16  1999/10/06 13:28:21  joergr
 * Corrected creation of PrintBitmap pixel data: VOI windows should be applied
 * before clipping to avoid that the region outside the image (border) is also
 * windowed (this requires a new method in dcmimgle to create a DicomImage
 * with the grayscale transformations already applied).
 *
 * Revision 1.15  1999/09/17 12:12:18  joergr
 * Added/changed/completed DOC++ style comments in the header files.
 *
 * Revision 1.14  1999/08/25 16:39:31  joergr
 * Allow clipping region to be outside the image (overlapping).
 *
 * Revision 1.13  1999/07/23 13:53:00  joergr
 * Added support for attribute 'ImagerPixelSpacing'.
 * Added support for attribute 'RepresentativeFrameNumber'.
 * Added methods to set 'PixelAspectRatio'.
 *
 * Revision 1.12  1999/04/28 14:47:34  joergr
 * Added experimental support to create grayscale images with more than 256
 * shades of gray to be displayed on a consumer monitor (use pastel colors).
 *
 * Revision 1.11  1999/03/24 17:20:01  joergr
 * Added/Modified comments and formatting.
 *
 * Revision 1.10  1999/02/08 12:38:12  joergr
 * Added parameter 'idx' to some overlay methods to distinguish between
 * built-in and additional overlay planes.
 *
 * Revision 1.9  1999/02/03 17:01:45  joergr
 * Added BEGIN_EXTERN_C and END_EXTERN_C to some C includes.
 *
 * Revision 1.8  1999/01/20 14:59:37  joergr
 * Added new output method to fill external memory buffer with rendered pixel
 * data.
 *
 * Revision 1.7  1999/01/11 09:32:32  joergr
 * Removed method 'getMinMaxValues()' in class 'DicomImage'.
 *
 * Revision 1.6  1998/12/23 11:33:08  joergr
 * Corrected some typos and formatting.
 *
 * Revision 1.5  1998/12/22 14:03:53  joergr
 * Changed parameter declaration to avoid compiler warnings (hide parameter
 * name).
 *
 * Revision 1.4  1998/12/16 16:29:04  joergr
 * Removed several methods used for monochrome images only in base class
 * 'DiImage'. Introduced mechanism to use the methods directly.
 *
 * Revision 1.3  1998/12/14 17:17:29  joergr
 * Added methods to add and remove additional overlay planes (still untested).
 *
 * Revision 1.2  1998/11/30 12:24:07  joergr
 * Added const type qualifier to some parameters to avoid errors with MSVC5
 * (couldn't create instance of abstract class).
 *
 * Revision 1.1  1998/11/27 15:06:08  joergr
 * Added copyright message.
 * Added methods and constructors for flipping and rotating, changed for
 * scaling and clipping.
 * Added method to directly create java AWT bitmaps.
 * Renamed variable 'Status' to 'ImageStatus' because of possible conflicts
 * with X windows systems.
 * Added method to detach pixel data if it is no longer needed.
 * Added methods to support presentation LUTs and shapes.
 *
 * Revision 1.6  1998/07/01 08:39:21  joergr
 * Minor changes to avoid compiler warnings (gcc 2.8.1 with additional
 * options), e.g. add copy constructors.
 *
 * Revision 1.5  1998/05/11 14:53:16  joergr
 * Added CVS/RCS header to each file.
 *
 *
 */

---

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