register_framedata_list#
- astropop.image.register.register_framedata_list(frame_list, algorithm='cross-correlation', ref_image=0, clip_output=False, cval='median', inplace=False, skip_failure=False, **kwargs)#
Perform registration in a framedata list.
- Parameters:
- frame_listlist
A list containing
FrameData
images to be registered. All images must have the same shape.- algorith{‘cross-correlation’, ‘asterism-matching’} (optional)
The algorithm to compute the
AffineTransform
between the images. ‘cross-correlation’ will compute the transform usingphase_cross_correlation
method. ‘asterism-matching’ will useastroalign
to match asterisms of 3 detected stars in the field and compute the transform. Default: ‘cross-correlation’- ref_imageint (optional)
Reference image index to compute the registration. Default: 0
- clip_outputbool (optional)
If True, the output images will be clipped to a only-valid pixels frame.
- cvalfloat or {‘median’, ‘mean’} (optional)
Fill value for the empty pixels in the transformed image. If ‘mean’ or ‘median’, the correspondent values will be computed from the image. Default: ‘median’
- skip_failure: bool (optional)
If True, the images that fail to register will be skipped. Their data will be fill with the cval and all pixels mask will be set to True. If False, the error will be raised. Default: False
- inplacebool (optional)
Perform the operation inplace, modifying the original FrameData container. If
False
, a new container will be created. Default:False
- **kwargs
keyword arguments to be passed to
CrossCorrelationRegister
orAsterismRegister
during instance creation. See the parameters in each class documentation.