source: sasview/sansmodels/src/sans/models/c_models/CFractalModel.cpp @ 01de557

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