Cutout

class sunpy.net.jsoc.attrs.Cutout(

bottom_left,

top_right=None,

width=None,

height=None,

tracking=False,

register=False,

nan_off_limb=False,

)

Bases: DataAttr

Select a cutout region.

The JSOC allows for users to request cutouts. This process is performed server side so as to allow users to download only the portions of the full-disk images they are interested in. For a detailed explanation of the routine used to perform these cutouts on the JSOC server, see http://jsoc.stanford.edu/doxygen_html/group__im__patch.html.

Parameters:

• bottom_left (SkyCoord) – Helioprojective coordinate for the bottom left corner of the cutout.

• top_right (SkyCoord, optional) – Coordinate for the top right corner of the cutout. If this is not specified, both width and height must both be specified.

• width (Quantity, optional) – Width of the cutout. If this parameter, along with height, is not specified, top_right must be specified.

• height (Quantity, optional) – Height of the cutout. If this parameter, along with width, is not specified, top_right must be specified.

• tracking (bool, optional) – If True, the field of view follows the rotation of the Sun

• register (bool, optional) – If True, use sub-pixel registration when cropping to the target location.

• nan_off_limb (bool, optional) – If True, all off-limb pixels are set to NaN

See also

sunpy.coordinates.utils.get_rectangle_coordinates

Notes

The bottom_left coordinate must be in the Helioprojective frame. The observer frame attribute of bottom_left is ignored, and instead the observer location is assumed to be SDO.

If tracking is True, the center of the cutout is required to be on the solar disk, otherwise the JSOC will produce unexpected output.

Methods Summary

collides(other)

Methods Documentation

collides(other)