ResampleStep

class romancal.resample.ResampleStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source]

Bases: RomanStep

Resample input data onto a regular grid using the drizzle algorithm.

Note

When supplied via output_wcs, a custom WCS overrides other custom WCS parameters such as output_shape (now computed from by output_wcs.bounding_box), crpix

Parameters:

input (str, roman_datamodels.datamodels.DataModel, or ModelLibrary) – If a string is provided, it should correspond to either a single ASDF filename or an association filename. Alternatively, a single DataModel instance can be provided instead of an ASDF filename. Multiple files can be processed via either an association file or wrapped by a ModelLibrary.

Returns:

A mosaic datamodel with the final output frame.

Return type:

roman_datamodels.datamodels.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 = 'resample'
reference_file_types: ClassVar = []
spec
pixfrac = float(default=1.0)
kernel = string(default='square')
fillval = string(default='NAN' )
weight_type = option('ivm', 'exptime', 'ivm-sky', None, default='ivm')
output_shape = int_list(min=2, max=2, default=None)  # [x, y] order
crpix = float_list(min=2, max=2, default=None)
crval = float_list(min=2, max=2, default=None)
rotation = float(default=None)  # Position angle of +y axis in degrees
pixel_scale_ratio = float(default=1.0) # Ratio of output to input pixel scale
pixel_scale = float(default=None) # Absolute pixel scale in arcsec
output_wcs = string(default='')  # Custom output WCS.
resample_on_skycell = boolean(default=True)  # if association contains skycell information use it for the wcs
in_memory = boolean(default=True)
good_bits = string(default='~DO_NOT_USE+NON_SCIENCE')  # The good bits to use for building the resampling mask.
include_var_flat = boolean(default=False)  # include var_flat in output image

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.