is_all_off_disk#
- sunpy.map.is_all_off_disk(smap)[source]#
Checks if none of the coordinates in the
GenericMap
are on the solar disk.This is done by checking if the edges of the map are all beyond the solar limb, and checking that the solar center is not in the map.
- Parameters:
smap (
GenericMap
) – A map in helioprojective Cartesian coordinates.- Returns:
bool
– ReturnsTrue
if the map does not contain any part of the disk of the Sun, otherwiseFalse
.
Notes
For coronagraph images such as those from LASCO C2 and C3 the full disk is within the field of view of the instrument, even though the solar disk itself is not imaged. For such images this function will return
False
.