Skip to main content

A shape-based feature extractor for use in biological and medical studies.

Project description

pycellmech Logo

PyCellMech

Introduction

PyCellMech is designed to understand how shapes impact our understanding of medical conditions and/or their progression.

This package currently begins by introducing some preliminary shape-based analyses, with focus on geometric, polygonal and one-dimensional shape features.

License

This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International Public License. See the LICENSE file for details.

Requirements

Packages used in PyCellMech include:

    matplotlib
    numpy
    math
    opencv-python
    pandas
    scikit-learn

Usage

PyCellMech takes binarized masks as its input. There are no restrictions in terms of regions of interest (ROI), as the method will iterate through each ROI within each binarized image. Whether you have a single image or multiple images to process, binarized masks should be contained within a folder.

Once you have your input images ready, download the code, head to the main.py file, and change the following settings (located on lines 176-178)::

    folder_path = '/path/to/binarized/images'
    csv_file_path = '/path/to/save/shape_features.csv'
    output_folder = '/path/to/save/feature/maps'

csv_file_path will reflect the location you would like to save the CSV file, and output_folder is where the feature visualization map for every image processed will be saved.

Feature visualization maps select the largest ROI and superimpose the extracted features on the ROI. Thus, this package provides quantitative and qualitative assessments.

A handful of samples from the Kvasir dataset have been included in this repository for testing.

Shape Features

The current iteration of PyCellMech involves three shape-based feature classes:

- One-dimensional function shape features
- Geometric Shape Features
- Polygonal Approximation Shape Features

These feature classes will continue to be built upon in future iterations. A summary of these feature descriptions are found below.

One-dimensional function shape features

Complex Coordinate

A complex coordinate function derives a complex number from a point on an object's contour.

Centroid Distance Function (CDF)

CDF the distance from the centroid of an object to points on its boundary, providing a way to describe the shape's geometry relative to its center.

Area Function (AF)

AF quantifies the total surface area enclosed by the boundaries of the shape.

Triange Area Representation (TAR)

TAR calculates the area of triangles formed within or around the shape.

Chord Length Function (CLF)

CLF measures the distances between pairs of points on the shape's boundary.

Geometric Shape Features

Axis Minimum Inertia (AMI)

AMI identifies the axis along which the shape exhibits the least resistance to rotational motion.

Average Bending Energy (ABE)

ABE quantifies the mean amount of effort required to deform the shape.

Eccentricity

Eccentricity describes the degree to which a shape deviates from being circular.

Minimum Bounding Rectangle (MBR)

MBR represents the smallest rectangle that entirely encloses the shape, representing its rectilinear approximation.

Circularity Ratio (CR)

CR compares the area of the shape to the area of a circle with the same perimeter.

Ellipse Variance and Moment Invariants (EM and EV)

EV measures the deviation of a shape from an elliptical form, and EM quantifies shape characteristics that remain constant under transformations (e.g., rotation, scaling, and translation).

Solidity

Solidity calculates the ratio of the shape's area to the area of its convex hull.

Polygonal Approximation Shape Features

Distance Threshold Method (DTM)

DTM involves setting a specific distance limit to differentiate between relevant and irrelevant points.

Polygon Evolution by Vertex Deletion (PEVD)

PEVD is a process where vertices are incrementally removed from a polygonal shape to simplify its structure while trying to preserve its overall form and characteristics.

Splitting Method (SM)

SM involves dividing a shape into smaller, manageable segments or components.

Minimum Perimeter Polygon (MPP)

MPP is the polygon with the smallest possible perimeter that can enclose a given shape.

K-Means Method

KMeans clusters points on the shape into a specified number of groups based on their proximity.

References

The PyCellMech package was inspired by the below works. The package will be continually updated based on the latest research developments.

P.-Y. Yin. Pattern Recognition Techniques, Technology and Applications. InTech, November
2008. ISBN 9789537619244. doi: 10.5772/90.
J. Chaki and N. Dey. A Beginners Guide to Image Shape Feature Extraction Techniques.
Taylor Francis Group, 2019. ISBN 9781000034301. doi: 10.5772/90.

Kvasir Dataset

Konstantin Pogorelov, Kristin Ranheim Randel, Carsten Griwodz, Sigrun Losada Eskeland,
Thomas de Lange, Dag Johansen, Concetto Spampinato, Duc-Tien Dang-Nguyen, Math-
ias Lux, Peter Thelin Schmidt, Michael Riegler, and Pal Halvorsen. Kvasir: A multi-class
image dataset for computer aided gastrointestinal disease detection. In Proceedings of the
8th ACM on Multimedia Systems Conference, MMSys’17, pages 164–169, New York, NY,
USA, 2017. ACM. ISBN 978-1-4503-5002-0. doi: 10.1145/3083187.3083212.

Citation

@misc{
arslan2024pycellmech,
title={PyCellMech: A shape-based feature extraction pipeline for elucidating biological differences between disease states},
author={Janan Arslan and Henri Chhoa and Ines Khemir and Romain Valabregue and Stephen Whitmarsh},
year={2024},
url={https://openreview.net/forum?id=VzvRnPMDhX}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pycellmech-2.1.5.tar.gz (20.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pycellmech-2.1.5-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

Details for the file pycellmech-2.1.5.tar.gz.

File metadata

  • Download URL: pycellmech-2.1.5.tar.gz
  • Upload date:
  • Size: 20.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.0

File hashes

Hashes for pycellmech-2.1.5.tar.gz
Algorithm Hash digest
SHA256 0b525b323a7f6e7f6e049942014d7edb3018673dc8d88f2c6fa027dec872fc91
MD5 e10c06c46a9de29dcea9059d90a6ce79
BLAKE2b-256 a18a0c5cf43b43ca1b66d1b290d8550c756fc807132a28fc40d1618a53e706cf

See more details on using hashes here.

File details

Details for the file pycellmech-2.1.5-py3-none-any.whl.

File metadata

  • Download URL: pycellmech-2.1.5-py3-none-any.whl
  • Upload date:
  • Size: 20.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.0

File hashes

Hashes for pycellmech-2.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 1f611a4a75b049b8f7a1a0e9f99c0f0680d36369072df17cc12de71ef4f5c71c
MD5 c63019ffd1f7c949196ee2b86b5ada04
BLAKE2b-256 96fbb41bd8357fde9cb0bd670c3a34dd5b2a3bb62119d6fea3dbc26142db2db6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page