Skip to main content

Combines dataArrays with attributes for fitting, plottingand analysis including models for Xray and neutron scattering

Project description

The aim of Jscatter is treatment of experimental data and models:

  • Reading and analyzing experimental data with associated attributes as temperature, wavevector, comment, ….
  • Multidimensional fitting taking attributes into account.
  • Providing useful models for neutron and X-ray scattering as form factors, structure factors and dynamic models (quasi elastic neutron scattering) and other topics.
  • Simplified plotting with paper ready quality (preferred in xmgrace).
  • Easy model building for non programmers.
  • Python scripts to document data evaluation and modelling.

link to mybinder citation install license pyversion Read the Docs Beginners Guide

Jscatter Logo

Main concept

  • Link data from experiment, analytical model or simulation with attributes as .temperature, .wavevector, .pressure,…
  • Methods for fitting, filter, merging,… using the attributes by name.
  • Provide an extensible library with common theories/models for fitting of physical models.
  • Allowing evaluation even of hundreds of datasets using scripts.

1 Data organisation

Multiple measurements are stored in a dataList (subclass of list) of dataArray. dataArray is a subclass of numpy ndarray but with attributes and more. Full numpy ndarray functionality is preserved. Special attributes are .X,.Y, .eY…- for convenience and easy reading. Thus dataList represents e.g. a temperature series (as dataList) with measurements (dataArray) as list elements.

2 Read/Write data

The intention is to read everything in the file to use it later and not ignore it as in numpy.loadtxt. Multiple measurement files can be read at once and then filtered according to attributes to get subsets.

An ASCII file may consist of multiple sets of data with optional attributes or comments. Data are a matrix of values in a file. Attribute lines have a name in front. Everything else is a comment.

Even complex ASCII files can be read with a few changes given as options. The ASCII file is still human readable and can be edited. Attributes can be generated from content of the comments (attributes which are text and not numbers).

3 Fitting

Multidimensional attribute dependent fitting (least square Levenberg-Marquardt, differential evolution, …. from scipy.optimize). Attributes are used automatically as fixed fit parameters but can be overwritten. See for detailed description.

4 Plotting

We use an adaption of xmgrace for 2D plots (a wrapper; see GracePlot) as it allows interactive publication ready output in high quality for 2D plots. The plot is stored as ASCII (.agr file) with original data and not as non-editable image as png or jpg. This allows a later change of the plot layout without recalculation, because data are stored as data and not as image. Imagine the boss/reviewer asking for a change of colors/symbol size. Nevertheless a small matplotlib interface is there and matplotlib can be used as it is (e.g. for 3D plots).

5 Models

A set of models/theories is included see module e.g. formel, form factor and structure factor. User defined models can be used (e.g. as lambda function) just within a script or in interactive session of (i)python. By intention the user should write own models (to include e.g. a background, instrument resolution, …) or to add different contributions. Contribution by new models is welcome. Please give a publication as reference as in the provided models.

some special functions:

formel.scatteringLengthDensityCalc -> electron density, coh and inc neutron scattering length, mass
formel.sedimentationProfile        -> approximate solution to the Lamm equation of sedimenting particles
formel.waterdensity                -> temperature dependent density of water (H2O/D2O) with inorganic substances
structurefactor.RMSA               -> rescaled MSA structure factor for dilute charged colloidal dispersions
structurefactor.hydrodynamicFunct  -> hydrodynamic function from hydrodynamic pair interaction
formfactor.multiShellSphere        -> formfactor of multi shell spherical particles
formfactor.multiShellCylinder      -> formfactor of multi shell cylinder particles
formfactor.orientedCloudScattering -> 2D scattering of an oriented cloud of scatterers
dynamic.finiteZimm                 -> Zimm model with internal friction -> intermediate scattering function
dynamic.diffusionHarmonicPotential -> diffusion in harmonic potential-> intermediate scattering function
sas.smear                          -> smearing enabling simultaneous fits of differently smeared SANS/SAXS data
sas.desmear                        -> desmearing according to the Lake algorithm for the above
sas.waterXrayScattering            -> absolute scattering of water with components (salt, buffer)

6 Examples & Documentation

A number of examples how to use Jscatter is provided and can be run from Jscatter. Documentation located at The html documentation can be opened in browser (for dev versions)

import jscatter as js
js.showDoc()                     # open html documentation
js.examples.showExampleList()    # show list of examples
js.examples.runExample(1)        # run example by number of filename
js.examples.showExample(1)       # show example source code

A short example how to use Jscatter:

import jscatter as js

i5=js.dL(js.examples.datapath+'/iqt_1hho.dat')     # read the data (16 sets) with attributes
# define a model for the fit
diffusion=lambda A,D,t,wavevector,elastic=0:A*np.exp(-wavevector**2*D*t)+elastic

# do the fit,                     # the fit function
       freepar={'D':[0.08],'A':0.98},       # start parameters, "[]" -> independent fit
       fixpar={'elastic':0.0},              # fixed parameters
       mapNames={'t':'X','wavevector':'q'}) # map names from the model to names from the data

p=js.grace(1.2,0.8)                         # open a plot
p.plot(i5,symbol=[-1,0.4,-1],legend='Q=$q') # plot with Q values in legend
p.plot(i5.lastfit,symbol=0,line=[1,1,-1])   # plot fit as lines'test.agr')

** Released under the GPLv3 **

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jscatter-1.4.2.tar.gz (33.3 MB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page