Bases: object
A class for combining CCDData objects.
The Combiner class is used to combine together CCDData objects including the method for combining the data, rejecting outlying data, and weighting used for combining frames
Parameters: | ccd_list : list
dtype : ‘numpy dtype’
|
---|---|
Raises: | TypeError
|
Notes
The following is an example of combining together different CCDData objects:
>>> from combiner import combiner
>>> c = combiner([ccddata1, cccdata2, ccddata3])
>>> ccdall = c.median_combine()
Attributes Summary
dtype | |
scaling | Scaling factor used in combining images. |
weights |
Methods Summary
average_combine([scale_func, scale_to]) | Average combine together a set of arrays. |
median_combine([median_func]) | Median combine a set of arrays. |
minmax_clipping([min_clip, max_clip]) | Mask all pixels that are below min_clip or above max_clip. |
sigma_clipping([low_thresh, high_thresh, ...]) | Pixels will be rejected if they have deviations greater than those set by the threshold values. |
Attributes Documentation
Scaling factor used in combining images.
Parameters: | scale : function or array-like or None, optional
|
---|
Methods Documentation
Average combine together a set of arrays. A CCDData object is returned with the data property set to the average of the arrays. If the data was masked or any data have been rejected, those pixels will not be included in the median. A mask will be returned, and if a pixel has been rejected in all images, it will be masked. The uncertainty of the combined image is set by the standard deviation of the input images.
Returns: | combined_image: CCDData
|
---|
Median combine a set of arrays.
A CCDData object is returned with the data property set to the median of the arrays. If the data was masked or any data have been rejected, those pixels will not be included in the median. A mask will be returned, and if a pixel has been rejected in all images, it will be masked. The uncertainty of the combined image is set by 1.4826 times the median absolute deviation of all input images.
Parameters: | median_func : function, optional
|
---|---|
Returns: | combined_image: CCDData
|
Warning
The uncertainty currently calculated using the median absolute deviation does not account for rejected pixels
Mask all pixels that are below min_clip or above max_clip.
Parameters: | min_clip : None or float
max_clip : None or float
|
---|
Parameters: | low_thresh : positive float or None
high_thresh : positive float or None
func : function
dev_func : function
|
---|