HighParticleFluxRegion

class gdt.missions.gifts.region.HighParticleFluxRegion

Bases: SouthAtlanticAnomaly

A base class for a high particle flux region boundary in Earth latitude and longitude. This is required as the core class assumes that only the SAA will be encountered by a mission.

The boundary will be loaded from the region file for the specified altitude (region name and altitude are defined in subclasses)

Attributes Summary

latitude	The latitude points of the boundary
longitude	The longitude points of the boundary
num_points	Number of vertices in polygon

Methods Summary

is_closed()	Test if the boundary represents a closed polygon.
is_convex()	Test if the boundary represents a convex polygon.

Attributes Documentation

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)

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)