wsireg


Namewsireg JSON
Version 0.3.10 PyPI version JSON
download
home_pagehttps://github.com/nhpatterson/wsireg
Summarypython package for registering multimodal whole slide microscopy images
upload_time2024-07-04 08:54:55
maintainerNone
docs_urlNone
authorNathan Heath Patterson
requires_python>=3.8
licenseMIT license
keywords wsireg
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            ======
wsireg
======

.. image:: https://readthedocs.org/projects/wsireg/badge/?version=latest
        :target: https://wsireg.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status


Multi-modal or mono-modal whole slide image registration in a graph structure for complex registration tasks using `elastix`.


* Documentation: https://wsireg.readthedocs.io.


Features
--------

* Graph based approach to defining modalities and arbitrary transformation paths between associated images
* Use of `elastix` (through `ITKElastix <https://github.com/InsightSoftwareConsortium/ITKElastix/>`_) to perform registration
* Support for linear and non-linear transformation models
* Transform associated data (masks, shape data) along the same path as the images.
* Supports images converted to OME-TIFF using `bioformats2raw <https://github.com/glencoesoftware/bioformats2raw>`_ -> `raw2ometiff <https://github.com/glencoesoftware/bioformats2raw>`_ pipeline
* All registered images exported as pyramidal OME-TIFF or OME-zarr that can be viewed in software such as `Vitessce <https://vitessce.io>`_ , `vizarr <https://github.com/hms-dbmi/vizarr>`_, `QuPath <https://qupath.github.io>`_, `OMERO <https://www.openmicroscopy.org/omero/>`_ or any platform that supports these formats.
* All transforms for complex registration paths are internally composited and only 1 interpolation step is performed, avoiding accumulation of interpolation error from many registrations
* Shape data (polygons, point sets, etc.) in GeoJSON format (future portable format for QuPath detection/annotation data) can be imported and transformations applied producing a modified GeoJSON
* Some support for reading native WSI formats: currently reads .czi and .scn but could be expanded to other formats supported by python package `tifffile`



=======
History
=======

0.3.10 (2024-07-04)
---------------------
Use headless opencv

0.3.9 (2024-03-10)
---------------------
Deprecates unused aicsimageio dependency.

0.3.8 (2023-01-10)
---------------------
Fix bug that occurs when file paths contain a period.

0.3.7 (2022-04-28)
---------------------
Add support for translation transformation. Fix writing of merge modalities in cmd line configuration.

0.3.6 (2022-04-28)
---------------------
Fixes bug in wsireg2d console script.

0.3.5 (2022-04-28)
---------------------
Add support for python 3.10 with updated itk-elastix.

0.3.4 (2022-04-27)
---------------------
Major refactor of RegImage class, various small improvements throughout to support napari-wsireg.


0.3.2.2 (2022-02-04)
---------------------
This minor update adds the ability to draw binary or label masks using RegShapes.


0.3.2.1 (2021-12-28)
---------------------
This releases fixes some small bugs around shape transforms.

* fix geojson import/export
* fix bug with geojson reading


0.3.0 (2021-09-22)
-------------------

* add "ome.tiff-bytile" writer to write transformed images tile-by-tile
* unify data reading from tiffs to use `dask`
* numerous improvements, bug fixes, and additional tests

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/nhpatterson/wsireg",
    "name": "wsireg",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "wsireg",
    "author": "Nathan Heath Patterson",
    "author_email": "heath.patterson@vanderbilt.edu",
    "download_url": "https://files.pythonhosted.org/packages/43/1c/5fe3ff8324fe6f7b84ab4f75061f0a824b6f66308d7dcb1a45c6d12ee481/wsireg-0.3.10.tar.gz",
    "platform": null,
    "description": "======\nwsireg\n======\n\n.. image:: https://readthedocs.org/projects/wsireg/badge/?version=latest\n        :target: https://wsireg.readthedocs.io/en/latest/?badge=latest\n        :alt: Documentation Status\n\n\nMulti-modal or mono-modal whole slide image registration in a graph structure for complex registration tasks using `elastix`.\n\n\n* Documentation: https://wsireg.readthedocs.io.\n\n\nFeatures\n--------\n\n* Graph based approach to defining modalities and arbitrary transformation paths between associated images\n* Use of `elastix` (through `ITKElastix <https://github.com/InsightSoftwareConsortium/ITKElastix/>`_) to perform registration\n* Support for linear and non-linear transformation models\n* Transform associated data (masks, shape data) along the same path as the images.\n* Supports images converted to OME-TIFF using `bioformats2raw <https://github.com/glencoesoftware/bioformats2raw>`_ -> `raw2ometiff <https://github.com/glencoesoftware/bioformats2raw>`_ pipeline\n* All registered images exported as pyramidal OME-TIFF or OME-zarr that can be viewed in software such as `Vitessce <https://vitessce.io>`_ , `vizarr <https://github.com/hms-dbmi/vizarr>`_, `QuPath <https://qupath.github.io>`_, `OMERO <https://www.openmicroscopy.org/omero/>`_ or any platform that supports these formats.\n* All transforms for complex registration paths are internally composited and only 1 interpolation step is performed, avoiding accumulation of interpolation error from many registrations\n* Shape data (polygons, point sets, etc.) in GeoJSON format (future portable format for QuPath detection/annotation data) can be imported and transformations applied producing a modified GeoJSON\n* Some support for reading native WSI formats: currently reads .czi and .scn but could be expanded to other formats supported by python package `tifffile`\n\n\n\n=======\nHistory\n=======\n\n0.3.10 (2024-07-04)\n---------------------\nUse headless opencv\n\n0.3.9 (2024-03-10)\n---------------------\nDeprecates unused aicsimageio dependency.\n\n0.3.8 (2023-01-10)\n---------------------\nFix bug that occurs when file paths contain a period.\n\n0.3.7 (2022-04-28)\n---------------------\nAdd support for translation transformation. Fix writing of merge modalities in cmd line configuration.\n\n0.3.6 (2022-04-28)\n---------------------\nFixes bug in wsireg2d console script.\n\n0.3.5 (2022-04-28)\n---------------------\nAdd support for python 3.10 with updated itk-elastix.\n\n0.3.4 (2022-04-27)\n---------------------\nMajor refactor of RegImage class, various small improvements throughout to support napari-wsireg.\n\n\n0.3.2.2 (2022-02-04)\n---------------------\nThis minor update adds the ability to draw binary or label masks using RegShapes.\n\n\n0.3.2.1 (2021-12-28)\n---------------------\nThis releases fixes some small bugs around shape transforms.\n\n* fix geojson import/export\n* fix bug with geojson reading\n\n\n0.3.0 (2021-09-22)\n-------------------\n\n* add \"ome.tiff-bytile\" writer to write transformed images tile-by-tile\n* unify data reading from tiffs to use `dask`\n* numerous improvements, bug fixes, and additional tests\n",
    "bugtrack_url": null,
    "license": "MIT license",
    "summary": "python package for registering multimodal whole slide microscopy images",
    "version": "0.3.10",
    "project_urls": {
        "Homepage": "https://github.com/nhpatterson/wsireg"
    },
    "split_keywords": [
        "wsireg"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f736bc8c91fcde5566b5adec980beb1e4f7f84982eed59cb58d8973651c9a8b9",
                "md5": "fa6307ab213ae58d8a4be59a825bdc49",
                "sha256": "e0e56aab392e8faa09dab698ccd6d8190cec6a3168bd241a78190a7020a9f549"
            },
            "downloads": -1,
            "filename": "wsireg-0.3.10-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fa6307ab213ae58d8a4be59a825bdc49",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.8",
            "size": 79491,
            "upload_time": "2024-07-04T08:54:54",
            "upload_time_iso_8601": "2024-07-04T08:54:54.336553Z",
            "url": "https://files.pythonhosted.org/packages/f7/36/bc8c91fcde5566b5adec980beb1e4f7f84982eed59cb58d8973651c9a8b9/wsireg-0.3.10-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "431c5fe3ff8324fe6f7b84ab4f75061f0a824b6f66308d7dcb1a45c6d12ee481",
                "md5": "6a7beabb42f7b4f593b07cb94c4b5822",
                "sha256": "884b73f75784595351b7aae90e833776f028c5c72d6b04922008c4d69d88a7ea"
            },
            "downloads": -1,
            "filename": "wsireg-0.3.10.tar.gz",
            "has_sig": false,
            "md5_digest": "6a7beabb42f7b4f593b07cb94c4b5822",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 868469,
            "upload_time": "2024-07-04T08:54:55",
            "upload_time_iso_8601": "2024-07-04T08:54:55.618723Z",
            "url": "https://files.pythonhosted.org/packages/43/1c/5fe3ff8324fe6f7b84ab4f75061f0a824b6f66308d7dcb1a45c6d12ee481/wsireg-0.3.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-04 08:54:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nhpatterson",
    "github_project": "wsireg",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "wsireg"
}
        
Elapsed time: 1.47360s