MIRIDataset

class jwst.refpix.reference_pixels.MIRIDataset(input_model, odd_even_rows, conv_kernel_params, siglimit)

Bases: Dataset

Container for MIRI data.

Parameters:

input_modelJwstDataModel

Science data model to be corrected

odd_even_rowsbool

Flag that controls whether odd and even-numbered rows are handled separately

conv_kernel_paramsdict

Dictionary containing the parameters needed for the optimized convolution kernel

siglimitfloat

Sigma clipping limit for outlier rejection

Methods Summary

collect_even_refpixels(group, amplifier, ...)	Collect reference pixels from even-numbered rows.
collect_odd_refpixels(group, amplifier, ...)	Collect reference pixels from odd-numbered rows.
detector_to_dms(integration, group)	Convert MIRI data from detector to DMS frame.
dms_to_detector(integration, group)	Convert MIRI data from DMS to detector frame.
do_corrections()	Perform reference pixel correction for MIRI data.
do_fullframe_corrections()	Do Reference Pixels Corrections for all amplifiers, MIRI detectors.
do_left_right_correction(group, refvalues)	Do the reference pixel correction.
do_subarray_corrections()	Perform reference pixel correction for MIRI subarrays.
get_amplifier_refvalue(group, amplifier, ...)	Calculate the reference pixel mean for a given amplifier.
get_even_refvalue(group, amplifier, ...)	Calculate reference value in even-numbered rows.
get_odd_refvalue(group, amplifier, left_or_right)	Calculate reference values in odd-numbered rows.
get_refvalues(group)	Get the reference pixel values.

Methods Documentation

collect_even_refpixels(group, amplifier, left_or_right)

Collect reference pixels from even-numbered rows.

Parameters:

groupndarray

Group being processed

amplifier{‘A’, ‘B’, ‘C’, ‘D’}

Amplifier being processed

left_or_right{‘left’, ‘right’}

Process left or right side reference pixels

Returns:

evenrefndarray

Reference pixels from even-numbered rows

evendqndarray

DQ values for reference pixels from even-numbered rows

collect_odd_refpixels(group, amplifier, left_or_right)

Collect reference pixels from odd-numbered rows.

Parameters:

groupndarray

Group being processed

amplifier{‘A’, ‘B’, ‘C’, ‘D’}

Amplifier being processed

left_or_right{‘left’, ‘right’}

Process left or right side reference pixels

Returns:

oddrefndarray

Reference pixels from odd-numbered rows

odddqndarray

DQ values for reference pixels from odd-numbered rows

detector_to_dms(integration, group)

Convert MIRI data from detector to DMS frame.

Parameters:

integrationint

Integration number

groupint

Group number

dms_to_detector(integration, group)

Convert MIRI data from DMS to detector frame.

MIRI data is the same in detector and DMS frames.

Parameters:

integrationint

Integration number

groupint

Group number

do_corrections()

Perform reference pixel correction for MIRI data.

do_fullframe_corrections()

Do Reference Pixels Corrections for all amplifiers, MIRI detectors.

do_left_right_correction(group, refvalues)

Do the reference pixel correction.

Parameters:

groupndarray

Group that is being processed. This parameter is corrected for the bias drift using the left and right reference pixels

refvaluesdict

Dictionary of reference pixel clipped means

do_subarray_corrections()

Perform reference pixel correction for MIRI subarrays.

Currently skipped.

get_amplifier_refvalue(group, amplifier, left_or_right)

Calculate the reference pixel mean for a given amplifier.

Parameters:

groupndarray

Group that is being processed

amplifier{‘A’, ‘B’, ‘C’, ‘D’}

Amplifier that is being processed

left_or_right{‘left’, ‘right’}

Processing left or right side reference pixels?

Returns:

oddfloat

Value of the clipped mean of the reference pixels in odd-numbered rows (if self.odd_even_rows)

evenfloat

Value of the clipped mean of the reference pixels in even-numbered rows (if self.odd_even_rows)

meanfloat

Value of the clipped mean of the reference pixels in both odd-numbered and even-numbered rows (if not self.odd_even_rows)

get_even_refvalue(group, amplifier, left_or_right)

Calculate reference value in even-numbered rows.

Parameters:

groupndarray

Group that is being processed

amplifier{‘A’, ‘B’, ‘C’, ‘D’}

Amplifier that is being processed

left_or_right{‘left’, ‘right’}

Processing left or right reference pixels?

Returns:

evenfloat

Value of the clipped mean of the reference pixels in even-numbered rows

get_odd_refvalue(group, amplifier, left_or_right)

Calculate reference values in odd-numbered rows.

Parameters:

groupndarray

Group that is being processed

amplifier{‘A’, ‘B’, ‘C’, ‘D’}

Amplifier that is being processed

left_or_right{‘left’, ‘right’}

Processing left or right reference pixels?

Returns:

oddfloat

Value of the clipped mean of the reference pixels in odd-numbered rows

get_refvalues(group)

Get the reference pixel values.

Values for each amplifier, odd and even rows and left and right side reference pixels are returned in a dictionary.

Parameters:

groupndarray

Group that is being processed.

Returns:

refpixdict

Dictionary containing the clipped mean of the reference pixels for each amplifier, odd and even rows (if selected, otherwise all rows) and left and right.