ConvolutionKernel#

class lsst.images.convolution_kernels.ConvolutionKernel#

An abstract base class for spatially-varying convolution kernels.

Attributes Summary

`bounds`	The region where this convolution kernel is valid (`Bounds`).
`kernel_bbox`	Bounding box of all images returned by `compute_kernel_image` (`Box`).

Methods Summary

`compute_kernel_image`(*, x, y)	Evaluate the kernel at a point.
`describe`(*[, brief, detail, exclude])	Return a `Report` describing this object.
`serialize`(archive)	Serialize the kernel to an output archive.

Attributes Documentation

kernel_bbox#: Bounding box of all images returned by compute_kernel_image (Box).

Methods Documentation

abstract compute_kernel_image(*, x, y)#

Evaluate the kernel at a point.

Parameters:

Returns:

An image of the kernel, centered on the center of the center pixel, which is defined to be (0, 0) by the image’s origin.

Return type:

Image

describe(*, brief=False, detail=False, exclude=())#

Return a Report describing this object.

Parameters:

brief (bool, optional) – Whether to build only what repr and str read.
detail (bool, optional) – Whether to include extras that are too expensive for a default report, such as per-plane set-pixel counts.
exclude (Collection [str], optional) – Names of report elements to omit.

Returns:

report – Report describing this object.

Return type:

Report

abstract serialize(archive)#

Serialize the kernel to an output archive.