source: sasview/src/sans/models/c_extension/python_wrapper/generated/CLamellarModel.cpp @ 400155b

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 400155b was 400155b, checked in by gonzalezm, 9 years ago

Implementing request from ticket 261 - default number of bins in Annulus [Phi View] is now 36 and the first bin is now centered at 0 degrees
  • Property mode set to 100644
File size: 19.9 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 src\sans\models\include\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
36}
37
38#include "lamellar.h"
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
90        self->model = new LamellarModel();
91
92        // Initialize parameter dictionary
93        PyDict_SetItemString(self->params,"sld_sol",Py_BuildValue("d",0.000006300000));
94        PyDict_SetItemString(self->params,"scale",Py_BuildValue("d",1.000000000000));
95        PyDict_SetItemString(self->params,"bi_thick",Py_BuildValue("d",50.000000000000));
96        PyDict_SetItemString(self->params,"background",Py_BuildValue("d",0.000000000000));
97        PyDict_SetItemString(self->params,"sld_bi",Py_BuildValue("d",0.000001000000));
98        // Initialize dispersion / averaging parameter dict
99        DispersionVisitor* visitor = new DispersionVisitor();
100        PyObject * disp_dict;
101        disp_dict = PyDict_New();
102        self->model->bi_thick.dispersion->accept_as_source(visitor, self->model->bi_thick.dispersion, disp_dict);
103        PyDict_SetItemString(self->dispersion, "bi_thick", disp_dict);
104
105
106         
107        // Create empty log
108        self->log = PyDict_New();
109       
110       
111
112    }
113    return 0;
114}
115
116static char name_params[] = "params";
117static char def_params[] = "Parameters";
118static char name_dispersion[] = "dispersion";
119static char def_dispersion[] = "Dispersion parameters";
120static char name_log[] = "log";
121static char def_log[] = "Log";
122
123static PyMemberDef CLamellarModel_members[] = {
124    {name_params, T_OBJECT, offsetof(CLamellarModel, params), 0, def_params},
125        {name_dispersion, T_OBJECT, offsetof(CLamellarModel, dispersion), 0, def_dispersion},     
126    {name_log, T_OBJECT, offsetof(CLamellarModel, log), 0, def_log},
127    {NULL}  /* Sentinel */
128};
129
130/** Read double from PyObject
131    @param p PyObject
132    @return double
133*/
134double CLamellarModel_readDouble(PyObject *p) {
135    if (PyFloat_Check(p)==1) {
136        return (double)(((PyFloatObject *)(p))->ob_fval);
137    } else if (PyInt_Check(p)==1) {
138        return (double)(((PyIntObject *)(p))->ob_ival);
139    } else if (PyLong_Check(p)==1) {
140        return (double)PyLong_AsLong(p);
141    } else {
142        return 0.0;
143    }
144}
145/**
146 * Function to call to evaluate model
147 * @param args: input numpy array q[]
148 * @return: numpy array object
149 */
150 
151static PyObject *evaluateOneDim(LamellarModel* model, PyArrayObject *q){
152    PyArrayObject *result;
153   
154    // Check validity of array q , q must be of dimension 1, an array of double
155    if (q->nd != 1 || q->descr->type_num != PyArray_DOUBLE)
156    {
157        //const char * message= "Invalid array: q->nd=%d,type_num=%d\n",q->nd,q->descr->type_num;
158        //PyErr_SetString(PyExc_ValueError , message);
159        return NULL;
160    }
161    result = (PyArrayObject *)PyArray_FromDims(q->nd, (int *)(q->dimensions), 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( LamellarModel* 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(CLamellarModelError, 
221                   "CLamellarModel.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(CLamellarModel *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->sld_sol = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sld_sol") );
239    self->model->scale = PyFloat_AsDouble( PyDict_GetItemString(self->params, "scale") );
240    self->model->bi_thick = PyFloat_AsDouble( PyDict_GetItemString(self->params, "bi_thick") );
241    self->model->background = PyFloat_AsDouble( PyDict_GetItemString(self->params, "background") );
242    self->model->sld_bi = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sld_bi") );
243    // Read in dispersion parameters
244    PyObject* disp_dict;
245    DispersionVisitor* visitor = new DispersionVisitor();
246    disp_dict = PyDict_GetItemString(self->dispersion, "bi_thick");
247    self->model->bi_thick.dispersion->accept_as_destination(visitor, self->model->bi_thick.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(CLamellarModelError, 
253                "CLamellarModel.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(CLamellarModelError, 
269                   "CLamellarModel.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(CLamellarModelError, 
277                        "CLamellarModel.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(CLamellarModelError, 
287                   "CLamellarModel.evalDistribution expect 2 numpy arrays in list.");
288                return NULL;
289             }
290        }
291        PyErr_SetString(CLamellarModelError, 
292                   "CLamellarModel.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(CLamellarModel *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->sld_sol = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sld_sol") );
311    self->model->scale = PyFloat_AsDouble( PyDict_GetItemString(self->params, "scale") );
312    self->model->bi_thick = PyFloat_AsDouble( PyDict_GetItemString(self->params, "bi_thick") );
313    self->model->background = PyFloat_AsDouble( PyDict_GetItemString(self->params, "background") );
314    self->model->sld_bi = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sld_bi") );
315    // Read in dispersion parameters
316    PyObject* disp_dict;
317    DispersionVisitor* visitor = new DispersionVisitor();
318    disp_dict = PyDict_GetItemString(self->dispersion, "bi_thick");
319    self->model->bi_thick.dispersion->accept_as_destination(visitor, self->model->bi_thick.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(CLamellarModelError, 
325                "CLamellarModel.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(CLamellarModelError, 
336                        "CLamellarModel.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 = CLamellarModel_readDouble(PyList_GET_ITEM(pars,0));
342            phi_value = CLamellarModel_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 = CLamellarModel_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(CLamellarModel *self) {
362
363        // Get parameters
364       
365            // Reader parameter dictionary
366    self->model->sld_sol = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sld_sol") );
367    self->model->scale = PyFloat_AsDouble( PyDict_GetItemString(self->params, "scale") );
368    self->model->bi_thick = PyFloat_AsDouble( PyDict_GetItemString(self->params, "bi_thick") );
369    self->model->background = PyFloat_AsDouble( PyDict_GetItemString(self->params, "background") );
370    self->model->sld_bi = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sld_bi") );
371    // Read in dispersion parameters
372    PyObject* disp_dict;
373    DispersionVisitor* visitor = new DispersionVisitor();
374    disp_dict = PyDict_GetItemString(self->dispersion, "bi_thick");
375    self->model->bi_thick.dispersion->accept_as_destination(visitor, self->model->bi_thick.dispersion, disp_dict);
376
377               
378        return Py_BuildValue("d",(*(self->model)).calculate_ER());
379
380}
381/**
382 * Function to call to cal the ratio shell volume/ total volume
383 * @return: the ratio shell volume/ total volume
384 */
385static PyObject * calculate_VR(CLamellarModel *self) {
386
387        // Get parameters
388       
389            // Reader parameter dictionary
390    self->model->sld_sol = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sld_sol") );
391    self->model->scale = PyFloat_AsDouble( PyDict_GetItemString(self->params, "scale") );
392    self->model->bi_thick = PyFloat_AsDouble( PyDict_GetItemString(self->params, "bi_thick") );
393    self->model->background = PyFloat_AsDouble( PyDict_GetItemString(self->params, "background") );
394    self->model->sld_bi = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sld_bi") );
395    // Read in dispersion parameters
396    PyObject* disp_dict;
397    DispersionVisitor* visitor = new DispersionVisitor();
398    disp_dict = PyDict_GetItemString(self->dispersion, "bi_thick");
399    self->model->bi_thick.dispersion->accept_as_destination(visitor, self->model->bi_thick.dispersion, disp_dict);
400
401               
402        return Py_BuildValue("d",(*(self->model)).calculate_VR());
403
404}
405/**
406 * Function to call to evaluate model in cartesian coordinates
407 * @param args: input q or [qx, qy]]
408 * @return: function value
409 */
410static PyObject * runXY(CLamellarModel *self, PyObject *args) {
411        double qx_value, qy_value;
412        PyObject* pars;
413        int npars;
414       
415        // Get parameters
416       
417            // Reader parameter dictionary
418    self->model->sld_sol = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sld_sol") );
419    self->model->scale = PyFloat_AsDouble( PyDict_GetItemString(self->params, "scale") );
420    self->model->bi_thick = PyFloat_AsDouble( PyDict_GetItemString(self->params, "bi_thick") );
421    self->model->background = PyFloat_AsDouble( PyDict_GetItemString(self->params, "background") );
422    self->model->sld_bi = PyFloat_AsDouble( PyDict_GetItemString(self->params, "sld_bi") );
423    // Read in dispersion parameters
424    PyObject* disp_dict;
425    DispersionVisitor* visitor = new DispersionVisitor();
426    disp_dict = PyDict_GetItemString(self->dispersion, "bi_thick");
427    self->model->bi_thick.dispersion->accept_as_destination(visitor, self->model->bi_thick.dispersion, disp_dict);
428
429       
430        // Get input and determine whether we have to supply a 1D or 2D return value.
431        if ( !PyArg_ParseTuple(args,"O",&pars) ) {
432            PyErr_SetString(CLamellarModelError, 
433                "CLamellarModel.run expects a q value.");
434                return NULL;
435        }
436         
437        // Check params
438        if( PyList_Check(pars)==1) {
439               
440                // Length of list should be 2 for I(qx, qy))
441            npars = PyList_GET_SIZE(pars); 
442            if(npars!=2) {
443                PyErr_SetString(CLamellarModelError, 
444                        "CLamellarModel.run expects a double or a list of dimension 2.");
445                return NULL;
446            }
447            // We have a vector q, get the qx and qy values at which
448            // to evaluate I(qx,qy)
449            qx_value = CLamellarModel_readDouble(PyList_GET_ITEM(pars,0));
450            qy_value = CLamellarModel_readDouble(PyList_GET_ITEM(pars,1));
451            return Py_BuildValue("d",(*(self->model))(qx_value,qy_value));
452
453        } else {
454
455                // We have a scalar q, we will evaluate I(q)
456                qx_value = CLamellarModel_readDouble(pars);             
457               
458                return Py_BuildValue("d",(*(self->model))(qx_value));
459        }       
460}
461
462static PyObject * reset(CLamellarModel *self, PyObject *args) {
463   
464
465    return Py_BuildValue("d",0.0);
466}
467
468static PyObject * set_dispersion(CLamellarModel *self, PyObject *args) {
469        PyObject * disp;
470        const char * par_name;
471
472        if ( !PyArg_ParseTuple(args,"sO", &par_name, &disp) ) {
473            PyErr_SetString(CLamellarModelError,
474                "CLamellarModel.set_dispersion expects a DispersionModel object.");
475                return NULL;
476        }
477        void *temp = PyCObject_AsVoidPtr(disp);
478        DispersionModel * dispersion = static_cast<DispersionModel *>(temp);
479
480
481        // Ugliness necessary to go from python to C
482            // TODO: refactor this
483    if (!strcmp(par_name, "bi_thick")) {
484        self->model->bi_thick.dispersion = dispersion;
485    } else {
486            PyErr_SetString(CLamellarModelError,
487                "CLamellarModel.set_dispersion expects a valid parameter name.");
488                return NULL;
489        }
490
491        DispersionVisitor* visitor = new DispersionVisitor();
492        PyObject * disp_dict = PyDict_New();
493        dispersion->accept_as_source(visitor, dispersion, disp_dict);
494        PyDict_SetItemString(self->dispersion, par_name, disp_dict);
495    return Py_BuildValue("i",1);
496}
497
498
499static PyMethodDef CLamellarModel_methods[] = {
500    {"run",      (PyCFunction)run     , METH_VARARGS,
501      "Evaluate the model at a given Q or Q, phi"},
502    {"runXY",      (PyCFunction)runXY     , METH_VARARGS,
503      "Evaluate the model at a given Q or Qx, Qy"},
504    {"calculate_ER",      (PyCFunction)calculate_ER     , METH_VARARGS,
505      "Evaluate the model at a given Q or Q, phi"},
506    {"calculate_VR",      (PyCFunction)calculate_VR     , METH_VARARGS,
507      "Evaluate VR"},   
508    {"evalDistribution",  (PyCFunction)evalDistribution , METH_VARARGS,
509      "Evaluate the model at a given Q or Qx, Qy vector "},
510    {"reset",    (PyCFunction)reset   , METH_VARARGS,
511      "Reset pair correlation"},
512    {"set_dispersion",      (PyCFunction)set_dispersion     , METH_VARARGS,
513      "Set the dispersion model for a given parameter"},
514   {NULL}
515};
516
517static PyTypeObject CLamellarModelType = {
518    PyObject_HEAD_INIT(NULL)
519    0,                         /*ob_size*/
520    "CLamellarModel",             /*tp_name*/
521    sizeof(CLamellarModel),             /*tp_basicsize*/
522    0,                         /*tp_itemsize*/
523    (destructor)CLamellarModel_dealloc, /*tp_dealloc*/
524    0,                         /*tp_print*/
525    0,                         /*tp_getattr*/
526    0,                         /*tp_setattr*/
527    0,                         /*tp_compare*/
528    0,                         /*tp_repr*/
529    0,                         /*tp_as_number*/
530    0,                         /*tp_as_sequence*/
531    0,                         /*tp_as_mapping*/
532    0,                         /*tp_hash */
533    0,                         /*tp_call*/
534    0,                         /*tp_str*/
535    0,                         /*tp_getattro*/
536    0,                         /*tp_setattro*/
537    0,                         /*tp_as_buffer*/
538    Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
539    "CLamellarModel objects",           /* tp_doc */
540    0,                         /* tp_traverse */
541    0,                         /* tp_clear */
542    0,                         /* tp_richcompare */
543    0,                         /* tp_weaklistoffset */
544    0,                         /* tp_iter */
545    0,                         /* tp_iternext */
546    CLamellarModel_methods,             /* tp_methods */
547    CLamellarModel_members,             /* tp_members */
548    0,                         /* tp_getset */
549    0,                         /* tp_base */
550    0,                         /* tp_dict */
551    0,                         /* tp_descr_get */
552    0,                         /* tp_descr_set */
553    0,                         /* tp_dictoffset */
554    (initproc)CLamellarModel_init,      /* tp_init */
555    0,                         /* tp_alloc */
556    CLamellarModel_new,                 /* tp_new */
557};
558
559
560//static PyMethodDef module_methods[] = {
561//    {NULL}
562//};
563
564/**
565 * Function used to add the model class to a module
566 * @param module: module to add the class to
567 */ 
568void addCLamellarModel(PyObject *module) {
569        PyObject *d;
570       
571    if (PyType_Ready(&CLamellarModelType) < 0)
572        return;
573
574    Py_INCREF(&CLamellarModelType);
575    PyModule_AddObject(module, "CLamellarModel", (PyObject *)&CLamellarModelType);
576   
577    d = PyModule_GetDict(module);
578    static char error_name[] = "CLamellarModel.error";
579    CLamellarModelError = PyErr_NewException(error_name, NULL, NULL);
580    PyDict_SetItemString(d, "CLamellarModelError", CLamellarModelError);
581}
582
Note: See TracBrowser for help on using the repository browser.