acdc.database.within_saa

Functions

saaFilter

Flag within the specified SAA contour as bad.

testWithinSAA

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

toRect

Convert longitude and latitude to rectangular coordinates.

saaFilter(longitude_col, latitude_col, model=[(-28.3, 14.0), (-27.5, 15.0), (-26.1, 13.0), (-19.8, 1.5), (-9.6, 341.0), (-7.6, 330.4), (-6.0, 318.8), (-7.9, 297.2), (-12.0, 286.1), (-17.1, 279.9), (-20.3, 277.5), (-23.5, 276.5), (-26.0, 276.4), (-28.6, 276.7)])[source]

Flag within the specified SAA contour as bad.

Parameters:

model (int) – The SAA model number. Currently these range from 2 to 32 inclusive. (Models 0 and 1 are radio frequence interference contours.)

Returns:

flag (array_like) – This is a boolean array, one element for each row of the TIMELINE table. True means that HST was within the SAA contour (specified by model) at the time corresponding to the TIMELINE row.

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.

toRect(longitude, latitude)[source]

Convert longitude and latitude to rectangular coordinates.

Parameters:
  • longitude (float) – longitude in degrees.

  • latitude (float) – latitude in degrees.

Returns:

rect (array-like) – Unit vector in rectangular coordinates.