source: sasview/sansmodels/src/python_wrapper/CLamellarModel.cpp @ 8343e18

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 8343e18 was 67424cd, checked in by Mathieu Doucet <doucetm@…>, 13 years ago

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