dcmjpeg/include/dcmtk/dcmjpeg/djcparam.h

/*
 *
 *  Copyright (C) 1997-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:  dcmjpeg
 *
 *  Author:  Norbert Olges, Marco Eichelberg
 *
 *  Purpose: codec parameter class for dcmjpeg codecs
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2010-10-14 13:17:17 $
 *  CVS/RCS Revision: $Revision: 1.12 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */

#ifndef DJCPARAM_H
#define DJCPARAM_H

#include "dcmtk/config/osconfig.h"
#include "dcmtk/dcmdata/dccodec.h" /* for DcmCodecParameter */
#include "dcmtk/dcmjpeg/djutils.h" /* for enums */

class DJCodecParameter: public DcmCodecParameter
{
public:

  DJCodecParameter(
    E_CompressionColorSpaceConversion pCompressionCSConversion,
    E_DecompressionColorSpaceConversion pDecompressionCSConversion,
    E_UIDCreation pCreateSOPInstanceUID,
    E_PlanarConfiguration pPlanarConfiguration,
    OFBool predictor6WorkaroundEnable = OFFalse,
    OFBool pOptimizeHuffman = OFFalse,
    int pSmoothingFactor = 0,
    int pForcedBitDepth = 0,
    Uint32 pFragmentSize = 0,
    OFBool pCreateOffsetTable = OFTrue,
    E_SubSampling pSampleFactors = ESS_444,
    OFBool pWriteYBR422 = OFFalse,
    OFBool pConvertToSC = OFFalse,
    unsigned long pWindowType = 0,
    unsigned long pWindowParameter = 0,
    double pVoiCenter = 0.0,
    double pVoiWidth = 0.0,
    unsigned long pRoiLeft = 0,
    unsigned long pRoiTop = 0,
    unsigned long pRoiWidth = 0,
    unsigned long pRoiHeight = 0,
    OFBool pUsePixelValues = OFTrue,
    OFBool pUseModalityRescale = OFFalse,
    OFBool pAcceptWrongPaletteTags = OFFalse,
    OFBool pAcrNemaCompatibility = OFFalse,
    OFBool pTrueLosslessMode = OFTrue);

  DJCodecParameter(const DJCodecParameter& arg);

  virtual ~DJCodecParameter();

  virtual DcmCodecParameter *clone() const;

  virtual const char *className() const;

  OFBool getOptimizeHuffmanCoding() const
  {
    return optimizeHuffman;
  }

  int getSmoothingFactor() const
  {
    return smoothingFactor;
  }

  int getForcedBitDepth() const
  {
    return forcedBitDepth;
  }

  Uint32 getFragmentSize() const
  {
    return fragmentSize;
  }

  OFBool getCreateOffsetTable() const
  {
    return createOffsetTable;
  }

  E_SubSampling getSampleFactors() const
  {
    return sampleFactors;
  }

  OFBool getWriteYBR422() const
  {
    return writeYBR422;
  }

  OFBool getConvertToSC() const
  {
    return convertToSC;
  }

  E_UIDCreation getUIDCreation() const
  {
    return uidCreation;
  }

  unsigned long getWindowType() const
  {
    return windowType;
  }

  unsigned long getWindowParameter() const
  {
    return windowParameter;
  }

  void getVOIWindow(double& center, double& width) const
  {
    center = voiCenter;
    width = voiWidth;
  }

  void getROI(
    unsigned long& left_pos,
    unsigned long& top_pos,
    unsigned long& width,
    unsigned long& height) const
  {
    left_pos = roiLeft;
    top_pos = roiTop;
    width = roiWidth;
    height = roiHeight;
  }

  E_PlanarConfiguration getPlanarConfiguration() const
  {
    return planarConfiguration;
  }

  E_CompressionColorSpaceConversion getCompressionColorSpaceConversion() const
  {
    return compressionCSConversion;
  }

  E_DecompressionColorSpaceConversion getDecompressionColorSpaceConversion() const
  {
    return decompressionCSConversion;
  }

  OFBool getUsePixelValues() const
  {
    return usePixelValues;
  }

  OFBool getUseModalityRescale() const
  {
    return useModalityRescale;
  }

  OFBool getAcceptWrongPaletteTags() const
  {
    return acceptWrongPaletteTags;
  }

  OFBool getAcrNemaCompatibility() const
  {
    return acrNemaCompatibility;
  }

  OFBool getTrueLosslessMode() const
  {
    return trueLosslessMode;
  }

  OFBool predictor6WorkaroundEnabled() const
  {
    return predictor6WorkaroundEnabled_;
  }

private:

  DJCodecParameter& operator=(const DJCodecParameter&);

  E_CompressionColorSpaceConversion compressionCSConversion;

  E_DecompressionColorSpaceConversion decompressionCSConversion;

  E_PlanarConfiguration planarConfiguration;

  OFBool optimizeHuffman;

  int smoothingFactor;

  int forcedBitDepth;

  Uint32 fragmentSize;

  OFBool createOffsetTable;

  E_SubSampling sampleFactors;

  OFBool writeYBR422;

  OFBool convertToSC;

  E_UIDCreation uidCreation;

  unsigned long windowType;

  unsigned long windowParameter;

  double voiCenter;

  double voiWidth;

  unsigned long roiLeft;

  unsigned long roiTop;

  unsigned long roiWidth;

  unsigned long roiHeight;

  OFBool usePixelValues;

  OFBool useModalityRescale;

  OFBool acceptWrongPaletteTags;

  OFBool acrNemaCompatibility;

  OFBool trueLosslessMode;

  OFBool predictor6WorkaroundEnabled_;

};


#endif

/*
 * CVS/RCS Log
 * $Log: djcparam.h,v $
 * Revision 1.12  2010-10-14 13:17:17  joergr
 * Updated copyright header. Added reference to COPYRIGHT file.
 *
 * Revision 1.11  2010-06-01 16:17:49  onken
 * Added some comments and line breaks (improved code readability).
 *
 * Revision 1.10  2010-03-24 15:01:34  joergr
 * Fixed minor formatting issues in API documentation.
 *
 * Revision 1.9  2009-10-07 12:44:33  uli
 * Switched to logging mechanism provided by the "new" oflog module.
 *
 * Revision 1.8  2006-03-29 15:58:52  meichel
 * Added support for decompressing images with 16 bits/pixel compressed with
 *   a faulty lossless JPEG encoder that produces integer overflows in predictor 6.
 *
 * Revision 1.7  2005/12/08 16:59:13  meichel
 * Changed include path schema for all DCMTK header files
 *
 * Revision 1.6  2005/11/29 15:57:05  onken
 * Added commandline options --accept-acr-nema and --accept-palettes
 * (same as in dcm2pnm) to dcmcjpeg and extended dcmjpeg to support
 * these options. Thanks to Gilles Mevel for suggestion.
 *
 * Revision 1.4  2005/11/29 08:50:34  onken
 * Added support for "true" lossless compression in dcmjpeg, that doesn't
 *   use dcmimage classes, but compresses raw pixel data (8 and 16 bit) to
 *   avoid losses in quality caused by color space conversions or modality
 *   transformations etc.
 * Corresponding commandline option in dcmcjpeg (new default)
 *
 * Revision 1.3  2002/12/09 13:51:26  joergr
 * Renamed parameter/local variable to avoid name clashes with global
 * declaration left and/or right (used for as iostream manipulators).
 *
 * Revision 1.2  2001/11/19 15:13:26  meichel
 * Introduced verbose mode in module dcmjpeg. If enabled, warning
 *   messages from the IJG library are printed on ofConsole, otherwise
 *   the library remains quiet.
 *
 * Revision 1.1  2001/11/13 15:56:17  meichel
 * Initial release of module dcmjpeg
 *
 *
 */

---

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