Metadata-Version: 2.1
Name: fitting2d
Version: 1.0.0a2
Summary: a library for performing two-dimensional curve-fitting
Home-page: https://github.com/gwappa/fitting2d
Author: Keisuke Sehara
Author-email: keisuke.sehara@gmail.com
License: MIT
Description: # fitting2d
        
        a library for performing two-dimensional curve-fitting.
        
        ## Install
        
        ```
        pip install . # within this repository
        ```
        
        Presumably, it can be also installed from PyPI:
        
        ```
        pip install fitting2d
        ```
        
        ## Usage
        
        ### Classes
        
        Currently, it has only two types of fitting procedures as classes:
        
        - `Ellipse`
        - `Parabola`
        
        Both classes are built as `namedtuple`s.
        
        You can also extend the library by adding the `FittingMixin` mix-in class
        to your shape class (built as a `namedtuple`).
        
        ### Performing fitting
        
        To perform the fitting procedure, run e.g.
        
        ```python
        # xp and yp consisting of x- and y- coordinates as arrays
        model = Ellipse.fit(xp, yp)
        ```
        
        ### Drawing the fitted shapes
        
        Both classes have the `draw` method making use the parameter-based representation:
        
        ```python
        # t being the coordinate parameter
        xp, yp = model.draw(t)
        ```
        
        The nature of the parameter `t` above depends on the fitted shape.
        Some tips are in the docstring for the `draw` method.
        
        ## License
        
        Copyright (c) 2020 Keisuke Sehara, the MIT License
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
