source: sasview/sansmodels/src/sans/models/c_models/CFractalModel.cpp @ 839f7e28

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 839f7e28 was 2605da22, checked in by Mathieu Doucet <doucetm@…>, 13 years ago

Re #4 Still a few more warnings
  • Property mode set to 100644
File size: 20.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/** 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         for (int i = 0; i < q->dimensions[0]; i++){
170      double q_value  = *(double *)(q->data + i*q->strides[0]);
171      double *result_value = (double *)(result->data + i*result->strides[0]);
172      *result_value =(*model)(q_value);
173        }
174    return PyArray_Return(result); 
175 }
176
177 /**
178 * Function to call to evaluate model
179 * @param args: input numpy array  [x[],y[]]
180 * @return: numpy array object
181 */
182 static PyObject * evaluateTwoDimXY( FractalModel* model, 
183                              PyArrayObject *x, PyArrayObject *y)
184 {
185    PyArrayObject *result;
186    int i, x_len, y_len, dims[1];
187    //check validity of input vectors
188    if (x->nd != 1 || x->descr->type_num != PyArray_DOUBLE
189        || y->nd != 1 || y->descr->type_num != PyArray_DOUBLE
190        || y->dimensions[0] != x->dimensions[0]){
191        const char * message= "evaluateTwoDimXY  expect 2 numpy arrays";
192        PyErr_SetString(PyExc_ValueError , message); 
193        return NULL;
194    }
195   
196        if (PyArray_Check(x) && PyArray_Check(y)) {
197               
198            x_len = dims[0]= x->dimensions[0];
199        y_len = dims[0]= y->dimensions[0];
200           
201            // Make a new double matrix of same dims
202        result=(PyArrayObject *) PyArray_FromDims(1,dims,NPY_DOUBLE);
203        if (result == NULL){
204            const char * message= "Could not create result ";
205        PyErr_SetString(PyExc_RuntimeError , message);
206            return NULL;
207            }
208       
209        /* Do the calculation. */
210        for ( 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(CFractalModelError, 
221                   "CFractalModel.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(CFractalModel *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->scale = PyFloat_AsDouble( PyDict_GetItemString(self->params, "scale") );
239    self->model->fractal_dim = PyFloat_AsDouble( PyDict_GetItemString(self->params, "fractal_dim") );
240    self->model->sldSolv = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sldSolv") );
241    self->model->cor_length = PyFloat_AsDouble( PyDict_GetItemString(self->params, "cor_length") );
242    self->model->background = PyFloat_AsDouble( PyDict_GetItemString(self->params, "background") );
243    self->model->radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "radius") );
244    self->model->sldBlock = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sldBlock") );
245    // Read in dispersion parameters
246    PyObject* disp_dict;
247    DispersionVisitor* visitor = new DispersionVisitor();
248    disp_dict = PyDict_GetItemString(self->dispersion, "radius");
249    self->model->radius.dispersion->accept_as_destination(visitor, self->model->radius.dispersion, disp_dict);
250
251       
252        // Get input and determine whether we have to supply a 1D or 2D return value.
253        if ( !PyArg_ParseTuple(args,"O",&pars) ) {
254            PyErr_SetString(CFractalModelError, 
255                "CFractalModel.evalDistribution expects a q value.");
256                return NULL;
257        }
258    // Check params
259       
260    if(PyArray_Check(pars)==1) {
261               
262            // Length of list should 1 or 2
263            npars = pars->nd; 
264            if(npars==1) {
265                // input is a numpy array
266                if (PyArray_Check(pars)) {
267                        return evaluateOneDim(self->model, (PyArrayObject*)pars); 
268                    }
269                }else{
270                    PyErr_SetString(CFractalModelError, 
271                   "CFractalModel.evalDistribution expect numpy array of one dimension.");
272                return NULL;
273                }
274    }else if( PyList_Check(pars)==1) {
275        // Length of list should be 2 for I(qx,qy)
276            mpars = PyList_GET_SIZE(pars); 
277            if(mpars!=2) {
278                PyErr_SetString(CFractalModelError, 
279                        "CFractalModel.evalDistribution expects a list of dimension 2.");
280                return NULL;
281            }
282             qx = PyList_GET_ITEM(pars,0);
283             qy = PyList_GET_ITEM(pars,1);
284             if (PyArray_Check(qx) && PyArray_Check(qy)) {
285                 return evaluateTwoDimXY(self->model, (PyArrayObject*)qx,
286                           (PyArrayObject*)qy);
287                 }else{
288                    PyErr_SetString(CFractalModelError, 
289                   "CFractalModel.evalDistribution expect 2 numpy arrays in list.");
290                return NULL;
291             }
292        }
293        PyErr_SetString(CFractalModelError, 
294                   "CFractalModel.evalDistribution couln't be run.");
295        return NULL;
296       
297}
298
299/**
300 * Function to call to evaluate model
301 * @param args: input q or [q,phi]
302 * @return: function value
303 */
304static PyObject * run(CFractalModel *self, PyObject *args) {
305        double q_value, phi_value;
306        PyObject* pars;
307        int npars;
308       
309        // Get parameters
310       
311            // Reader parameter dictionary
312    self->model->scale = PyFloat_AsDouble( PyDict_GetItemString(self->params, "scale") );
313    self->model->fractal_dim = PyFloat_AsDouble( PyDict_GetItemString(self->params, "fractal_dim") );
314    self->model->sldSolv = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sldSolv") );
315    self->model->cor_length = PyFloat_AsDouble( PyDict_GetItemString(self->params, "cor_length") );
316    self->model->background = PyFloat_AsDouble( PyDict_GetItemString(self->params, "background") );
317    self->model->radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "radius") );
318    self->model->sldBlock = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sldBlock") );
319    // Read in dispersion parameters
320    PyObject* disp_dict;
321    DispersionVisitor* visitor = new DispersionVisitor();
322    disp_dict = PyDict_GetItemString(self->dispersion, "radius");
323    self->model->radius.dispersion->accept_as_destination(visitor, self->model->radius.dispersion, disp_dict);
324
325       
326        // Get input and determine whether we have to supply a 1D or 2D return value.
327        if ( !PyArg_ParseTuple(args,"O",&pars) ) {
328            PyErr_SetString(CFractalModelError, 
329                "CFractalModel.run expects a q value.");
330                return NULL;
331        }
332         
333        // Check params
334        if( PyList_Check(pars)==1) {
335               
336                // Length of list should be 2 for I(q,phi)
337            npars = PyList_GET_SIZE(pars); 
338            if(npars!=2) {
339                PyErr_SetString(CFractalModelError, 
340                        "CFractalModel.run expects a double or a list of dimension 2.");
341                return NULL;
342            }
343            // We have a vector q, get the q and phi values at which
344            // to evaluate I(q,phi)
345            q_value = CFractalModel_readDouble(PyList_GET_ITEM(pars,0));
346            phi_value = CFractalModel_readDouble(PyList_GET_ITEM(pars,1));
347            // Skip zero
348            if (q_value==0) {
349                return Py_BuildValue("d",0.0);
350            }
351                return Py_BuildValue("d",(*(self->model)).evaluate_rphi(q_value,phi_value));
352
353        } else {
354
355                // We have a scalar q, we will evaluate I(q)
356                q_value = CFractalModel_readDouble(pars);               
357               
358                return Py_BuildValue("d",(*(self->model))(q_value));
359        }       
360}
361/**
362 * Function to call to calculate_ER
363 * @return: effective radius value
364 */
365static PyObject * calculate_ER(CFractalModel *self) {
366
367        // Get parameters
368       
369            // Reader parameter dictionary
370    self->model->scale = PyFloat_AsDouble( PyDict_GetItemString(self->params, "scale") );
371    self->model->fractal_dim = PyFloat_AsDouble( PyDict_GetItemString(self->params, "fractal_dim") );
372    self->model->sldSolv = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sldSolv") );
373    self->model->cor_length = PyFloat_AsDouble( PyDict_GetItemString(self->params, "cor_length") );
374    self->model->background = PyFloat_AsDouble( PyDict_GetItemString(self->params, "background") );
375    self->model->radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "radius") );
376    self->model->sldBlock = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sldBlock") );
377    // Read in dispersion parameters
378    PyObject* disp_dict;
379    DispersionVisitor* visitor = new DispersionVisitor();
380    disp_dict = PyDict_GetItemString(self->dispersion, "radius");
381    self->model->radius.dispersion->accept_as_destination(visitor, self->model->radius.dispersion, disp_dict);
382
383               
384        return Py_BuildValue("d",(*(self->model)).calculate_ER());
385
386}
387/**
388 * Function to call to evaluate model in cartesian coordinates
389 * @param args: input q or [qx, qy]]
390 * @return: function value
391 */
392static PyObject * runXY(CFractalModel *self, PyObject *args) {
393        double qx_value, qy_value;
394        PyObject* pars;
395        int npars;
396       
397        // Get parameters
398       
399            // Reader parameter dictionary
400    self->model->scale = PyFloat_AsDouble( PyDict_GetItemString(self->params, "scale") );
401    self->model->fractal_dim = PyFloat_AsDouble( PyDict_GetItemString(self->params, "fractal_dim") );
402    self->model->sldSolv = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sldSolv") );
403    self->model->cor_length = PyFloat_AsDouble( PyDict_GetItemString(self->params, "cor_length") );
404    self->model->background = PyFloat_AsDouble( PyDict_GetItemString(self->params, "background") );
405    self->model->radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "radius") );
406    self->model->sldBlock = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sldBlock") );
407    // Read in dispersion parameters
408    PyObject* disp_dict;
409    DispersionVisitor* visitor = new DispersionVisitor();
410    disp_dict = PyDict_GetItemString(self->dispersion, "radius");
411    self->model->radius.dispersion->accept_as_destination(visitor, self->model->radius.dispersion, disp_dict);
412
413       
414        // Get input and determine whether we have to supply a 1D or 2D return value.
415        if ( !PyArg_ParseTuple(args,"O",&pars) ) {
416            PyErr_SetString(CFractalModelError, 
417                "CFractalModel.run expects a q value.");
418                return NULL;
419        }
420         
421        // Check params
422        if( PyList_Check(pars)==1) {
423               
424                // Length of list should be 2 for I(qx, qy))
425            npars = PyList_GET_SIZE(pars); 
426            if(npars!=2) {
427                PyErr_SetString(CFractalModelError, 
428                        "CFractalModel.run expects a double or a list of dimension 2.");
429                return NULL;
430            }
431            // We have a vector q, get the qx and qy values at which
432            // to evaluate I(qx,qy)
433            qx_value = CFractalModel_readDouble(PyList_GET_ITEM(pars,0));
434            qy_value = CFractalModel_readDouble(PyList_GET_ITEM(pars,1));
435            return Py_BuildValue("d",(*(self->model))(qx_value,qy_value));
436
437        } else {
438
439                // We have a scalar q, we will evaluate I(q)
440                qx_value = CFractalModel_readDouble(pars);             
441               
442                return Py_BuildValue("d",(*(self->model))(qx_value));
443        }       
444}
445
446static PyObject * reset(CFractalModel *self, PyObject *args) {
447   
448
449    return Py_BuildValue("d",0.0);
450}
451
452static PyObject * set_dispersion(CFractalModel *self, PyObject *args) {
453        PyObject * disp;
454        const char * par_name;
455
456        if ( !PyArg_ParseTuple(args,"sO", &par_name, &disp) ) {
457            PyErr_SetString(CFractalModelError,
458                "CFractalModel.set_dispersion expects a DispersionModel object.");
459                return NULL;
460        }
461        void *temp = PyCObject_AsVoidPtr(disp);
462        DispersionModel * dispersion = static_cast<DispersionModel *>(temp);
463
464
465        // Ugliness necessary to go from python to C
466            // TODO: refactor this
467    if (!strcmp(par_name, "radius")) {
468        self->model->radius.dispersion = dispersion;
469    } else {
470            PyErr_SetString(CFractalModelError,
471                "CFractalModel.set_dispersion expects a valid parameter name.");
472                return NULL;
473        }
474
475        DispersionVisitor* visitor = new DispersionVisitor();
476        PyObject * disp_dict = PyDict_New();
477        dispersion->accept_as_source(visitor, dispersion, disp_dict);
478        PyDict_SetItemString(self->dispersion, par_name, disp_dict);
479    return Py_BuildValue("i",1);
480}
481
482
483static PyMethodDef CFractalModel_methods[] = {
484    {"run",      (PyCFunction)run     , METH_VARARGS,
485      "Evaluate the model at a given Q or Q, phi"},
486    {"runXY",      (PyCFunction)runXY     , METH_VARARGS,
487      "Evaluate the model at a given Q or Qx, Qy"},
488    {"calculate_ER",      (PyCFunction)calculate_ER     , METH_VARARGS,
489      "Evaluate the model at a given Q or Q, phi"},
490     
491    {"evalDistribution",  (PyCFunction)evalDistribution , METH_VARARGS,
492      "Evaluate the model at a given Q or Qx, Qy vector "},
493    {"reset",    (PyCFunction)reset   , METH_VARARGS,
494      "Reset pair correlation"},
495    {"set_dispersion",      (PyCFunction)set_dispersion     , METH_VARARGS,
496      "Set the dispersion model for a given parameter"},
497   {NULL}
498};
499
500static PyTypeObject CFractalModelType = {
501    PyObject_HEAD_INIT(NULL)
502    0,                         /*ob_size*/
503    "CFractalModel",             /*tp_name*/
504    sizeof(CFractalModel),             /*tp_basicsize*/
505    0,                         /*tp_itemsize*/
506    (destructor)CFractalModel_dealloc, /*tp_dealloc*/
507    0,                         /*tp_print*/
508    0,                         /*tp_getattr*/
509    0,                         /*tp_setattr*/
510    0,                         /*tp_compare*/
511    0,                         /*tp_repr*/
512    0,                         /*tp_as_number*/
513    0,                         /*tp_as_sequence*/
514    0,                         /*tp_as_mapping*/
515    0,                         /*tp_hash */
516    0,                         /*tp_call*/
517    0,                         /*tp_str*/
518    0,                         /*tp_getattro*/
519    0,                         /*tp_setattro*/
520    0,                         /*tp_as_buffer*/
521    Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
522    "CFractalModel objects",           /* tp_doc */
523    0,                         /* tp_traverse */
524    0,                         /* tp_clear */
525    0,                         /* tp_richcompare */
526    0,                         /* tp_weaklistoffset */
527    0,                         /* tp_iter */
528    0,                         /* tp_iternext */
529    CFractalModel_methods,             /* tp_methods */
530    CFractalModel_members,             /* tp_members */
531    0,                         /* tp_getset */
532    0,                         /* tp_base */
533    0,                         /* tp_dict */
534    0,                         /* tp_descr_get */
535    0,                         /* tp_descr_set */
536    0,                         /* tp_dictoffset */
537    (initproc)CFractalModel_init,      /* tp_init */
538    0,                         /* tp_alloc */
539    CFractalModel_new,                 /* tp_new */
540};
541
542
543//static PyMethodDef module_methods[] = {
544//    {NULL}
545//};
546
547/**
548 * Function used to add the model class to a module
549 * @param module: module to add the class to
550 */ 
551void addCFractalModel(PyObject *module) {
552        PyObject *d;
553       
554    if (PyType_Ready(&CFractalModelType) < 0)
555        return;
556
557    Py_INCREF(&CFractalModelType);
558    PyModule_AddObject(module, "CFractalModel", (PyObject *)&CFractalModelType);
559   
560    d = PyModule_GetDict(module);
561    static char error_name[] = "CFractalModel.error";
562    CFractalModelError = PyErr_NewException(error_name, NULL, NULL);
563    PyDict_SetItemString(d, "CFractalModelError", CFractalModelError);
564}
565
Note: See TracBrowser for help on using the repository browser.