Image

class prose.Image

Image object containing image data and metadata.

This is a Python Data Class, so that most attributes described below can be used as keyword-arguments when instantiated.

Methods

__init__([data, metadata, catalogs, ...])
asdict([image_dtype, low_data])
copy([data])	Copy of image object
cutout(coords, shape[, wcs, sources, ...])	Return a cutout Image instance.
data_cutouts(sources, shape)	Extract cutouts from image.
get(name)	Get computed value
load(filepath)	Load an image from a file.
plot_catalog(name[, color, label, n])	Plot catalog stars
plot_model(data[, figsize, cmap, c, contour])	Plot the data and a model side by side.
save(filepath[, image_dtype, low_data])	Save the image to a file using pickle.
set(name, value)	Set a computed value
show([cmap, ax, figsize, zscale, frame, ...])	Show image data
writeto(destination)	Write image to FITS file

Attributes

catalogs	Catalogs associated with the image contained in a dictionary of pandas dataframes
computed	A dictionary containing any user and block-defined attributes
data	Image data
date	datetime of the observation
dec	Declination as an astropy Quantity
discard	Whether image as been discarded by a block
exposure	Exposure time as an astropy Quantity
filter	Filter name
fits_header	Same as header (backward compatibility)
fov	RA-DEC field of view of the image in degrees
gain	Gain of the camera
header	FITS header associated with the image (optional)
jd	Julian Date of the observation
label	A conveniant {Telescope}_{Date}_{Object}_{Filter} string
metadata	Image metadata
night_date	date of the night when night started.
origin	Image origin
pixel_scale	Pixel scale (or plate scale) as an astropy Quantity
plate_solved	Return whether the image is plate solved.
ra	Right-Ascension as an astropy Quantity
read_noise	Read noise of the camera
shape	Image.data shape
skycoord	Astropy SkyCoord object based on header RAn, DEC.
sources	Image sources.
wcs	astropy.wcs.WCS object associated with the FITS Image.header.