params.h 9.31 KB
Newer Older
1 2
#pragma once

3 4 5 6 7 8 9 10
#include <string>
#include <map>
#include <cmath>
#include <cstdio>
#include <cstring>
#include <cassert>
#include <iostream>

11 12 13 14 15 16 17 18 19 20
/*! \brief a static class allowing to change from one parametrization
 *  to another.
 *  \ingroup core
 *
 *  \details
 *  Any \typedef function object or \typedef data object should have
 *  an associated parametrization.
 */
class params
{
21
    public: // data
22

23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
		 //! \brief list of all supported parametrization for the input space.
		 //! An unsupported parametrization will go under the name
		 //! <em>unknown</em>.
		 enum input
		 {
			 ROMEIRO_TH_TD,
			 RUSIN_TH_TD,
			 RUSIN_TH_PH_TD,
			 RUSIN_TH_TD_PD,
			 RUSIN_TH_PH_TD_PD,
			 COS_TH,
			 COS_TH_TD,
			 ISOTROPIC_TV_TL_DPHI,
			 ISOTROPIC_TD_PD, // Difference between two directions such as R and H
			 CARTESIAN,
			 SPHERICAL_TL_PL_TV_PV,
			 UNKNOWN_INPUT
		 };

		 //! \brief list of all supported parametrization for the output space.
		 //! An unsupported parametrization will go under the name
		 //! <em>unknown</em>.
		 enum output
		 {
			 INV_STERADIAN,
			 ENERGY,
			 RGB_COLOR,
			 XYZ_COLOR,
			 UNKNOWN_OUTPUT
		 };
53 54 55

    public: // methods

56
        //! \brief parse a string to provide a parametrization type.
57
        static params::input parse_input(const std::string& txt);
Laurent Belcour's avatar
Laurent Belcour committed
58

59 60 61
		  //! \brief look for the string associated with a parametrization
		  //! type.
		  static std::string get_name(const params::input param);
Laurent Belcour's avatar
Laurent Belcour committed
62

63 64 65 66 67 68 69 70 71 72 73 74 75
        //! \brief parse a string to provide a parametrization type.
        static params::output parse_output(const std::string& txt)
        {
            if(txt == std::string("ENERGY"))
            {
                return params::ENERGY;
            }
            else
            {
                return params::UNKNOWN_OUTPUT;
            }
        }

76 77
        //! \brief static function for input type convertion. This
        //! function allocate the resulting vector.
78 79
        static double* convert(const double* invec, params::input intype,
                               params::input outtype)
80
        {
81 82 83 84 85
            int dim = dimension(outtype); // Get the size of the output vector

            if(dim > 0)
            {
                double* outvec = new double[dim];
86
                double  temvec[6] = {0.0, 0.0, 0.0, 0.0, 0.0, 0.0}; // Temp CARTESIAN vectors
87 88 89 90 91 92 93 94 95 96 97
                to_cartesian(invec, intype, temvec);
                from_cartesian(temvec, outtype, outvec);

                return outvec;
            }
            else
            {
                return NULL;
            }
        }

98 99
        //! \brief static function for input type convertion. The outvec
        //! resulting vector should be allocated with the correct
100
        //! output size.
101 102
        static void convert(const double* invec, params::input intype,
                            params::input outtype, double* outvec)
103
        {
104
            double  temvec[6] = {0.0, 0.0, 0.0, 0.0, 0.0, 0.0}; // Temp CARTESIAN vectors
105
            to_cartesian(invec, intype, temvec);
106 107 108 109 110
#ifdef DEBUG
            std::cout << "<<DEBUG>> temp vec = ["
                      << temvec[0] << ", " << temvec[1] << ", " << temvec[2] << "] => ["
                      << temvec[3] << ", " << temvec[4] << ", " << temvec[5] << "]" << std::endl;
#endif
111 112 113 114 115 116
            from_cartesian(temvec, outtype, outvec);
        }

        //! \brief convert a input vector in a given parametrization to an
        //! output vector in a cartesian parametrization, that is two 3d
        //! vectors concatenated.
117
        static void to_cartesian(const double* invec, params::input intype,
118
                                 double* outvec);
119 120 121

        //! \brief convert a input CARTESIAN vector, that is two 3d vectors
        //! concatenated  to an output vector in a given parametrization.
122
        static void from_cartesian(const double* invec, params::input outtype,
123
                                   double* outvec);
124 125

        //! \brief provide a dimension associated with a parametrization
126
        static int  dimension(params::input t);
127

128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
        //! \brief provide a dimension associated with a parametrization
        static int  dimension(params::output t)
        {
            switch(t)
            {
                // 1D Parametrizations
                case params::INV_STERADIAN:
                case params::ENERGY:
                    return 1;
                    break;

                // 3D Parametrization
                case params::RGB_COLOR:
                case params::XYZ_COLOR:
                    return 3;
                    break;

                default:
146
                    assert(false);
147 148 149 150 151
                    return -1;
                    break;
            }
        }

152 153 154 155 156 157 158
        //! \brief from the 4D definition of a half vector parametrization,
        //! export the cartesian coordinates.
        static void half_to_cartesian(double theta_h, double phi_h,
                                      double theta_d, double phi_d, double* out)
        {
            // Calculate the half vector
            double half[3];
159 160
            half[0] = sin(theta_h)*sin(phi_h);
            half[1] = sin(theta_h)*cos(phi_h);
161 162 163
            half[2] = cos(theta_h);

            // Compute the light vector using the rotation formula.
164 165
            out[0] = sin(theta_d)*sin(phi_d);
            out[1] = sin(theta_d)*cos(phi_d);
166
            out[2] = cos(theta_d);
167

168
				// Rotate the diff vector to get the output vector
169
            rotate_binormal(out, theta_h);
170
            rotate_normal(out, phi_h);
171 172 173 174

            // Compute the out vector from the in vector and the half
            // vector.
            const double dot = out[0]*half[0] + out[1]*half[1] + out[2]*half[2];
175 176 177
            out[3] = -out[0] + 2.0*dot * half[0];
            out[4] = -out[1] + 2.0*dot * half[1];
            out[5] = -out[2] + 2.0*dot * half[2];
178

179 180 181
#ifdef DEBUG
				assert(out[2] >= 0.0 && out[5] >= 0.0);
#endif
182
        }
183 184 185 186 187 188 189 190 191 192 193 194 195
			
        //! \brief from the 4D definition of a classical vector parametrization,
        //! export the cartesian coordinates.
		  static void classical_to_cartesian(double theta_l, double phi_l, 
		                                     double theta_v, double phi_v, double* out)
		  {
			  out[0] = cos(phi_l)*sin(theta_l);
			  out[1] = sin(phi_l)*sin(theta_l);
			  out[2] = cos(theta_l);
			  out[3] = cos(phi_v)*sin(theta_v);
			  out[4] = sin(phi_v)*sin(theta_v);
			  out[5] = cos(theta_v);
		  }
196

197
        //! \brief rotate a cartesian vector with respect to the normal of
198
        //! theta degrees.
199
        static void rotate_normal(double* vec, double theta)
200 201 202
        {
            const double cost = cos(theta);
            const double sint = sin(theta);
203

Laurent Belcour's avatar
Laurent Belcour committed
204
			const double temp = cost * vec[0] + sint * vec[1];
205 206 207

            vec[1] = cost * vec[1] - sint * vec[0];
            vec[0] = temp;
208 209
        }

210
        //! \brief rotate a cartesian vector with respect to the bi-normal of
211
        //! theta degrees.
212
        static void rotate_binormal(double* vec, double theta)
213 214 215 216
        {
            const double cost = cos(theta);
            const double sint = sin(theta);

Laurent Belcour's avatar
Laurent Belcour committed
217
			const double temp = cost * vec[1] + sint * vec[2];
218

Laurent Belcour's avatar
Laurent Belcour committed
219 220 221
#ifdef DEBUG
			std::cout << acos(vec[2]) << std::endl;
#endif
222
            vec[2] = cost * vec[2] - sint * vec[1];
Laurent Belcour's avatar
Laurent Belcour committed
223 224 225
#ifdef DEBUG
			std::cout << acos(vec[2]) << std::endl;
#endif
226
            vec[1] = temp;
227
        }
228

229
		  static void print_input_params();
230

231
};
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290

/*! \brief A parametrized object. Allow to define function object (either data
 *  or functions that are defined over an input space and output space. This
 *  Object allowas to change the parametrization of the input or output space.
 */
class parametrized
{
	public:
		parametrized() : _in_param(params::UNKNOWN_INPUT), 
		                 _out_param(params::UNKNOWN_OUTPUT) { }

		//! \brief provide the input parametrization of the object.
		virtual params::input parametrization() const
		{
			return _in_param;
		}
		
		//! \brief provide the input parametrization of the object.
		virtual params::input input_parametrization() const
		{
			return _in_param;
		}
		
		//! \brief provide the outout parametrization of the object.
		virtual params::output output_parametrization() const
		{
			return _out_param;
		}

		//! \brief can set the input parametrization of a non-parametrized
		//! object. Print an error if it is already defined.
		virtual void setParametrization(params::input new_param)
		{
			//! \todo Here is something strange happening. The equality between
			//! those enums is not correct for UNKNOWN_INPUT
			if(_in_param == new_param)
			{
				return;
			}
			else if(_in_param == params::UNKNOWN_INPUT)
			{
				_in_param = new_param;
			}
			else
			{
				std::cout << "<<ERROR>> an input parametrization is already defined: " << params::get_name(_in_param) << std::endl;
				std::cout << "<<ERROR>> trying to change to: " << params::get_name(new_param) << std::endl;
			}
		}
		
		//! \brief can set the output parametrization of a non-parametrized
		//! function. Throw an exception if it tries to erase a previously
		//! defined one.
		virtual void setParametrization(params::output new_param)
		{
			if(_out_param == new_param)
			{
				return;
			}
291
            else if(_out_param == params::UNKNOWN_OUTPUT)
292 293 294 295 296 297 298 299 300 301 302 303 304 305
			{
				_out_param = new_param;
			}
			else
			{
				std::cout << "<<ERROR>> an output parametrization is already defined: " << std::endl;
			}
		}

	protected:
		// Input and output parametrization
		params::input  _in_param ;
		params::output _out_param ;
};