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 ModelContainer) – 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 ModelContainer.
Returns:: A mosaic datamodel with the final output frame.
Return type:: roman_datamodels.datamodels.MosaicModel

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)	This is where real work happens.
`set_drizzle_defaults`()	Set the default parameters for drizzle.
`update_phot_keywords`(model)	Update pixel scale keywords

Attributes Documentation

class_alias = 'resample'¶

reference_file_types = []¶

spec¶

pixfrac = float(default=1.0) # change back to None when drizpar reference files are updated
kernel = string(default='square') # change back to None when drizpar reference files are updated
fillval = string(default='INDEF' ) # change back to None when drizpar reference files are updated
weight_type = option('ivm', 'exptime', None, default='ivm')  # change back to None when drizpar ref update
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)
pixel_scale_ratio = float(default=1.0) # Ratio of input to output pixel scale
pixel_scale = float(default=None) # Absolute pixel scale in arcsec
output_wcs = string(default='')  # Custom output WCS.
single = boolean(default=False)
blendheaders = boolean(default=True)
allowed_memory = float(default=None)  # Fraction of memory to use for the combined image.
in_memory = boolean(default=True)

Methods Documentation

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

set_drizzle_defaults()[source]¶: Set the default parameters for drizzle.

update_phot_keywords(model)[source]¶: Update pixel scale keywords