InstrumentInfo

class jwst.cube_build.instrument_defaults.InstrumentInfo[source]

Bases: object

Define the basic instrument parameters.

These parameters are filled in from the CUBEPAR reference file and MIRI resolution reference file.

Methods Summary

`get_end_slice`(parameter1)	MIRI MRS function to return the ending x pixel values of a channel.
`get_high_table`()	Get the NIRSpec high resolution table containing flux weighting parameters.
`get_med_table`()	Get the NIRSpec medium resolution table containing flux weighting parameters.
`get_miri_slice_endpts`(parameter1)	MIRI MRS function to return the starting and ending x pixel value of a channel.
`get_msm_power`(parameter1, parameter2)	Get Modified Shepard `msm_power` value for data defined by given parameters.
`get_multichannel_table`()	Get the MRS multichannel table containing flux weighting parameters.
`get_nslice`(parameter1)	MIRI MRS function to return number of slices on given channel.
`get_prism_table`()	Get the NIRSpec prism table containing flux weighting parameters.
`get_scale`(parameter1, parameter2)	Get spatial and spectral scales for data defined by given parameters.
`get_scale_rad`(parameter1, parameter2)	Get Modified Shepard `scale_rad` value define by given parameters.
`get_soft_rad`(parameter1, parameter2)	Get Modified Shepard `soft_rad` value defined by given parameters.
`get_spatial_roi`(parameter1, parameter2)	Get spatial ROI for data defined by given parameters.
`get_start_slice`(parameter1)	MIRI MRS function to return the starting x pixel value of a channel.
`get_wave_max`(parameter1, parameter2)	Get maximum for data defined by given parameters.
`get_wave_min`(parameter1, parameter2)	Get minimum for data defined by given parameters.
`get_wave_roi`(parameter1, parameter2)	Get spectral ROI for data defined by given parameters.
`set_emsm`(parameter1, parameter2, sroi, wroi, ...)	Set `emsm` modified Shepard cube parameters.
`set_high_driz_table`(wave)	Set the drizzle related cube parameters for NIRSpec high resolution data.
`set_high_emsm_table`(wave, sroi, wroi, scalerad)	Set Modified Shepard (EMSM) cube parameters for NIRSpec high resolution data.
`set_high_table`(wave, sroi, wroi, power, softrad)	Set Modified Shepard (MSM) cube parameters for NIRSpec high resolution data.
`set_med_driz_table`(wave)	Set the drizzle related cube parameters for NIRSpec medium resolution data.
`set_med_emsm_table`(wave, sroi, wroi, scalerad)	Set Modified Shepard (EMSM) cube parameters for NIRSpec Medium resolution data.
`set_med_table`(wave, sroi, wroi, power, softrad)	Set Modified Shepard (MSM) cube parameters for NIRSpec Medium resolution data.
`set_msm`(parameter1, parameter2, sroi, wroi, ...)	Set `msm` modified Shepard cube parameters.
`set_multi_channel_driz_table`(wave)	Set the drizzle related cube parameters for MIRI MRS channel data.
`set_multi_channel_emsm_table`(wave, sroi, ...)	Set Modified Shepard (EMSM) cube parameters for multiple MRS channels.
`set_multi_channel_table`(wave, sroi, wroi, ...)	Set Modified Shepard (MSM) cube parameters for multiple MRS channels.
`set_prism_driz_table`(wave)	Set the drizzle related cube parameters for NIRSpec prism data.
`set_prism_emsm_table`(wave, sroi, wroi, scalerad)	Set Modified Shepard (EMSM) cube parameters for NIRSpec prism data.
`set_prism_table`(wave, sroi, wroi, power, softrad)	Set Modified Shepard (MSM) cube parameters for NIRSpec prism data.
`set_spatial_size`(value, parameter1[, parameter2])	Set spatial size of cube voxel.
`set_spectral_step`(value, parameter1, parameter2)	Set spectral size of cube voxel.
`set_wave_max`(value, parameter1, parameter2)	Set maximum wavelength for IFU band.
`set_wave_min`(value, parameter1, parameter2)	Set minimum wavelength for IFU band.
`set_xslice_limits`(x1, x2, parameter1)	Set the x limits of channels for MIRI.

Methods Documentation

get_end_slice(parameter1)[source]

MIRI MRS function to return the ending x pixel values of a channel.

Parameters:

parameter1str: MRS Channel number

Returns:

slicenoint: Ending x pixel value of channel.

get_high_table()[source]

Get the NIRSpec high resolution table containing flux weighting parameters.

Returns:

tabledict: Dictionary of flux weighting values

get_med_table()[source]

Get the NIRSpec medium resolution table containing flux weighting parameters.

Returns:

tabledict: Dictionary of flux weighting values

get_miri_slice_endpts(parameter1)[source]

MIRI MRS function to return the starting and ending x pixel value of a channel.

Parameters:

parameter1str: MRS Channel number

Returns:

slice_xstartint: Starting x pixel value slice
slice_endint: Ending x pixel value slice

get_msm_power(parameter1, parameter2)[source]

Get Modified Shepard msm_power value for data defined by given parameters.

Parameters:

parameter1str: Grating for NIRSpec data, or channel for MIRI data
parameter2str: Filter for NIRSpec data, or band for MIRI data

Returns:

weight_powerfloat: Modified Shepard (MSM) weighting parameter

get_multichannel_table()[source]

Get the MRS multichannel table containing flux weighting parameters.

Returns:

tabledict: Dictionary of flux weighting values

get_nslice(parameter1)[source]

MIRI MRS function to return number of slices on given channel.

Parameters:

parameter1str: MRS Channel number

Returns:

numsliceint: Number of slices on channel

get_prism_table()[source]

Get the NIRSpec prism table containing flux weighting parameters.

Returns:

tabledict: Dictionary of flux weighting values

get_scale(parameter1, parameter2)[source]

Get spatial and spectral scales for data defined by given parameters.

Parameters:

parameter1str: Grating for NIRSpec data, or channel for MIRI data
parameter2str: Filter for NIRSpec data, or band for MIRI data

Returns:

scale(float, float, float): Spatial scale, spatial scale, and spectral scale

get_scale_rad(parameter1, parameter2)[source]

Get Modified Shepard scale_rad value define by given parameters.

Parameters:

parameter1str: Grating for NIRSpec data, or channel for MIRI data
parameter2str: Filter for NIRSpec data, or band for MIRI data

Returns:

scale_radfloat: Modified Shepard scale_rad value

get_soft_rad(parameter1, parameter2)[source]

Get Modified Shepard soft_rad value defined by given parameters.

Parameters:

parameter1str: Grating for NIRSpec data, or channel for MIRI data
parameter2str: Filter for NIRSpec data, or band for MIRI data

Returns:

softradfloat: Modified Shepard weighting parameter for weight type=msm

get_spatial_roi(parameter1, parameter2)[source]

Get spatial ROI for data defined by given parameters.

Parameters:

parameter1str: Grating for NIRSpec data, or channel for MIRI data
parameter2str: Filter for NIRSpec data, or band for MIRI data

Returns:

roisfloat: Spatial ROI for parameters

get_start_slice(parameter1)[source]

MIRI MRS function to return the starting x pixel value of a channel.

Parameters:

parameter1str: MRS Channel number

Returns:

slicenoint: Starting x pixel value of channel

get_wave_max(parameter1, parameter2)[source]

Get maximum for data defined by given parameters.

Parameters:

parameter1str: Grating for NIRSpec data, or channel for MIRI data
parameter2str: Filter for NIRSpec data, or band for MIRI data

Returns:

wavemaxfloat: Maximum wavelength of the data

get_wave_min(parameter1, parameter2)[source]

Get minimum for data defined by given parameters.

Parameters:

parameter1str: Grating for NIRSpec data, or channel for MIRI data
parameter2str: Filter for NIRSpec data, or band for MIRI data

Returns:

waveminfloat: Minimum wavelength of the data

get_wave_roi(parameter1, parameter2)[source]

Get spectral ROI for data defined by given parameters.

Parameters:

parameter1str: Grating for NIRSpec data, or channel for MIRI data
parameter2str: Filter for NIRSpec data, or band for MIRI data

Returns:

roiwfloat: Spectral ROI for parameters

set_emsm(parameter1, parameter2, sroi, wroi, scalerad)[source]

Set emsm modified Shepard cube parameters.

Cube parameters read in from the CUBEPAR reference file. These parameters are used for single band data and do not depend on wavelength.

Parameters:

parameter1str: Grating for NIRSpec data, or channel for MIRI data
parameter2str: Filter for NIRSpec data, or band for MIRI data
sroindarray: Spatial ROI value
wroindarray: Wavelength ROI
scaleradndarray: Modified Shepard weighting function scale factor

set_high_driz_table(wave)[source]

Set the drizzle related cube parameters for NIRSpec high resolution data.

Parameters:

wavendarray: Wavelength array of the CUBEPAR reference file

set_high_emsm_table(wave, sroi, wroi, scalerad)[source]

Set Modified Shepard (EMSM) cube parameters for NIRSpec high resolution data.

Cube parameters read in from the CUBEPAR reference file. These parameters are for the weighting function, emsm, and they vary with wavelength. This function fills in the self.high_* parameters

Parameters:

wavendarray: Wavelength array of the CUBEPAR reference file
sroindarray: Spatial ROI value to use for the corresponding wavelength value
wroindarray: Wavelength ROI values to use for the corresponding wavelength value
scaleradndarray: Modified Shepard weighting function scale factor to use for the corresponding wavelength value

set_high_table(wave, sroi, wroi, power, softrad)[source]

Set Modified Shepard (MSM) cube parameters for NIRSpec high resolution data.

Cube parameters read in from the CUBEPAR reference file. These parameters are for the weighting function, msm, and they vary with wavelength. This function fills in the self.high_* parameters.

Parameters:

wavendarray: Wavelength array of the CUBEPAR reference file
sroindarray: Spatial ROI value to use for the corresponding wavelength value
wroindarray: Wavelength ROI values to use for the corresponding wavelength value
powerndarray: Power of the modified Shepard weighting function to use for the corresponding wavelength value
softradndarray: Modified Shepard weighting function scale factor to use for the corresponding wavelength value

set_med_driz_table(wave)[source]

Set the drizzle related cube parameters for NIRSpec medium resolution data.

Parameters:

wavendarray: Wavelength array of the CUBEPAR reference file

set_med_emsm_table(wave, sroi, wroi, scalerad)[source]

Set Modified Shepard (EMSM) cube parameters for NIRSpec Medium resolution data.

Cube parameters read in from the CUBEPAR reference file. These parameters are for the weighting function, emsm, and they vary with wavelength. This function fills in the self.med_* parameters

Parameters:

wavendarray: Wavelength array of the CUBEPAR reference file
sroindarray: Spatial ROI value to use for the corresponding wavelength value
wroindarray: Wavelength ROI values to use for the corresponding wavelength value
scaleradndarray: Modified Shepard weighting function scale factor to use for the corresponding wavelength value

set_med_table(wave, sroi, wroi, power, softrad)[source]

Set Modified Shepard (MSM) cube parameters for NIRSpec Medium resolution data.

Cube parameters read in from the CUBEPAR reference file. These parameters are for the weighting function, msm, and they vary with wavelength. This function fills in the self.med_* parameters.

Parameters:

wavendarray: Wavelength array of the CUBEPAR reference file
sroindarray: Spatial ROI value to use for the corresponding wavelength
wroindarray: Wavelength ROI values to use for the corresponding wavelength
powerndarray: Power of the Modified Shepard weighting function to use for the corresponding wavelength value
softradndarray: Modified Shepard weighting function scale factor to use for the corresponding wavelength value

set_msm(parameter1, parameter2, sroi, wroi, power, softrad)[source]

Set msm modified Shepard cube parameters.

Cube parameters read in from the CUBEPAR reference file. These parameters are used for single band data and do not depend on wavelength.

Parameters:

parameter1str: Grating for NIRSpec data, or channel for MIRI data
parameter2str: Filter for NIRSpec data, or band for MIRI data
sroindarray: Spatial ROI value
wroindarray: Wavelength ROI
powerndarray: Power of the modified Shepard weighting function
softradndarray: Modified Shepard weighting function parameter

set_multi_channel_driz_table(wave)[source]

Set the drizzle related cube parameters for MIRI MRS channel data.

Parameters:

wavendarray: Wavelength array of the CUBEPAR reference file. The table is used when IFU cubes are built from multiple bands.

set_multi_channel_emsm_table(wave, sroi, wroi, scalerad)[source]

Set Modified Shepard (EMSM) cube parameters for multiple MRS channels.

Cube parameters read in from the CUBEPAR reference file. These parameters are for the weighting function, emsm, and they vary with wavelength. This function fills in the self.multich_* parameters. This table is used when the IFU cubes are built from multiple channels.

Parameters:

wavendarray: Wavelength array of the CUBEPAR reference file
sroindarray: Spatial ROI value to use for the corresponding wavelength
wroindarray: Wavelength ROI values to use for the corresponding wavelength
scaleradndarray: Modified Shepard weighting function scale factor to use for the corresponding wavelength

set_multi_channel_table(wave, sroi, wroi, power, softrad)[source]

Set Modified Shepard (MSM) cube parameters for multiple MRS channels.

Cube parameters read in from the CUBEPAR reference file. These parameters are for the weighting function, msm, and they vary with wavelength. This function fills in the self.multich_* parameters. This table is used when the IFU cubes are built from multiple channels.

Parameters:

wavendarray: Wavelength array of the CUBEPAR reference file
sroindarray: Spatial ROI value to use for the corresponding wavelength value
wroindarray: Wavelength ROI values to use for the corresponding wavelength value
powerndarray: Power of the modified Shepard weighting function to use for the corresponding wavelength value
softradndarray: Modified Shepard weighting function scale factor to use for the corresponding wavelength value

set_prism_driz_table(wave)[source]

Set the drizzle related cube parameters for NIRSpec prism data.

Parameters:

wavendarray: Wavelength array of the CUBEPAR reference file

set_prism_emsm_table(wave, sroi, wroi, scalerad)[source]

Set Modified Shepard (EMSM) cube parameters for NIRSpec prism data.

Cube parameters read in from the CUBEPAR reference file. These parameters are for the weighting function, emsm, and they vary with wavelength. This function fills in the self.prism_* parameters. This table is used when building IFU cubes from data from more than one grating/filter setting.

Parameters:

wavendarray: Wavelength array of the CUBEPAR reference file
sroindarray: Spatial ROI value to use for the corresponding wavelength value
wroindarray: Wavelength ROI values to use for the corresponding wavelength value
scaleradndarray: Modified Shepard weighting function scale factor to use for the corresponding wavelength value

set_prism_table(wave, sroi, wroi, power, softrad)[source]

Set Modified Shepard (MSM) cube parameters for NIRSpec prism data.

Cube parameters read in from the CUBEPAR reference file. These parameters are for the weighting function, msm, and they vary with wavelength. This function fills in the self.prism_* parameters.

Parameters:

wavendarray: Wavelength array of the cube pars reference table
sroindarray: Spatial ROI value to use for the corresponding wavelength
wroindarray: Wavelength ROI values to use for the corresponding wavelength
powerndarray: Power of the Modified Shepard weighting function to use for the corresponding wavelength
softradndarray: Modified Shepard weighting function scale factor to use for the corresponding wavelength

set_spatial_size(value, parameter1, parameter2=None)[source]

Set spatial size of cube voxel.

Parameters:

valuefloat: Spatial size of cube voxel
parameter1str: Grating for NIRSpec data or channel for MIRI data
parameter2str: MIRI band. This parameter is only valid for MIRI data

set_spectral_step(value, parameter1, parameter2)[source]

Set spectral size of cube voxel.

Parameters:

valuefloat: Spectral size of cube voxel
parameter1str: Grating for NIRSpec data, or channel for MIRI data
parameter2str: Filter for NIRSpec data, or band for MIRI data

set_wave_max(value, parameter1, parameter2)[source]

Set maximum wavelength for IFU band.

Parameters:

valuefloat: Maximum wavelength
parameter1str: Grating for NIRSpec data, or channel for MIRI data
parameter2str: Filter for NIRSpec data, or band for MIRI data

set_wave_min(value, parameter1, parameter2)[source]

Set minimum wavelength for IFU band.

Parameters:

valuefloat: Minimum wavelength
parameter1str: Grating for NIRSpec data, or channel for MIRI data
parameter2str: Filter for NIRSpec data, or band for MIRI data

set_xslice_limits(x1, x2, parameter1)[source]

Set the x limits of channels for MIRI.

Parameters:

x1int: X minimum pixel value of channel
x2int: X maximum pixel value of channel
parameter1str: Channel number