Metadata-Version: 2.1
Name: FractureDetector
Version: 0.0.11
Summary: FractureDetector Package is a CNN model that checks if a X-Ray image shows a fracture.
Author: Harjas Rohra
Author-email: <hrohra2004@gmaill.com>
License: MIT
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: pillow
Requires-Dist: joblib
Requires-Dist: numpy

## FractureDetector Package

FractureDetector Package is a CNN model that checks if a X-Ray image shows a fracture.

Additionally it also classifies a detected fracture(if any) into the following categories:

Avulsion fracture,
Comminuted fracture,
Fracture Dislocation,
Greenstick fracture,
Hairline Fracture,
Healthy Bone,
Impacted fracture,
Longitudinal fracture,
Oblique fracture,
Pathological fracture,
Spiral Fracture.

## Installation

You can install FractureDetector from PyPi using pip or pip3 as

`pip install FractureDetector`

or

`pip3 install FractureDetector`

## Modules

The FractureDetector package contains 1 module(utils) that contains a class that contains the FractureDetector class.

`from FractureDetector import FractureDetector.utils.FractureDetector`

The Fracture detector class takes image object and checks it for any fractures.

`f_detector = FractureDetector(img)#img is the X-Ray image`

It returns a FractureDetector object.

## Attributes and Functions

1) FractureDetector.category: A string of the category of the X-Ray(Avulsion fracture, Comminuted fracture, Fracture Dislocation, Greenstick fracture, Hairline Fracture, Healthy Bone, Impacted fracture, Longitudinal fracture, Oblique fracture, Pathological fracture, Spiral Fracture.)

2) FractureDetector.hasFracture(): Returns a boolean value. True if X-Ray shows a fracture, False otherwise.

3) FractureDetector.fractureType(): Returns a string representing the type of Fracture.

If no fracture detected returns "".
