SourceCatalogStep

class jwst.source_catalog.SourceCatalogStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source]

Bases: JwstStep

Create a final catalog of source photometry and morphologies.

Parameters:

input (str or ImageModel) – A FITS filename or an ImageModel of a drizzled image.

Create a Step instance.

Parameters:

  • name (str, optional) – The name of the Step instance. Used in logging messages and in cache filenames. If not provided, one will be generated based on the class name.

  • parent (Step instance, optional) – The parent step of this step. Used to determine a fully-qualified name for this step, and to determine the mode in which to run this step.

  • config_file (str path, optional) – The path to the config file that this step was initialized with. Use to determine relative path names of other config files.

  • **kws (dict) – Additional parameters to set. These will be set as member variables on the new Step instance.

Attributes Summary

class_alias

reference_file_types

spec

Methods Summary

process(input_model)

This is where real work happens.

Attributes Documentation

class_alias = 'source_catalog'
reference_file_types = ['apcorr', 'abvegaoffset']
spec
bkg_boxsize = integer(default=1000)   # background mesh box size in pixels
kernel_fwhm = float(default=2.0)      # Gaussian kernel FWHM in pixels
snr_threshold = float(default=3.0)    # SNR threshold above the bkg
npixels = integer(default=25)         # min number of pixels in source
deblend = boolean(default=False)      # deblend sources?
aperture_ee1 = integer(default=30)    # aperture encircled energy 1
aperture_ee2 = integer(default=50)    # aperture encircled energy 2
aperture_ee3 = integer(default=70)    # aperture encircled energy 3
ci1_star_threshold = float(default=2.0)  # CI 1 star threshold
ci2_star_threshold = float(default=1.8)  # CI 2 star threshold
suffix = string(default='cat')        # Default suffix for output files

Methods Documentation

process(input_model)[source]

This is where real work happens. Every Step subclass has to override this method. The default behaviour is to raise a NotImplementedError exception.