pywoc


Namepywoc JSON
Version 0.2.0 PyPI version JSON
download
home_pagehttps://github.com/csabiu/woc
Summary2-D comparison
upload_time2022-12-07 08:38:58
maintainer
docs_urlNone
authorCristiano Sabiu
requires_python
licenseGNU GPL v3 License
keywords woc spatial statistics statistics python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            WOC - Weighted Overlap Coefficient

Python code to calculate the weighted overlap coefficient between
2 fields while considering masking.

Please cite J. Yoo et.al., (ApJS, Vol 261, Issue 2, 2022)
arXiv:2205.08161

Install
-------

python -m pip install git+https://github.com/csabiu/WOC.git

or

pip install pywoc

Running
-------

from pywoc import woc

woc(map1,map2,radii, mask=mask)

- map1 is the 2D array of pixel values

- map2 should be same shape as map1

- radii is the array of radius values used to select the contours from map1 eg [100,200,300] in pixel units

- optional: mask is the array used to mask both maps (0=masked, 1=unmasked)

revision history
----------------

0.0.1
initial code release

0.1.0
added python notebook tutorial under /nb
improved documentation

0.2.0
added a dynamic calculation of radial profile
fixed some installation problems

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/csabiu/woc",
    "name": "pywoc",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "woc,spatial statistics,statistics,python",
    "author": "Cristiano Sabiu",
    "author_email": "csabiu@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/9f/df/33942c60020c0202af72bc3de40aef343e8cc640cb1cd8af2419d839111e/pywoc-0.2.0.tar.gz",
    "platform": null,
    "description": "WOC - Weighted Overlap Coefficient\n\nPython code to calculate the weighted overlap coefficient between\n2 fields while considering masking.\n\nPlease cite J. Yoo et.al., (ApJS, Vol 261, Issue 2, 2022)\narXiv:2205.08161\n\nInstall\n-------\n\npython -m pip install git+https://github.com/csabiu/WOC.git\n\nor\n\npip install pywoc\n\nRunning\n-------\n\nfrom pywoc import woc\n\nwoc(map1,map2,radii, mask=mask)\n\n- map1 is the 2D array of pixel values\n\n- map2 should be same shape as map1\n\n- radii is the array of radius values used to select the contours from map1 eg [100,200,300] in pixel units\n\n- optional: mask is the array used to mask both maps (0=masked, 1=unmasked)\n\nrevision history\n----------------\n\n0.0.1\ninitial code release\n\n0.1.0\nadded python notebook tutorial under /nb\nimproved documentation\n\n0.2.0\nadded a dynamic calculation of radial profile\nfixed some installation problems\n",
    "bugtrack_url": null,
    "license": "GNU GPL v3 License",
    "summary": "2-D comparison",
    "version": "0.2.0",
    "split_keywords": [
        "woc",
        "spatial statistics",
        "statistics",
        "python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "c0271bbefaf320e15e95378bebcb4ab3",
                "sha256": "568e9ba5d204365adb2b66801ec396cf5956902d27171fb2977796b6d0233f5d"
            },
            "downloads": -1,
            "filename": "pywoc-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c0271bbefaf320e15e95378bebcb4ab3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 16055,
            "upload_time": "2022-12-07T08:38:58",
            "upload_time_iso_8601": "2022-12-07T08:38:58.204363Z",
            "url": "https://files.pythonhosted.org/packages/9f/df/33942c60020c0202af72bc3de40aef343e8cc640cb1cd8af2419d839111e/pywoc-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-07 08:38:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "csabiu",
    "github_project": "woc",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "pywoc"
}
        
Elapsed time: 0.01423s