source: sasview/sansmodels/src/sans/models/c_models/CBinaryHSModel.cpp @ c146f092

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 c146f092 was 71e2de7, checked in by Gervaise Alina <gervyh@…>, 15 years ago

change destructor for models
  • Property mode set to 100644
File size: 19.7 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/** CBinaryHSModel
16 *
17 * C extension
18 *
19 * WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
20 *          DO NOT MODIFY THIS FILE, MODIFY binaryHS.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 "binaryHS.h"
36}
37
38#include "models.hh"
39#include "dispersion_visitor.hh"
40
41/// Error object for raised exceptions
42static PyObject * CBinaryHSModelError = 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    BinaryHSModel * model;
54    /// Log for unit testing
55    PyObject * log;
56} CBinaryHSModel;
57
58
59static void
60CBinaryHSModel_dealloc(CBinaryHSModel* 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 *
72CBinaryHSModel_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
73{
74    CBinaryHSModel *self;
75   
76    self = (CBinaryHSModel *)type->tp_alloc(type, 0);
77   
78    return (PyObject *)self;
79}
80
81static int
82CBinaryHSModel_init(CBinaryHSModel *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 BinaryHSModel();
90       
91        // Initialize parameter dictionary
92        PyDict_SetItemString(self->params,"s_radius",Py_BuildValue("d",25.000000));
93        PyDict_SetItemString(self->params,"vol_frac_ss",Py_BuildValue("d",0.200000));
94        PyDict_SetItemString(self->params,"l_radius",Py_BuildValue("d",100.000000));
95        PyDict_SetItemString(self->params,"vol_frac_ls",Py_BuildValue("d",0.100000));
96        // Initialize dispersion / averaging parameter dict
97        DispersionVisitor* visitor = new DispersionVisitor();
98        PyObject * disp_dict;
99        disp_dict = PyDict_New();
100        self->model->l_radius.dispersion->accept_as_source(visitor, self->model->l_radius.dispersion, disp_dict);
101        PyDict_SetItemString(self->dispersion, "l_radius", disp_dict);
102        disp_dict = PyDict_New();
103        self->model->s_radius.dispersion->accept_as_source(visitor, self->model->s_radius.dispersion, disp_dict);
104        PyDict_SetItemString(self->dispersion, "s_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 PyMemberDef CBinaryHSModel_members[] = {
118    {"params", T_OBJECT, offsetof(CBinaryHSModel, params), 0,
119     "Parameters"},
120        {"dispersion", T_OBJECT, offsetof(CBinaryHSModel, dispersion), 0,
121          "Dispersion parameters"},     
122    {"log", T_OBJECT, offsetof(CBinaryHSModel, log), 0,
123     "Log"},
124    {NULL}  /* Sentinel */
125};
126
127/** Read double from PyObject
128    @param p PyObject
129    @return double
130*/
131double CBinaryHSModel_readDouble(PyObject *p) {
132    if (PyFloat_Check(p)==1) {
133        return (double)(((PyFloatObject *)(p))->ob_fval);
134    } else if (PyInt_Check(p)==1) {
135        return (double)(((PyIntObject *)(p))->ob_ival);
136    } else if (PyLong_Check(p)==1) {
137        return (double)PyLong_AsLong(p);
138    } else {
139        return 0.0;
140    }
141}
142/**
143 * Function to call to evaluate model
144 * @param args: input numpy array q[]
145 * @return: numpy array object
146 */
147 
148static PyObject *evaluateOneDim(BinaryHSModel* model, PyArrayObject *q){
149    PyArrayObject *result;
150   
151    // Check validity of array q , q must be of dimension 1, an array of double
152    if (q->nd != 1 || q->descr->type_num != PyArray_DOUBLE)
153    {
154        //const char * message= "Invalid array: q->nd=%d,type_num=%d\n",q->nd,q->descr->type_num;
155        //PyErr_SetString(PyExc_ValueError , message);
156        return NULL;
157    }
158    result = (PyArrayObject *)PyArray_FromDims(q->nd, (int *)(q->dimensions), 
159                                                                                  PyArray_DOUBLE);
160        if (result == NULL) {
161        const char * message= "Could not create result ";
162        PyErr_SetString(PyExc_RuntimeError , message);
163                return NULL;
164        }
165         for (int i = 0; i < q->dimensions[0]; i++){
166      double q_value  = *(double *)(q->data + i*q->strides[0]);
167      double *result_value = (double *)(result->data + i*result->strides[0]);
168      *result_value =(*model)(q_value);
169        }
170    return PyArray_Return(result); 
171 }
172
173 /**
174 * Function to call to evaluate model
175 * @param args: input numpy array  [x[],y[]]
176 * @return: numpy array object
177 */
178 static PyObject * evaluateTwoDimXY( BinaryHSModel* model, 
179                              PyArrayObject *x, PyArrayObject *y)
180 {
181    PyArrayObject *result;
182    int i,j, x_len, y_len, dims[2];
183    //check validity of input vectors
184    if (x->nd != 2 || x->descr->type_num != PyArray_DOUBLE
185        || y->nd != 2 || y->descr->type_num != PyArray_DOUBLE
186        || y->dimensions[1] != x->dimensions[0]){
187        const char * message= "evaluateTwoDimXY  expect 2 numpy arrays";
188        PyErr_SetString(PyExc_ValueError , message); 
189        return NULL;
190    }
191   
192        if (PyArray_Check(x) && PyArray_Check(y)) {
193               
194            x_len = dims[1]= x->dimensions[1];
195        y_len = dims[0]= y->dimensions[0];
196           
197            // Make a new double matrix of same dims
198        result=(PyArrayObject *) PyArray_FromDims(2,dims,NPY_DOUBLE);
199        if (result == NULL){
200            const char * message= "Could not create result ";
201        PyErr_SetString(PyExc_RuntimeError , message);
202            return NULL;
203            }
204       
205        /* Do the calculation. */
206        for ( j=0; j< y_len; j++) {
207            for ( i=0; i< x_len; i++) {
208                double x_value = *(double *)(x->data + i*x->strides[1]);
209                    double y_value = *(double *)(y->data + j*y->strides[0]);
210                        double *result_value = (double *)(result->data +
211                              j*result->strides[0] + i*result->strides[1]);
212                        *result_value = (*model)(x_value, y_value);
213            }           
214        }
215        return PyArray_Return(result); 
216       
217        }else{
218                    PyErr_SetString(CBinaryHSModelError, 
219                   "CBinaryHSModel.evaluateTwoDimXY couldn't run.");
220                return NULL;
221                }       
222}
223/**
224 *  evalDistribution function evaluate a model function with input vector
225 *  @param args: input q as vector or [qx, qy] where qx, qy are vectors
226 *
227 */ 
228static PyObject * evalDistribution(CBinaryHSModel *self, PyObject *args){
229        PyObject *qx, *qy;
230        PyArrayObject * pars;
231        int npars ,mpars;
232       
233        // Get parameters
234       
235            // Reader parameter dictionary
236    self->model->s_radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "s_radius") );
237    self->model->vol_frac_ss = PyFloat_AsDouble( PyDict_GetItemString(self->params, "vol_frac_ss") );
238    self->model->l_radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "l_radius") );
239    self->model->vol_frac_ls = PyFloat_AsDouble( PyDict_GetItemString(self->params, "vol_frac_ls") );
240    // Read in dispersion parameters
241    PyObject* disp_dict;
242    DispersionVisitor* visitor = new DispersionVisitor();
243    disp_dict = PyDict_GetItemString(self->dispersion, "l_radius");
244    self->model->l_radius.dispersion->accept_as_destination(visitor, self->model->l_radius.dispersion, disp_dict);
245    disp_dict = PyDict_GetItemString(self->dispersion, "s_radius");
246    self->model->s_radius.dispersion->accept_as_destination(visitor, self->model->s_radius.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(CBinaryHSModelError, 
252                "CBinaryHSModel.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(CBinaryHSModelError, 
268                   "CBinaryHSModel.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(CBinaryHSModelError, 
276                        "CBinaryHSModel.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(CBinaryHSModelError, 
286                   "CBinaryHSModel.evalDistribution expect 2 numpy arrays in list.");
287                return NULL;
288             }
289        }
290        PyErr_SetString(CBinaryHSModelError, 
291                   "CBinaryHSModel.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(CBinaryHSModel *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->s_radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "s_radius") );
310    self->model->vol_frac_ss = PyFloat_AsDouble( PyDict_GetItemString(self->params, "vol_frac_ss") );
311    self->model->l_radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "l_radius") );
312    self->model->vol_frac_ls = PyFloat_AsDouble( PyDict_GetItemString(self->params, "vol_frac_ls") );
313    // Read in dispersion parameters
314    PyObject* disp_dict;
315    DispersionVisitor* visitor = new DispersionVisitor();
316    disp_dict = PyDict_GetItemString(self->dispersion, "l_radius");
317    self->model->l_radius.dispersion->accept_as_destination(visitor, self->model->l_radius.dispersion, disp_dict);
318    disp_dict = PyDict_GetItemString(self->dispersion, "s_radius");
319    self->model->s_radius.dispersion->accept_as_destination(visitor, self->model->s_radius.dispersion, disp_dict);
320
321       
322        // Get input and determine whether we have to supply a 1D or 2D return value.
323        if ( !PyArg_ParseTuple(args,"O",&pars) ) {
324            PyErr_SetString(CBinaryHSModelError, 
325                "CBinaryHSModel.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(CBinaryHSModelError, 
336                        "CBinaryHSModel.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 = CBinaryHSModel_readDouble(PyList_GET_ITEM(pars,0));
342            phi_value = CBinaryHSModel_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 = CBinaryHSModel_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(CBinaryHSModel *self) {
362
363        PyObject* pars;
364        int npars;
365       
366        // Get parameters
367       
368            // Reader parameter dictionary
369    self->model->s_radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "s_radius") );
370    self->model->vol_frac_ss = PyFloat_AsDouble( PyDict_GetItemString(self->params, "vol_frac_ss") );
371    self->model->l_radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "l_radius") );
372    self->model->vol_frac_ls = PyFloat_AsDouble( PyDict_GetItemString(self->params, "vol_frac_ls") );
373    // Read in dispersion parameters
374    PyObject* disp_dict;
375    DispersionVisitor* visitor = new DispersionVisitor();
376    disp_dict = PyDict_GetItemString(self->dispersion, "l_radius");
377    self->model->l_radius.dispersion->accept_as_destination(visitor, self->model->l_radius.dispersion, disp_dict);
378    disp_dict = PyDict_GetItemString(self->dispersion, "s_radius");
379    self->model->s_radius.dispersion->accept_as_destination(visitor, self->model->s_radius.dispersion, disp_dict);
380
381               
382        return Py_BuildValue("d",(*(self->model)).calculate_ER());
383
384}
385/**
386 * Function to call to evaluate model in cartesian coordinates
387 * @param args: input q or [qx, qy]]
388 * @return: function value
389 */
390static PyObject * runXY(CBinaryHSModel *self, PyObject *args) {
391        double qx_value, qy_value;
392        PyObject* pars;
393        int npars;
394       
395        // Get parameters
396       
397            // Reader parameter dictionary
398    self->model->s_radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "s_radius") );
399    self->model->vol_frac_ss = PyFloat_AsDouble( PyDict_GetItemString(self->params, "vol_frac_ss") );
400    self->model->l_radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "l_radius") );
401    self->model->vol_frac_ls = PyFloat_AsDouble( PyDict_GetItemString(self->params, "vol_frac_ls") );
402    // Read in dispersion parameters
403    PyObject* disp_dict;
404    DispersionVisitor* visitor = new DispersionVisitor();
405    disp_dict = PyDict_GetItemString(self->dispersion, "l_radius");
406    self->model->l_radius.dispersion->accept_as_destination(visitor, self->model->l_radius.dispersion, disp_dict);
407    disp_dict = PyDict_GetItemString(self->dispersion, "s_radius");
408    self->model->s_radius.dispersion->accept_as_destination(visitor, self->model->s_radius.dispersion, disp_dict);
409
410       
411        // Get input and determine whether we have to supply a 1D or 2D return value.
412        if ( !PyArg_ParseTuple(args,"O",&pars) ) {
413            PyErr_SetString(CBinaryHSModelError, 
414                "CBinaryHSModel.run expects a q value.");
415                return NULL;
416        }
417         
418        // Check params
419        if( PyList_Check(pars)==1) {
420               
421                // Length of list should be 2 for I(qx, qy))
422            npars = PyList_GET_SIZE(pars); 
423            if(npars!=2) {
424                PyErr_SetString(CBinaryHSModelError, 
425                        "CBinaryHSModel.run expects a double or a list of dimension 2.");
426                return NULL;
427            }
428            // We have a vector q, get the qx and qy values at which
429            // to evaluate I(qx,qy)
430            qx_value = CBinaryHSModel_readDouble(PyList_GET_ITEM(pars,0));
431            qy_value = CBinaryHSModel_readDouble(PyList_GET_ITEM(pars,1));
432            return Py_BuildValue("d",(*(self->model))(qx_value,qy_value));
433
434        } else {
435
436                // We have a scalar q, we will evaluate I(q)
437                qx_value = CBinaryHSModel_readDouble(pars);             
438               
439                return Py_BuildValue("d",(*(self->model))(qx_value));
440        }       
441}
442
443static PyObject * reset(CBinaryHSModel *self, PyObject *args) {
444   
445
446    return Py_BuildValue("d",0.0);
447}
448
449static PyObject * set_dispersion(CBinaryHSModel *self, PyObject *args) {
450        PyObject * disp;
451        const char * par_name;
452
453        if ( !PyArg_ParseTuple(args,"sO", &par_name, &disp) ) {
454            PyErr_SetString(CBinaryHSModelError,
455                "CBinaryHSModel.set_dispersion expects a DispersionModel object.");
456                return NULL;
457        }
458        void *temp = PyCObject_AsVoidPtr(disp);
459        DispersionModel * dispersion = static_cast<DispersionModel *>(temp);
460
461
462        // Ugliness necessary to go from python to C
463            // TODO: refactor this
464    if (!strcmp(par_name, "l_radius")) {
465        self->model->l_radius.dispersion = dispersion;
466    } else    if (!strcmp(par_name, "s_radius")) {
467        self->model->s_radius.dispersion = dispersion;
468    } else {
469            PyErr_SetString(CBinaryHSModelError,
470                "CBinaryHSModel.set_dispersion expects a valid parameter name.");
471                return NULL;
472        }
473
474        DispersionVisitor* visitor = new DispersionVisitor();
475        PyObject * disp_dict = PyDict_New();
476        dispersion->accept_as_source(visitor, dispersion, disp_dict);
477        PyDict_SetItemString(self->dispersion, par_name, disp_dict);
478    return Py_BuildValue("i",1);
479}
480
481
482static PyMethodDef CBinaryHSModel_methods[] = {
483    {"run",      (PyCFunction)run     , METH_VARARGS,
484      "Evaluate the model at a given Q or Q, phi"},
485    {"runXY",      (PyCFunction)runXY     , METH_VARARGS,
486      "Evaluate the model at a given Q or Qx, Qy"},
487    {"calculate_ER",      (PyCFunction)calculate_ER     , METH_VARARGS,
488      "Evaluate the model at a given Q or Q, phi"},
489     
490    {"evalDistribution",  (PyCFunction)evalDistribution , METH_VARARGS,
491      "Evaluate the model at a given Q or Qx, Qy vector "},
492    {"reset",    (PyCFunction)reset   , METH_VARARGS,
493      "Reset pair correlation"},
494    {"set_dispersion",      (PyCFunction)set_dispersion     , METH_VARARGS,
495      "Set the dispersion model for a given parameter"},
496   {NULL}
497};
498
499static PyTypeObject CBinaryHSModelType = {
500    PyObject_HEAD_INIT(NULL)
501    0,                         /*ob_size*/
502    "CBinaryHSModel",             /*tp_name*/
503    sizeof(CBinaryHSModel),             /*tp_basicsize*/
504    0,                         /*tp_itemsize*/
505    (destructor)CBinaryHSModel_dealloc, /*tp_dealloc*/
506    0,                         /*tp_print*/
507    0,                         /*tp_getattr*/
508    0,                         /*tp_setattr*/
509    0,                         /*tp_compare*/
510    0,                         /*tp_repr*/
511    0,                         /*tp_as_number*/
512    0,                         /*tp_as_sequence*/
513    0,                         /*tp_as_mapping*/
514    0,                         /*tp_hash */
515    0,                         /*tp_call*/
516    0,                         /*tp_str*/
517    0,                         /*tp_getattro*/
518    0,                         /*tp_setattro*/
519    0,                         /*tp_as_buffer*/
520    Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
521    "CBinaryHSModel objects",           /* tp_doc */
522    0,                         /* tp_traverse */
523    0,                         /* tp_clear */
524    0,                         /* tp_richcompare */
525    0,                         /* tp_weaklistoffset */
526    0,                         /* tp_iter */
527    0,                         /* tp_iternext */
528    CBinaryHSModel_methods,             /* tp_methods */
529    CBinaryHSModel_members,             /* tp_members */
530    0,                         /* tp_getset */
531    0,                         /* tp_base */
532    0,                         /* tp_dict */
533    0,                         /* tp_descr_get */
534    0,                         /* tp_descr_set */
535    0,                         /* tp_dictoffset */
536    (initproc)CBinaryHSModel_init,      /* tp_init */
537    0,                         /* tp_alloc */
538    CBinaryHSModel_new,                 /* tp_new */
539};
540
541
542//static PyMethodDef module_methods[] = {
543//    {NULL}
544//};
545
546/**
547 * Function used to add the model class to a module
548 * @param module: module to add the class to
549 */ 
550void addCBinaryHSModel(PyObject *module) {
551        PyObject *d;
552       
553    if (PyType_Ready(&CBinaryHSModelType) < 0)
554        return;
555
556    Py_INCREF(&CBinaryHSModelType);
557    PyModule_AddObject(module, "CBinaryHSModel", (PyObject *)&CBinaryHSModelType);
558   
559    d = PyModule_GetDict(module);
560    CBinaryHSModelError = PyErr_NewException("CBinaryHSModel.error", NULL, NULL);
561    PyDict_SetItemString(d, "CBinaryHSModelError", CBinaryHSModelError);
562}
563
Note: See TracBrowser for help on using the repository browser.