Skip to main content

A package to handle the spherical polygon

Project description

Welcome to the SphericalPolygon package

PyPI version shields.io PyPI pyversions PyPI status GitHub contributors Maintenance GitHub license Documentation Status

The SphericalPolygon package is an archive of scientific routines for handling spherical polygons. Currently, operations on spherical polygons include:

  1. calculate the area or mass(if the area density is given)
  2. calculate the perimeter
  3. identify the centroid
  4. compute the geometrical or physical moment of inertia tensor
  5. determine whether one or multiple points are inside the spherical polygon

How to Install

On Linux, macOS and Windows architectures, the binary wheels can be installed using pip by executing one of the following commands:

pip install sphericalpolygon
pip install sphericalpolygon --upgrade # to upgrade a pre-existing installation

How to use

Create a spherical polygon

Spherical polygons can be created from a 2d array in form of [[lat_0,lon_0],..,[lat_n,lon_n]] with unit of degrees, or from a boundary file, such as those in Plate boundaries for NNR-MORVEL56 model. The spherical polygon accepts a latitude range of [-90,90] and a longitude range of [-180,180] or [0,360].

from sphericalpolygon import Sphericalpolygon
# build a spherical polygon for Antarctica Plate
polygon = Sphericalpolygon.from_file('NnrMRVL_PltBndsLatLon/an',skiprows=1) 
print(polygon.orientation)
Counterclockwise

Calculate the area

Calculate the area(or the solid angle) of a spherical polygon over a unit sphere.

print(polygon.area())
1.4326235943514618

Calculate the area of the spherical polygon over the Earth with an averaged radius of 6371km.

print(polygon.area(6371), ' km2')
58149677.38285546  km2

Calculate the mass of the spherical polygon shell with a thickness of 100km and density of 3.1g/cm3 over the Earth with an averaged radius of 6371km.

print(polygon.area(6371,100*3.1), ' Gt')
18026399988.685192  Gt

Calculate the perimeter

Calculate the perimeter of a spherical polygon over a unit sphere.

print(polygon.perimeter())
6.322665894174733

Calculate the perimeter of a spherical polygon over the Earth with an averaged radius of 6371km.

print(polygon.perimeter(6371), ' km')
40281.70441178723  km

Identify the centroid

Identify the centroid of a spherical polygon over a unit sphere.

print(polygon.centroid())
[-83.61081032380656, 57.80052886741483, 0.13827778179537997]

Identify the centroid of a spherical polygon over the Earth with an averaged radius of 6371km.

print(polygon.centroid(6371),' deg deg km')
[-83.61081032380656, 57.80052886741483, 880.9677478183658]  deg deg km

It shows that the latitude of the centroid is close to the South Pole, and the centroid is located about 881km underground.

Compute the moment of inertia tensor

Compute the geometrical moment of inertia tensor of a spherical polygon over a unit sphere. The tensor is symmetrical and has six independent components. The first three components are located diagonally, corresponding to $Q_{11}$, $Q_{22}$, and $Q_{33}$; the last three components correspond to $Q_{12}$, $Q_{13}$, and $Q_{23}$.

print(polygon.inertia())
[ 1.32669154  1.17471081  0.36384484 -0.05095381  0.05246122  0.08126929]

Compute the physical moment of inertia tensor of the spherical polygon shell with a thickness of 100km and density of 3.1g/cm3 over the Earth with an averaged radius of 6371km.

print(polygon.inertia(6371,100*3.1)/1e12, ' Gt·Gm2')
[677582.33535848 599961.08075046 185826.79201142 -26023.68204226
  26793.56591716  41506.73569238]  Gt·Gm2

Points are inside a polygon?

Determine if a single point or multiple points are inside a given spherical polygon.

single point

print(polygon.contains_points([75,152]))
False

multiple points

print(polygon.contains_points([[-85,130],[35,70]]))
[True, False]

Change log

  • 1.2.1 — Feb 23, 2021
    • Replace the function create_polygon for building a spherical polygon object from a 2d array with methods from_array and from_file.
  • 1.2.0 — Mar 20, 2020
    • Add the perimeter() method that may calculate the perimeter of a spherical polygon.
    • Add the centroid() method that may determaine the centroid location for a spherical polygon.

Reference

Chunxiao, Li. "Inertia Tensor for MORVEL Tectonic Plates." ASTRONOMICAL RESEARCH AND TECHNOLOGY 13.1 (2016).

Project details


Download files

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

Files for sphericalpolygon, version 1.2.1
Filename, size File type Python version Upload date Hashes
Filename, size sphericalpolygon-1.2.1-py3-none-any.whl (13.3 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page