Cutout#
- class sunpy.net.jsoc.attrs.Cutout(bottom_left, top_right=None, width: Unit('arcsec') = None, height: Unit('arcsec') = None, tracking=False, register=False, nan_off_limb=False)[source]#
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
) – 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, bothwidth
andheight
must both be specified.width (
Quantity
, optional) – Width of the cutout. If this parameter, along withheight
, is not specified,top_right
must be specified.height (
Quantity
, optional) – Height of the cutout. If this parameter, along withwidth
, is not specified,top_right
must be specified.tracking (
bool
, optional) – If True, the field of view follows the rotation of the Sunregister (
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
Methods Summary
collides
(other)Methods Documentation