JumpStep

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

Bases: RomanStep

JumpStep: Performs CR/jump detection. The 2-point difference method is applied.

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

reference_file_types

spec

Methods Summary

process(input)

This is where real work happens.

Attributes Documentation

reference_file_types = ['gain', 'readnoise']
spec
rejection_threshold = float(default=180.0,min=0) # CR sigma rej thresh
three_group_rejection_threshold = float(default=185.0,min=0) # CR sigma rej thresh
four_group_rejection_threshold = float(default=190.0,min=0) # CR sigma rej thresh
maximum_cores = option('none', 'quarter', 'half', 'all', default='none') # max number of processes to create
flag_4_neighbors = boolean(default=True) # flag the four perpendicular neighbors of each CR
max_jump_to_flag_neighbors = float(default=1000) # maximum jump sigma that will trigger neighbor flagging
min_jump_to_flag_neighbors = float(default=10) # minimum jump sigma that will trigger neighbor flagging
min_sat_area = float(default=1.0) # minimum required area for the central saturation of snowballs
min_jump_area = float(default=5.0) # minimum area to trigger large events processing
expand_factor = float(default=2.0) # The expansion factor for the enclosing circles or ellipses
use_ellipses = boolean(default=False) # Use an enclosing ellipse rather than a circle for MIRI showers
sat_required_snowball = boolean(default=True) # Require the center of snowballs to be saturated
expand_large_events = boolean(default=False) # must be True to trigger snowball and shower flagging
use_ramp_jump_detection = boolean(default=True) # Use jump detection during ramp fitting

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.