simple manipulation and display of spatial regions in python
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
pngs
regional
tests
.gitignore
.travis.yml
LICENSE
MANIFEST.in
README.md
example.ipynb
requirements.txt
setup.cfg
setup.py

README.md

regional

Latest Version Build Status

manipulation and display of spatial regions in python

This package makes it easy to display spatial regions, and is useful when working with geometries, maps, feature extraction, or other spatial analyses. Designed to be small and light-weight, built on numpy and scipy, and composes with other modules for image analysis and display.

install

pip install regional

example

from regional import one

region = one([[0, 0], [0, 1], [1, 0], [1, 1]])

region.bbox
>> [0, 0, 1, 1]

region.center
>> [0.5, 0.5]

see the included notebook for a longer example

usage

region = one(coords)

constructs a single region

  • coords
    • list of coordinates [[x, y], [x, y], ...]

many

regions = many(list)

  • list :
    • list of regions [region, region, ...] or
    • list of lists of coordinates [[[x, y], [x, y], ...], [[x, y], [x, y], ...], ...]

many

one region and many regions have the same attributes and methods, the only difference is that in the case of many regions they are just evaluated once per region

attributes

region.hull

convex hull

region.bbox

rectangular bounding box

region.center

euclidean center

region.extent

total region extent

methods

region.distance(other)

distance to other region

region.merge(other)

merge with other region

region.exclude(other)

exclude other region

region.overlap(other, method)

compute overlap with other region

region.crop(min, max)

crop region to bounds

region.inbounds(min, max)

check whether region falls completely within bounds

region.dilate(size)

dilate region

region.outline(inner, outer)

compute region outline

region.mask(dims, base, fill, stroke, background, value, cmap)

generate image with regions as colored masks (value and cmap only for multiple regions)