SourceCatalogStep

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

Bases: RomanStep

Create a catalog of sources including photometry and basic shape measurements.

Parameters:: input (str, ImageModel, or MosaicModel) – Path to an ASDF file, or an ImageModel or MosaicModel.

Create a Step instance.

Parameters:

name (str) – 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) – 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 or pathlib.Path) – The path to the config file that this step was initialized with. Use to determine relative path names of other config files.
_validate_kwds (bool) – Validate given kws against specs/config.
**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(dataset)

This is where real work happens.

Attributes Documentation

class_alias = 'source_catalog'

reference_file_types: ClassVar = ['apcorr']

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)    # per-pixel SNR threshold above the bkg
npixels = integer(default=25)         # min number of pixels in source
deblend = boolean(default=False)      # deblend sources?
suffix = string(default='cat')        # Default suffix for output files
fit_psf = boolean(default=True)       # fit source PSFs for accurate astrometry?
forced_segmentation = string(default='')  # force the use of this segmentation map

Methods Documentation

process(dataset)[source]: This is where real work happens. Every Step subclass has to override this method. The default behaviour is to raise a NotImplementedError exception.