Dataset Exporter, version 1.0

The Dataset Exporter is a script collection that allows exporting data from datasets made from measurement data of ultrasonic pulse transmission tests. The entire script collection was conceived, implemented and tested by Jakob Harden using the scientific numerical programming language of GNU Octave 6.2.0. The main features cover the export of substructures to variables and the serialization to the CSV format, the JSON structure format and TeX code.

Table of contents

Licence

All files published under the DOI 10.3217/9adsn-8dv64 are licenced under the MIT licence.

Copyright 2023 Jakob Harden (jakob.harden@tugraz.at, Graz University of Technology, Graz, Austria)
License: MIT
This file is part of the PhD thesis of Jakob Harden.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the “Software”), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Prerequisites

To be able to use the scripts, GNU Octave 6.2.0 (or a higher version) need to be installed. GNU Octave is available via the package management system on many Linux distributions. Windows users have to download the Windows version of GNU Octave and to install the software manually.

GNU Octave download

Directory and file structure

All scripts files (*.m) are plain text files written in the scientific programming language of GNU Octave 6.2.0.

   dsexporter/
   ├── dsexporter_examples.m
   ├── dsexporter_settings.m
   ├── dsexporter_sig2csv.m
   ├── dsexporter_substruct2json.m
   ├── dsexporter_substruct2tex.m
   ├── dsexporter_substruct.m
   ├── dsexporter_tem2csv.m
   ├── examples
   │   ├── csv
   │   ├── json
   │   ├── latex
   │   └── tex
   ├── init.m
   ├── json
   │   ├── json_property.m
   │   ├── json_settings.m
   │   ├── json_struct_export.m
   │   ├── json_struct.m
   │   ├── json_struct_objattrib.m
   │   ├── json_struct_objdata.m
   │   ├── json_struct_objref.m
   │   ├── json_val_array.m
   │   ├── json_val_matrix.m
   │   └── json_val_scalar.m
   ├── README.html
   ├── README.md
   ├── struct
   │   ├── struct_objattrib.m
   │   ├── struct_objdata.m
   │   └── struct_objref.m
   ├── tex
   │   ├── tex_def_csvarray.m
   │   ├── tex_def_dotarray.m
   │   ├── tex_def_scalar.m
   │   ├── tex_def_tabarray.m
   │   ├── tex_def_tabmatrix.m
   │   ├── tex_serialize.m
   │   ├── tex_settings.m
   │   ├── tex_struct_export.m
   │   ├── tex_struct.m
   │   ├── tex_struct_objattrib.m
   │   ├── tex_struct_objdata.m
   │   └── tex_struct_objref.m
   ├── tmp
   └── tools
       ├── tool_get_maturity.m
       ├── tool_gui_dsload.m
       ├── tool_gui_selchn.m
       ├── tool_gui_selsig.m
       ├── tool_gui_selsub.m
       └── tool_gui_seltem.m

Installation instructions

  1. Copy the program directory to a location of your choice. e.g. working_directory.
  2. Open GNU Octave.
  3. Change the working directory to the program directory. e.g. working_directory.

Usage instructions

  1. Adjust the settings in the function files: dsexporter_settings.m, ./json/json_settings.m, ./tex/tex_settings.m
  2. Run GNU Octave.
  3. Initialize program.
  4. Execute any of the function files.

Initialize program

The 'init' command initializes the program. This is only required once before executing all the other functions. The command is adding the subdirectories included in the main program directory to the 'path' environment variable.

   octave: >> init;

Execute function file at the command line interface

The following commands are the main functions of the program. The function parameters are documented in the respective function files (see also section: Help). The functions can be used either in interactive or non-interactive mode. In interactive mode, dialog windows are used and user input is expected. That mode is always activated when necessary or all function parameters are missing.

   octave: >> [ds] = dsexporter_substruct(p_ss, p_fp, p_sp);
   octave: >> [fp1, fp2] = dsexporter_sig2csv(p_ss, p_odp, p_ifp, p_cn, p_si, p_i0, p_i1, p_del);
   octave: >> [fp1, fp2] = dsexporter_tem2csv(p_ss, p_odp, p_ifp, p_tcn, p_del);
   octave: >> [fp] = dsexporter_substruct2json(p_ss, p_odp, p_ifp, p_dsp);
   octave: >> [fp] = dsexporter_substruct2tex(p_ss, p_odp, p_ifp, p_dsp);
   octave: >> dsexporter_examples();

Help

All function files contain an adequate function description and instructions on how to use the functions. This documentation can be displayed in the GNU Octave command line interface by entering the following command:

   octave: >> help function_file_name;

Related data sources

Datasets from which data can be exported with these scripts are made available at the repository of Graz University of Technology under an open licence (Creative Commons Attribution 4.0 International, CC BY 4.0). The data records listed below contain the raw data, the compiled datasets and a technical description of the record content.

Data records

Related software

The referenced datasets are compiled from raw data using a dataset compilation tool implemented in the programming language of GNU Octave 6.2.0 ("Dataset Compiler, version 1.1") . To understand the structure of the datasets, it is a good idea to look at the soure code of that tool. Therefore, it was made publicly available under the MIT licence at the repository of Graz University of Technology.

Another tool, implemented in the programming language of GNU Octave 6.2.0, allows for plotting measurement data contained in the datasets ("Dataset viewer, version 1.0"). The main features of that script collection cover 2D plots, 3D plots and rendering MP4 video files from the measurement data contained in the datasets. It is also made publicly available under the MIT licence at the repository of Graz University of Technology.

Dataset Compiler, version 1.1:

Dataset Viewer, version 1.0:

Revision and release history

2023-08-26, release, version 1.0