Pyplis - Python Plume Imaging Software
Official website of pyplis, a Python software containing algorithms and analysis routines for UV SO2 camera data. Apart from the API documentation, this website includes additional relevant information about the software (e.g. installation details, access of example data) as well as useful practical information that helps getting started with pyplis.
A paper introducing the software is published in the Journal Geosciences (MDPI). If you find pyplis useful for your analysis, we highly appreciate if you acknowledge our work by citing the paper.
Screenshot of the pyplis paper. Please acknowledge our work by citing the paper.
Contents:
- Installation
- Main features
- Architecture
- Getting started
- Acknowledgement
- Scientific background
- Example scripts
- Basic examples for getting started
- Example 0.1 - Image representation
- Example 0.2 - The camera class
- Example 0.3 - Introduction into ImgList objects
- Example 0.4 - Introduction into the Dataset class
- Example 0.5 - Optical flow live view
- Example 0.6 - Plume cross section lines
- Example 0.7 - Manual cell calibration
- Example 0.8 - Parameterising optical flow histograms - The MultiGaussFit class
- Advanced examples for emission rate analysis
- Example 1 - Creation of analysis setup and Dataset
- Example 2 - Measurement Geometry
- Example 3 - Plume background analysis
- Example 4 - Preparation of AA image list
- Example 5 - Automatic cell calibration
- Example 6 - DOAS calibration
- Example 7 - AA sensitivity correction masks
- Example 8 - Plume velocity retrieval (Cross correlation)
- Example 9 - Plume velocity retrieval (Optical flow Farneback)
- Example 10 - Import plume background images
- Example 11 - Image based signal dilution correction
- Example 12 - Emission rate analysis (Etna example data)
- Basic examples for getting started
- Plot gallery
- Further reading
- API
- Setup classes
- Data Set object
- Geometrical calculations
- Image base module
- Image list objects
- Plume background analysis
- Plume velocity analysis
- Camera calibration base class
- Cell calibration
- DOAS calibration
- Emission rate retrieval
- Signal dilution correction
- Low level utils
- Further processing classes
- Fitting / Optimisation algorithms
- Mathematical model functions
- I/O routines
data_search_dirs()zip_example_scripts()get_all_files_in_dir()create_temporary_copy()download_test_data()find_test_data()all_test_data_paths()set_test_data_path()get_camera_info()save_new_default_camera()save_default_source()get_all_valid_cam_ids()get_cam_ids()get_source_ids()get_source_info()get_source_info_online()normalise_keys()get_icon()
- Custom image import methods
- Helper functions
exponent()matlab_datenum_to_datetime()get_pyr_factor_rel()nth_moment()set_ax_lim_roi()closest_index()to_datetime()isnum()mesh_from_img()make_circular_mask()get_img_maximum()sub_img_to_detector_coords()check_roi()subimg_shape()same_roi()roi2rect()map_coordinates_sub_img()map_roi()shifted_color_map()rotate_xtick_labels()rotate_ytick_labels()bytescale()
- Forms and geometrical objects
- Contributing
- Supplementary material
- Changelog