regularizepsf.psf#

Classes#

PointSpreadFunctionABC

SimplePSF

Model for a simple PSF.

VariedPSF

Model for a PSF that varies over the field of view.

Functions#

simple_psf(→ SimplePSF)

_varied_psf(→ VariedPSF)

varied_psf(→ VariedPSF)

Module Contents#

class regularizepsf.psf.PointSpreadFunctionABC#
abstract __call__(x: numbers.Real | numpy.ndarary, y: numbers.Real | numpy.ndarray) → numbers.Real | numpy.ndarray#

Evaluation of the point spread function.

Parameters:

  • x (real number or np.ndarray) – first dimension coordinate to evaluate at

  • y (real number or np.ndarray) – second dimension coordinate to evaluate at

Returns:

the value of the point spread function at (x,y)

Return type:

real number or np.ndarray

property parameters: list#
Abstractmethod:

Varying parameters of the model.

abstract evaluate_at(x: int, y: int) → SimplePSF#

Evaluate a PSF at a given point, convert a varied PSF to a simple PSF.

class regularizepsf.psf.SimplePSF(function: collections.abc.Callable)#

Bases: PointSpreadFunctionABC

Model for a simple PSF.

Creates a PSF object.

Parameters:

function –

Python function representing the PSF,

first two parameters must be x and y and must return an numpy array

_f: collections.abc.Callable#
_signature: inspect.Signature#
_parameters: set[str]#
__call__(x: numbers.Real | numpy.ndarray, y: numbers.Real | numpy.ndarray, **kwargs: dict[str, Any]) → numbers.Real | numpy.ndarray#

Evaluation of the point spread function.

Parameters:

  • x (real number or np.ndarray) – first dimension coordinate to evaluate at

  • y (real number or np.ndarray) – second dimension coordinate to evaluate at

Returns:

the value of the point spread function at (x,y)

Return type:

real number or np.ndarray

property parameters: set[str]#

Varying parameters of the model.

evaluate_at(x: int, y: int) → SimplePSF#

Evaluate a PSF at a given point, convert a varied PSF to a simple PSF.

regularizepsf.psf.simple_psf(arg: Any = None) → SimplePSF#
class regularizepsf.psf.VariedPSF(vary_function: collections.abc.Callable, base_psf: SimplePSF, validate_at_call: bool = True)#

Bases: PointSpreadFunctionABC

Model for a PSF that varies over the field of view.

_vary_function#
_base_psf#
validate_at_call#
parameterization_signature#
_origin_parameters: set[str]#
__call__(x: numbers.Real | numpy.ndarray, y: numbers.Real | numpy.ndarray) → numbers.Real | numpy.ndarray#

Evaluation of the point spread function.

Parameters:

  • x (real number or np.ndarray) – first dimension coordinate to evaluate at

  • y (real number or np.ndarray) – second dimension coordinate to evaluate at

Returns:

the value of the point spread function at (x,y)

Return type:

real number or np.ndarray

property parameters: list#

Varying parameters of the model.

evaluate_at(x: int, y: int) → SimplePSF#

Evaluate a PSF at a given point, convert a varied PSF to a simple PSF.

regularizepsf.psf._varied_psf(base_psf: SimplePSF) → VariedPSF#
regularizepsf.psf.varied_psf(base_psf: SimplePSF = None) → VariedPSF#