/* -*- mia-c++  -*-
 *
 * This file is part of MIA - a toolbox for medical image analysis 
 * Copyright (c) Leipzig, Madrid 1999-2015 Gert Wollny
 *
 * MIA 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.
 *
 * 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 MIA; if not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef mia_core_pixeltype_hh
#define mia_core_pixeltype_hh

#include <mia/core/dictmap.hh>
#include <miaconfig.h>

NS_MIA_BEGIN

/** an enumerate for the different pixel types
    \remark replacing the values to become flags might be a better idea then a sequancial numbering
 */
enum EPixelType {it_bit,  /**< bit/bool pixels */
		 it_sbyte,  /**< signed byte pixels  (8-bit)*/
		 it_ubyte,  /**< unsigned byte pixels (8-bit) */
		 it_sshort, /**< signed short pixels (16-bit) */
		 it_ushort, /**< unsigned short pixels (16-bit) */
		 it_sint,   /**< signed int pixels (32-bit)*/
		 it_uint,   /**< unsigned int pixels (32-bit)*/
#ifdef LONG_64BIT
		 it_slong,  /**< signed long pixels (64 bit)*/
		 it_ulong,  /**< unsigned long pixels (64 bit) */
#endif
		 it_float,  /**< float pixels (32 bit)*/
		 it_double, /**< double pixels (63 bit)*/
		 it_none,   /**< type not set */
		 it_unknown /**< unexpected type */
};

/**
   types of pixel conversions 
 */
enum EPixelConversion {pc_copy, /**< copy pixel values, ranges and values are truncated at conversion */
		       pc_linear, /**< apply the linear function ax+b to the voxel values, then convert the values */
		       pc_range, /**< apply a linear mapping the maps the complete input range of the input type to the 
				    complete output range of the output type, output to float and double 
				    is mapped to [-1,1] */
		       pc_opt, /**< apply a linear mapping the maps the actual input value range to the 
				    complete output value range, output to float and double is mapped to [-1,1] */
		       pc_opt_stat, /**< apply a linear mapping the maps the mean of the the actual input values 
				       to the mean of the output range and lets the output variation be 0.25 of 
				       the output range */
		       pc_unknown};


/// dictionary table for the pixel types 
EXPORT_CORE extern const TDictMap<EPixelType>::Table PixelTypeTable[];

/// dictionary for the pixel types 
EXPORT_CORE extern const TDictMap<EPixelType> CPixelTypeDict;

/// dictionary table for the pixel conversion types 
EXPORT_CORE extern const TDictMap<EPixelConversion>::Table ConversionTypeTable[];

/// dictionary for the pixel conversion types 
EXPORT_CORE extern const TDictMap<EPixelConversion> CPixelConversionDict;

/**
   @cond INTERNAL 
   A type-traits class to map pixel types to the according pixel type value.
*/
template <typename T>
struct pixel_type {
	static const EPixelType value = it_unknown;
};

template <>
struct pixel_type<bool> {
	static const EPixelType value = it_bit;
};

template <>
struct pixel_type<signed char> {
	static const EPixelType value = it_sbyte;
};

template <>
struct pixel_type<unsigned char> {
	static const EPixelType value = it_ubyte;
};

template <>
struct pixel_type<signed short> {
	static const EPixelType value = it_sshort;
};

template <>
struct pixel_type<unsigned short> {
	static const EPixelType value = it_ushort;
};

template <>
struct pixel_type<signed int> {
	static const EPixelType value = it_sint;
};

template <>
struct pixel_type<unsigned int> {
	static const EPixelType value = it_uint;
};

#ifdef LONG_64BIT
template <>
struct pixel_type<signed long> {
	static const EPixelType value = it_slong;
};

template <>
struct pixel_type<unsigned long> {
	static const EPixelType value = it_ulong;
};
#endif

template <>
struct pixel_type<float> {
	static const EPixelType value = it_float;
};

template <>
struct pixel_type<double> {
	static const EPixelType value = it_double;
};

///   @endcond

NS_MIA_END

#endif
