Metadata-Version: 2.1
Name: endoseg
Version: 0.5.0
Summary: Python module to segment the visible circular area of endoscopic images.
Home-page: https://github.com/luiscarlosgph/endoseg
Author: Luis C. Garcia-Peraza Herrera
Author-email: luiscarlos.gph@gmail.com
License: MIT License
Description: Description
        -----------
        Endoseg is a Python package that facilitates the segmentation of the visible circular area of endoscopic images.
        
        Install dependencies
        ------------
        * Numpy
        ```bash
        # Ubuntu/Debian
        $ sudo apt update
        $ sudo apt install python3-pip
        $ python3 -m pip install numpy --user
        ```
        
        * OpenCV
        ```bash
        # Ubuntu/Debian
        $ sudo apt update
        $ sudo apt install libopencv-dev python3-opencv
        ```
        
        Install with pip
        ----------------
        ```bash
        $ python3 -m pip install endoseg --user
        ```
        
        Install from source
        -------------------
        ```bash
        $ git clone https://github.com/luiscarlosgph/endoseg.git
        $ cd endoseg
        $ python3 setup.py install --user
        ```
        
        Run
        ---
        ```bash
        $ git clone https://github.com/luiscarlosgph/endoseg.git
        $ cd endoseg
        $ python3 -m endoseg.run --input data/demo.jpg --output-seg data/demo_seg.png --output-crop data/demo_crop.jpg
        ```
        <table align="center">
          <tr>
            <td align="center">Input image</td> 
            <td align="center">Output segmentation</td>
            <td align="center">Output crop</td>
          </tr>
          <tr>
            <td align="center">
              <img src="https://github.com/luiscarlosgph/endoseg/blob/main/data/demo.jpg?raw=true" width=205>
            </td>
            <td align="center">
              <img src="https://github.com/luiscarlosgph/endoseg/blob/main/data/exemplary_seg.png?raw=true" width=205>
            </td>
            <td align="center">
              <img src="https://github.com/luiscarlosgph/endoseg/blob/main/data/exemplary_crop.jpg?raw=true" width=205>
            </td>
          </tr>
        </table>
        
        Exemplary code snippet
        ----------------------
        ```python
        # Read input image
        im = cv2.imread('input_image.jpg', cv2.IMREAD_UNCHANGED)
        
        # Segment the visible area of the endoscopic image
        segmenter = endoseg.Segmenter()
        seg = segmenter.segment(im)
        
        # Save the segmentation to file
        cv2.imwrite('output_segmentation.png', seg)
        
        # Get a rectangular crop of the visible area
        crop = segmenter.get_rect_crop(im)
        
        # Save the crop to file
        cv2.imwrite('output_crop.jpg', crop)
        ```
        
        License
        -------
        This code is released under an 
        [MIT license](https://github.com/luiscarlosgph/endoseg/blob/main/LICENSE).
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
