READ ME File For 'TERMITES-MAZE python module'

Dataset DOI: 10.5258/SOTON/D1678 

ReadMe Author: Apostolos Zdagkas, University of Southampton [https://orcid.org/0000-0002-1734-9722]

This dataset supports the publication:
AUTHORS: A.Zdagkas
TITLE: Flying Doughnuts: Space-Time non-Separable Electromagnetic Pulses
JOURNAL: Thesis
PAPER DOI IF KNOWN:


This dataset contains:

A python implementation of the TERMITES-MAZE method for the spatio-temporal characterization
of ultrashort cylindrical vector electromagnetic pulses. The first part implements the TERMITES algorithm
for the characterization of linearly polarized pulses with uniform spectral properties at their center.
The second part implements the analysis steps required to characterize cylindrical vector pulses.
An example with simulated data is included in the example.py file.

Instructions

1. Make sure you have installed the following:
- numpy (last tested with version 1.19.0)
- scipy (last tested with version 1.5.0)
- matplotlib (last tested with version 3.3.0)
- opencv (last tested with version 4.0.1)
- scikit-image (last tested with version 0.17.2)
	
2. Download the source code.

3. Run the example.py file with the test data to test if everything works.

4. Place your data in the input folder and make the appropriate changes in the example.py file


Date of data collection: December 2018

Information about geographic location of data collection: 

Licence: BSD 3-Clause License

Copyright (c) 2020, Apostolos Zdagkas
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


Related projects:
ADD IN


Date that the file was created: December, 2020