GiftsSouthRegion300

class gdt.missions.gifts.region.GiftsSouthRegion300(region: str = 'south', altitude: int = 300)[source]

Bases: HighParticleFluxRegion

Attributes Summary

altitude

latitude

The latitude points of the boundary

longitude

The longitude points of the boundary

num_points

Number of vertices in polygon

region

Methods Summary

is_closed()

Test if the boundary represents a closed polygon.

is_convex()

Test if the boundary represents a convex polygon.

Attributes Documentation

altitude: int = 300
latitude

The latitude points of the boundary

Type:

(np.array)

longitude

The longitude points of the boundary

Type:

(np.array)

num_points

Number of vertices in polygon

Type:

(int)

region: str = 'south'

Methods Documentation

is_closed()

Test if the boundary represents a closed polygon. A closed polygon is one where the first and last points are equal.

Returns:

(bool)

is_convex()

Test if the boundary represents a convex polygon. The test is performed by measuring every interior angle of the polygon and checking if all angles are < 180 deg. The definition of a convex polygon is one where all interior angles are < 180 deg.

Returns:

(bool)