https://github.com/kevinsbarnard/ifdo-py
iFDO Python utilities
https://github.com/kevinsbarnard/ifdo-py
Last synced: 3 months ago
JSON representation
iFDO Python utilities
- Host: GitHub
- URL: https://github.com/kevinsbarnard/ifdo-py
- Owner: kevinsbarnard
- License: mit
- Created: 2023-02-28T05:01:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-21T17:58:14.000Z (5 months ago)
- Last Synced: 2025-03-27T03:35:13.249Z (3 months ago)
- Language: Python
- Size: 98.6 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ifdo-py
ifdo-py is a Python library for the [iFDO](https://marine-imaging.com/fair/ifdos/iFDO-overview/) file format.
## Install
```bash
pip install ifdo
```
## Usage
### Read/write iFDO files
```python
from ifdo import iFDO
# Read from YAML file
ifdo_object = iFDO.load("path/to/ifdo.yaml")
# Write to YAML
ifdo_object.save("path/to/ifdo.yaml")
```
### Create image annotations
```python
from datetime import datetime
from ifdo.models import ImageAnnotation, AnnotationCoordinate, AnnotationLabel
# Create a bounding box
coordinates = [
AnnotationCoordinate(x=0, y=0),
AnnotationCoordinate(x=1, y=0),
AnnotationCoordinate(x=1, y=1),
AnnotationCoordinate(x=0, y=1),
]
# Create a label for it
label = AnnotationLabel(id="fish", annotator="kevin", created_at=datetime.now(), confidence=0.9)
# Pack it into an annotation
annotation = ImageAnnotation(coordinates=coordinates, labels=[label], shape='rectangle')
# Print it as a dictionary
print(annotation.to_dict())
```
```python
{
'coordinates': [
{'x': 0, 'y': 0},
{'x': 1, 'y': 0},
{'x': 1, 'y': 1},
{'x': 0, 'y': 1}
],
'labels': [
{
'id': 'fish',
'annotator': 'kevin',
'created-at': datetime.datetime(2023, 2, 28, 16, 39, 46, 451290),
'confidence': 0.9
}
],
'shape': 'rectangle'
}
```