source: sasview/sansmodels/src/sans/models/c_models/CLamellarFFHGModel.cpp @ 870f131

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

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