ImageSet

class ImageSet

Class representing a set of images.

A container for managing and processing a list of ScienceImage or ReferenceImage objects.

This class provides an interface to store a set of images and efficiently extract, filter, and manipulate background maps, source masks, and catalogs in parallel using multiprocessing.

It supports image selection and exclusion based on header metadata such as filter, exposure time, observation date, seeing, depth, telescope, and observatory information.

Parameters:

images (List[ScienceImage] or List[ReferenceImage]) – List of images to be included in the set.

__init__(images=None)

Methods

exclude_images(self, file_key=None, filter=None, exptime=None, objname=None, obs_start=None, obs_end=None, seeing=None, depth=None, observatory=None, telname=None)

Exclude images based on given criteria.

One can access selected images via .target_images attribute.

Parameters:

• file_key (str or list of str) – File key to exclude images.

• filter (str or list of str) – Filter to exclude images.

• exptime (float or list of float) – Exposure time to exclude images.

• objname (str or list of str) – Object name to exclude images.

• obs_start (str or list of str) – Observation start time to exclude images.

• obs_end (str or list of str) – Observation end time to exclude images.

• seeing (float or list of float) – Seeing to exclude images.

• depth (float or list of float) – Depth to exclude images.

• observatory (str or list of str) – Observatory to exclude images.

• telname (str or list of str) – Telescope name to exclude images.

Return type:

None

select_images(self, file_key=None, filter=None, exptime=None, objname=None, obs_start=None, obs_end=None, seeing=None, depth=None, observatory=None, telname=None)

Select images based on given criteria.

One can access selected images via .target_images attribute.

Parameters:

• file_key (str or list of str) – File key to select images.

• filter (str or list of str) – Filter to select images.

• exptime (float or list of float) – Exposure time to select images.

• objname (str or list of str) – Object name to select images.e

• obs_start (str or list of str) – Observation start time to select images.

• obs_end (str or list of str) – Observation end time to select images.

• seeing (float or list of float) – Seeing to select images.

• depth (float or list of float) – Depth to select images.

• observatory (str or list of str) – Observatory to select images.

• telname (str or list of str) – Telescope name to select images.

Return type:

None

clear(self)

Clear the image set.

run_ds9(self)

Run DS9 on the image set. :param None:

Return type:

None

Properties

Key Properties

Property	Description
bkgmap	Background map of the image set.
bkgrms	Background RMS map of the image set.
catalog	Source catalog of the image set.
df	Pandas DataFrame of the image set.
refcatalog	Reference catalog of the image set.
sourcemask	Source mask of the image set.
target_df	Target DataFrame of the image set.