acdc.database.within_saa.testWithinSAA

testWithinSAA(hst, vertices, middle_SAA)[source]

Test whether HST is within the polygon for an SAA contour.

Parameters:

  • hst (array_like) – Unit vector pointing from the center of the Earth toward the location of HST at a particular time.

  • vertices (array_like, shape (nvertices,3)) – vertices[i] is a unit vector from the center of the Earth toward vertex number i of a polygon that defines one of the SAA contour.

  • middle_SAA (array_like) – Unit vector from the center of the Earth toward a point near the middle of the SAA region. This is for making a quick check that hst is close enough to the SAA contour to be worth making a detailed check.

Returns:

bool – True if hst is within the SAA contour defined by vertices.