source: sasview/sansmodels/src/sans/models/c_models/CLamellarPSModel.cpp @ c1c29b6

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 c1c29b6 was c1c29b6, checked in by Jae Cho <jhjcho@…>, 15 years ago

some corrections and removed polydispersity from inside of function and set dQ =0

  • Property mode set to 100644
File size: 19.4 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/** CLamellarPSModel
16 *
17 * C extension
18 *
19 * WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
20 *          DO NOT MODIFY THIS FILE, MODIFY lamellarPS.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 "lamellarPS.h"
36}
37
38#include "models.hh"
39#include "dispersion_visitor.hh"
40
41/// Error object for raised exceptions
42static PyObject * CLamellarPSModelError = 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    LamellarPSModel * model;
54    /// Log for unit testing
55    PyObject * log;
56} CLamellarPSModel;
57
58
59static void
60CLamellarPSModel_dealloc(CLamellarPSModel* self)
61{
62    self->ob_type->tp_free((PyObject*)self);
63   
64
65}
66
67static PyObject *
68CLamellarPSModel_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
69{
70    CLamellarPSModel *self;
71   
72    self = (CLamellarPSModel *)type->tp_alloc(type, 0);
73   
74    return (PyObject *)self;
75}
76
77static int
78CLamellarPSModel_init(CLamellarPSModel *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 LamellarPSModel();
86       
87        // Initialize parameter dictionary
88        PyDict_SetItemString(self->params,"n_plates",Py_BuildValue("d",20.000000));
89        PyDict_SetItemString(self->params,"scale",Py_BuildValue("d",1.000000));
90        PyDict_SetItemString(self->params,"spacing",Py_BuildValue("d",400.000000));
91        PyDict_SetItemString(self->params,"caille",Py_BuildValue("d",0.100000));
92        PyDict_SetItemString(self->params,"background",Py_BuildValue("d",0.000000));
93        PyDict_SetItemString(self->params,"delta",Py_BuildValue("d",30.000000));
94        PyDict_SetItemString(self->params,"contrast",Py_BuildValue("d",0.000005));
95        // Initialize dispersion / averaging parameter dict
96        DispersionVisitor* visitor = new DispersionVisitor();
97        PyObject * disp_dict;
98        disp_dict = PyDict_New();
99        self->model->delta.dispersion->accept_as_source(visitor, self->model->delta.dispersion, disp_dict);
100        PyDict_SetItemString(self->dispersion, "delta", disp_dict);
101        disp_dict = PyDict_New();
102        self->model->spacing.dispersion->accept_as_source(visitor, self->model->spacing.dispersion, disp_dict);
103        PyDict_SetItemString(self->dispersion, "spacing", 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 CLamellarPSModel_members[] = {
117    {"params", T_OBJECT, offsetof(CLamellarPSModel, params), 0,
118     "Parameters"},
119        {"dispersion", T_OBJECT, offsetof(CLamellarPSModel, dispersion), 0,
120          "Dispersion parameters"},     
121    {"log", T_OBJECT, offsetof(CLamellarPSModel, log), 0,
122     "Log"},
123    {NULL}  /* Sentinel */
124};
125
126/** Read double from PyObject
127    @param p PyObject
128    @return double
129*/
130double CLamellarPSModel_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(LamellarPSModel* 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( LamellarPSModel* 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            x_len = dims[0]= x->dimensions[0];
193        y_len = dims[1]= y->dimensions[1];
194           
195            // Make a new double matrix of same dims
196        result=(PyArrayObject *) PyArray_FromDims(2,dims,NPY_DOUBLE);
197        if (result == NULL){
198            const char * message= "Could not create result ";
199        PyErr_SetString(PyExc_RuntimeError , message);
200            return NULL;
201            }
202       
203        /* Do the calculation. */
204        for ( i=0; i< x_len; i++) {
205            for ( j=0; j< y_len; j++) {
206                double x_value = *(double *)(x->data + i*x->strides[0]);
207                    double y_value = *(double *)(y->data + j*y->strides[1]);
208                        double *result_value = (double *)(result->data +
209                              i*result->strides[0] + j*result->strides[1]);
210                        *result_value = (*model)(x_value, y_value);
211            }           
212        }
213        return PyArray_Return(result); 
214       
215        }else{
216                    PyErr_SetString(CLamellarPSModelError, 
217                   "CLamellarPSModel.evaluateTwoDimXY couldn't run.");
218                return NULL;
219                }       
220}
221/**
222 *  evalDistribution function evaluate a model function with input vector
223 *  @param args: input q as vector or [qx, qy] where qx, qy are vectors
224 *
225 */ 
226static PyObject * evalDistribution(CLamellarPSModel *self, PyObject *args){
227        PyObject *qx, *qy;
228        PyArrayObject * pars;
229        int npars ,mpars;
230       
231        // Get parameters
232       
233            // Reader parameter dictionary
234    self->model->n_plates = PyFloat_AsDouble( PyDict_GetItemString(self->params, "n_plates") );
235    self->model->scale = PyFloat_AsDouble( PyDict_GetItemString(self->params, "scale") );
236    self->model->spacing = PyFloat_AsDouble( PyDict_GetItemString(self->params, "spacing") );
237    self->model->caille = PyFloat_AsDouble( PyDict_GetItemString(self->params, "caille") );
238    self->model->background = PyFloat_AsDouble( PyDict_GetItemString(self->params, "background") );
239    self->model->delta = PyFloat_AsDouble( PyDict_GetItemString(self->params, "delta") );
240    self->model->contrast = PyFloat_AsDouble( PyDict_GetItemString(self->params, "contrast") );
241    // Read in dispersion parameters
242    PyObject* disp_dict;
243    DispersionVisitor* visitor = new DispersionVisitor();
244    disp_dict = PyDict_GetItemString(self->dispersion, "delta");
245    self->model->delta.dispersion->accept_as_destination(visitor, self->model->delta.dispersion, disp_dict);
246    disp_dict = PyDict_GetItemString(self->dispersion, "spacing");
247    self->model->spacing.dispersion->accept_as_destination(visitor, self->model->spacing.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(CLamellarPSModelError, 
253                "CLamellarPSModel.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(CLamellarPSModelError, 
269                   "CLamellarPSModel.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(CLamellarPSModelError, 
277                        "CLamellarPSModel.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(CLamellarPSModelError, 
287                   "CLamellarPSModel.evalDistribution expect 2 numpy arrays in list.");
288                return NULL;
289             }
290        }else{
291            PyErr_SetString(CLamellarPSModelError, 
292                   "CLamellarPSModel.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(CLamellarPSModel *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->n_plates = PyFloat_AsDouble( PyDict_GetItemString(self->params, "n_plates") );
311    self->model->scale = PyFloat_AsDouble( PyDict_GetItemString(self->params, "scale") );
312    self->model->spacing = PyFloat_AsDouble( PyDict_GetItemString(self->params, "spacing") );
313    self->model->caille = PyFloat_AsDouble( PyDict_GetItemString(self->params, "caille") );
314    self->model->background = PyFloat_AsDouble( PyDict_GetItemString(self->params, "background") );
315    self->model->delta = PyFloat_AsDouble( PyDict_GetItemString(self->params, "delta") );
316    self->model->contrast = PyFloat_AsDouble( PyDict_GetItemString(self->params, "contrast") );
317    // Read in dispersion parameters
318    PyObject* disp_dict;
319    DispersionVisitor* visitor = new DispersionVisitor();
320    disp_dict = PyDict_GetItemString(self->dispersion, "delta");
321    self->model->delta.dispersion->accept_as_destination(visitor, self->model->delta.dispersion, disp_dict);
322    disp_dict = PyDict_GetItemString(self->dispersion, "spacing");
323    self->model->spacing.dispersion->accept_as_destination(visitor, self->model->spacing.dispersion, disp_dict);
324
325       
326        // Get input and determine whether we have to supply a 1D or 2D return value.
327        if ( !PyArg_ParseTuple(args,"O",&pars) ) {
328            PyErr_SetString(CLamellarPSModelError, 
329                "CLamellarPSModel.run expects a q value.");
330                return NULL;
331        }
332         
333        // Check params
334        if( PyList_Check(pars)==1) {
335               
336                // Length of list should be 2 for I(q,phi)
337            npars = PyList_GET_SIZE(pars); 
338            if(npars!=2) {
339                PyErr_SetString(CLamellarPSModelError, 
340                        "CLamellarPSModel.run expects a double or a list of dimension 2.");
341                return NULL;
342            }
343            // We have a vector q, get the q and phi values at which
344            // to evaluate I(q,phi)
345            q_value = CLamellarPSModel_readDouble(PyList_GET_ITEM(pars,0));
346            phi_value = CLamellarPSModel_readDouble(PyList_GET_ITEM(pars,1));
347            // Skip zero
348            if (q_value==0) {
349                return Py_BuildValue("d",0.0);
350            }
351                return Py_BuildValue("d",(*(self->model)).evaluate_rphi(q_value,phi_value));
352
353        } else {
354
355                // We have a scalar q, we will evaluate I(q)
356                q_value = CLamellarPSModel_readDouble(pars);           
357               
358                return Py_BuildValue("d",(*(self->model))(q_value));
359        }       
360}
361
362/**
363 * Function to call to evaluate model in cartesian coordinates
364 * @param args: input q or [qx, qy]]
365 * @return: function value
366 */
367static PyObject * runXY(CLamellarPSModel *self, PyObject *args) {
368        double qx_value, qy_value;
369        PyObject* pars;
370        int npars;
371       
372        // Get parameters
373       
374            // Reader parameter dictionary
375    self->model->n_plates = PyFloat_AsDouble( PyDict_GetItemString(self->params, "n_plates") );
376    self->model->scale = PyFloat_AsDouble( PyDict_GetItemString(self->params, "scale") );
377    self->model->spacing = PyFloat_AsDouble( PyDict_GetItemString(self->params, "spacing") );
378    self->model->caille = PyFloat_AsDouble( PyDict_GetItemString(self->params, "caille") );
379    self->model->background = PyFloat_AsDouble( PyDict_GetItemString(self->params, "background") );
380    self->model->delta = PyFloat_AsDouble( PyDict_GetItemString(self->params, "delta") );
381    self->model->contrast = PyFloat_AsDouble( PyDict_GetItemString(self->params, "contrast") );
382    // Read in dispersion parameters
383    PyObject* disp_dict;
384    DispersionVisitor* visitor = new DispersionVisitor();
385    disp_dict = PyDict_GetItemString(self->dispersion, "delta");
386    self->model->delta.dispersion->accept_as_destination(visitor, self->model->delta.dispersion, disp_dict);
387    disp_dict = PyDict_GetItemString(self->dispersion, "spacing");
388    self->model->spacing.dispersion->accept_as_destination(visitor, self->model->spacing.dispersion, disp_dict);
389
390       
391        // Get input and determine whether we have to supply a 1D or 2D return value.
392        if ( !PyArg_ParseTuple(args,"O",&pars) ) {
393            PyErr_SetString(CLamellarPSModelError, 
394                "CLamellarPSModel.run expects a q value.");
395                return NULL;
396        }
397         
398        // Check params
399        if( PyList_Check(pars)==1) {
400               
401                // Length of list should be 2 for I(qx, qy))
402            npars = PyList_GET_SIZE(pars); 
403            if(npars!=2) {
404                PyErr_SetString(CLamellarPSModelError, 
405                        "CLamellarPSModel.run expects a double or a list of dimension 2.");
406                return NULL;
407            }
408            // We have a vector q, get the qx and qy values at which
409            // to evaluate I(qx,qy)
410            qx_value = CLamellarPSModel_readDouble(PyList_GET_ITEM(pars,0));
411            qy_value = CLamellarPSModel_readDouble(PyList_GET_ITEM(pars,1));
412            return Py_BuildValue("d",(*(self->model))(qx_value,qy_value));
413
414        } else {
415
416                // We have a scalar q, we will evaluate I(q)
417                qx_value = CLamellarPSModel_readDouble(pars);           
418               
419                return Py_BuildValue("d",(*(self->model))(qx_value));
420        }       
421}
422
423static PyObject * reset(CLamellarPSModel *self, PyObject *args) {
424   
425
426    return Py_BuildValue("d",0.0);
427}
428
429static PyObject * set_dispersion(CLamellarPSModel *self, PyObject *args) {
430        PyObject * disp;
431        const char * par_name;
432
433        if ( !PyArg_ParseTuple(args,"sO", &par_name, &disp) ) {
434            PyErr_SetString(CLamellarPSModelError,
435                "CLamellarPSModel.set_dispersion expects a DispersionModel object.");
436                return NULL;
437        }
438        void *temp = PyCObject_AsVoidPtr(disp);
439        DispersionModel * dispersion = static_cast<DispersionModel *>(temp);
440
441
442        // Ugliness necessary to go from python to C
443            // TODO: refactor this
444    if (!strcmp(par_name, "delta")) {
445        self->model->delta.dispersion = dispersion;
446    } else    if (!strcmp(par_name, "spacing")) {
447        self->model->spacing.dispersion = dispersion;
448    } else {
449            PyErr_SetString(CLamellarPSModelError,
450                "CLamellarPSModel.set_dispersion expects a valid parameter name.");
451                return NULL;
452        }
453
454        DispersionVisitor* visitor = new DispersionVisitor();
455        PyObject * disp_dict = PyDict_New();
456        dispersion->accept_as_source(visitor, dispersion, disp_dict);
457        PyDict_SetItemString(self->dispersion, par_name, disp_dict);
458    return Py_BuildValue("i",1);
459}
460
461
462static PyMethodDef CLamellarPSModel_methods[] = {
463    {"run",      (PyCFunction)run     , METH_VARARGS,
464      "Evaluate the model at a given Q or Q, phi"},
465    {"runXY",      (PyCFunction)runXY     , METH_VARARGS,
466      "Evaluate the model at a given Q or Qx, Qy"},
467     
468    {"evalDistribution",  (PyCFunction)evalDistribution , METH_VARARGS,
469      "Evaluate the model at a given Q or Qx, Qy vector "},
470    {"reset",    (PyCFunction)reset   , METH_VARARGS,
471      "Reset pair correlation"},
472    {"set_dispersion",      (PyCFunction)set_dispersion     , METH_VARARGS,
473      "Set the dispersion model for a given parameter"},
474   {NULL}
475};
476
477static PyTypeObject CLamellarPSModelType = {
478    PyObject_HEAD_INIT(NULL)
479    0,                         /*ob_size*/
480    "CLamellarPSModel",             /*tp_name*/
481    sizeof(CLamellarPSModel),             /*tp_basicsize*/
482    0,                         /*tp_itemsize*/
483    (destructor)CLamellarPSModel_dealloc, /*tp_dealloc*/
484    0,                         /*tp_print*/
485    0,                         /*tp_getattr*/
486    0,                         /*tp_setattr*/
487    0,                         /*tp_compare*/
488    0,                         /*tp_repr*/
489    0,                         /*tp_as_number*/
490    0,                         /*tp_as_sequence*/
491    0,                         /*tp_as_mapping*/
492    0,                         /*tp_hash */
493    0,                         /*tp_call*/
494    0,                         /*tp_str*/
495    0,                         /*tp_getattro*/
496    0,                         /*tp_setattro*/
497    0,                         /*tp_as_buffer*/
498    Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
499    "CLamellarPSModel objects",           /* tp_doc */
500    0,                         /* tp_traverse */
501    0,                         /* tp_clear */
502    0,                         /* tp_richcompare */
503    0,                         /* tp_weaklistoffset */
504    0,                         /* tp_iter */
505    0,                         /* tp_iternext */
506    CLamellarPSModel_methods,             /* tp_methods */
507    CLamellarPSModel_members,             /* tp_members */
508    0,                         /* tp_getset */
509    0,                         /* tp_base */
510    0,                         /* tp_dict */
511    0,                         /* tp_descr_get */
512    0,                         /* tp_descr_set */
513    0,                         /* tp_dictoffset */
514    (initproc)CLamellarPSModel_init,      /* tp_init */
515    0,                         /* tp_alloc */
516    CLamellarPSModel_new,                 /* tp_new */
517};
518
519
520//static PyMethodDef module_methods[] = {
521//    {NULL}
522//};
523
524/**
525 * Function used to add the model class to a module
526 * @param module: module to add the class to
527 */ 
528void addCLamellarPSModel(PyObject *module) {
529        PyObject *d;
530       
531    if (PyType_Ready(&CLamellarPSModelType) < 0)
532        return;
533
534    Py_INCREF(&CLamellarPSModelType);
535    PyModule_AddObject(module, "CLamellarPSModel", (PyObject *)&CLamellarPSModelType);
536   
537    d = PyModule_GetDict(module);
538    CLamellarPSModelError = PyErr_NewException("CLamellarPSModel.error", NULL, NULL);
539    PyDict_SetItemString(d, "CLamellarPSModelError", CLamellarPSModelError);
540}
541
Note: See TracBrowser for help on using the repository browser.