Potku project

Requirements Specification 0.2.4

Jarkko Aalto

Timo Konu

Samuli Kärkkäinen

Samuli Rahkonen

Miika Raunio

• FUNCTIONAL REQUIREMENTS
  • Specifying measurement data
    • The software reads an .evnt file (ascii) provided by a measuring unit.
    • The software reads a .lst file (binary) provided by a conversion (similar to Finlandia).
    • The software reads a standardized XML format.
  • ToF-E histogram
    • The histogram can be zoomed.
    • The histogram can be dragged.
    • The histogram data point count in a pixel is displayed via logarithmic coloring.
    • The cursor coordinates are shown when hovering over the graph.
    • The histogram axes bins can be specified by a non-negative integer.
    • The histogram X-axis and/or Y-axis can be inverted.
    • The histogram axes can be transposed (i.e. switch X-axis and Y-axis).
    • The histogram can be saved as an imagefile.
    • The histogram data point count in a pixel can be displayed via linear coloring.
    • The histogram axes functions can be specified manually.
    • The histogram data coloring scheme can be changed.
    • A starting point of element can be automatically estimated.
    • The event count in a pixel is displayed when hovering over with the cursor
  • Element Selection in ToF-E histogram

    • The weight factor of an element selection can be defined.

      The last node of an open selection can be cancelled.

      Element selection is shown with borders.

      Element selections are automatically saved into the 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 for each element that includes a type (ERD/RBS), an element mass, a weight factor and data points.

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

      Element selection can be highlighted by moving the cursor over selection.

      A node in an element selection can be moved.

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

  • Element
    • The type (ERD/RBS) of an element can be selected.
    • An element uses an efficiency file if such exists.
    • An average (default) or an isotope (stable) can be chosen.
    • Colors of elements are predetermined.
    • Several of commonly used elements' colors are fixed.
    • The periodic table is color-coded when choosing element.
    • An unstable element isotope can be chosen.
  • + - Calibration

    • The front edge of an element can be estimated.

      A linear fit can be done with the calibration parameters and the selected front edge fits of elements.

      The front edge of element can be chosen by clicking on the graph.

      Cut files from outside the project can be specified for the calibration.

      Parameter values can be saved to a calibration file.

      Other saved calibrations can be chosen to be used.

      Previous calibration can be shown in linear fit.

  • Elemental Losses

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

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

      Elemental losses can only be saved manually into new partitioned cut files .

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

      Multiple target cut-files can be shown in the graph at the same time.

      Energy spectrum from a cut file can be generated.

  • Depth profile logic
    • Depth profile is calculated with cut files and depth parameters.
    • The Y-axis of depth profile can be normalized over selected depth.
    • The Y-axis of depth profile can be scaled on every channel to 100%.
    • The ratio of elements can be integrated at selected depth.
    • Depth profile's stopping model can be chosen.
    • The margin of error can be displayed (none / automatic / manual) in the log.
    • In depth profile count of elements' data points can be shown at selected depth.
  • Depth profile graph
    • The unit of X-axis in the depth profile can be changed.
    • The axes ticks are rounded to integers (i.e. no decimals).
    • The cursor coordinates are shown when hovering over the graph.
    • Depth profile can be saved as an imagefile.
    • Depth distribution of depth profile 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 specified from the graph.
  • Energy Spectrum
    • Energy spectrum can be made from cut files.
  • Project management
    • By default project is saved in the users' documents directory.
    • Project is saved in logical folder structure.
    • Project can include multiple measurements.
    • Several measurements can be opened into the sample collection as tabs.
    • Upon opening project, it loads current stage from a 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 selected histograms in project.
    • Report includes selected depth profiles in project.
    • Report includes selected integrations of selected depths in depth profiles.
    • Report includes graphs' parameters.
    • 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.