Potku project

Requirements Specification 0.2.0

Jarkko Aalto

Timo Konu

Samuli Kärkkäinen

Samuli Rahkonen

Miika Raunio

• FUNCTIONAL REQUIREMENTS
  • Reading measurement data
    • Software reads an .evnt file (ascii) from measuring unit.
    • Software reads a .lst file (binary) from conversion (similar to Finlandia).
    • Software reads standardized XML format.
  • ToF-E histogram
    • Histogram can be zoomed.
    • Histogram can be dragged.
    • Histogram data point count in a pixel is displayed via logarithmic coloring.
    • The cursor coordinates are shown when hovering over the graph.
    • Histogram axes bins can be changed.
    • Histogram axes can be inverted (invert X-axis, Y-axis or both).
    • Histogram axes can be transposed (switch X-axis and Y-axis around).
    • Histogram can be saved as an image.
    • Histogram data point count in a pixel can be displayed via linear coloring.
    • Histogram axes functions can be input manually.
    • Histogram data coloring scheme can be changed.
    • The starting point of elements can be estimated.
    • Event count in a pixel is displayed when hovering over with cursor
  • Element Selection

    • The weight factor of element selection can be defined.

      The last node of an open selection can be undone.

      Element selection can be highlighted.

      Element selection uses an efficiency file for each element.

      Element selections are automatically saved into a selection file when selections are added, removed or modified.

      Element selections can be loaded from a selection file.

      Element selection can be removed.

      Element selections are saved in a cut file that includes type (ERD/RBS), element mass, weight factor and data points.

      Element selection information can be modified (change element, type or weight factor) after it has been closed.

      A node of element selection can be moved.

      Element selection can be composed from several selections utilizing Boole's operators.

      The periodic table is color-coded when choosing element.

  • Element
    • The type of element (ERD/RBS) can be selected.
    • Colors of elements are predetermined.
    • Several of commonly used elements' colors are fixed.
  • Isotope
    • An average (default) or an isotope (stable) can be chosen.
    • An unstable element isotope can be chosen.
  • Calibration
    • The front edge of element can be estimated with cut file.
    • A linear fit can be done with calibration parameters and selected front edge fittings.
    • The front edge of element can be chosen by clicking on the graph.
    • Calibration can use cut files from outside the project.
    • Parameter values can be saved in a calibration file.
    • Calibration has option to select other saved calibrations.
    • Previous calibration can be shown in linear fit.
  • Elemental Losses

    • ElemLoss divides a target cut file into N (user selected) partitions using a reference cut file (heavier element).

      ElemLoss saves partition count (as weight factor) into new cut files.

      ElemLoss has a button to save partitioned cut files.

      ElemLoss will save new partitioned cut files only manually.

      The y-axis can be scaled as min-max or zero-max.

      ElemLoss can graph multiple target cut-files at the same time.

      ElemLoss can generate energy spectrum from a cut file.

  • Depth profile logic
    • Depth profile should use cut files and depth parameters.
    • The y-axis of depth profile scales every channel 100%.
    • The y-axis of depth profile can be normalized over defined depth.
    • The ratio of elements can be integrated at selected depth.
    • Depth profile's stopping model can be changed and toggled on or off.
    • The margin of error can be displayed (none / automatic / manual).
    • Depth profile can show count of elements' data points at selected depth.
  • Depth profile graph
    • The x-axis of depth profile unit can be changed.
    • The axes ticks are rounded to integers (no decimals).
    • The cursor coordinates are shown when hovering over the graph.
    • Depth profile can be saved as an image.
    • Depth profile's depth distribution is shown on the graph (but outside the grid).
    • Graph's text and font can be changed.
    • The depth at which y-axis is normalized can be graphically selected.
  • Energy Spectrum
    • Energy spectrum can be made from cut files.
  • Sample management
    • By default sample collection is saved in users' documents.
    • Sample collection is saved in logical folder structure.
    • Sample collection can include multiple measurements.
    • Several measurements can be opened into the sample collection as tabs.
    • Upon opening sample collection, it loads current stage from python file.
  • Python interpreter interface
    • GUI functions can be used through interpreter.
    • GUI produces (command log) process of a sample collection in a python file.
    • A series of commands issued in GUI can be rerun through interpreter.
  • Reporting
    • Report includes all histograms in project.
    • Report includes all depth profiles in project.
    • Report includes all integrations of selected depths in depth profiles.
    • Report includes files in Gnuplot/GLE format.
  • Additional functionalities
    • Show ratio between selected cut-files.
    • Software can be extended with plugins.
    • Software plugin: can convert data to read other formats.
    • Software plugin: can do Monte-Carlo simulation.
• NON-FUNCTIONAL REQUIREMENTS
  • Software works under Windows.
  • Software works under Linux.
  • Software works under Mac OS.
  • Software has to be easily extendable.