view CppClient/PublicEnumerations.h @ 17:ae34bde412ae default tip

note
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 21 Dec 2016 11:05:16 +0100
parents e59bf2554e59
children
line wrap: on
line source

/**
 * Orthanc - A Lightweight, RESTful DICOM Store
 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
 * Department, University Hospital of Liege, Belgium
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * In addition, as a special exception, the copyright holders of this
 * program give permission to link the code of its release with the
 * OpenSSL project's "OpenSSL" library (or with modified versions of it
 * that use the same license as the "OpenSSL" library), and distribute
 * the linked executables. You must obey the GNU General Public License
 * in all respects for all of the code used other than "OpenSSL". If you
 * modify file(s) with this exception, you may extend this exception to
 * your version of the file(s), but you are not obligated to do so. If
 * you do not wish to do so, delete this exception statement from your
 * version. If you delete this exception statement from all source files
 * in the program, then also delete it here.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 **/


#pragma once

#include "../Orthanc/Core/Enumerations.h"

#include <laaw/laaw.h>

namespace OrthancClient
{
  /**
   * {summary}{The memory layout of the pixels (resp. voxels) of a 2D (resp. 3D) image.}
   **/
  enum LAAW_API PixelFormat
  {
    /**
     * {summary}{Color image in RGB24 format.}
     * {description}{This format describes a color image. The pixels are stored in 3
     * consecutive bytes. The memory layout is RGB.}
     **/
    PixelFormat_RGB24 = Orthanc::PixelFormat_RGB24,

      /**
       * {summary}{Color image in RGBA32 format.}
       * {description}{This format describes a color image. The pixels are stored in 4
       * consecutive bytes. The memory layout is RGBA.}
       **/
      PixelFormat_RGBA32 = Orthanc::PixelFormat_RGBA32,

      /**
       * {summary}{Graylevel 8bpp image.}
       * {description}{The image is graylevel. Each pixel is unsigned and stored in one byte.}
       **/
      PixelFormat_Grayscale8 = Orthanc::PixelFormat_Grayscale8,
      
      /**
       * {summary}{Graylevel, unsigned 16bpp image.}
       * {description}{The image is graylevel. Each pixel is unsigned and stored in two bytes.}
       **/
      PixelFormat_Grayscale16 = Orthanc::PixelFormat_Grayscale16,
      
      /**
       * {summary}{Graylevel, signed 16bpp image.}
       * {description}{The image is graylevel. Each pixel is signed and stored in two bytes.}
       **/
      PixelFormat_SignedGrayscale16 = Orthanc::PixelFormat_SignedGrayscale16
      };


  /**
   * {summary}{The extraction mode specifies the way the values of the pixels are scaled when downloading a 2D image.}
   **/
  enum LAAW_API ImageExtractionMode
  {
    /**
     * {summary}{Rescaled to 8bpp.}
     * {description}{The minimum value of the image is set to 0, and its maximum value is set to 255.}
     **/
    ImageExtractionMode_Preview = Orthanc::ImageExtractionMode_Preview,

      /**
       * {summary}{Truncation to the [0, 255] range.}
       **/
      ImageExtractionMode_UInt8 = Orthanc::ImageExtractionMode_UInt8,

      /**
       * {summary}{Truncation to the [0, 65535] range.}
       **/
      ImageExtractionMode_UInt16 = Orthanc::ImageExtractionMode_UInt16,

      /**
       * {summary}{Truncation to the [-32768, 32767] range.}
       **/
      ImageExtractionMode_Int16 = Orthanc::ImageExtractionMode_Int16
      };
}