colourConverter.h 4.08 KB
Newer Older
Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
1
2
3
/*******************************************************************************
* CGoGN: Combinatorial and Geometric modeling with Generic N-dimensional Maps  *
* version 0.1                                                                  *
4
* Copyright (C) 2009-2011, IGG Team, LSIIT, University of Strasbourg           *
Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
*                                                                              *
* This library is free software; you can redistribute it and/or modify it      *
* under the terms of the GNU Lesser General Public License as published by the *
* Free Software Foundation; either version 2.1 of the License, or (at your     *
* option) any later version.                                                   *
*                                                                              *
* This library 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 Lesser General Public License  *
* for more details.                                                            *
*                                                                              *
* You should have received a copy of the GNU Lesser General Public License     *
* along with this library; if not, write to the Free Software Foundation,      *
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.           *
*                                                                              *
20
* Web site: http://cgogn.u-strasbg.fr/                                         *
Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
21
22
23
24
25
26
27
28
29
* Contact information: cgogn@unistra.fr                                        *
*                                                                              *
*******************************************************************************/

#ifndef __COLOURCONVERTER_H__
#define __COLOURCONVERTER_H__

#include "Geometry/vector_gen.h"
#include "Geometry/matrix.h"
30
#include "Utils/cgognStream.h"
Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
31
32
33
34
35

namespace CGoGN {

namespace Utils {

Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
36
37
38
39
40
41
/**
 * Supported colour spaces
 */
enum ColourEncoding
{
	C_RGB = 0,
42
43
	C_XYZ = 1,
	C_Luv = 2,
Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
44
45
46
	C_Lab = 3
} ;

Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/**
 * Class for colour conversions between the enumerated colour spaces.
 * Usage :
 *  VEC3 colRGB ; 								// current colour in RGB for example
 *  ColourConverter<REAL> cc(colRGB,C_RGB) ;	// Tell constructor you provided RGB
 *  VEC3 colLuv = cc.getLuv() ; 				// ask whatever supported colour type you require
 *
 * All conversion formulae were provided by "Notes about color", january 5th, 2011 by B. Sauvage
 */
template <typename REAL>
class ColourConverter
{

public: // types
	typedef Geom::Vector<3,REAL> VEC3 ;

public: // methods
64
65
66
67
68
	/**
	 * Constructor
	 * @param col a VEC3 colour
	 * @param enc the colour space of provided colour
	 */
Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
69
	ColourConverter(VEC3 col, enum ColourEncoding enc) ;
70
71
72
	/**
	 * Destructor
	 */
73
	~ColourConverter() ;
Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
74

75
76
77
78
79
80
81
82
83
84
	/**
	 * getR
	 * @return original value (in its original space)
	 */
	VEC3 getOriginal() ;
	/**
	 * getR
	 * @return enc value of provided colour
	 */
	VEC3 getColour(enum ColourEncoding enc) ;
85
86
87
88
	/**
	 * getR
	 * @return RGB value of provided colour
	 */
Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
89
	VEC3 getRGB() ;
90
91
92
93
	/**
	 * getR
	 * @return Luv value of provided colour
	 */
Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
94
	VEC3 getLuv() ;
95
96
97
98
99
100
101
102
103
	/**
	 * getR
	 * @return Lab value of provided colour
	 */
	VEC3 getLab() ;
	/**
	 * getR
	 * @return XYZ value of provided colour
	 */
Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
104
105
106
	VEC3 getXYZ() ;

public: // members
107
108
109
	/**
	 * Colour space of original (unaltered) data
	 */
Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
110
111
112
113
114
	enum ColourEncoding originalEnc ;

private: // private members
	VEC3 *RGB ;
	VEC3 *Luv ;
115
	VEC3 *Lab ;
Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
116
117
118
119
	VEC3 *XYZ ;

	bool convert(enum ColourEncoding from, enum ColourEncoding to) ;
	void convertRGBtoXYZ() ;
120
121
	void convertXYZtoRGB() ;

Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
122
123
	void convertXYZtoLuv() ;
	void convertLuvToXYZ() ;
124
125
126
127
128
129
130
131
132
133
134
135
136

	void convertXYZtoLab() ;
	void convertLabToXYZ() ;

private: // private constants

	// D65 reference white
	static const REAL Xn = 0.950456 ;
	static const REAL Yn = 1.0 ;
	static const REAL Zn = 1.088754 ;

	static const REAL un = 0.197832 ;
	static const REAL vn = 0.468340 ;
Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
137
138
139
140
141
142
143
144
145
146

} ;

} // namespace Utils

} // namespace CGoGN

#include "colourConverter.hpp"

#endif // __COLOURCONVERTER_H__