fastlbp-baseline-imbg


Namefastlbp-baseline-imbg JSON
Version 0.0.7 PyPI version JSON
download
home_page
SummaryA wrapper for Ben's LBP bio pipeline
upload_time2023-10-26 22:43:01
maintainer
docs_urlNone
author
requires_python>=3.8
license
keywords lbp texture features image
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ImageTextureFinder
A project to create an easy-to-use way of finding areas of common patterns and structures within an image. Should work on any image, designed for use on any biological images including DAPI, IMC and H&E.

See `sample_run.sh` for details.

- Branch `baseline` is the most stable. It is ready for pip packaging.
- Branch `pip` is stale at the moment
- Branch `dev` is unstable and for dev purposes only.


## Container
Image tag is `mkrooted/imbg-fastlbp`. Hosted on Docker Hub (https://hub.docker.com/repository/docker/mkrooted/imbg-fastlbp/general).
See https://github.com/imbg-ua/fastLBP-sandbox for details

---

# Guides

## How to build and deploy a pip package

Src: https://packaging.python.org/en/latest/tutorials/packaging-projects/

- Add your access token to `.pypirc`
    ```
    # ~/.pypirc 
    [pypi]
      username = __token__
      password = pypi-TOKEN_FROM_YOUR_PYPI_SETTINGS_GOES_HERE
    ```
- Ensure that your Python is 3.8 because the package targets Python 3.8 and thus requires to be build using this Python version
    ```
    python --version
    # Should show Python 3.8.something
    ```
- Install prerequisites (`twine` and `build`)
    ```
    pip install --upgrade twine build
    ```
- Edit project version in `pyproject.toml`
- Build and upload the project
    ```
    # while in root project directory
    python -m build      # .whl and .gz output will be at ./dist directory
    python3 -m twine upload dist/*   # note that this can accidentally upload unneeded builds
    ```

---

## Algorithm notes

Step 1 performs an LBP and creates histograms for each **method**.

**Method** is a combination of the following parameters:
- image name
- image channel
- LBP radius
- LBP number of points

Every method's result got saved into the separate `.npy` file. There is a correspondence betweeen a method and a computational job.

Step 2 collects all the results and concatenate them along the features dimension.
That means that feature vector of a patch is a concatenation of all LBP codes from all channels and all LBP radii. 


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "fastlbp-baseline-imbg",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "lbp,texture,features,image",
    "author": "",
    "author_email": "Mykhailo Koreshkov <koreshov.m@gmail.com>, Ben Woodhams <benwoodhams@outlook.com>",
    "download_url": "https://files.pythonhosted.org/packages/32/15/e47958d53297a9a695018573a120a5552c906f4a485542915bcc1ba08a96/fastlbp-baseline-imbg-0.0.7.tar.gz",
    "platform": null,
    "description": "# ImageTextureFinder\r\nA project to create an easy-to-use way of finding areas of common patterns and structures within an image. Should work on any image, designed for use on any biological images including DAPI, IMC and H&E.\r\n\r\nSee `sample_run.sh` for details.\r\n\r\n- Branch `baseline` is the most stable. It is ready for pip packaging.\r\n- Branch `pip` is stale at the moment\r\n- Branch `dev` is unstable and for dev purposes only.\r\n\r\n\r\n## Container\r\nImage tag is `mkrooted/imbg-fastlbp`. Hosted on Docker Hub (https://hub.docker.com/repository/docker/mkrooted/imbg-fastlbp/general).\r\nSee https://github.com/imbg-ua/fastLBP-sandbox for details\r\n\r\n---\r\n\r\n# Guides\r\n\r\n## How to build and deploy a pip package\r\n\r\nSrc: https://packaging.python.org/en/latest/tutorials/packaging-projects/\r\n\r\n- Add your access token to `.pypirc`\r\n    ```\r\n    # ~/.pypirc \r\n    [pypi]\r\n      username = __token__\r\n      password = pypi-TOKEN_FROM_YOUR_PYPI_SETTINGS_GOES_HERE\r\n    ```\r\n- Ensure that your Python is 3.8 because the package targets Python 3.8 and thus requires to be build using this Python version\r\n    ```\r\n    python --version\r\n    # Should show Python 3.8.something\r\n    ```\r\n- Install prerequisites (`twine` and `build`)\r\n    ```\r\n    pip install --upgrade twine build\r\n    ```\r\n- Edit project version in `pyproject.toml`\r\n- Build and upload the project\r\n    ```\r\n    # while in root project directory\r\n    python -m build      # .whl and .gz output will be at ./dist directory\r\n    python3 -m twine upload dist/*   # note that this can accidentally upload unneeded builds\r\n    ```\r\n\r\n---\r\n\r\n## Algorithm notes\r\n\r\nStep 1 performs an LBP and creates histograms for each **method**.\r\n\r\n**Method** is a combination of the following parameters:\r\n- image name\r\n- image channel\r\n- LBP radius\r\n- LBP number of points\r\n\r\nEvery method's result got saved into the separate `.npy` file. There is a correspondence betweeen a method and a computational job.\r\n\r\nStep 2 collects all the results and concatenate them along the features dimension.\r\nThat means that feature vector of a patch is a concatenation of all LBP codes from all channels and all LBP radii. \r\n\r\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A wrapper for Ben's LBP bio pipeline",
    "version": "0.0.7",
    "project_urls": {
        "Bug Tracker": "https://github.com/imbg-ua/ImageTextureFinder/issues",
        "Homepage": "https://github.com/imbg-ua/ImageTextureFinder"
    },
    "split_keywords": [
        "lbp",
        "texture",
        "features",
        "image"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "437bd66ab0ab4e972b54a0629335e0a219d0a783bea9a79179aae27a2cc11bb9",
                "md5": "53a4cdd0ab95e3b4c0388b06c5d7695e",
                "sha256": "4b071860d1103d819ede07d8a4003a05274f92e7ffa1d6384bda58c5ed07e9db"
            },
            "downloads": -1,
            "filename": "fastlbp_baseline_imbg-0.0.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "53a4cdd0ab95e3b4c0388b06c5d7695e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 37253,
            "upload_time": "2023-10-26T22:42:59",
            "upload_time_iso_8601": "2023-10-26T22:42:59.553246Z",
            "url": "https://files.pythonhosted.org/packages/43/7b/d66ab0ab4e972b54a0629335e0a219d0a783bea9a79179aae27a2cc11bb9/fastlbp_baseline_imbg-0.0.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3215e47958d53297a9a695018573a120a5552c906f4a485542915bcc1ba08a96",
                "md5": "d9ac11aff659a293bdfea047b95df261",
                "sha256": "3d24ee802e4b8a7073fe7b9e9cc7fe19f2d5e1c32d1cc081733fbc204aa9ada1"
            },
            "downloads": -1,
            "filename": "fastlbp-baseline-imbg-0.0.7.tar.gz",
            "has_sig": false,
            "md5_digest": "d9ac11aff659a293bdfea047b95df261",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 35153,
            "upload_time": "2023-10-26T22:43:01",
            "upload_time_iso_8601": "2023-10-26T22:43:01.311075Z",
            "url": "https://files.pythonhosted.org/packages/32/15/e47958d53297a9a695018573a120a5552c906f4a485542915bcc1ba08a96/fastlbp-baseline-imbg-0.0.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-26 22:43:01",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "imbg-ua",
    "github_project": "ImageTextureFinder",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "fastlbp-baseline-imbg"
}
        
Elapsed time: 0.13044s