dcmimage/include/dcmtk/dcmimage/dicoimg.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:  dcmimage
 *
 *  Author:  Joerg Riesmeier
 *
 *  Purpose: DicomColorImage (Header)
 *
 *  Last Update:         $Author: joergr $
 *  Update Date:         $Date: 2010-10-14 13:16:29 $
 *  CVS/RCS Revision:    $Revision: 1.30 $
 *  Status:              $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */


#ifndef DICOIMG_H
#define DICOIMG_H

#include "dcmtk/config/osconfig.h"

#include "dcmtk/dcmimgle/diimage.h"
#include "dcmtk/dcmimage/dicopx.h"


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

class DiColorOutputPixel;


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

class DiColorImage
  : public DiImage
{

 public:

    DiColorImage(const DiDocument *docu,
                 const EI_Status status,
                 const int spp,
                 const OFBool rgb = OFTrue);

    virtual ~DiColorImage();

    virtual EP_Interpretation getInternalColorModel() const
    {
        return (RGBColorModel) ? EPI_RGB : EPI_YBR_Full;
    }

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

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

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

    const void *getOutputPlane(const int plane) const;

    void deleteOutputData();

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

    DiImage *createScale(const signed long left_pos,
                         const signed long top_pos,
                         const unsigned long src_cols,
                         const unsigned long src_rows,
                         const unsigned long dest_cols,
                         const unsigned long dest_rows,
                         const int interpolate,
                         const int aspect,
                         const Uint16 pvalue) const;

    int flip(const int horz,
             const int vert);

    DiImage *createFlip(const int horz,
                        const int vert) const;

    int rotate(const int degree);

    DiImage *createRotate(const int degree) const;

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

    const DiPixel *getInterData() const
    {
        return InterData;
    }

    const DiColorPixel *getColorInterData() const
    {
        return InterData;
    }

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

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

    int writeImageToDataset(DcmItem &dataset,
                            const int mode,
                            const int planar);

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

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

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

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


 protected:

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

    DiColorImage(const DiColorImage *image,
                 const signed long left_pos,
                 const signed long top_pos,
                 const Uint16 src_cols,
                 const Uint16 src_rows,
                 const Uint16 dest_cols,
                 const Uint16 dest_rows,
                 const int interpolate = 0,
                 const int aspect = 0);

    DiColorImage(const DiColorImage *image,
                 const int horz,
                 const int vert);

    DiColorImage(const DiColorImage *image,
                 const int degree);

    int checkInterData(const int mode = 1);

    const void *getData(void *buffer,
                        const unsigned long size,
                        const unsigned long frame,
                        const int bits,
                        const int planar);

    virtual void updateImagePixelModuleAttributes(DcmItem &dataset);

    const OFBool RGBColorModel;

    DiColorPixel *InterData;


 private:

    DiColorOutputPixel *OutputData;

 // --- declarations to avoid compiler warnings

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


#endif


/*
 *
 * CVS/RCS Log:
 * $Log: dicoimg.h,v $
 * Revision 1.30  2010-10-14 13:16:29  joergr
 * Updated copyright header. Added reference to COPYRIGHT file.
 *
 * Revision 1.29  2010-03-01 09:08:46  uli
 * Removed some unnecessary include directives in the headers.
 *
 * Revision 1.28  2008-07-11 08:36:05  joergr
 * Fixed typo in API documentation.
 *
 * Revision 1.27  2008-05-20 10:38:50  joergr
 * Added new bilinear and bicubic scaling algorithms for image magnification.
 *
 * Revision 1.26  2008-05-13 10:03:08  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.25  2006/08/15 16:35:01  meichel
 * Updated the code in module dcmimage to correctly compile when
 *   all standard C++ classes remain in namespace std.
 *
 * Revision 1.24  2006/07/10 10:57:50  joergr
 * Added support for 32-bit BMP images.
 *
 * Revision 1.23  2005/12/08 16:01:30  meichel
 * Changed include path schema for all DCMTK header files
 *
 * Revision 1.22  2005/03/09 17:45:08  joergr
 * Added mode to writeImageToDataset() - only used for monochrome images.
 *
 * Revision 1.21  2004/07/20 18:13: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.20  2004/02/06 11:18:18  joergr
 * Distinguish more clearly between const and non-const access to pixel data.
 *
 * Revision 1.19  2003/12/17 18:10:56  joergr
 * Removed leading underscore characters from preprocessor symbols (reserved
 * symbols).
 *
 * Revision 1.18  2003/06/12 15:09:41  joergr
 * Fixed inconsistent API documentation reported by Doxygen.
 *
 * Revision 1.17  2003/05/20 09:26:05  joergr
 * Added method returning the number of bytes required to store a single
 * rendered frame: getOutputDataSize().
 *
 * Revision 1.16  2002/12/09 13:37:51  joergr
 * Renamed parameter/local variable to avoid name clashes with global
 * declaration left and/or right (used for as iostream manipulators).
 *
 * Revision 1.15  2002/08/02 15:07:02  joergr
 * Added function to write the current image (not only a selected frame) to a
 * DICOM dataset.
 *
 * Revision 1.14  2002/01/29 17:07:07  joergr
 * Added optional flag to the "Windows DIB" methods allowing to switch off the
 * scanline padding.
 *
 * Revision 1.13  2001/11/27 18:22:17  joergr
 * Added support for plugable output formats in class DicomImage. First
 * implementation is JPEG.
 *
 * Revision 1.12  2001/11/09 16:38:36  joergr
 * Added support for Windows BMP file format.
 * Enhanced and renamed createTrueColorDIB() method.
 * Updated/Enhanced comments.
 *
 * Revision 1.11  2001/09/28 13:55:40  joergr
 * Added new flag (CIF_KeepYCbCrColorModel) which avoids conversion of YCbCr
 * color models to RGB.
 *
 * Revision 1.10  2001/06/01 15:49:28  meichel
 * Updated copyright header
 *
 * Revision 1.9  2000/03/08 16:21:50  meichel
 * Updated copyright header.
 *
 * Revision 1.8  1999/08/25 16:58:06  joergr
 * Added new feature: Allow clipping region to be outside the image
 * (overlapping).
 *
 * Revision 1.7  1999/04/28 12:51:57  joergr
 * Corrected some typos, comments and formatting.
 *
 * Revision 1.6  1999/01/20 14:39:52  joergr
 * Added new output method to fill external memory buffer with rendered pixel
 * data.
 *
 * Revision 1.5  1998/11/27 13:43:29  joergr
 * Added methods and constructors for flipping and rotating, changed for
 * scaling and clipping.
 *
 * Revision 1.4  1998/07/01 08:39:18  joergr
 * Minor changes to avoid compiler warnings (gcc 2.8.1 with additional
 * options), e.g. add copy constructors.
 *
 * Revision 1.3  1998/05/11 14:53:11  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