Skip to main content

Simple analysis tool for NeXus data files

Project description

xrd-viewer

Simple analysis tool for NeXus data files measured at the SIXS beamline at synchrotron Soleil.
Written in Python with Qt5 Gui

Installation

Please install the python3-pyqt5 package of your distribution and then run
pip install xrd-viewer

then start the program by running xrd-viewer

Usage

Once you opened the program, you will be greeted by the default interface with an logo on the top plot and an empty plot on the bottom.

The (optional) first step is to load a mask file via File > Load Mask... After file selection a preview of the mask file is presented on the upper plot. The program adds an automatic correction of the borders of the detector chips to the mask (hard coded factor of 0.4 will change in the future). The mask can not be unloaded. So please restart the program for a empty mask.

Then File > Open... the folder of the measurements. It will list all measurement files in the list on the left. There you can select one or multiple files to analyse. If you select mutiple, only one can be visualized on the top plot. The name of this file is visible in the window title bar of the program.

After selection of the measurement file the analysis plot on the bottom gets updated. You can select which attributes to assign to each axis. The possible attributes are exctracted from the measurement file. There are two special attributes added: xpad_image and slices. The xpad_image corresponds to the region of interest (see below) and slices corresponds to the scan frame in the measurement (slider on the top of the upper plot). The typical setting is omega vs xpad_image.

The region of interest (ROI) can be selected in the upper plot window. Click the Edit regions... button to open the extended region editor. By default it has two regions. The first region is the background region and all regions afterwards are ROIs. By default the second region (= the first ROI) is the active region. The active region is displayed as red rectangle and can be manipulated by moving the edges to the desired positions. The region editor can also be used to refine the region (values are in pixels). A new ROI can be added by New Region button.

Tips for analysis of measurements

  • If the background region should not be applied. You can move it to the upper left corner with an width and length of 1. (In this corner is typically a shadow in the measurements, so zero counts.)
  • You can move the cursor in the bottom plot my draging the mouse. The upper plot gets updated. This also sets the focus on the frame slider, so you can move the cursor by pressing left and right.
  • Typically the first frames of a measurement are corrupted, you can set an value in the bottom input box to ignore them.
  • After selecting a measurement File > Save Graph... becomes enabled. You can save the current analysis plot as image in *.JPG,*.PNG or *.PDF format (the cursor and indicator will be removed) or as plain text *.TXT for further analysis. The plain text file will have some metadata about the measurement file, the mask file and the selected regions.

Project details


Download files

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

Source Distribution

XRD-Viewer-1.0.0.tar.gz (30.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

XRD_Viewer-1.0.0-py3-none-any.whl (29.1 kB view details)

Uploaded Python 3

File details

Details for the file XRD-Viewer-1.0.0.tar.gz.

File metadata

  • Download URL: XRD-Viewer-1.0.0.tar.gz
  • Upload date:
  • Size: 30.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.17 CPython/3.6.8 Linux/4.15.0-55-generic

File hashes

Hashes for XRD-Viewer-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a48989e725ad8486604a8a6346cdf519a3b33548851fafa4eaffa3bda07a2ffa
MD5 fa2675cb520debf7455ae84a795f0734
BLAKE2b-256 2b29683cf03c1851faa15efa7a5a7e5d01fdfd4db945cf2aac317572a4e1be39

See more details on using hashes here.

File details

Details for the file XRD_Viewer-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: XRD_Viewer-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 29.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.17 CPython/3.6.8 Linux/4.15.0-55-generic

File hashes

Hashes for XRD_Viewer-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e0d41df8b6f10c8c9239841acbfc068bd1103388d26143dec9e4b6eefeccea82
MD5 8217d58ebcb20f497dccaaffee0ae1e5
BLAKE2b-256 4a230d5eeb81f82fff6c2e4d925f5ac4752b49374ec3837e410f8a16881732f4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page