Metadata-Version: 2.4
Name: tracee
Version: 0.0.4
Author-email: Ryou Ohsawa <ryou.ohsawa@nao.ac.jp>
Maintainer-email: Ryou Ohsawa <ryou.ohsawa@nao.ac.jp>
License: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: minimalKNN>=0.5
Requires-Dist: fdlsgm>=0.5.5
Dynamic: license-file

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![CodeQL](https://github.com/astronasutarou/tracee/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/astronasutarou/tracee/actions/workflows/github-code-scanning/codeql)

# Tracklet Extraction Engine

This package provides a function to retrieve _tracklets_ from a list of _vertices_ in a three-dimensional space. The function find a set of linearly aligned vertices in the list and derive a line segment (tracklet) to approximate the vertex distribution.


## Overview

The module provides a class `Tracklet` and a function `extract`. The `extract` function receives a list of vertices as `numpy.ndarray`. The array shape should be `(n,6)`, where _n_ is the number of vertices. Then, a list of `Tracklets` instances are returned. Some tutorials are available in [notebook][notebook].

[notebook]: https://bitbucket.org/ryou_ohsawa/tracee/src/master/notebook/


## Requiremnts
The package `tracee` depends on the following packages. Both packages are available in [PyPi][pypi]. Installation on Ubuntu 18.04 was confirmed. If you have any troubles in installation, please contact to the developer.

- [fdlsgm>=0.5.5][fdlsgm]
- [minimalKNN>=0.5][minimalKNN]


[pypi]: https://pypi.org/
[fdlsgm]: https://pypi.org/project/fdlsgm/
[minimalKNN]: https://pypi.org/project/minimalKNN/
