Metadata-Version: 2.1
Name: mini-auspex
Version: 1.5.13
Summary: Package for processing non-destructive ultrasound testing data
Home-page: http://auspex.xyz
Author: LASSIP-UTFPR
Author-email: giovanni@utfpr.edu.br
Description-Content-Type: text/markdown
License-File: LICENSE

This package contains the functions to process and analyze nondestructive ultrasound tests. Among these codes are tools for reading inspection files from various sources, data preprocessing algorithms, image reconstruction algorithms, and codes for presenting results.
The primary function of each module is described below:
 - `framework.data_types`: contains classes that define data structures other modules use in the mini-auspex package. Data structures store inspection data (such as inspection, part, and transducer parameters), generate regions of interest (ROI), and store results from imaging algorithms.
 - `framework.file_civa`: dedicated to reading CIVA simulator files.
 - `framework.file_m2k`: responsible for reading files that have the .m2k extension. Currently, the module can read files generated by inspections with Multix++ and Panther equipment.
 - `framework.pre_proc`: the algorithms implemented to perform the preprocessing on the inspection data.
 - `framework.post_proc`: functions that apply postprocessing operations to the results provided by image reconstruction algorithms.
 - `imaging.bscan`: implements the B-Scan image reconstruction algorithm.
 - `imaging.saft`: implements the SAFT image reconstruction algorithm.
 - `imaging.tfm`: implements the TFM image reconstruction algorithm.
 - `imaging.cpwc`: implements the CPWC  image reconstruction algorithm.
 - `surface.surface`: implements the module class that identifies the external surface of an object inspected by the immersion technique and also provides propagation times for a set of transducer elements and region of interest (ROI) points.
 - `surface.nonlinearopt`: implements auxiliary functions necessary for surface estimation by the surface class.
 - `parameter_estimation.intsurf_estimation`: algorithms for estimating underwater pipes' internal surface to evaluate these pipes' internal corrosion.
 - `parameter_estimation.cl_estimators`: algorithms for estimating the propagation speed of ultrasonic waves within water.

## Building

These are the necessary steps to build the `mini-auspex` wheel package:
 - Update the `miniAUSPEX` branch with the latest changes from the `origin/miniAUSPEX` branch.
 - Merge the `origin/develop` branch into the `miniAUSPEX` branch.
 - Edit the setup.cfg file to update the version number.
 - Run the command `python setup_mini.py sdist bdist_wheel` from the terminal in the root directory of the AUSPEX project.
 - The wheel file will be available in the `dist` directory.

## Acknowledgments

The package was developed by the [Laboratory of Statistical Signal Processing & Inverse Problems - LASSIP](https://www.utfpr.curitiba.br/lassip/) at the [UNIVERSIDADE TECNOLÓGICA FEDERAL DO PARANÁ - UTFPR](https://www.utfpr.edu.br/)).
