is_all_on_disk

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

Checks if all 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 less 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 coordinates have an angular radius less than the angular radius of the Sun.