lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack Class Reference

Public Member Functions
	__init__ (self, shape, bit_mask_value, mask_threshold_dict={}, mask_map=[], no_good_pixels_mask=None, calc_error_from_input_variance=True, compute_n_image=False)
	add_masked_image (self, masked_image, weight=1.0)
	fill_stacked_masked_image (self, stacked_masked_image)
	add_image (self, image, weight=1.0)
	fill_stacked_image (self, stacked_image)

Static Public Member Functions
	stats_ctrl_to_threshold_dict (stats_ctrl)

Public Attributes
	shape = shape
	bit_mask_value = bit_mask_value
	mask_map = mask_map
	no_good_pixels_mask = no_good_pixels_mask
	calc_error_from_input_variance = calc_error_from_input_variance
	compute_n_image = compute_n_image
dict	mask_threshold_dict = {}
	sum_weight = np.zeros(shape, dtype=np.float64)
	sum_wdata = np.zeros(shape, dtype=np.float64)
	sum_w2var = np.zeros(shape, dtype=np.float64)
	sum_weight2 = np.zeros(shape, dtype=np.float64)
	sum_wdata2 = np.zeros(shape, dtype=np.float64)
	or_mask = np.zeros(shape, dtype=np.int64)
dict	rejected_weights_by_bit = {}
	masked_pixels_mask = np.zeros(shape, dtype=np.int64)
	n_image = np.zeros(shape, dtype=np.int32)

Detailed Description

Stack masked images.

Parameters
----------
shape : `tuple`
    Shape of the input and output images.
bit_mask_value : `int`
    Bit mask to flag for "bad" inputs that should not be stacked.
mask_threshold_dict : `dict` [`int`: `float`], optional
    Dictionary of mapping from bit number to threshold for flagging.
    Only bad bits (in bit_mask_value) which mask fractional weight
    greater than this threshold will be flagged in the output image.
mask_map : `list` [`tuple`], optional
    Mapping from input image bits to aggregated coadd bits.
no_good_pixels_mask : `int`, optional
    Bit mask to set when there are no good pixels in the stack.
    If not set then will set coadd masked image 'NO_DATA' bit.
calc_error_from_input_variance : `bool`, optional
    Calculate the error from the input variance?
compute_n_image : `bool`, optional
    Calculate the n_image map as well as stack?

Definition at line 30 of file accumulator_mean_stack.py.

Constructor & Destructor Documentation

__init__()

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.__init__	(		self,
			shape,
			bit_mask_value,
			mask_threshold_dict = {},
			mask_map = [],
			no_good_pixels_mask = None,
			calc_error_from_input_variance = True,
			compute_n_image = False )

Definition at line 53 of file accumulator_mean_stack.py.

Member Function Documentation

add_image()

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.add_image	(		self,
			image,
			weight = 1.0 )

Add an image to the stack.

No bit-filtering is performed when adding an image.

Parameters
----------
image : `lsst.afw.image.Image`
    Image to add to the stack.
weight : `float`, optional
    Weight to apply for weighted mean.

Definition at line 180 of file accumulator_mean_stack.py.

add_masked_image()

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.add_masked_image	(		self,
			masked_image,
			weight = 1.0 )

Add a masked image to the stack.

Parameters
----------
masked_image : `lsst.afw.image.MaskedImage`
    Masked image to add to the stack.
weight : `float`, optional
    Weight to apply for weighted mean.

Definition at line 95 of file accumulator_mean_stack.py.

fill_stacked_image()

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.fill_stacked_image	(		self,
			stacked_image )

Fill the image after accumulation.

Parameters
----------
stacked_image : `lsst.afw.image.Image`
    Total image.

Definition at line 198 of file accumulator_mean_stack.py.

fill_stacked_masked_image()

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.fill_stacked_masked_image	(		self,
			stacked_masked_image )

Fill the stacked mask image after accumulation.

Parameters
----------
stacked_masked_image : `lsst.afw.image.MaskedImage`
    Total masked image.

Definition at line 129 of file accumulator_mean_stack.py.

stats_ctrl_to_threshold_dict()

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.stats_ctrl_to_threshold_dict ( stats_ctrl )

static

Convert stats control to threshold dict.

Parameters
----------
stats_ctrl : `lsst.afw.math.StatisticsControl`

Returns
-------
threshold_dict : `dict`
    Dict mapping from bit to propagation threshold.

Definition at line 215 of file accumulator_mean_stack.py.

Member Data Documentation

bit_mask_value

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.bit_mask_value = bit_mask_value

Definition at line 59 of file accumulator_mean_stack.py.

calc_error_from_input_variance

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.calc_error_from_input_variance = calc_error_from_input_variance

Definition at line 62 of file accumulator_mean_stack.py.

compute_n_image

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.compute_n_image = compute_n_image

Definition at line 63 of file accumulator_mean_stack.py.

mask_map

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.mask_map = mask_map

Definition at line 60 of file accumulator_mean_stack.py.

mask_threshold_dict

dict lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.mask_threshold_dict = {}

Definition at line 66 of file accumulator_mean_stack.py.

masked_pixels_mask

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.masked_pixels_mask = np.zeros(shape, dtype=np.int64)

Definition at line 90 of file accumulator_mean_stack.py.

n_image

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.n_image = np.zeros(shape, dtype=np.int32)

Definition at line 93 of file accumulator_mean_stack.py.

no_good_pixels_mask

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.no_good_pixels_mask = no_good_pixels_mask

Definition at line 61 of file accumulator_mean_stack.py.

or_mask

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.or_mask = np.zeros(shape, dtype=np.int64)

Definition at line 85 of file accumulator_mean_stack.py.

rejected_weights_by_bit

dict lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.rejected_weights_by_bit = {}

Definition at line 86 of file accumulator_mean_stack.py.

shape

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.shape = shape

Definition at line 58 of file accumulator_mean_stack.py.

sum_w2var

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.sum_w2var = np.zeros(shape, dtype=np.float64)

Definition at line 78 of file accumulator_mean_stack.py.

sum_wdata

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.sum_wdata = np.zeros(shape, dtype=np.float64)

Definition at line 74 of file accumulator_mean_stack.py.

sum_wdata2

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.sum_wdata2 = np.zeros(shape, dtype=np.float64)

Definition at line 83 of file accumulator_mean_stack.py.

sum_weight

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.sum_weight = np.zeros(shape, dtype=np.float64)

Definition at line 72 of file accumulator_mean_stack.py.

sum_weight2

lsst.meas.algorithms.accumulator_mean_stack.AccumulatorMeanStack.sum_weight2 = np.zeros(shape, dtype=np.float64)

Definition at line 81 of file accumulator_mean_stack.py.

---

The documentation for this class was generated from the following file:

• python/lsst/meas/algorithms/accumulator_mean_stack.py