is_all_off_disk

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

Checks if none of the coordinates in the GenericMap are on the solar disk.

The check is performed by calculating the angle of every pixel from the center of the Sun. If they are all greater than the angular radius of the Sun, then the function returns True. Otherwise, the function returns False.

Parameters

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

Returns

bool – Returns True if all map pixels have an angular radius greater than the angular radius of the Sun.

Notes

For coronagraph images such as those from LASCO C2 and C3 the full disk is within the field of view of the instrument, but the solar disk itself is not imaged. For such images this function will return False.