README.md

---
license: eupl-1.2
language:
  - en
---

# Vuurwerkverkenner

This dataset is utilized by the Vuurwerkverkenner application to link fragments of exploded (heavy) fireworks to their
originating firework types. You can explore the application
at [www.vuurwerkverkenner.nl](https://www.vuurwerkverkenner.nl). The dataset includes various firework types examined in
casework by the Netherlands Forensic Institute.

## Categories

Firework wrappers that closely resemble each other visually may be grouped into categories. Typically, a wrapper stands
alone without resemblance to others, forming a category with one unique wrapper.

## Contents

The dataset comprises 219 categories, featuring a total of 368 unique wrappers. It
is organized as follows:

```
reference_data 
└───bigboy 
  └─── big boy xl 
    └─── wrapper.png 
    └─── compleet exemplaar.png
  └─── bigboy
    └─── wrapper.png 
    └─── compleet exemplaar.png
└───atomyc 
  └─── atomyc 3 
    └─── wrapper.png
    └─── compleet exemplaar.png
    └─── gedemonteerd.png
└───meta.json.gz 
```

The top-level folders (`bigboy`, `atomyc`, ...) indicate the firework categories. The next level (`big boy xl`, 
`atomyc 3`, ...)
identifies specific wrappers within each category. For each wrapper, one or more images may be included. At a minimum,
`wrapper.png`, a scan of the complete wrapper, is present. Additional images, like photographs of the whole firework
article or schematic drawings of its internals, may also be available.

In `meta.json.gz`, both metadata and reference embeddings for each firework category are stored. It aligns in structure 
as follows:

```
{ 
  "bigboy": {
    "big boy xl": {
      "embeddings": [[...], [...], ...], 
      "wrappers": {
          "wrapper_text": "abcdef", 
          "article_name": "abc",
          ... 
        },
      }, 
    }, 
} 
```

The first level (`meta['bigboy']`, `meta['butterfly']`, ...) denotes the firework category corresponding to the top level
of photo folders (e.g., `meta[0]` matches the folder `bigboy`). The second level (`meta['bigboy']['big boy xl']`,
`meta['bigboy']['bigboy']`, ...) identifies individual wrappers within the category, aligning with the second level of
photo folders (e.g., `meta['bigboy']['big boy xl']` corresponds to `bigboy/big boy xl`). Each wrapper holds reference
embeddings and metadata. The third level, such as `meta['bigboy']['big boy xl']['wrappers']`, aligns with a specific
wrapper's photo folder (like `bigboy/big boy xl/wrapper.png`). Embeddings stored at this level are used to compare
embeddings of uploaded images in the application with.

### _Reference embeddings_

Reference embeddings are provided for each category. These are generated by an AI model trained to create embeddings for
firework wrappers and exploded wrapper snippets. When snippets from a category are fed into the model, they should yield
similar embeddings to those for the wrappers. For further details on the model,
see [here](https://huggingface.co/NetherlandsForensicInstitute/vuurwerkverkenner).

### _Metadata_

Metadata for each wrapper includes various fields, described as follows:

| Field                        | Description                                                       | 
|------------------------------|-------------------------------------------------------------------| 
| `text`                       | Full text present on the wrapper (excluding non-Latin alphabets). | 
| `endangerment`               | The level of danger or risk associated with the firework.         | 
| `article_name`               | The name of the item.                                             | 
| `firework_type`              | The type of firework.                                             | 
| `firework_category`          | The category or classification of the firework.                   | 
| `tube_length`                | The length of the tube.                                           | 
| `tube_diameter`              | The diameter of the tube.                                         | 
| `composition_burst_charge`   | The composition of the main charge of the firework.               | 
| `composition_other_mixtures` | The composition of other charges of the firework.                 | 
| `mass_burst_charge`          | The mass of the main charge.                                      | 
| `mass_other_mixtures`        | The mass of other charges.                                        |