source: sasview/sansmodels/src/sans/models/c_models/CSphereModel.cpp @ 2cef9d3

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 2cef9d3 was 0b082f3, checked in by Mathieu Doucet <doucetm@…>, 13 years ago

Re #7 Enable openmp for all models
  • Property mode set to 100644
File size: 19.0 KB
Line 
1/**
2        This software was developed by the University of Tennessee as part of the
3        Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
4        project funded by the US National Science Foundation.
5
6        If you use DANSE applications to do scientific research that leads to
7        publication, we ask that you acknowledge the use of the software with the
8        following sentence:
9
10        "This work benefited from DANSE software developed under NSF award DMR-0520547."
11
12        copyright 2008, University of Tennessee
13 */
14
15/** CSphereModel
16 *
17 * C extension
18 *
19 * WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
20 *          DO NOT MODIFY THIS FILE, MODIFY sphere.h
21 *          AND RE-RUN THE GENERATOR SCRIPT
22 *
23 */
24#define NO_IMPORT_ARRAY
25#define PY_ARRAY_UNIQUE_SYMBOL PyArray_API_sans
26 
27extern "C" {
28#include <Python.h>
29#include <arrayobject.h>
30#include "structmember.h"
31#include <stdio.h>
32#include <stdlib.h>
33#include <math.h>
34#include <time.h>
35#include "sphere.h"
36}
37
38#include "models.hh"
39#include "dispersion_visitor.hh"
40
41/// Error object for raised exceptions
42static PyObject * CSphereModelError = NULL;
43
44
45// Class definition
46typedef struct {
47    PyObject_HEAD
48    /// Parameters
49    PyObject * params;
50    /// Dispersion parameters
51    PyObject * dispersion;
52    /// Underlying model object
53    SphereModel * model;
54    /// Log for unit testing
55    PyObject * log;
56} CSphereModel;
57
58
59static void
60CSphereModel_dealloc(CSphereModel* self)
61{
62    Py_DECREF(self->params);
63    Py_DECREF(self->dispersion);
64    Py_DECREF(self->log);
65    delete self->model;
66    self->ob_type->tp_free((PyObject*)self);
67   
68
69}
70
71static PyObject *
72CSphereModel_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
73{
74    CSphereModel *self;
75   
76    self = (CSphereModel *)type->tp_alloc(type, 0);
77   
78    return (PyObject *)self;
79}
80
81static int
82CSphereModel_init(CSphereModel *self, PyObject *args, PyObject *kwds)
83{
84    if (self != NULL) {
85       
86        // Create parameters
87        self->params = PyDict_New();
88        self->dispersion = PyDict_New();
89        self->model = new SphereModel();
90       
91        // Initialize parameter dictionary
92        PyDict_SetItemString(self->params,"sldSolv",Py_BuildValue("d",0.000001000000));
93        PyDict_SetItemString(self->params,"sldSph",Py_BuildValue("d",0.000002000000));
94        PyDict_SetItemString(self->params,"scale",Py_BuildValue("d",1.000000000000));
95        PyDict_SetItemString(self->params,"radius",Py_BuildValue("d",60.000000000000));
96        PyDict_SetItemString(self->params,"background",Py_BuildValue("d",0.000000000000));
97        // Initialize dispersion / averaging parameter dict
98        DispersionVisitor* visitor = new DispersionVisitor();
99        PyObject * disp_dict;
100        disp_dict = PyDict_New();
101        self->model->radius.dispersion->accept_as_source(visitor, self->model->radius.dispersion, disp_dict);
102        PyDict_SetItemString(self->dispersion, "radius", disp_dict);
103
104
105         
106        // Create empty log
107        self->log = PyDict_New();
108       
109       
110
111    }
112    return 0;
113}
114
115static char name_params[] = "params";
116static char def_params[] = "Parameters";
117static char name_dispersion[] = "dispersion";
118static char def_dispersion[] = "Dispersion parameters";
119static char name_log[] = "log";
120static char def_log[] = "Log";
121
122static PyMemberDef CSphereModel_members[] = {
123    {name_params, T_OBJECT, offsetof(CSphereModel, params), 0, def_params},
124        {name_dispersion, T_OBJECT, offsetof(CSphereModel, dispersion), 0, def_dispersion},     
125    {name_log, T_OBJECT, offsetof(CSphereModel, log), 0, def_log},
126    {NULL}  /* Sentinel */
127};
128
129/** Read double from PyObject
130    @param p PyObject
131    @return double
132*/
133double CSphereModel_readDouble(PyObject *p) {
134    if (PyFloat_Check(p)==1) {
135        return (double)(((PyFloatObject *)(p))->ob_fval);
136    } else if (PyInt_Check(p)==1) {
137        return (double)(((PyIntObject *)(p))->ob_ival);
138    } else if (PyLong_Check(p)==1) {
139        return (double)PyLong_AsLong(p);
140    } else {
141        return 0.0;
142    }
143}
144/**
145 * Function to call to evaluate model
146 * @param args: input numpy array q[]
147 * @return: numpy array object
148 */
149 
150static PyObject *evaluateOneDim(SphereModel* model, PyArrayObject *q){
151    PyArrayObject *result;
152   
153    // Check validity of array q , q must be of dimension 1, an array of double
154    if (q->nd != 1 || q->descr->type_num != PyArray_DOUBLE)
155    {
156        //const char * message= "Invalid array: q->nd=%d,type_num=%d\n",q->nd,q->descr->type_num;
157        //PyErr_SetString(PyExc_ValueError , message);
158        return NULL;
159    }
160    result = (PyArrayObject *)PyArray_FromDims(q->nd, (int *)(q->dimensions), 
161                                                                                  PyArray_DOUBLE);
162        if (result == NULL) {
163        const char * message= "Could not create result ";
164        PyErr_SetString(PyExc_RuntimeError , message);
165                return NULL;
166        }
167#pragma omp parallel for
168         for (int i = 0; i < q->dimensions[0]; i++){
169      double q_value  = *(double *)(q->data + i*q->strides[0]);
170      double *result_value = (double *)(result->data + i*result->strides[0]);
171      *result_value =(*model)(q_value);
172        }
173    return PyArray_Return(result); 
174 }
175
176 /**
177 * Function to call to evaluate model
178 * @param args: input numpy array  [x[],y[]]
179 * @return: numpy array object
180 */
181 static PyObject * evaluateTwoDimXY( SphereModel* model, 
182                              PyArrayObject *x, PyArrayObject *y)
183 {
184    PyArrayObject *result;
185    int x_len, y_len, dims[1];
186    //check validity of input vectors
187    if (x->nd != 1 || x->descr->type_num != PyArray_DOUBLE
188        || y->nd != 1 || y->descr->type_num != PyArray_DOUBLE
189        || y->dimensions[0] != x->dimensions[0]){
190        const char * message= "evaluateTwoDimXY  expect 2 numpy arrays";
191        PyErr_SetString(PyExc_ValueError , message); 
192        return NULL;
193    }
194   
195        if (PyArray_Check(x) && PyArray_Check(y)) {
196               
197            x_len = dims[0]= x->dimensions[0];
198        y_len = dims[0]= y->dimensions[0];
199           
200            // Make a new double matrix of same dims
201        result=(PyArrayObject *) PyArray_FromDims(1,dims,NPY_DOUBLE);
202        if (result == NULL){
203            const char * message= "Could not create result ";
204        PyErr_SetString(PyExc_RuntimeError , message);
205            return NULL;
206            }
207       
208        /* Do the calculation. */
209#pragma omp parallel for
210        for (int i=0; i< x_len; i++) {
211            double x_value = *(double *)(x->data + i*x->strides[0]);
212                    double y_value = *(double *)(y->data + i*y->strides[0]);
213                        double *result_value = (double *)(result->data +
214                              i*result->strides[0]);
215                        *result_value = (*model)(x_value, y_value);
216        }           
217        return PyArray_Return(result); 
218       
219        }else{
220                    PyErr_SetString(CSphereModelError, 
221                   "CSphereModel.evaluateTwoDimXY couldn't run.");
222                return NULL;
223                }       
224}
225/**
226 *  evalDistribution function evaluate a model function with input vector
227 *  @param args: input q as vector or [qx, qy] where qx, qy are vectors
228 *
229 */ 
230static PyObject * evalDistribution(CSphereModel *self, PyObject *args){
231        PyObject *qx, *qy;
232        PyArrayObject * pars;
233        int npars ,mpars;
234       
235        // Get parameters
236       
237            // Reader parameter dictionary
238    self->model->sldSolv = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sldSolv") );
239    self->model->sldSph = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sldSph") );
240    self->model->scale = PyFloat_AsDouble( PyDict_GetItemString(self->params, "scale") );
241    self->model->radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "radius") );
242    self->model->background = PyFloat_AsDouble( PyDict_GetItemString(self->params, "background") );
243    // Read in dispersion parameters
244    PyObject* disp_dict;
245    DispersionVisitor* visitor = new DispersionVisitor();
246    disp_dict = PyDict_GetItemString(self->dispersion, "radius");
247    self->model->radius.dispersion->accept_as_destination(visitor, self->model->radius.dispersion, disp_dict);
248
249       
250        // Get input and determine whether we have to supply a 1D or 2D return value.
251        if ( !PyArg_ParseTuple(args,"O",&pars) ) {
252            PyErr_SetString(CSphereModelError, 
253                "CSphereModel.evalDistribution expects a q value.");
254                return NULL;
255        }
256    // Check params
257       
258    if(PyArray_Check(pars)==1) {
259               
260            // Length of list should 1 or 2
261            npars = pars->nd; 
262            if(npars==1) {
263                // input is a numpy array
264                if (PyArray_Check(pars)) {
265                        return evaluateOneDim(self->model, (PyArrayObject*)pars); 
266                    }
267                }else{
268                    PyErr_SetString(CSphereModelError, 
269                   "CSphereModel.evalDistribution expect numpy array of one dimension.");
270                return NULL;
271                }
272    }else if( PyList_Check(pars)==1) {
273        // Length of list should be 2 for I(qx,qy)
274            mpars = PyList_GET_SIZE(pars); 
275            if(mpars!=2) {
276                PyErr_SetString(CSphereModelError, 
277                        "CSphereModel.evalDistribution expects a list of dimension 2.");
278                return NULL;
279            }
280             qx = PyList_GET_ITEM(pars,0);
281             qy = PyList_GET_ITEM(pars,1);
282             if (PyArray_Check(qx) && PyArray_Check(qy)) {
283                 return evaluateTwoDimXY(self->model, (PyArrayObject*)qx,
284                           (PyArrayObject*)qy);
285                 }else{
286                    PyErr_SetString(CSphereModelError, 
287                   "CSphereModel.evalDistribution expect 2 numpy arrays in list.");
288                return NULL;
289             }
290        }
291        PyErr_SetString(CSphereModelError, 
292                   "CSphereModel.evalDistribution couln't be run.");
293        return NULL;
294       
295}
296
297/**
298 * Function to call to evaluate model
299 * @param args: input q or [q,phi]
300 * @return: function value
301 */
302static PyObject * run(CSphereModel *self, PyObject *args) {
303        double q_value, phi_value;
304        PyObject* pars;
305        int npars;
306       
307        // Get parameters
308       
309            // Reader parameter dictionary
310    self->model->sldSolv = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sldSolv") );
311    self->model->sldSph = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sldSph") );
312    self->model->scale = PyFloat_AsDouble( PyDict_GetItemString(self->params, "scale") );
313    self->model->radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "radius") );
314    self->model->background = PyFloat_AsDouble( PyDict_GetItemString(self->params, "background") );
315    // Read in dispersion parameters
316    PyObject* disp_dict;
317    DispersionVisitor* visitor = new DispersionVisitor();
318    disp_dict = PyDict_GetItemString(self->dispersion, "radius");
319    self->model->radius.dispersion->accept_as_destination(visitor, self->model->radius.dispersion, disp_dict);
320
321       
322        // Get input and determine whether we have to supply a 1D or 2D return value.
323        if ( !PyArg_ParseTuple(args,"O",&pars) ) {
324            PyErr_SetString(CSphereModelError, 
325                "CSphereModel.run expects a q value.");
326                return NULL;
327        }
328         
329        // Check params
330        if( PyList_Check(pars)==1) {
331               
332                // Length of list should be 2 for I(q,phi)
333            npars = PyList_GET_SIZE(pars); 
334            if(npars!=2) {
335                PyErr_SetString(CSphereModelError, 
336                        "CSphereModel.run expects a double or a list of dimension 2.");
337                return NULL;
338            }
339            // We have a vector q, get the q and phi values at which
340            // to evaluate I(q,phi)
341            q_value = CSphereModel_readDouble(PyList_GET_ITEM(pars,0));
342            phi_value = CSphereModel_readDouble(PyList_GET_ITEM(pars,1));
343            // Skip zero
344            if (q_value==0) {
345                return Py_BuildValue("d",0.0);
346            }
347                return Py_BuildValue("d",(*(self->model)).evaluate_rphi(q_value,phi_value));
348
349        } else {
350
351                // We have a scalar q, we will evaluate I(q)
352                q_value = CSphereModel_readDouble(pars);               
353               
354                return Py_BuildValue("d",(*(self->model))(q_value));
355        }       
356}
357/**
358 * Function to call to calculate_ER
359 * @return: effective radius value
360 */
361static PyObject * calculate_ER(CSphereModel *self) {
362
363        // Get parameters
364       
365            // Reader parameter dictionary
366    self->model->sldSolv = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sldSolv") );
367    self->model->sldSph = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sldSph") );
368    self->model->scale = PyFloat_AsDouble( PyDict_GetItemString(self->params, "scale") );
369    self->model->radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "radius") );
370    self->model->background = PyFloat_AsDouble( PyDict_GetItemString(self->params, "background") );
371    // Read in dispersion parameters
372    PyObject* disp_dict;
373    DispersionVisitor* visitor = new DispersionVisitor();
374    disp_dict = PyDict_GetItemString(self->dispersion, "radius");
375    self->model->radius.dispersion->accept_as_destination(visitor, self->model->radius.dispersion, disp_dict);
376
377               
378        return Py_BuildValue("d",(*(self->model)).calculate_ER());
379
380}
381/**
382 * Function to call to evaluate model in cartesian coordinates
383 * @param args: input q or [qx, qy]]
384 * @return: function value
385 */
386static PyObject * runXY(CSphereModel *self, PyObject *args) {
387        double qx_value, qy_value;
388        PyObject* pars;
389        int npars;
390       
391        // Get parameters
392       
393            // Reader parameter dictionary
394    self->model->sldSolv = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sldSolv") );
395    self->model->sldSph = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sldSph") );
396    self->model->scale = PyFloat_AsDouble( PyDict_GetItemString(self->params, "scale") );
397    self->model->radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "radius") );
398    self->model->background = PyFloat_AsDouble( PyDict_GetItemString(self->params, "background") );
399    // Read in dispersion parameters
400    PyObject* disp_dict;
401    DispersionVisitor* visitor = new DispersionVisitor();
402    disp_dict = PyDict_GetItemString(self->dispersion, "radius");
403    self->model->radius.dispersion->accept_as_destination(visitor, self->model->radius.dispersion, disp_dict);
404
405       
406        // Get input and determine whether we have to supply a 1D or 2D return value.
407        if ( !PyArg_ParseTuple(args,"O",&pars) ) {
408            PyErr_SetString(CSphereModelError, 
409                "CSphereModel.run expects a q value.");
410                return NULL;
411        }
412         
413        // Check params
414        if( PyList_Check(pars)==1) {
415               
416                // Length of list should be 2 for I(qx, qy))
417            npars = PyList_GET_SIZE(pars); 
418            if(npars!=2) {
419                PyErr_SetString(CSphereModelError, 
420                        "CSphereModel.run expects a double or a list of dimension 2.");
421                return NULL;
422            }
423            // We have a vector q, get the qx and qy values at which
424            // to evaluate I(qx,qy)
425            qx_value = CSphereModel_readDouble(PyList_GET_ITEM(pars,0));
426            qy_value = CSphereModel_readDouble(PyList_GET_ITEM(pars,1));
427            return Py_BuildValue("d",(*(self->model))(qx_value,qy_value));
428
429        } else {
430
431                // We have a scalar q, we will evaluate I(q)
432                qx_value = CSphereModel_readDouble(pars);               
433               
434                return Py_BuildValue("d",(*(self->model))(qx_value));
435        }       
436}
437
438static PyObject * reset(CSphereModel *self, PyObject *args) {
439   
440
441    return Py_BuildValue("d",0.0);
442}
443
444static PyObject * set_dispersion(CSphereModel *self, PyObject *args) {
445        PyObject * disp;
446        const char * par_name;
447
448        if ( !PyArg_ParseTuple(args,"sO", &par_name, &disp) ) {
449            PyErr_SetString(CSphereModelError,
450                "CSphereModel.set_dispersion expects a DispersionModel object.");
451                return NULL;
452        }
453        void *temp = PyCObject_AsVoidPtr(disp);
454        DispersionModel * dispersion = static_cast<DispersionModel *>(temp);
455
456
457        // Ugliness necessary to go from python to C
458            // TODO: refactor this
459    if (!strcmp(par_name, "radius")) {
460        self->model->radius.dispersion = dispersion;
461    } else {
462            PyErr_SetString(CSphereModelError,
463                "CSphereModel.set_dispersion expects a valid parameter name.");
464                return NULL;
465        }
466
467        DispersionVisitor* visitor = new DispersionVisitor();
468        PyObject * disp_dict = PyDict_New();
469        dispersion->accept_as_source(visitor, dispersion, disp_dict);
470        PyDict_SetItemString(self->dispersion, par_name, disp_dict);
471    return Py_BuildValue("i",1);
472}
473
474
475static PyMethodDef CSphereModel_methods[] = {
476    {"run",      (PyCFunction)run     , METH_VARARGS,
477      "Evaluate the model at a given Q or Q, phi"},
478    {"runXY",      (PyCFunction)runXY     , METH_VARARGS,
479      "Evaluate the model at a given Q or Qx, Qy"},
480    {"calculate_ER",      (PyCFunction)calculate_ER     , METH_VARARGS,
481      "Evaluate the model at a given Q or Q, phi"},
482     
483    {"evalDistribution",  (PyCFunction)evalDistribution , METH_VARARGS,
484      "Evaluate the model at a given Q or Qx, Qy vector "},
485    {"reset",    (PyCFunction)reset   , METH_VARARGS,
486      "Reset pair correlation"},
487    {"set_dispersion",      (PyCFunction)set_dispersion     , METH_VARARGS,
488      "Set the dispersion model for a given parameter"},
489   {NULL}
490};
491
492static PyTypeObject CSphereModelType = {
493    PyObject_HEAD_INIT(NULL)
494    0,                         /*ob_size*/
495    "CSphereModel",             /*tp_name*/
496    sizeof(CSphereModel),             /*tp_basicsize*/
497    0,                         /*tp_itemsize*/
498    (destructor)CSphereModel_dealloc, /*tp_dealloc*/
499    0,                         /*tp_print*/
500    0,                         /*tp_getattr*/
501    0,                         /*tp_setattr*/
502    0,                         /*tp_compare*/
503    0,                         /*tp_repr*/
504    0,                         /*tp_as_number*/
505    0,                         /*tp_as_sequence*/
506    0,                         /*tp_as_mapping*/
507    0,                         /*tp_hash */
508    0,                         /*tp_call*/
509    0,                         /*tp_str*/
510    0,                         /*tp_getattro*/
511    0,                         /*tp_setattro*/
512    0,                         /*tp_as_buffer*/
513    Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
514    "CSphereModel objects",           /* tp_doc */
515    0,                         /* tp_traverse */
516    0,                         /* tp_clear */
517    0,                         /* tp_richcompare */
518    0,                         /* tp_weaklistoffset */
519    0,                         /* tp_iter */
520    0,                         /* tp_iternext */
521    CSphereModel_methods,             /* tp_methods */
522    CSphereModel_members,             /* tp_members */
523    0,                         /* tp_getset */
524    0,                         /* tp_base */
525    0,                         /* tp_dict */
526    0,                         /* tp_descr_get */
527    0,                         /* tp_descr_set */
528    0,                         /* tp_dictoffset */
529    (initproc)CSphereModel_init,      /* tp_init */
530    0,                         /* tp_alloc */
531    CSphereModel_new,                 /* tp_new */
532};
533
534
535//static PyMethodDef module_methods[] = {
536//    {NULL}
537//};
538
539/**
540 * Function used to add the model class to a module
541 * @param module: module to add the class to
542 */ 
543void addCSphereModel(PyObject *module) {
544        PyObject *d;
545       
546    if (PyType_Ready(&CSphereModelType) < 0)
547        return;
548
549    Py_INCREF(&CSphereModelType);
550    PyModule_AddObject(module, "CSphereModel", (PyObject *)&CSphereModelType);
551   
552    d = PyModule_GetDict(module);
553    static char error_name[] = "CSphereModel.error";
554    CSphereModelError = PyErr_NewException(error_name, NULL, NULL);
555    PyDict_SetItemString(d, "CSphereModelError", CSphereModelError);
556}
557
Note: See TracBrowser for help on using the repository browser.