didispfn.h

/*
 *
 *  Copyright (C) 1996-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:  dcmimgle
 *
 *  Author:  Joerg Riesmeier
 *
 *  Purpose: DicomDisplayFunction (Header)
 *
 *  Last Update:      $Author: meichel $
 *  Update Date:      $Date: 2005/12/08 16:47:37 $
 *  CVS/RCS Revision: $Revision: 1.23 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */


#ifndef DIDISPFN_H
#define DIDISPFN_H

#include "dcmtk/config/osconfig.h"

#include "dcmtk/dcmimgle/didislut.h"


/*---------------------*
 *  macro definitions  *
 *---------------------*/

#define MAX_DISPLAY_FUNCTIONS 2
#define MAX_NUMBER_OF_TABLES 15
#define WIDTH_OF_PVALUES     16


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

class DiDisplayFunction
{

 public:

    enum E_DeviceType
    {
        EDT_Monitor,
        EDT_Camera,
        EDT_Printer,
        EDT_Scanner
    };

    DiDisplayFunction(const char *filename,
                      const E_DeviceType deviceType = EDT_Monitor,
                      const signed int ord = -1);

    DiDisplayFunction(const double *val_tab,
                      const unsigned long count,
                      const Uint16 max = 255,
                      const E_DeviceType deviceType = EDT_Monitor,
                      const signed int ord = 0);

    DiDisplayFunction(const Uint16 *ddl_tab,
                      const double *val_tab,
                      const unsigned long count,
                      const Uint16 max = 255,
                      const E_DeviceType deviceType = EDT_Monitor,
                      const signed int ord = 0);

    DiDisplayFunction(const double val_min,
                      const double val_max,
                      const unsigned long count = 256,
                      const E_DeviceType deviceType = EDT_Monitor,
                      const signed int ord = 0);

    virtual ~DiDisplayFunction();

    inline int isValid() const
    {
        return Valid;
    }

    inline E_DeviceType getDeviceType() const
    {
        return DeviceType;
    }

    inline Uint16 getMaxDDLValue() const
    {
        return MaxDDLValue;
    }

    inline double getMinValue() const
    {
        return MinValue;
    }

    inline double getMaxValue() const
    {
        return MaxValue;
    }

    double getValueforDDL(const Uint16 ddl) const;

    Uint16 getDDLforValue(const double value) const;

    const DiDisplayLUT *getLookupTable(const int bits,
                                       unsigned long count = 0);

    int deleteLookupTable(const int bits);

    virtual int writeCurveData(const char *filename,
                               const OFBool mode = OFTrue) = 0;

    inline double getAmbientLightValue() const
    {
        return AmbientLight;
    }

    virtual int setAmbientLightValue(const double value);

    inline double getIlluminationValue() const
    {
        return Illumination;
    }

    virtual int setIlluminationValue(const double value);

    inline double getMinDensityValue() const
    {
        return MinDensity;
    }

    virtual int setMinDensityValue(const double value);

    inline double getMaxDensityValue() const
    {
        return MaxDensity;
    }

    virtual int setMaxDensityValue(const double value);

    double getMinLuminanceValue() const;

    double getMaxLuminanceValue() const;

    inline signed int getPolynomialOrder() const
    {
        return Order;
    }

    double convertODtoLum(const double value,
                          const OFBool useAmb = OFTrue) const;

    static double convertODtoLum(const double value,
                                 const double ambient,
                                 const double illum);


 protected:

    virtual DiDisplayLUT *getDisplayLUT(unsigned long count) = 0;

    int readConfigFile(const char *filename);

    int createSortedTable(const Uint16 *ddl_tab,
                          const double *val_tab);

    double *convertODtoLumTable(const double *od_tab,
                                const unsigned long count,
                                const OFBool useAmb);

    int interpolateValues();

    int calculateMinMax();

    int checkMinMaxDensity() const;

    int Valid;

    const E_DeviceType DeviceType;

    unsigned long ValueCount;
    Uint16 MaxDDLValue;
    signed int Order;

    double AmbientLight;
    double Illumination;

    double MinDensity;
    double MaxDensity;

    Uint16 *DDLValue;
    double *LODValue;

    double MinValue;
    double MaxValue;

    static const int MinBits;
    static const int MaxBits;

    DiDisplayLUT *LookupTable[MAX_NUMBER_OF_TABLES];


 private:

 // --- declarations to avoid compiler warnings

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


#endif


/*
 *
 * CVS/RCS Log:
 * $Log: didispfn.h,v $
 * Revision 1.23  2005/12/08 16:47:37  meichel
 * Changed include path schema for all DCMTK header files
 *
 * Revision 1.22  2003/12/08 18:18:35  joergr
 * Removed leading underscore characters from preprocessor symbols (reserved
 * symbols). Updated CVS header.
 *
 * Revision 1.21  2003/03/12 14:56:14  joergr
 * Removed default value from parameter "useAmb" in method convertODtoLumTable.
 *
 * Revision 1.20  2003/02/12 11:35:16  joergr
 * Added Dmin/max support to CIELAB calibration routines.
 *
 * Revision 1.19  2003/02/11 16:32:02  joergr
 * Added two new functions to determine the luminance/OD value of a particular
 * DDL according to the device's characteristic curve and vice versa.
 *
 * Revision 1.18  2003/02/11 10:01:14  joergr
 * Added support for Dmin/max to calibration routines (required for printers).
 *
 * Revision 1.17  2002/07/19 08:24:21  joergr
 * Enhanced/corrected comments.
 *
 * Revision 1.16  2002/07/18 12:29:08  joergr
 * Added support for hardcopy and softcopy input devices (camera and scanner).
 * Added polygonal curve fitting algorithm as an alternate interpolation
 * method.
 *
 * Revision 1.15  2002/07/03 13:50:24  joergr
 * Fixed inconsistencies regarding the handling of ambient light.
 *
 * Revision 1.14  2002/07/02 16:23:42  joergr
 * Added support for hardcopy devices to the calibrated output routines.
 *
 * Revision 1.13  2001/06/01 15:49:40  meichel
 * Updated copyright header
 *
 * Revision 1.12  2000/03/08 16:24:15  meichel
 * Updated copyright header.
 *
 * Revision 1.11  2000/03/06 18:19:35  joergr
 * Moved get-method to base class, renamed method and made method virtual to
 * avoid hiding of methods (reported by Sun CC 4.2).
 *
 * Revision 1.10  1999/10/18 15:05:51  joergr
 * Enhanced command line tool dcmdspfn (added new options).
 *
 * Revision 1.9  1999/10/18 10:15:50  joergr
 * Moved min/max value determination to display function base class. Now the
 * actual min/max values are also used for GSDFunction (instead of first and
 * last luminance value).
 *
 * Revision 1.8  1999/09/17 12:08:24  joergr
 * Added/changed/completed DOC++ style comments in the header files.
 *
 * Revision 1.7  1999/09/10 08:45:18  joergr
 * Added support for CIELAB display function.
 *
 * Revision 1.6  1999/03/24 17:19:20  joergr
 * Added/Modified comments and formatting.
 * Added support for Barten transformation from 2 to 7 bits input (now: 2-16).
 *
 * Revision 1.5  1999/03/03 11:47:42  joergr
 * Added support to specify ambient light value (re: Barten transformation).
 *
 * Revision 1.4  1999/02/23 16:55:32  joergr
 * Added tool to export display curves to a text file.
 *
 * Revision 1.3  1999/02/11 15:44:22  joergr
 * Removed unused parameter / member variable.
 *
 * Revision 1.2  1999/02/05 16:43:12  joergr
 * Added optional parameter to method convertPValueToDDL to specify width
 * of output data (number of bits).
 *
 * Revision 1.1  1999/02/03 17:46:37  joergr
 * Added support for calibration according to Barten transformation (incl.
 * a DISPLAY file describing the monitor characteristic).
 *
 *
 */

---

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