Metadata-Version: 2.1
Name: TCFile
Version: 2023.4.1
Summary: Python package for handling TCF data. It works with Tomcube data
Author-email: Dohyeon Lee <dleh428@kaist.ac.kr>
Maintainer-email: Dohyeon Lee <dleh428@kaist.ac.kr>
Requires-Python: >=3.7,<4
Description-Content-Type: text/markdown
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Dist: numpy>=1.18.5,<2
Requires-Dist: h5py>=3.2.0,<4
Requires-Dist: pillow>=9.5.0,<10
Project-URL: repository, https://github.com/ehgus/TCFile

# TCFile python package

A basic image processing tool of tomocube data.

## Installation

```bash
pip install TCFile
```

## Use case

```python

from TCFile import TCFile

tcfile = TCFile('test.TCF','3D') # ready for return 3D RI images
print(f"number of snapshots : {len(tcfile)}")

## Usage 1: handling each snapshots (or data)
data = tcfile[0]
print(f"shape of data : {data.shape}")
# or
for data in tcfile:
    # do some operations on the data ...
    pass
```

## TODO

- [ ] fluorescence data reader
- [ ] TCFile compressor/decompressor for portability
- [ ] rich documentation
- [ ] rigorous tests
- [ ] TCFile writer ?
- [ ] TCFile converter ?

Any suggestions and comments are welcome!

## Test

```bash
# install this package in editable mode
git clone https://github.com/ehgus/TCFile.git
cd TCFile
pip install -e .
# execute pytest
pytest
```

