CubeBuildStep¶
-
class
jwst.cube_build.
CubeBuildStep
(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source]¶ Bases:
jwst.stpipe.Step
CubeBuildStep: Creates a 3-D spectral cube from a given association, single model, single input file, or model container. Input parameters allow the spectral cube to be built from a provided channel/subchannel (MIRI) or grating/filer (NIRSPEC)
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.
- **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. read_user_input
()Short Summary Attributes Documentation
-
reference_file_types
= ['cubepar', 'resol']¶
-
spec
= "\n channel = option('1','2','3','4','all',default='all') # Options: 1,2,3,4, or all\n band = option('short','medium','long','all',default='all') # Options: short, medium, long, all\n grating = option('prism','g140m','g140h','g235m','g235h',g395m','g395h','all',default='all') # Options: prism,g140m,g140h,g235m,g235h,g395m,g395h, or all\n filter = option('clear','f100lp','f070lp','g170lp','f290lp','all',default='all') # Options: clear,f100lp,f070lp,g170lp,f290lp, or all\n scale1 = float(default=0.0) # cube sample size to use for axis 1, arc seconds\n scale2 = float(default=0.0) # cube sample size to use for axis 2, arc seconds\n scalew = float(default=0.0) # cube sample size to use for axis 3, microns\n weighting = option('msm','miripsf','area',default = 'msm') # Type of weighting function\n coord_system = option('world','alpha-beta',default='world') # Output Coordinate system. Options: world or alpha-beta\n rois = float(default=0.0) # region of interest spatial size, arc seconds\n roiw = float(default=0.0) # region of interest wavelength size, microns\n weight_power = float(default=2.0) # Weighting option to use for Modified Shepard Method\n wavemin = float(default=None) # Minimum wavelength to be used in the IFUCube\n wavemax = float(default=None) # Maximum wavelength to be used in the IFUCube\n single = boolean(default=false) # Internal pipeline option used by mrs_imatch and outlier detection\n xdebug = integer(default=None) # debug option, x spaxel value to report information on\n ydebug = integer(default=None) # debug option, y spaxel value to report information on\n zdebug = integer(default=None) # debug option, z spaxel value to report information on\n output_type = option('band','channel','grating','multi',default='band') # Type IFUcube to create. Options=band,channel,grating,multi\n search_output_file = boolean(default=false)\n output_use_model = boolean(default=true) # Use filenames in the output models\n "¶
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.
-
read_user_input
()[source]¶ figure out if any of the input paramters channel,band,filter or grating have been set. If they have been check that they are valid and fill in input_pars paramters
Parameters: none – Returns: - self.pars_input[‘channel’]
- self.pars_input[‘sub_channel’]
- self.pars_input[‘grating’]
- self.pars_input[‘filter’]