contains_full_disk

sunpy.map.contains_full_disk(smap)[source] [edit on github]

Checks if a map contains the full disk of the Sun.

A map contains the full disk of the Sun if the following two conditions are met: (1) all the coordinates at the edge of the map are more than solar angular radius from the center of the Sun and, (2) the map is not all off disk. If both these conditions are met, the function returns True. Otherwise, the function returns False.

Parameters

smap (GenericMap) – A map in helioprojective Cartesian coordinates.

Returns

bool

Returns False if any of the coordinates at the edge of the map

are less than one solar radius away from the center of the Sun.

Notes

This function checks if the image coordinates include the solar disk. Therefore this function would return True for a coronagraph image such as from LASCO/C3 or STEREO/SECCHI COR1 since the solar disk is within the field of the view of the instrument (although no emission from the disk itself is present in the data.)