# TapCorder Data Set

This README file was generated on **2024-11-18** by **Ashish**

## GENERAL INFORMATION

1. **Title of Dataset**: The TapCorder Data Set

2. **Authors**:
   - **Name**: Ashish Shivajirao Jadhav  
     **Institution**: University of Magdeburg / Compolytics GmbH  
     **Address**: Germany

   - **Name**: Udo Seiffert  
     **Institution**: University of Magdeburg / Compolytics GmbH  
     **Address**: Germany

## SHARING/ACCESS INFORMATION

1. **Licenses placed on the data**:  
   This work is licensed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International. To view a copy of this license, visit [https://creativecommons.org/licenses/by-nc-sa/4.0/](https://creativecommons.org/licenses/by-nc-sa/4.0/)

2. **Links to publications that cite or use the data**:
   - Jadhav, A. S., Seiffert, U., and Backhaus, A. *Machine Learning on Smartphone-Captured Diffraction Data*. ESANN 2025 proceedings [submitted]

## DATA & FILE OVERVIEW

This section provides an overview of the data files used in the project, including their contents, structure, and purpose.

### 1. Directory Structure:

Below is the file tree showing the project organisation:

```plaintext
tapcorderv1/
├── data/
│   ├── used/
│   │   ├── used00001.png
│   │   └── used00002.png
│   ├── new/
│   │   ├── new00001.png
│   │   └── new00002.png
│   └── clean/
│       ├── clean00001.png
│       └── clean00002.png
└── README.md
```

### 2. tapcorderv1/ Directory

The root directory of the project contains all relevant data, images, and the documentation file (README.txt).

### 3. Description of Directories:

The `data/` directory holds all the images categorised into three subdirectories: `used`, `new`, and `clean`.

- **used/**  
  Contains the 117 images with used oil.  
  Example files: `used00001.png`, `used00002.png`

- **new/**  
  Contains the 110 images with new oil.  
  Example files: `new00001.png`, `new00002.png`

- **clean/**  
  Contains the 113 images with a clean lens.  
  Example files: `clean00001.png`, `clean00002.png`

### 4. README. md

This file provides an overview of the project structure, version history, and contributors.

## VERSION HISTORY

| Version | Date       | Contributors                                              |
|---------|------------|-----------------------------------------------------------|
| 1       | 2024-11-18 | Ashish Shivajirao Jadhav, Udo Seiffert                    |