From 85be0a29e6a5a23aabbd6157b7e6032c4b1c49ce Mon Sep 17 00:00:00 2001 From: jmbhughes Date: Mon, 24 Jun 2024 07:23:42 +0000 Subject: [PATCH] deploy: 7f287fce0119a914e76cd45522a650174fafdec6 --- .../regularizepsf/corrector/index.rst.txt | 119 ------ .../regularizepsf/fitter/index.rst.txt | 171 --------- .../autoapi/regularizepsf/psf/index.rst.txt | 25 -- .../regularizepsf/visualize/index.rst.txt | 254 ------------ _sources/development.rst.txt | 6 +- autoapi/regularizepsf/corrector/index.html | 173 +-------- autoapi/regularizepsf/fitter/index.html | 247 +----------- autoapi/regularizepsf/index.html | 4 +- autoapi/regularizepsf/psf/index.html | 31 -- autoapi/regularizepsf/visualize/index.html | 362 +----------------- development.html | 6 +- genindex.html | 144 +------ objects.inv | Bin 1529 -> 1295 bytes searchindex.js | 2 +- 14 files changed, 34 insertions(+), 1510 deletions(-) diff --git a/_sources/autoapi/regularizepsf/corrector/index.rst.txt b/_sources/autoapi/regularizepsf/corrector/index.rst.txt index 856bab1..0474298 100644 --- a/_sources/autoapi/regularizepsf/corrector/index.rst.txt +++ b/_sources/autoapi/regularizepsf/corrector/index.rst.txt @@ -4,24 +4,11 @@ regularizepsf.corrector .. py:module:: regularizepsf.corrector -Exceptions ----------- - -.. autoapisummary:: - - regularizepsf.corrector.EvaluatedModelInconsistentSizeError - regularizepsf.corrector.InvalidSizeError - regularizepsf.corrector.UnevaluatedPointError - - Classes ------- .. autoapisummary:: - regularizepsf.corrector.PointSpreadFunctionABC - regularizepsf.corrector.SimplePSF - regularizepsf.corrector.VariedPSF regularizepsf.corrector.CorrectorABC regularizepsf.corrector.FunctionalCorrector regularizepsf.corrector.ArrayCorrector @@ -38,112 +25,6 @@ Functions Module Contents --------------- -.. py:exception:: EvaluatedModelInconsistentSizeError - - Bases: :py:obj:`ValidationError` - - - Common base class for all non-exit exceptions. - - -.. py:exception:: InvalidSizeError - - Bases: :py:obj:`ValidationError` - - - Common base class for all non-exit exceptions. - - -.. py:exception:: UnevaluatedPointError - - Bases: :py:obj:`Exception` - - - Common base class for all non-exit exceptions. - - -.. py:class:: PointSpreadFunctionABC - - .. py:method:: __call__(x: numbers.Real | numpy.ndarary, y: numbers.Real | numpy.ndarray) -> numbers.Real | numpy.ndarray - :abstractmethod: - - - Evaluation of the point spread function - - :param x: first dimension coordinate to evaluate at - :type x: real number or `np.ndarray` - :param y: second dimension coordinate to evaluate at - :type y: real number or `np.ndarray` - - :returns: the value of the point spread function at (x,y) - :rtype: real number or `np.ndarray` - - - - .. py:property:: parameters - :type: List - - :abstractmethod: - - Varying parameters of the model. - - -.. py:class:: SimplePSF(function: Callable) - - Bases: :py:obj:`PointSpreadFunctionABC` - - - Model for a simple PSF - - - .. py:method:: __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 - - :param x: first dimension coordinate to evaluate at - :type x: real number or `np.ndarray` - :param y: second dimension coordinate to evaluate at - :type y: real number or `np.ndarray` - - :returns: the value of the point spread function at (x,y) - :rtype: real number or `np.ndarray` - - - - .. py:property:: parameters - :type: set[str] - - Varying parameters of the model. - - -.. py:class:: VariedPSF(vary_function: Callable, base_psf: SimplePSF, validate_at_call: bool = True) - - Bases: :py:obj:`PointSpreadFunctionABC` - - - Model for a PSF that varies over the field of view - - - .. py:method:: __call__(x: numbers.Real | numpy.ndarray, y: numbers.Real | numpy.ndarray) -> numbers.Real | numpy.ndarray - - Evaluation of the point spread function - - :param x: first dimension coordinate to evaluate at - :type x: real number or `np.ndarray` - :param y: second dimension coordinate to evaluate at - :type y: real number or `np.ndarray` - - :returns: the value of the point spread function at (x,y) - :rtype: real number or `np.ndarray` - - - - .. py:property:: parameters - :type: List - - Varying parameters of the model. - - .. py:class:: CorrectorABC .. py:method:: save(path: str | pathlib.Path) -> None diff --git a/_sources/autoapi/regularizepsf/fitter/index.rst.txt b/_sources/autoapi/regularizepsf/fitter/index.rst.txt index e0a8e5c..c869857 100644 --- a/_sources/autoapi/regularizepsf/fitter/index.rst.txt +++ b/_sources/autoapi/regularizepsf/fitter/index.rst.txt @@ -12,189 +12,18 @@ Attributes regularizepsf.fitter.CoordinateIdentifier -Exceptions ----------- - -.. autoapisummary:: - - regularizepsf.fitter.InvalidSizeError - - Classes ------- .. autoapisummary:: - regularizepsf.fitter.ArrayCorrector - regularizepsf.fitter.PointSpreadFunctionABC - regularizepsf.fitter.SimplePSF regularizepsf.fitter.PatchCollectionABC regularizepsf.fitter.CoordinatePatchCollection -Functions ---------- - -.. autoapisummary:: - - regularizepsf.fitter.calculate_covering - - Module Contents --------------- -.. py:class:: ArrayCorrector(evaluations: dict[Any, numpy.ndarray], target_evaluation: numpy.ndarray) - - Bases: :py:obj:`CorrectorABC` - - - A PSF corrector that is evaluated as array patches - - - - .. py:property:: evaluations - :type: dict[Any, numpy.ndarray] - - - - .. py:property:: evaluation_points - :type: list - - - - .. py:method:: correct_image(image: numpy.ndarray, size: Optional[int] = None, alpha: float = 0.5, epsilon: float = 0.05) -> numpy.ndarray - - PSF correct an image according to the model - - :param image: image to be corrected - :type image: 2D float np.ndarray - :param size: how big to make the patches when correcting an image, - only used for FunctionalCorrector - :type size: int - :param alpha: controls the “hardness” of the transition from amplification - to attenuation, see notes - :type alpha: float - :param epsilon: controls the maximum of the amplification, see notes - :type epsilon: float - - :returns: a image that has been PSF corrected - :rtype: np.ndarray - - - - .. py:method:: __getitem__(xy: Tuple[int, int]) -> numpy.ndarray - - - .. py:method:: save(path: str) -> None - - Save the model to a file. - - :param path: where to save the model, suggested extension is ".psf" - :type path: str or `pathlib.Path` - - :rtype: None - - - - .. py:method:: load(path: str) -> ArrayCorrector - :classmethod: - - - Loads a model from the path - - :param path: where to load the model from, suggested extension is ".psf" - :type path: str or `pathlib.Path` - - - - .. py:method:: simulate_observation(image: numpy.ndarray) -> numpy.ndarray - - Simulates on a star field what an observation using this PSF looks like - - :param image: image of point source stars to simluate PSF for - :type image: 2D float np.ndarray - - :returns: an image with the PSF applied - :rtype: np.ndarray - - - -.. py:function:: calculate_covering(image_shape: tuple[int, int], size: int) -> numpy.ndarray - - Determines the grid of overlapping neighborhood patches. - - :param image_shape: shape of the image we plan to correct - :type image_shape: tuple of 2 ints - :param size: size of the square patches we want to create - :type size: int - - :returns: an array of shape Nx2 where return[:, 0] - are the x coordinate and return[:, 1] are the y coordinates - :rtype: np.ndarray - - -.. py:exception:: InvalidSizeError - - Bases: :py:obj:`ValidationError` - - - Common base class for all non-exit exceptions. - - -.. py:class:: PointSpreadFunctionABC - - .. py:method:: __call__(x: numbers.Real | numpy.ndarary, y: numbers.Real | numpy.ndarray) -> numbers.Real | numpy.ndarray - :abstractmethod: - - - Evaluation of the point spread function - - :param x: first dimension coordinate to evaluate at - :type x: real number or `np.ndarray` - :param y: second dimension coordinate to evaluate at - :type y: real number or `np.ndarray` - - :returns: the value of the point spread function at (x,y) - :rtype: real number or `np.ndarray` - - - - .. py:property:: parameters - :type: List - - :abstractmethod: - - Varying parameters of the model. - - -.. py:class:: SimplePSF(function: Callable) - - Bases: :py:obj:`PointSpreadFunctionABC` - - - Model for a simple PSF - - - .. py:method:: __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 - - :param x: first dimension coordinate to evaluate at - :type x: real number or `np.ndarray` - :param y: second dimension coordinate to evaluate at - :type y: real number or `np.ndarray` - - :returns: the value of the point spread function at (x,y) - :rtype: real number or `np.ndarray` - - - - .. py:property:: parameters - :type: set[str] - - Varying parameters of the model. - - .. py:class:: PatchCollectionABC(patches: dict[Any, numpy.ndarray], counts: Optional[dict[Any, int]] = None) .. py:method:: __len__() -> int diff --git a/_sources/autoapi/regularizepsf/psf/index.rst.txt b/_sources/autoapi/regularizepsf/psf/index.rst.txt index 5eee647..6bf2757 100644 --- a/_sources/autoapi/regularizepsf/psf/index.rst.txt +++ b/_sources/autoapi/regularizepsf/psf/index.rst.txt @@ -4,15 +4,6 @@ regularizepsf.psf .. py:module:: regularizepsf.psf -Exceptions ----------- - -.. autoapisummary:: - - regularizepsf.psf.PSFParameterValidationError - regularizepsf.psf.VariedPSFParameterMismatchError - - Classes ------- @@ -36,22 +27,6 @@ Functions Module Contents --------------- -.. py:exception:: PSFParameterValidationError - - Bases: :py:obj:`ValidationError` - - - Common base class for all non-exit exceptions. - - -.. py:exception:: VariedPSFParameterMismatchError - - Bases: :py:obj:`ValidationError` - - - Common base class for all non-exit exceptions. - - .. py:class:: PointSpreadFunctionABC .. py:method:: __call__(x: numbers.Real | numpy.ndarary, y: numbers.Real | numpy.ndarray) -> numbers.Real | numpy.ndarray diff --git a/_sources/autoapi/regularizepsf/visualize/index.rst.txt b/_sources/autoapi/regularizepsf/visualize/index.rst.txt index 0cfda39..90cbc7f 100644 --- a/_sources/autoapi/regularizepsf/visualize/index.rst.txt +++ b/_sources/autoapi/regularizepsf/visualize/index.rst.txt @@ -9,19 +9,9 @@ Attributes .. autoapisummary:: - regularizepsf.visualize.CoordinateIdentifier regularizepsf.visualize._colormap -Classes -------- - -.. autoapisummary:: - - regularizepsf.visualize.ArrayCorrector - regularizepsf.visualize.PatchCollectionABC - - Functions --------- @@ -36,250 +26,6 @@ Functions Module Contents --------------- -.. py:class:: ArrayCorrector(evaluations: dict[Any, numpy.ndarray], target_evaluation: numpy.ndarray) - - Bases: :py:obj:`CorrectorABC` - - - A PSF corrector that is evaluated as array patches - - - - .. py:property:: evaluations - :type: dict[Any, numpy.ndarray] - - - - .. py:property:: evaluation_points - :type: list - - - - .. py:method:: correct_image(image: numpy.ndarray, size: Optional[int] = None, alpha: float = 0.5, epsilon: float = 0.05) -> numpy.ndarray - - PSF correct an image according to the model - - :param image: image to be corrected - :type image: 2D float np.ndarray - :param size: how big to make the patches when correcting an image, - only used for FunctionalCorrector - :type size: int - :param alpha: controls the “hardness” of the transition from amplification - to attenuation, see notes - :type alpha: float - :param epsilon: controls the maximum of the amplification, see notes - :type epsilon: float - - :returns: a image that has been PSF corrected - :rtype: np.ndarray - - - - .. py:method:: __getitem__(xy: Tuple[int, int]) -> numpy.ndarray - - - .. py:method:: save(path: str) -> None - - Save the model to a file. - - :param path: where to save the model, suggested extension is ".psf" - :type path: str or `pathlib.Path` - - :rtype: None - - - - .. py:method:: load(path: str) -> ArrayCorrector - :classmethod: - - - Loads a model from the path - - :param path: where to load the model from, suggested extension is ".psf" - :type path: str or `pathlib.Path` - - - - .. py:method:: simulate_observation(image: numpy.ndarray) -> numpy.ndarray - - Simulates on a star field what an observation using this PSF looks like - - :param image: image of point source stars to simluate PSF for - :type image: 2D float np.ndarray - - :returns: an image with the PSF applied - :rtype: np.ndarray - - - -.. py:data:: CoordinateIdentifier - -.. py:class:: PatchCollectionABC(patches: dict[Any, numpy.ndarray], counts: Optional[dict[Any, int]] = None) - - .. py:method:: __len__() -> int - - - .. py:method:: extract(images: list[numpy.ndarray], coordinates: list, size: int) -> PatchCollectionABC - :classmethod: - - :abstractmethod: - - - Construct a PatchCollection from a set of images - using the specified coordinates and patch size - - :param images: the images loaded - :type images: list of np.ndarrays - :param coordinates: - A list of coordinates for the lower left pixel of each patch, - specified in each type of PatchCollection - :type coordinates: list - :param size: size of one side of the square patches extracted - :type size: int - - :returns: the square patches extracted into a PatchCollection - :rtype: np.ndarray - - - - .. py:method:: __getitem__(identifier: Any) -> numpy.ndarray - - Access a patch with square brackets - - :param identifier: identifier for a given patch, specifically implemented - for each PatchCollection - :type identifier: Any - - :returns: a patch's data - :rtype: np.ndarray - - - - .. py:method:: __contains__(identifier: Any) -> bool - - Determines if a patch is in the collection - - :param identifier: - identifier for a given patch, - specifically implemented for each PatchCollection - :type identifier: Any - - :returns: - - True if patch with specified identifier is in the collection, - False otherwise - :rtype: bool - - - - .. py:method:: add(identifier: Any, patch: numpy.ndarray, count: Optional[int] = None) -> None - - Add a new patch to the collection - - :param identifier: - identifier for a given patch, - specifically implemented for each PatchCollection - :type identifier: Any - :param patch: the data for a specific patch - :type patch: np.ndarray - :param count: Optionally, a corresponding item to add to the `counts` dictionary - :type count: int - - :rtype: None - - - - .. py:method:: average(corners: numpy.ndarray, step: int, size: int, mode: str) -> PatchCollectionABC - :abstractmethod: - - - Construct a new PatchCollection where patches - lying inside a new grid are averaged together - - :param corners: an Nx2 `np.ndarray` of the lower left corners of the new patch grid - :type corners: np.ndarray - :param step: how far apart each corner patch is - :type step: int - :param size: dimension of the new (size, size) shaped square patches - :type size: int - :param mode: either average using "mean" or "median" - :type mode: str - - :returns: a PatchCollection where data is sampled at the new grid - :rtype: PatchCollectionABC - - - - .. py:method:: fit(base_psf: regularizepsf.psf.SimplePSF, is_varied: bool = False) -> regularizepsf.psf.PointSpreadFunctionABC - :abstractmethod: - - - :param base_psf: - :param is_varied: - - - - .. py:method:: save(path: str) -> None - :abstractmethod: - - - Save the PatchCollection to a file - - :param path: where to save the patch collection - :type path: str - - :rtype: None - - - - .. py:method:: load(path: str) -> PatchCollectionABC - :classmethod: - - :abstractmethod: - - - Load a PatchCollection from a file - - :param path: file path to load from - :type path: str - - :returns: the new patch collection - :rtype: PatchCollectionABC - - - - .. py:method:: keys() -> List - - Gets identifiers for all patches - - - - .. py:method:: values() -> List - - Gets values of all patches - - - - .. py:method:: items() -> Dict - - A dictionary like iterator over the patches - - - - .. py:method:: _fit_lmfit(base_psf: regularizepsf.psf.SimplePSF, initial_guesses: dict[str, numbers.Real]) -> dict[Any, lmfit.minimizer.MinimizerResult] - - Fit a patch using lmfit - - :param base_psf: the PSF model to use in fitting - :type base_psf: SimplePSF - :param initial_guesses: the initial guesses for all the PSF parameters - :type initial_guesses: dict[str, Real] - - :returns: keys are the identifiers, values are the `MinimizerResults` from lmfit - :rtype: dict - - - .. py:function:: visualize_patch_counts(patch_collection: regularizepsf.fitter.PatchCollectionABC, ax: Optional[matplotlib.axes.Axes] = None, label_pixel_bounds: bool = False) -> matplotlib.axes.Axes Utility to visualize the number of stars identified within each patch diff --git a/_sources/development.rst.txt b/_sources/development.rst.txt index 2b0019f..069d1c0 100644 --- a/_sources/development.rst.txt +++ b/_sources/development.rst.txt @@ -4,7 +4,7 @@ We encourage all contributions. Please see our `contribution guide first `. @@ -12,7 +12,7 @@ Setting up pre-commit ---------------------- The first time you develop code, you'll need to install the pre-commit. This checks that our style is consistent. -It gets installed when you do ``pip install -r requirements_dev.txt`` but then requires you to activate them by +It gets installed when you do ``pip install ".[test]"`` but then requires you to activate them by running ``pre-commit install``. Now everytime you commit, our checks will run first. Building the docs @@ -20,7 +20,7 @@ Building the docs The docs are built using ``sphinx``. First, you must install it and the other documentation requirements with :: pip install -r ./docs/requirements.txt - pip install -r requirements.txt + pip install ".[test]" python setup.py build_ext --inplace Then, navigate to the ``docs`` directory and run ``make html`` to build the docs. diff --git a/autoapi/regularizepsf/corrector/index.html b/autoapi/regularizepsf/corrector/index.html index 0c0a51b..107934e 100644 --- a/autoapi/regularizepsf/corrector/index.html +++ b/autoapi/regularizepsf/corrector/index.html @@ -453,43 +453,17 @@

regularizepsf.corrector#

-
-

Exceptions#

-
- - - - - - - - - - - -

EvaluatedModelInconsistentSizeError

Common base class for all non-exit exceptions.

InvalidSizeError

Common base class for all non-exit exceptions.

UnevaluatedPointError

Common base class for all non-exit exceptions.

-
-

Classes#

- - - - - - - - - - + - + - + @@ -509,128 +483,6 @@

Functions

Module Contents#

-
-
-exception regularizepsf.corrector.EvaluatedModelInconsistentSizeError#
-

Bases: ValidationError

-

Common base class for all non-exit exceptions.

-
- -
-
-exception regularizepsf.corrector.InvalidSizeError#
-

Bases: ValidationError

-

Common base class for all non-exit exceptions.

-
- -
-
-exception regularizepsf.corrector.UnevaluatedPointError#
-

Bases: Exception

-

Common base class for all non-exit exceptions.

-
- -
-
-class regularizepsf.corrector.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.

-
- -
- -
-
-class regularizepsf.corrector.SimplePSF(function: Callable)#
-

Bases: PointSpreadFunctionABC

-

Model for a simple PSF

-
-
-__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.

-
- -
- -
-
-class regularizepsf.corrector.VariedPSF(vary_function: Callable, base_psf: SimplePSF, validate_at_call: bool = True)#
-

Bases: PointSpreadFunctionABC

-

Model for a PSF that varies over the field of view

-
-
-__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.

-
- -
-
class regularizepsf.corrector.CorrectorABC#
@@ -981,28 +833,9 @@

Module Contents

PointSpreadFunctionABC

SimplePSF

Model for a simple PSF

VariedPSF

Model for a PSF that varies over the field of view

CorrectorABC

CorrectorABC

FunctionalCorrector

FunctionalCorrector

A version of the PSF corrector that stores the model as a set of functions.

ArrayCorrector

ArrayCorrector

A PSF corrector that is evaluated as array patches
- - - - - -

InvalidSizeError

Common base class for all non-exit exceptions.

-
-

Classes#

- - - - + - - - - - - - +

ArrayCorrector

A PSF corrector that is evaluated as array patches

PointSpreadFunctionABC

PatchCollectionABC

SimplePSF

Model for a simple PSF

PatchCollectionABC

CoordinatePatchCollection

CoordinatePatchCollection

A representation of a PatchCollection that operates
-
-

Functions#

-
- - - - - -

calculate_covering(→ numpy.ndarray)

Determines the grid of overlapping neighborhood patches.

-
-

Module Contents#

-
-
-class regularizepsf.fitter.ArrayCorrector(evaluations: dict[Any, numpy.ndarray], target_evaluation: numpy.ndarray)#
-

Bases: CorrectorABC

-

A PSF corrector that is evaluated as array patches

-
-
-property evaluations: dict[Any, numpy.ndarray]#
-
- -
-
-property evaluation_points: list#
-
- -
-
-correct_image(image: numpy.ndarray, size: int | None = None, alpha: float = 0.5, epsilon: float = 0.05) → numpy.ndarray#
-

PSF correct an image according to the model

-
-
Parameters:
-
    -

  • image (2D float np.ndarray) – image to be corrected

    • -

  • size (int) – how big to make the patches when correcting an image, -only used for FunctionalCorrector

    • -

  • alpha (float) – controls the “hardness” of the transition from amplification -to attenuation, see notes

    • -

  • epsilon (float) – controls the maximum of the amplification, see notes

    • -
-
-
Returns:
-

a image that has been PSF corrected

-
-
Return type:
-

np.ndarray

-
-
-
- -
-
-__getitem__(xy: Tuple[int, int]) → numpy.ndarray#
-
- -
-
-save(path: str) → None#
-

Save the model to a file.

-
-
Parameters:
-

path (str or pathlib.Path) – where to save the model, suggested extension is “.psf”

-
-
Return type:
-

None

-
-
-
- -
-
-classmethod load(path: str) → ArrayCorrector#
-

Loads a model from the path

-
-
Parameters:
-

path (str or pathlib.Path) – where to load the model from, suggested extension is “.psf”

-
-
-
- -
-
-simulate_observation(image: numpy.ndarray) → numpy.ndarray#
-

Simulates on a star field what an observation using this PSF looks like

-
-
Parameters:
-

image (2D float np.ndarray) – image of point source stars to simluate PSF for

-
-
Returns:
-

an image with the PSF applied

-
-
Return type:
-

np.ndarray

-
-
-
- -
- -
-
-regularizepsf.fitter.calculate_covering(image_shape: tuple[int, int], size: int) → numpy.ndarray#
-

Determines the grid of overlapping neighborhood patches.

-
-
Parameters:
-
    -

  • image_shape (tuple of 2 ints) – shape of the image we plan to correct

    • -

  • size (int) – size of the square patches we want to create

    • -
-
-
Returns:
-

an array of shape Nx2 where return[:, 0] -are the x coordinate and return[:, 1] are the y coordinates

-
-
Return type:
-

np.ndarray

-
-
-
- -
-
-exception regularizepsf.fitter.InvalidSizeError#
-

Bases: ValidationError

-

Common base class for all non-exit exceptions.

-
- -
-
-class regularizepsf.fitter.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.

-
- -
- -
-
-class regularizepsf.fitter.SimplePSF(function: Callable)#
-

Bases: PointSpreadFunctionABC

-

Model for a simple PSF

-
-
-__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.

-
- -
-
class regularizepsf.fitter.PatchCollectionABC(patches: dict[Any, numpy.ndarray], counts: dict[Any, int] | None = None)#
@@ -894,7 +679,7 @@

Module Contents
Parameters:
    -

  • base_psf (SimplePSF) – the PSF model to use in fitting

    • +

  • base_psf (SimplePSF) – the PSF model to use in fitting

  • initial_guesses (dict[str, Real]) – the initial guesses for all the PSF parameters

@@ -1062,7 +847,7 @@

Module Contents

An array corrector that can be used to correct PSFs

Return type:
-

ArrayCorrector

+

ArrayCorrector

@@ -1150,32 +935,8 @@

Module Contents -
  • SimplePSF (class in regularizepsf.corrector) - -
  • simulate_observation() (regularizepsf.ArrayCorrector method)
    • @@ -908,7 +798,7 @@

    T

    U

    @@ -919,27 +809,19 @@

    V

  • ValidationError
  • values() (regularizepsf.fitter.PatchCollectionABC method) - -
  • varied_psf() (in module regularizepsf)
    • -
  • VariedPSF (class in regularizepsf.corrector) - -
      • -
    • VariedPSFParameterMismatchError, [1] -
    • visualize_patch_counts() (in module regularizepsf)
        diff --git a/objects.inv b/objects.inv index cdea26f3399521aa6528739ff57352491313c79a..e78b4e3c7bf0b995421d2bd41479de79ea4320d2 100644 GIT binary patch delta 1186 zcmV;T1YP_23y%treSb}F<2De6@A?%gy4QHy>)ui~i~112SflBYV5G54EJX?=9mMS2efAq2NNQ&$JIl`__(@}gjNdx$@&}364v*V zsHG_nwRbrb!)`M!K(iA7X+5-;s)#{i8rKiS=qrcidyWebVt%@GL(EL4ZiFqU+Yd5{ ziwzTpN^#%NZ`2%w%=Lt?we?E@n_HB>RVYy%7Dtja9%0PV3cK3Zt6~zev>cti#ustsGUvXJd@@?w1M2znndzcBHAmp?nL&WZ^tXmyQ{S5Qj{KV(=Q`Un3ql{#(f9t0@z9@L z(+felwZa#MeQUih2;IL}76j*C3k-rAuMEyO8-IFG?lvILBqRvSGYJX8x~XzFgZzQ# zbzoa0zalskVJH*YtN5`LHmA_Cl*K{ZgM*I)=FLVI7=%e3xoQ z>*$o9aE=cNzi>Ms;a6-2q)O8vl*9b~!NK>R9IC(i^sp-x(EM`R^;+#G3-sgS)ml$E z_kUUwmte}vA;PaH?1kE~D)+$?N+1uldcmF2DaY_bdr}MJhgL7RA3Eh2ey9s;kdr1b zC(AQlqPqTcVKqa)=gfD!sx|Z7u4^%U!UN(j@K`5XTd&o!wZ`MGPm+e4nZ zH+kcO_Qj}fPPNIu z%+wX_B$J~0ih5wyv^A#9U6R8aa9I{0Oy9cKY&-njH6)jES--=egqA)vcL}cjoewyD z1zs6nTCMS>x=fD1%f4WBZ=e5zSIH+&_5}U|p2-4IBZp4=Ey117fiKSwmj_nh*>0-# zMS4#sx^2&x%ZXuc4OC^vVMp6$`y1@+^DR9)z5di~112SflAtV5D(OEF}sg9mMc|Te z<-EJfXh~iHSsUI6I}t^BmDQY9N;dkn;57(!Mke5EGfoQR29e|qyNx9+^+N?2e~}>G z+O`NqJa8@wT4~iCQTg$KGp1p^aKNBm)ZJt`VR=`NniQElk{Y7bVw34nLyHEc`$On) zpJ}6x$m=Qb0DthV1j$uAz(K#4NkxRrh`x$mp#zOr84SZ-R>!dMWp%|f(l~%DpH4I( ztna6)l_m^p?lLIiPBSJzKNCPUw9tWzG6soC?LP!1FAT!x91{Rze42DIMy63W!W1;l z2RYZyhE}hQ;-RN|YR*jNdcZf7wF>=)(#}Dkkz)^V41WwmX`ifk(jo9p%9??67WIn~ zL#yH%Ifn8qjXD%#Y2(2dKa+RH4#fMv9wHdiRNi@t3Zumu4>L%t(J+VHXe>PTGko!+ zgLSs8a&5X)DyY<6mwgnX^SAJxLw$9Ua3*_&NEnp(V-hu#LZQ2cS18a})))|m;jnIG zo7<{gQh&!b#9b2~>}vs}xYRbz#9#*LXiLYXEKaDkfUJoi8U-R!n6jr$)VAAykI;&P zcGQL&DY4t?-|FHTi?+974)te!Ph+C=%b*>#Uq(voe(_u^T5^WYl@{y9v9Q&`aV(A( z-k3k(D%;O}dw}$4*j)z0bC-nG_v11Htk#2etAAPz)-|-}6P0C?EsVfDP^AGD!@nzN zHT1ip&Iyyx1WRehREa;wHD>oG`DIQpc(F;A@wh+0G6)X<_(k3hz;TmcTj*JW9%yHx z+WQb(edk?342tibAP(DihY*EszrBWnv)?^L!7cA4I%JbAC^xGRzOxG6T|{Ad?KL`( z{ePlP2f&94S)~es35y+`x(A z!VR2T^h-0MWpv6dBXu;(uvv0pczLCiT$09-*{Ea@!PIzQF+pC`4?FD z{h_Rt_a90-r@@UJdw}EGF_h+-5)bA1CC2fnx8Yf?Ex*EFU&7oO>y9&XWwd;dd@9msq57mAAhtjh1%PxRK>S~=jq+}_E-)++$pn*{3kXW6@ zGbyeg-%A&c2qt#tpVpzq6I1EZDXnBZ&A5*Il$1!%V#FLe!{JQcr_02Nj zgXyhvOtzXXjQ=FpQ}$G{`QN?qKvlc)NOTz8^rD;<>+khN`+rFRZ@_q6>VMV5wDjb5 z_rl-fjpTB^Vfw=C%tQLv|4X#*AKQSD7hp}{%iXT!0M@B^S^ukkG@Jiwd6$L zKVUg8Ays_dXul;TFAVtle0O=!2|RUqk?un#Pgh>so%JMK&EJ+lM1GvV*xl>i*>}%( cI&w`eecCM-Cv}@W=-zvt-Umwl2mET53VB7zVE_OC diff --git a/searchindex.js b/searchindex.js index f6fd7e6..162ee97 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"API Reference": [[0, "api-reference"]], "Attributes": [[3, "attributes"], [6, "attributes"]], "Build the target PSF": [[10, "build-the-target-psf"]], "Building the ArrayCorrector": [[10, "building-the-arraycorrector"]], "Building the docs": [[9, "building-the-docs"]], "Citation": [[7, "citation"]], "Classes": [[1, "classes"], [3, "classes"], [4, "classes"], [5, "classes"], [6, "classes"]], "Concepts": [[8, "concepts"]], "Contents:": [[12, null]], "Defining input parameters": [[10, "defining-input-parameters"]], "Demo: Correction PUNCH Data": [[10, "demo-correction-punch-data"]], "Demo: correcting DASH image": [[10, "demo-correcting-dash-image"]], "Development": [[9, "development"]], "Distribution of identified stars": [[13, "distribution-of-identified-stars"]], "Examples": [[10, "examples"]], "Exceptions": [[1, "exceptions"], [2, "exceptions"], [3, "exceptions"], [5, "exceptions"]], "Extracted PSFs": [[13, "extracted-psfs"]], "Extracted and Corrected PSFs": [[13, "extracted-and-corrected-psfs"]], "Functions": [[1, "functions"], [3, "functions"], [4, "functions"], [5, "functions"], [6, "functions"]], "Help": [[11, "help"]], "Indices and tables": [[12, "indices-and-tables"]], "Module Contents": [[1, "module-contents"], [2, "module-contents"], [3, "module-contents"], [5, "module-contents"], [6, "module-contents"]], "Overview of the package": [[8, "overview-of-the-package"]], "Overview of the technique": [[8, "overview-of-the-technique"]], "Package Contents": [[4, "package-contents"]], "Performing the correction": [[10, "performing-the-correction"]], "Purpose of the target PSF": [[8, "purpose-of-the-target-psf"]], "Running tests": [[9, "running-tests"]], "Setting up pre-commit": [[9, "setting-up-pre-commit"]], "Submodules": [[4, "submodules"]], "Transfer Kernels": [[13, "transfer-kernels"]], "Visualization": [[13, "visualization"]], "Welcome to regularizepsf!": [[12, "welcome-to-regularizepsf"]], "regularizepsf": [[4, "module-regularizepsf"]], "regularizepsf.corrector": [[1, "module-regularizepsf.corrector"]], "regularizepsf.exceptions": [[2, "module-regularizepsf.exceptions"]], "regularizepsf.fitter": [[3, "module-regularizepsf.fitter"]], "regularizepsf.psf": [[5, "module-regularizepsf.psf"]], "regularizepsf.visualize": [[6, "module-regularizepsf.visualize"]]}, "docnames": ["autoapi/index", "autoapi/regularizepsf/corrector/index", "autoapi/regularizepsf/exceptions/index", "autoapi/regularizepsf/fitter/index", "autoapi/regularizepsf/index", "autoapi/regularizepsf/psf/index", "autoapi/regularizepsf/visualize/index", "cite", "concepts", "development", "examples", "help", "index", "visualization"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["autoapi/index.rst", "autoapi/regularizepsf/corrector/index.rst", "autoapi/regularizepsf/exceptions/index.rst", "autoapi/regularizepsf/fitter/index.rst", "autoapi/regularizepsf/index.rst", "autoapi/regularizepsf/psf/index.rst", "autoapi/regularizepsf/visualize/index.rst", "cite.rst", "concepts.rst", "development.rst", "examples.rst", "help.rst", "index.rst", "visualization.rst"], "indexentries": {"__call__() (regularizepsf.corrector.pointspreadfunctionabc method)": [[1, "regularizepsf.corrector.PointSpreadFunctionABC.__call__", false]], "__call__() (regularizepsf.corrector.simplepsf method)": [[1, "regularizepsf.corrector.SimplePSF.__call__", false]], "__call__() (regularizepsf.corrector.variedpsf method)": [[1, "regularizepsf.corrector.VariedPSF.__call__", false]], "__call__() (regularizepsf.fitter.pointspreadfunctionabc method)": [[3, "regularizepsf.fitter.PointSpreadFunctionABC.__call__", false]], "__call__() (regularizepsf.fitter.simplepsf method)": [[3, "regularizepsf.fitter.SimplePSF.__call__", false]], "__call__() (regularizepsf.psf.pointspreadfunctionabc method)": [[5, "regularizepsf.psf.PointSpreadFunctionABC.__call__", false]], "__call__() (regularizepsf.psf.simplepsf method)": [[5, "regularizepsf.psf.SimplePSF.__call__", false]], "__call__() (regularizepsf.psf.variedpsf method)": [[5, "regularizepsf.psf.VariedPSF.__call__", false]], "__contains__() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.__contains__", false]], "__contains__() (regularizepsf.visualize.patchcollectionabc method)": [[6, "regularizepsf.visualize.PatchCollectionABC.__contains__", false]], "__getitem__() (regularizepsf.arraycorrector method)": [[4, "regularizepsf.ArrayCorrector.__getitem__", false]], "__getitem__() (regularizepsf.corrector.arraycorrector method)": [[1, "regularizepsf.corrector.ArrayCorrector.__getitem__", false]], "__getitem__() (regularizepsf.fitter.arraycorrector method)": [[3, "regularizepsf.fitter.ArrayCorrector.__getitem__", false]], "__getitem__() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.__getitem__", false]], "__getitem__() (regularizepsf.visualize.arraycorrector method)": [[6, "regularizepsf.visualize.ArrayCorrector.__getitem__", false]], "__getitem__() (regularizepsf.visualize.patchcollectionabc method)": [[6, "regularizepsf.visualize.PatchCollectionABC.__getitem__", false]], "__len__() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.__len__", false]], "__len__() (regularizepsf.visualize.patchcollectionabc method)": [[6, "regularizepsf.visualize.PatchCollectionABC.__len__", false]], "_calculate_pad_shape() (regularizepsf.coordinatepatchcollection method)": [[4, "regularizepsf.CoordinatePatchCollection._calculate_pad_shape", false]], "_calculate_pad_shape() (regularizepsf.fitter.coordinatepatchcollection method)": [[3, "regularizepsf.fitter.CoordinatePatchCollection._calculate_pad_shape", false]], "_colormap (in module regularizepsf.visualize)": [[6, "regularizepsf.visualize._colormap", false]], "_fit_lmfit() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC._fit_lmfit", false]], "_fit_lmfit() (regularizepsf.visualize.patchcollectionabc method)": [[6, "regularizepsf.visualize.PatchCollectionABC._fit_lmfit", false]], "_generate_colormap() (in module regularizepsf.visualize)": [[6, "regularizepsf.visualize._generate_colormap", false]], "_validate_average_mode() (regularizepsf.coordinatepatchcollection static method)": [[4, "regularizepsf.CoordinatePatchCollection._validate_average_mode", false]], "_validate_average_mode() (regularizepsf.fitter.coordinatepatchcollection static method)": [[3, "regularizepsf.fitter.CoordinatePatchCollection._validate_average_mode", false]], "_varied_psf() (in module regularizepsf.psf)": [[5, "regularizepsf.psf._varied_psf", false]], "add() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.add", false]], "add() (regularizepsf.visualize.patchcollectionabc method)": [[6, "regularizepsf.visualize.PatchCollectionABC.add", false]], "arraycorrector (class in regularizepsf)": [[4, "regularizepsf.ArrayCorrector", false]], "arraycorrector (class in regularizepsf.corrector)": [[1, "regularizepsf.corrector.ArrayCorrector", false]], "arraycorrector (class in regularizepsf.fitter)": [[3, "regularizepsf.fitter.ArrayCorrector", false]], "arraycorrector (class in regularizepsf.visualize)": [[6, "regularizepsf.visualize.ArrayCorrector", false]], "average() (regularizepsf.coordinatepatchcollection method)": [[4, "regularizepsf.CoordinatePatchCollection.average", false]], "average() (regularizepsf.fitter.coordinatepatchcollection method)": [[3, "regularizepsf.fitter.CoordinatePatchCollection.average", false]], "average() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.average", false]], "average() (regularizepsf.visualize.patchcollectionabc method)": [[6, "regularizepsf.visualize.PatchCollectionABC.average", false]], "calculate_covering() (in module regularizepsf)": [[4, "regularizepsf.calculate_covering", false]], "calculate_covering() (in module regularizepsf.corrector)": [[1, "regularizepsf.corrector.calculate_covering", false]], "calculate_covering() (in module regularizepsf.fitter)": [[3, "regularizepsf.fitter.calculate_covering", false]], "coordinateidentifier (in module regularizepsf.fitter)": [[3, "regularizepsf.fitter.CoordinateIdentifier", false]], "coordinateidentifier (in module regularizepsf.visualize)": [[6, "regularizepsf.visualize.CoordinateIdentifier", false]], "coordinatepatchcollection (class in regularizepsf)": [[4, "regularizepsf.CoordinatePatchCollection", false]], "coordinatepatchcollection (class in regularizepsf.fitter)": [[3, "regularizepsf.fitter.CoordinatePatchCollection", false]], "correct_image() (in module regularizepsf.corrector.arraycorrector)": [[10, "regularizepsf.corrector.ArrayCorrector.correct_image", false]], "correct_image() (regularizepsf.arraycorrector method)": [[4, "regularizepsf.ArrayCorrector.correct_image", false]], "correct_image() (regularizepsf.corrector.arraycorrector method)": [[1, "regularizepsf.corrector.ArrayCorrector.correct_image", false]], "correct_image() (regularizepsf.corrector.correctorabc method)": [[1, "regularizepsf.corrector.CorrectorABC.correct_image", false]], "correct_image() (regularizepsf.corrector.functionalcorrector method)": [[1, "regularizepsf.corrector.FunctionalCorrector.correct_image", false]], "correct_image() (regularizepsf.fitter.arraycorrector method)": [[3, "regularizepsf.fitter.ArrayCorrector.correct_image", false]], "correct_image() (regularizepsf.functionalcorrector method)": [[4, "regularizepsf.FunctionalCorrector.correct_image", false]], "correct_image() (regularizepsf.visualize.arraycorrector method)": [[6, "regularizepsf.visualize.ArrayCorrector.correct_image", false]], "correctorabc (class in regularizepsf.corrector)": [[1, "regularizepsf.corrector.CorrectorABC", false]], "evaluate_to_array_form() (regularizepsf.corrector.functionalcorrector method)": [[1, "regularizepsf.corrector.FunctionalCorrector.evaluate_to_array_form", false]], "evaluate_to_array_form() (regularizepsf.functionalcorrector method)": [[4, "regularizepsf.FunctionalCorrector.evaluate_to_array_form", false]], "evaluatedmodelinconsistentsizeerror": [[1, "regularizepsf.corrector.EvaluatedModelInconsistentSizeError", false], [2, "regularizepsf.exceptions.EvaluatedModelInconsistentSizeError", false]], "evaluation_points (regularizepsf.arraycorrector property)": [[4, "regularizepsf.ArrayCorrector.evaluation_points", false]], "evaluation_points (regularizepsf.corrector.arraycorrector property)": [[1, "regularizepsf.corrector.ArrayCorrector.evaluation_points", false]], "evaluation_points (regularizepsf.fitter.arraycorrector property)": [[3, "regularizepsf.fitter.ArrayCorrector.evaluation_points", false]], "evaluation_points (regularizepsf.visualize.arraycorrector property)": [[6, "regularizepsf.visualize.ArrayCorrector.evaluation_points", false]], "evaluations (regularizepsf.arraycorrector property)": [[4, "regularizepsf.ArrayCorrector.evaluations", false]], "evaluations (regularizepsf.corrector.arraycorrector property)": [[1, "regularizepsf.corrector.ArrayCorrector.evaluations", false]], "evaluations (regularizepsf.fitter.arraycorrector property)": [[3, "regularizepsf.fitter.ArrayCorrector.evaluations", false]], "evaluations (regularizepsf.visualize.arraycorrector property)": [[6, "regularizepsf.visualize.ArrayCorrector.evaluations", false]], "extract() (regularizepsf.coordinatepatchcollection class method)": [[4, "regularizepsf.CoordinatePatchCollection.extract", false]], "extract() (regularizepsf.fitter.coordinatepatchcollection class method)": [[3, "regularizepsf.fitter.CoordinatePatchCollection.extract", false]], "extract() (regularizepsf.fitter.patchcollectionabc class method)": [[3, "regularizepsf.fitter.PatchCollectionABC.extract", false]], "extract() (regularizepsf.visualize.patchcollectionabc class method)": [[6, "regularizepsf.visualize.PatchCollectionABC.extract", false]], "find_stars_and_average() (in module regularizepsf.fitter.coordinatepatchcollection)": [[10, "regularizepsf.fitter.CoordinatePatchCollection.find_stars_and_average", false]], "find_stars_and_average() (regularizepsf.coordinatepatchcollection class method)": [[4, "regularizepsf.CoordinatePatchCollection.find_stars_and_average", false]], "find_stars_and_average() (regularizepsf.fitter.coordinatepatchcollection class method)": [[3, "regularizepsf.fitter.CoordinatePatchCollection.find_stars_and_average", false]], "fit() (regularizepsf.coordinatepatchcollection method)": [[4, "regularizepsf.CoordinatePatchCollection.fit", false]], "fit() (regularizepsf.fitter.coordinatepatchcollection method)": [[3, "regularizepsf.fitter.CoordinatePatchCollection.fit", false]], "fit() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.fit", false]], "fit() (regularizepsf.visualize.patchcollectionabc method)": [[6, "regularizepsf.visualize.PatchCollectionABC.fit", false]], "functionalcorrector (class in regularizepsf)": [[4, "regularizepsf.FunctionalCorrector", false]], "functionalcorrector (class in regularizepsf.corrector)": [[1, "regularizepsf.corrector.FunctionalCorrector", false]], "invalidsizeerror": [[1, "regularizepsf.corrector.InvalidSizeError", false], [2, "regularizepsf.exceptions.InvalidSizeError", false], [3, "regularizepsf.fitter.InvalidSizeError", false]], "is_variable (regularizepsf.corrector.functionalcorrector property)": [[1, "regularizepsf.corrector.FunctionalCorrector.is_variable", false]], "is_variable (regularizepsf.functionalcorrector property)": [[4, "regularizepsf.FunctionalCorrector.is_variable", false]], "items() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.items", false]], "items() (regularizepsf.visualize.patchcollectionabc method)": [[6, "regularizepsf.visualize.PatchCollectionABC.items", false]], "keys() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.keys", false]], "keys() (regularizepsf.visualize.patchcollectionabc method)": [[6, "regularizepsf.visualize.PatchCollectionABC.keys", false]], "load() (regularizepsf.arraycorrector class method)": [[4, "regularizepsf.ArrayCorrector.load", false]], "load() (regularizepsf.coordinatepatchcollection class method)": [[4, "regularizepsf.CoordinatePatchCollection.load", false]], "load() (regularizepsf.corrector.arraycorrector class method)": [[1, "regularizepsf.corrector.ArrayCorrector.load", false]], "load() (regularizepsf.corrector.correctorabc class method)": [[1, "regularizepsf.corrector.CorrectorABC.load", false]], "load() (regularizepsf.corrector.functionalcorrector class method)": [[1, "regularizepsf.corrector.FunctionalCorrector.load", false]], "load() (regularizepsf.fitter.arraycorrector class method)": [[3, "regularizepsf.fitter.ArrayCorrector.load", false]], "load() (regularizepsf.fitter.coordinatepatchcollection class method)": [[3, "regularizepsf.fitter.CoordinatePatchCollection.load", false]], "load() (regularizepsf.fitter.patchcollectionabc class method)": [[3, "regularizepsf.fitter.PatchCollectionABC.load", false]], "load() (regularizepsf.functionalcorrector class method)": [[4, "regularizepsf.FunctionalCorrector.load", false]], "load() (regularizepsf.visualize.arraycorrector class method)": [[6, "regularizepsf.visualize.ArrayCorrector.load", false]], "load() (regularizepsf.visualize.patchcollectionabc class method)": [[6, "regularizepsf.visualize.PatchCollectionABC.load", false]], "module": [[1, "module-regularizepsf.corrector", false], [2, "module-regularizepsf.exceptions", false], [3, "module-regularizepsf.fitter", false], [4, "module-regularizepsf", false], [5, "module-regularizepsf.psf", false], [6, "module-regularizepsf.visualize", false]], "parameters (regularizepsf.corrector.pointspreadfunctionabc property)": [[1, "regularizepsf.corrector.PointSpreadFunctionABC.parameters", false]], "parameters (regularizepsf.corrector.simplepsf property)": [[1, "regularizepsf.corrector.SimplePSF.parameters", false]], "parameters (regularizepsf.corrector.variedpsf property)": [[1, "regularizepsf.corrector.VariedPSF.parameters", false]], "parameters (regularizepsf.fitter.pointspreadfunctionabc property)": [[3, "regularizepsf.fitter.PointSpreadFunctionABC.parameters", false]], "parameters (regularizepsf.fitter.simplepsf property)": [[3, "regularizepsf.fitter.SimplePSF.parameters", false]], "parameters (regularizepsf.psf.pointspreadfunctionabc property)": [[5, "regularizepsf.psf.PointSpreadFunctionABC.parameters", false]], "parameters (regularizepsf.psf.simplepsf property)": [[5, "regularizepsf.psf.SimplePSF.parameters", false]], "parameters (regularizepsf.psf.variedpsf property)": [[5, "regularizepsf.psf.VariedPSF.parameters", false]], "patchcollectionabc (class in regularizepsf.fitter)": [[3, "regularizepsf.fitter.PatchCollectionABC", false]], "patchcollectionabc (class in regularizepsf.visualize)": [[6, "regularizepsf.visualize.PatchCollectionABC", false]], "pointspreadfunctionabc (class in regularizepsf.corrector)": [[1, "regularizepsf.corrector.PointSpreadFunctionABC", false]], "pointspreadfunctionabc (class in regularizepsf.fitter)": [[3, "regularizepsf.fitter.PointSpreadFunctionABC", false]], "pointspreadfunctionabc (class in regularizepsf.psf)": [[5, "regularizepsf.psf.PointSpreadFunctionABC", false]], "psfparametervalidationerror": [[2, "regularizepsf.exceptions.PSFParameterValidationError", false], [5, "regularizepsf.psf.PSFParameterValidationError", false]], "regularizepsf": [[4, "module-regularizepsf", false]], "regularizepsf.corrector": [[1, "module-regularizepsf.corrector", false]], "regularizepsf.exceptions": [[2, "module-regularizepsf.exceptions", false]], "regularizepsf.fitter": [[3, "module-regularizepsf.fitter", false]], "regularizepsf.psf": [[5, "module-regularizepsf.psf", false]], "regularizepsf.visualize": [[6, "module-regularizepsf.visualize", false]], "save() (regularizepsf.arraycorrector method)": [[4, "regularizepsf.ArrayCorrector.save", false]], "save() (regularizepsf.coordinatepatchcollection method)": [[4, "regularizepsf.CoordinatePatchCollection.save", false]], "save() (regularizepsf.corrector.arraycorrector method)": [[1, "regularizepsf.corrector.ArrayCorrector.save", false]], "save() (regularizepsf.corrector.correctorabc method)": [[1, "regularizepsf.corrector.CorrectorABC.save", false]], "save() (regularizepsf.corrector.functionalcorrector method)": [[1, "regularizepsf.corrector.FunctionalCorrector.save", false]], "save() (regularizepsf.fitter.arraycorrector method)": [[3, "regularizepsf.fitter.ArrayCorrector.save", false]], "save() (regularizepsf.fitter.coordinatepatchcollection method)": [[3, "regularizepsf.fitter.CoordinatePatchCollection.save", false]], "save() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.save", false]], "save() (regularizepsf.functionalcorrector method)": [[4, "regularizepsf.FunctionalCorrector.save", false]], "save() (regularizepsf.visualize.arraycorrector method)": [[6, "regularizepsf.visualize.ArrayCorrector.save", false]], "save() (regularizepsf.visualize.patchcollectionabc method)": [[6, "regularizepsf.visualize.PatchCollectionABC.save", false]], "simple_psf() (in module regularizepsf)": [[4, "regularizepsf.simple_psf", false]], "simple_psf() (in module regularizepsf.psf)": [[5, "regularizepsf.psf.simple_psf", false]], "simplepsf (class in regularizepsf.corrector)": [[1, "regularizepsf.corrector.SimplePSF", false]], "simplepsf (class in regularizepsf.fitter)": [[3, "regularizepsf.fitter.SimplePSF", false]], "simplepsf (class in regularizepsf.psf)": [[5, "regularizepsf.psf.SimplePSF", false]], "simulate_observation() (regularizepsf.arraycorrector method)": [[4, "regularizepsf.ArrayCorrector.simulate_observation", false]], "simulate_observation() (regularizepsf.corrector.arraycorrector method)": [[1, "regularizepsf.corrector.ArrayCorrector.simulate_observation", false]], "simulate_observation() (regularizepsf.corrector.correctorabc method)": [[1, "regularizepsf.corrector.CorrectorABC.simulate_observation", false]], "simulate_observation() (regularizepsf.corrector.functionalcorrector method)": [[1, "regularizepsf.corrector.FunctionalCorrector.simulate_observation", false]], "simulate_observation() (regularizepsf.fitter.arraycorrector method)": [[3, "regularizepsf.fitter.ArrayCorrector.simulate_observation", false]], "simulate_observation() (regularizepsf.functionalcorrector method)": [[4, "regularizepsf.FunctionalCorrector.simulate_observation", false]], "simulate_observation() (regularizepsf.visualize.arraycorrector method)": [[6, "regularizepsf.visualize.ArrayCorrector.simulate_observation", false]], "to_array_corrector() (regularizepsf.coordinatepatchcollection method)": [[4, "regularizepsf.CoordinatePatchCollection.to_array_corrector", false]], "to_array_corrector() (regularizepsf.fitter.coordinatepatchcollection method)": [[3, "regularizepsf.fitter.CoordinatePatchCollection.to_array_corrector", false]], "unevaluatedpointerror": [[1, "regularizepsf.corrector.UnevaluatedPointError", false], [2, "regularizepsf.exceptions.UnevaluatedPointError", false]], "validationerror": [[2, "regularizepsf.exceptions.ValidationError", false]], "values() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.values", false]], "values() (regularizepsf.visualize.patchcollectionabc method)": [[6, "regularizepsf.visualize.PatchCollectionABC.values", false]], "varied_psf() (in module regularizepsf)": [[4, "regularizepsf.varied_psf", false]], "varied_psf() (in module regularizepsf.psf)": [[5, "regularizepsf.psf.varied_psf", false]], "variedpsf (class in regularizepsf.corrector)": [[1, "regularizepsf.corrector.VariedPSF", false]], "variedpsf (class in regularizepsf.psf)": [[5, "regularizepsf.psf.VariedPSF", false]], "variedpsfparametermismatcherror": [[2, "regularizepsf.exceptions.VariedPSFParameterMismatchError", false], [5, "regularizepsf.psf.VariedPSFParameterMismatchError", false]], "visualize_patch_counts() (in module regularizepsf)": [[4, "regularizepsf.visualize_patch_counts", false]], "visualize_patch_counts() (in module regularizepsf.visualize)": [[6, "regularizepsf.visualize.visualize_patch_counts", false]], "visualize_psfs() (in module regularizepsf)": [[4, "regularizepsf.visualize_PSFs", false]], "visualize_psfs() (in module regularizepsf.visualize)": [[6, "regularizepsf.visualize.visualize_PSFs", false]], "visualize_transfer_kernels() (in module regularizepsf)": [[4, "regularizepsf.visualize_transfer_kernels", false]], "visualize_transfer_kernels() (in module regularizepsf.visualize)": [[6, "regularizepsf.visualize.visualize_transfer_kernels", false]]}, "objects": {"": [[4, 0, 0, "-", "regularizepsf"]], "regularizepsf": [[4, 1, 1, "", "ArrayCorrector"], [4, 1, 1, "", "CoordinatePatchCollection"], [4, 1, 1, "", "FunctionalCorrector"], [4, 4, 1, "", "calculate_covering"], [1, 0, 0, "-", "corrector"], [2, 0, 0, "-", "exceptions"], [3, 0, 0, "-", "fitter"], [5, 0, 0, "-", "psf"], [4, 4, 1, "", "simple_psf"], [4, 4, 1, "", "varied_psf"], [6, 0, 0, "-", "visualize"], [4, 4, 1, "", "visualize_PSFs"], [4, 4, 1, "", "visualize_patch_counts"], [4, 4, 1, "", "visualize_transfer_kernels"]], "regularizepsf.ArrayCorrector": [[4, 2, 1, "", "__getitem__"], [4, 2, 1, "", "correct_image"], [4, 3, 1, "", "evaluation_points"], [4, 3, 1, "", "evaluations"], [4, 2, 1, "", "load"], [4, 2, 1, "", "save"], [4, 2, 1, "", "simulate_observation"]], "regularizepsf.CoordinatePatchCollection": [[4, 2, 1, "", "_calculate_pad_shape"], [4, 2, 1, "", "_validate_average_mode"], [4, 2, 1, "", "average"], [4, 2, 1, "", "extract"], [4, 2, 1, "", "find_stars_and_average"], [4, 2, 1, "", "fit"], [4, 2, 1, "", "load"], [4, 2, 1, "", "save"], [4, 2, 1, "", "to_array_corrector"]], "regularizepsf.FunctionalCorrector": [[4, 2, 1, "", "correct_image"], [4, 2, 1, "", "evaluate_to_array_form"], [4, 3, 1, "", "is_variable"], [4, 2, 1, "", "load"], [4, 2, 1, "", "save"], [4, 2, 1, "", "simulate_observation"]], "regularizepsf.corrector": [[1, 1, 1, "", "ArrayCorrector"], [1, 1, 1, "", "CorrectorABC"], [1, 5, 1, "", "EvaluatedModelInconsistentSizeError"], [1, 1, 1, "", "FunctionalCorrector"], [1, 5, 1, "", "InvalidSizeError"], [1, 1, 1, "", "PointSpreadFunctionABC"], [1, 1, 1, "", "SimplePSF"], [1, 5, 1, "", "UnevaluatedPointError"], [1, 1, 1, "", "VariedPSF"], [1, 4, 1, "", "calculate_covering"]], "regularizepsf.corrector.ArrayCorrector": [[1, 2, 1, "", "__getitem__"], [10, 4, 1, "", "correct_image"], [1, 3, 1, "", "evaluation_points"], [1, 3, 1, "", "evaluations"], [1, 2, 1, "", "load"], [1, 2, 1, "", "save"], [1, 2, 1, "", "simulate_observation"]], "regularizepsf.corrector.CorrectorABC": [[1, 2, 1, "", "correct_image"], [1, 2, 1, "", "load"], [1, 2, 1, "", "save"], [1, 2, 1, "", "simulate_observation"]], "regularizepsf.corrector.FunctionalCorrector": [[1, 2, 1, "", "correct_image"], [1, 2, 1, "", "evaluate_to_array_form"], [1, 3, 1, "", "is_variable"], [1, 2, 1, "", "load"], [1, 2, 1, "", "save"], [1, 2, 1, "", "simulate_observation"]], "regularizepsf.corrector.PointSpreadFunctionABC": [[1, 2, 1, "", "__call__"], [1, 3, 1, "", "parameters"]], "regularizepsf.corrector.SimplePSF": [[1, 2, 1, "", "__call__"], [1, 3, 1, "", "parameters"]], "regularizepsf.corrector.VariedPSF": [[1, 2, 1, "", "__call__"], [1, 3, 1, "", "parameters"]], "regularizepsf.exceptions": [[2, 5, 1, "", "EvaluatedModelInconsistentSizeError"], [2, 5, 1, "", "InvalidSizeError"], [2, 5, 1, "", "PSFParameterValidationError"], [2, 5, 1, "", "UnevaluatedPointError"], [2, 5, 1, "", "ValidationError"], [2, 5, 1, "", "VariedPSFParameterMismatchError"]], "regularizepsf.fitter": [[3, 1, 1, "", "ArrayCorrector"], [3, 6, 1, "", "CoordinateIdentifier"], [3, 1, 1, "", "CoordinatePatchCollection"], [3, 5, 1, "", "InvalidSizeError"], [3, 1, 1, "", "PatchCollectionABC"], [3, 1, 1, "", "PointSpreadFunctionABC"], [3, 1, 1, "", "SimplePSF"], [3, 4, 1, "", "calculate_covering"]], "regularizepsf.fitter.ArrayCorrector": [[3, 2, 1, "", "__getitem__"], [3, 2, 1, "", "correct_image"], [3, 3, 1, "", "evaluation_points"], [3, 3, 1, "", "evaluations"], [3, 2, 1, "", "load"], [3, 2, 1, "", "save"], [3, 2, 1, "", "simulate_observation"]], "regularizepsf.fitter.CoordinatePatchCollection": [[3, 2, 1, "", "_calculate_pad_shape"], [3, 2, 1, "", "_validate_average_mode"], [3, 2, 1, "", "average"], [3, 2, 1, "", "extract"], [10, 4, 1, "", "find_stars_and_average"], [3, 2, 1, "", "fit"], [3, 2, 1, "", "load"], [3, 2, 1, "", "save"], [3, 2, 1, "", "to_array_corrector"]], "regularizepsf.fitter.PatchCollectionABC": [[3, 2, 1, "", "__contains__"], [3, 2, 1, "", "__getitem__"], [3, 2, 1, "", "__len__"], [3, 2, 1, "", "_fit_lmfit"], [3, 2, 1, "", "add"], [3, 2, 1, "", "average"], [3, 2, 1, "", "extract"], [3, 2, 1, "", "fit"], [3, 2, 1, "", "items"], [3, 2, 1, "", "keys"], [3, 2, 1, "", "load"], [3, 2, 1, "", "save"], [3, 2, 1, "", "values"]], "regularizepsf.fitter.PointSpreadFunctionABC": [[3, 2, 1, "", "__call__"], [3, 3, 1, "", "parameters"]], "regularizepsf.fitter.SimplePSF": [[3, 2, 1, "", "__call__"], [3, 3, 1, "", "parameters"]], "regularizepsf.psf": [[5, 5, 1, "", "PSFParameterValidationError"], [5, 1, 1, "", "PointSpreadFunctionABC"], [5, 1, 1, "", "SimplePSF"], [5, 1, 1, "", "VariedPSF"], [5, 5, 1, "", "VariedPSFParameterMismatchError"], [5, 4, 1, "", "_varied_psf"], [5, 4, 1, "", "simple_psf"], [5, 4, 1, "", "varied_psf"]], "regularizepsf.psf.PointSpreadFunctionABC": [[5, 2, 1, "", "__call__"], [5, 3, 1, "", "parameters"]], "regularizepsf.psf.SimplePSF": [[5, 2, 1, "", "__call__"], [5, 3, 1, "", "parameters"]], "regularizepsf.psf.VariedPSF": [[5, 2, 1, "", "__call__"], [5, 3, 1, "", "parameters"]], "regularizepsf.visualize": [[6, 1, 1, "", "ArrayCorrector"], [6, 6, 1, "", "CoordinateIdentifier"], [6, 1, 1, "", "PatchCollectionABC"], [6, 6, 1, "", "_colormap"], [6, 4, 1, "", "_generate_colormap"], [6, 4, 1, "", "visualize_PSFs"], [6, 4, 1, "", "visualize_patch_counts"], [6, 4, 1, "", "visualize_transfer_kernels"]], "regularizepsf.visualize.ArrayCorrector": [[6, 2, 1, "", "__getitem__"], [6, 2, 1, "", "correct_image"], [6, 3, 1, "", "evaluation_points"], [6, 3, 1, "", "evaluations"], [6, 2, 1, "", "load"], [6, 2, 1, "", "save"], [6, 2, 1, "", "simulate_observation"]], "regularizepsf.visualize.PatchCollectionABC": [[6, 2, 1, "", "__contains__"], [6, 2, 1, "", "__getitem__"], [6, 2, 1, "", "__len__"], [6, 2, 1, "", "_fit_lmfit"], [6, 2, 1, "", "add"], [6, 2, 1, "", "average"], [6, 2, 1, "", "extract"], [6, 2, 1, "", "fit"], [6, 2, 1, "", "items"], [6, 2, 1, "", "keys"], [6, 2, 1, "", "load"], [6, 2, 1, "", "save"], [6, 2, 1, "", "values"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "function", "Python function"], "5": ["py", "exception", "Python exception"], "6": ["py", "data", "Python data"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:function", "5": "py:exception", "6": "py:data"}, "terms": {"": [3, 4, 6, 9, 10, 11, 13], "0": [1, 3, 4, 6, 10, 13], "05": [1, 3, 4, 6, 10], "1": [0, 1, 3, 4, 6, 10, 13], "10": [3, 4, 7, 10], "100": [3, 4, 10], "10066960": 7, "1538": 7, "16": 13, "165": 7, "2": [1, 3, 4, 10, 13], "2023": [7, 10], "204": 7, "25": 10, "256": [10, 13], "256x256": 10, "2d": [1, 3, 4, 6, 10], "3": [3, 4, 10, 13], "32": 10, "32x32": 10, "355": 10, "3847": 7, "3881": 7, "4": [10, 13], "5": [1, 3, 4, 6, 7, 10, 13], "6": 13, "8": 13, "A": [1, 3, 4, 6, 8, 10, 13], "As": 10, "By": 13, "For": [1, 4, 8, 10], "If": [3, 4, 6, 7, 9, 10, 11], "In": [10, 13], "It": [7, 9, 10, 12, 13], "The": [3, 4, 6, 7, 8, 9, 10, 12, 13], "Then": [8, 9], "These": [4, 6, 8, 10], "To": [4, 6, 7, 8, 9], "__call__": [1, 3, 5], "__contains__": [3, 6], "__getitem__": [1, 3, 4, 6], "__len__": [3, 6], "_calculate_pad_shap": [3, 4], "_colormap": 6, "_fit_lmfit": [3, 6], "_generate_colormap": 6, "_validate_average_mod": [3, 4], "_varied_psf": 5, "about": 10, "abstract": [1, 3, 4, 5, 6], "abstractmethod": [1, 3, 4, 5, 6], "acc578": 7, "accept": [4, 6, 13], "access": [3, 6], "accompani": 10, "accord": [1, 3, 4, 6, 10], "across": [1, 4, 6, 8, 10, 13], "activ": 9, "actual": [1, 4, 13], "ad": 8, "add": [3, 6], "addit": [4, 6], "adequ": 13, "after": [4, 6, 10], "again": 13, "aim": 10, "airglow": 10, "align": [3, 4, 10], "all": [1, 2, 3, 4, 5, 6, 9, 10, 11, 13], "all_patch": [4, 6], "alpha": [1, 3, 4, 6, 10, 13], "also": [4, 6, 7, 8, 10, 13], "alwai": 7, "american": 7, "amplif": [1, 3, 4, 6, 10], "amplitud": [4, 6], "an": [1, 3, 4, 6, 8, 10, 11, 12, 13], "ani": [1, 3, 4, 5, 6, 8, 9], "apart": [3, 4, 6], "api": [3, 4, 10, 12], "appear": 13, "appli": [1, 3, 4, 6, 8, 10, 13], "applic": 10, "apr": 7, "ar": [1, 3, 4, 6, 8, 9, 10, 12, 13], "arang": 10, "arg": [4, 5], "argument": [4, 6, 13], "arrai": [1, 3, 4, 6, 10], "array_corrector": [10, 13], "arraycorrector": [1, 3, 4, 6, 8, 13], "articl": 7, "artifact": 13, "assist": 8, "associ": [7, 8], "astronom": [7, 8, 12], "astropi": 10, "astyp": [10, 13], "attenu": [1, 3, 4, 6, 10], "author": 7, "auto": 0, "autoapi": 0, "avail": 13, "averag": [3, 4, 6, 10], "average_mod": [3, 4, 10], "ax": [4, 6, 13], "axis_border_color": [4, 6], "b": [7, 12], "back": 13, "background": 13, "base": [1, 2, 3, 4, 5, 6, 9], "base_psf": [1, 3, 4, 5, 6], "baselin": 9, "basic": 8, "becaus": [8, 10], "been": [1, 3, 4, 6, 10, 13], "befor": [4, 6, 10], "begin": 8, "behav": 8, "being": [3, 4, 6, 10, 13], "below": [8, 12], "benefit": 11, "better": 8, "big": [1, 3, 4, 6, 10], "bin": 9, "black": [4, 6], "bool": [1, 3, 4, 5, 6], "boolean": [4, 6], "both": [4, 6, 10], "box": [1, 4, 10], "bracket": [3, 6], "break": 10, "bright": [4, 6], "bug": 11, "build": [3, 4, 12], "build_ext": 9, "built": [3, 4, 9, 10], "c": 12, "calcul": 8, "calculate_cov": [1, 3, 4], "call": [4, 6], "callabl": [1, 3, 5], "can": [3, 4, 6, 8, 9, 10, 11, 13], "case": 10, "center": [8, 10], "central": [4, 6], "chang": [1, 4], "check": 9, "citat": 12, "cite": 7, "class": 2, "classmethod": [1, 3, 4, 6], "code": [9, 11], "collect": [3, 4, 6, 10], "color": [4, 6], "colorbar": [4, 6], "colorbar_label": [4, 6], "column": 13, "coma": 7, "combin": [3, 4, 10, 13], "command": 9, "commit": 12, "common": [1, 2, 3, 4, 5, 10], "commonli": 8, "compact": 10, "compar": 9, "comparison": [9, 13], "compon": [8, 10], "compress": [3, 4, 10], "comput": [4, 6, 8, 10, 13], "concept": [10, 12], "confer": 10, "consist": 9, "construct": [3, 4, 6, 10], "contact": 9, "contain": [0, 4, 6], "contribut": [9, 10], "control": [1, 3, 4, 6, 10], "conveni": [4, 6], "convert": [3, 4, 8, 10, 13], "convolut": [8, 12, 13], "convolv": [8, 13], "coordin": [1, 3, 4, 5, 6], "coordinate_patch_collect": 10, "coordinateidentifi": [3, 4, 6], "coordinatepatchcollect": [3, 4, 6, 8, 10, 13], "corner": [3, 4, 6], "correct": [1, 3, 4, 6, 8, 12], "correct_imag": [1, 3, 4, 6, 8, 10, 13], "corrector": [0, 3, 4, 6, 8, 10], "correctorabc": [1, 3, 4, 6], "correspond": [3, 4, 6, 10, 13], "could": [3, 4, 8, 10], "count": [3, 4, 6, 13], "cover": [4, 6], "cpc": 13, "cpc_after": 13, "craig": 7, "creat": [0, 1, 3, 4, 6, 8, 9, 10], "cryptic": 10, "cython": [8, 12], "d": 12, "daniel": 7, "dash": 12, "data": [3, 4, 6, 12], "date": 7, "de": 13, "decor": 10, "deepnot": 10, "def": [10, 13], "default": [3, 4, 10, 13], "deforest": 7, "degre": 13, "demand": 13, "demo": 12, "demonstr": [8, 10], "deriv": [8, 10], "describ": 8, "descript": 10, "detail": [3, 4, 10], "determin": [1, 3, 4, 6, 10, 12], "develop": 12, "diagnos": [4, 6, 13], "dict": [1, 3, 4, 5, 6, 13], "dictionari": [3, 6], "differ": 8, "dimens": [1, 3, 4, 5, 6], "dimension": 13, "direct": 12, "directli": [8, 10], "directori": 9, "discuss": 11, "disk": 13, "displai": 13, "distribut": 12, "do": [4, 6, 8, 9, 10], "doc": 12, "document": [0, 9, 12], "doi": 7, "done": [8, 10, 13], "down": [3, 4, 6, 10], "dramat": [3, 4, 10], "dtype": 10, "dure": [3, 4, 10], "dx": 7, "e": [7, 8, 10], "each": [3, 4, 6, 10, 13], "easili": 13, "edg": [4, 6, 8], "effect": 13, "effici": 10, "either": [3, 4, 6, 10], "els": [10, 11], "email": 11, "empti": [4, 6], "en": [3, 4, 10], "encount": 11, "encourag": [9, 11], "end": 9, "endian": 10, "entir": [4, 6], "environ": 9, "epsilon": [1, 3, 4, 6, 10, 13], "equat": 10, "error": 10, "estim": [4, 6, 13], "etc": 13, "evalu": [1, 3, 4, 5, 6, 10], "evaluate_to_array_form": [1, 4], "evaluatedmodelinconsistentsizeerror": [1, 2], "evaluation_point": [1, 3, 4, 6], "evelop": 9, "everi": [4, 6, 13], "everyon": 11, "everyth": 10, "everytim": 9, "everywher": 8, "exampl": [8, 12, 13], "except": [0, 4], "execut": [3, 4, 10], "exercis": 13, "exhibit": 10, "exit": [1, 2, 3, 5], "exp": 10, "extens": [1, 3, 4, 6], "extract": [3, 4, 6, 10, 12], "factor": [3, 4, 6, 10], "fail": 9, "fals": [1, 3, 4, 6], "far": [3, 4, 6], "faster": 8, "few": 8, "fft": 8, "field": [1, 3, 4, 5, 6], "fig": [4, 6], "fig_scal": [4, 6, 13], "figsiz": 13, "figur": [4, 6, 13], "file": [1, 3, 4, 6, 8, 9, 13], "filenam": [3, 4, 10], "fill": 10, "final": [8, 10, 12], "find": [3, 4, 10, 13], "find_stars_and_averag": [3, 4, 6, 8, 10, 13], "first": [1, 3, 4, 5, 9, 10, 11], "fit": [3, 4, 6, 8, 10, 13], "fitter": [0, 4, 6, 8, 10], "float": [1, 3, 4, 6, 10, 13], "fname": 13, "follow": [9, 13], "form": [1, 4, 10], "four": [4, 6, 13], "fourier": [8, 13], "fourth": [4, 6], "friendli": 11, "from": [1, 3, 4, 6, 8, 10, 11, 13], "full": 10, "function": [7, 8, 10, 12, 13], "functionalcorrector": [1, 3, 4, 6, 10], "futur": 10, "fwhm": 10, "g": 8, "gamma": [10, 12], "gaussian": [8, 10], "gca": 13, "gener": [0, 3, 4, 6, 9, 10, 13], "get": [3, 6, 9], "getdata": 13, "github": 11, "given": [3, 6], "grid": [1, 3, 4, 6], "guess": [3, 6], "guid": 9, "guidelin": 9, "ha": [1, 3, 4, 6, 7, 8, 10, 13], "half": 10, "hand": 13, "handl": 10, "hard": [1, 3, 4, 6, 8, 10], "have": [10, 13], "hdu": [3, 4, 10], "hdu_choic": [3, 4, 10], "hdul": 10, "heliospher": 10, "help": [12, 13], "helper": 8, "here": [9, 10], "highlight": [10, 12], "histogram": 13, "homogen": 8, "how": [1, 3, 4, 6, 8, 10], "howev": 10, "html": [3, 4, 9, 10], "http": [3, 4, 7, 10], "hugh": 7, "hughes_2023": 7, "i": [1, 3, 4, 6, 8, 9, 10, 11, 12, 13], "identifi": [3, 4, 6, 12], "illustr": [4, 6, 13], "imag": [1, 3, 4, 6, 8, 9, 12, 13], "image_fn": [10, 13], "image_shap": [1, 3, 4], "implement": [3, 6], "import": [10, 13], "improv": [10, 12], "imshow": [4, 6], "imshow_arg": [4, 6, 13], "includ": [8, 9, 13], "index": 12, "indic": 10, "initi": [3, 6, 12], "initial_guess": [3, 6], "inplac": 9, "input": 13, "inquiri": 11, "insid": [3, 4, 6], "instal": 9, "instead": [8, 10], "instrument": [10, 13], "int": [1, 3, 4, 6, 10], "interpolation_scal": [3, 4, 10], "invalidsizeerror": [1, 2, 3], "invers": 8, "invert": 8, "io": [3, 4, 10], "iop": 7, "iopscienc": 7, "is_vari": [1, 3, 4, 6], "issu": [9, 11], "item": [3, 6], "iter": [3, 6], "its": 13, "j": 7, "journal": [7, 8, 12], "kei": [3, 6], "kernel": [4, 6, 12], "kind": [3, 4], "know": 10, "kwarg": [1, 3, 5], "label": [4, 6], "label_pixel_bound": [4, 6], "larg": [1, 3, 4, 10, 13], "larger": 13, "least": 10, "left": [3, 4, 6, 10], "length": 10, "less": [4, 6], "light": [8, 10], "like": [1, 3, 4, 6, 11], "line": [4, 6, 9], "list": [1, 3, 4, 5, 6, 10], "listedcolormap": 6, "littl": 10, "ll": [9, 10], "lmfit": [3, 6], "load": [1, 3, 4, 6, 10], "loader": 13, "local": 8, "locat": [9, 13], "look": [1, 3, 4, 6], "lower": [3, 4, 6], "ly": [3, 4, 6], "m": 9, "mai": [4, 6, 13], "main": 8, "make": [1, 3, 4, 6, 8, 9, 10, 11], "mani": [8, 10], "marcu": 7, "mask": [3, 4, 10], "match": [10, 12], "mathemat": 8, "matplotlb": [4, 6], "matplotlib": [4, 6], "maximum": [1, 3, 4, 6, 10], "mean": [3, 4, 6, 10], "median": [3, 4, 6, 10], "meshgrid": 10, "method": [8, 10], "might": 8, "minim": [3, 6], "minimizerresult": [3, 6], "mission": [8, 12], "mode": [3, 4, 6], "model": [1, 3, 4, 5, 6, 8, 10, 12], "modul": 12, "month": 7, "more": [3, 4, 8, 10, 13], "most": [3, 4, 7, 8, 10], "mpl": 9, "much": [8, 13], "multipli": 8, "must": [1, 4, 9, 10], "n_imag": [3, 4, 10], "navig": 9, "ndarari": [1, 3, 5], "ndarrai": [1, 3, 4, 5, 6, 10], "necessari": 8, "need": [8, 9, 10, 11], "neighbor": 13, "neighborhood": [1, 3, 4, 10], "new": [3, 4, 6, 8], "non": [1, 2, 3, 5], "none": [1, 3, 4, 5, 6, 10], "normal": [4, 6], "note": [1, 3, 4, 6, 10, 13], "notic": 11, "now": [9, 10], "np": [1, 3, 4, 5, 6, 10], "number": [1, 3, 4, 5, 6, 7, 13], "numpi": [1, 3, 4, 5, 6, 10], "nx": [3, 4, 10], "nx2": [1, 3, 4, 6], "ny": [3, 4, 10], "object": [4, 6, 10], "observ": [1, 3, 4, 6, 8, 12], "off": 7, "omit": [4, 6], "onc": 13, "one": [3, 4, 6, 10], "onli": [1, 3, 4, 6, 8, 10, 13], "open": [10, 11], "oper": [3, 4, 8], "optic": 8, "option": [3, 6], "org": 7, "origin": [10, 12], "other": [3, 4, 6, 9, 10, 11, 13], "otherwis": [1, 3, 4, 6, 10], "our": [8, 9], "outlin": 8, "output": [9, 10], "outsid": 10, "over": [1, 3, 4, 5, 6, 10], "overlap": [1, 3, 4, 6, 8, 10, 13], "overview": 12, "packag": [7, 9, 11, 12], "page": [0, 7, 9, 12], "panel": [10, 12], "paper": [7, 8, 10, 12], "paramet": [1, 3, 4, 5, 6], "part": 10, "pass": [4, 6], "patch": [1, 3, 4, 6, 10, 13], "patch_collect": [4, 6], "patch_siz": [3, 4, 6, 10, 13], "patchcollect": [3, 4, 6], "patchcollectionabc": [3, 4, 6], "path": [1, 3, 4, 6, 9], "path_to_sav": 10, "pathlib": [1, 3, 4, 6], "percentil": [3, 4, 10], "peripheri": [10, 12], "pip": 9, "pixel": [1, 3, 4, 6, 10], "plan": [1, 3, 4], "plane": 13, "pleas": [7, 9, 11], "plot": [4, 6, 9, 13], "plt": [4, 6, 13], "point": [1, 3, 4, 5, 6, 7, 8, 12], "pointspreadfunctionabc": [1, 3, 4, 5, 6], "posit": 13, "possibl": 11, "pre": 12, "premis": 8, "prepar": 10, "previou": 10, "problem": 10, "process": [3, 4, 10], "produc": [4, 6, 10, 13], "project": 9, "properti": [1, 3, 4, 5, 6], "provid": [3, 4, 6, 10, 13], "psf": [0, 1, 3, 4, 6, 12], "psf_size": [3, 4, 6, 10, 13], "psfparametervalidationerror": [2, 5], "publish": 7, "punch": [8, 12], "purpos": 10, "py": 9, "pytest": 9, "python": [9, 10, 12, 13], "pyx": 8, "quickstart": 10, "r": 9, "rang": [4, 6], "rather": [11, 13], "re": [9, 10, 11, 13], "read": [9, 10, 13], "readthedoc": [3, 4, 10], "real": [1, 3, 5, 6], "reason": [10, 13], "receiv": 10, "reciproc": [4, 6], "recommend": [9, 10], "record": 7, "refer": [9, 12], "region": [4, 6, 8, 10], "region_s": [4, 6, 13], "regular": [4, 6, 7, 10, 12, 13], "regularizepsf": [0, 8, 10, 13], "repeat": 13, "repositori": 9, "represent": [3, 4], "requir": [9, 10, 13], "requirements_dev": 9, "result": [3, 4, 8, 10, 13], "return": [1, 3, 4, 5, 6, 10], "right": 10, "robust": 13, "routin": 8, "row": 13, "run": [4, 6, 10, 12], "same": [4, 6, 8], "sampl": [3, 4, 6, 13], "save": [1, 3, 4, 6, 9, 10, 13], "scale": [3, 4, 6, 10], "search": 12, "seaton": 7, "second": [1, 3, 4, 5, 13], "section": 10, "see": [1, 3, 4, 6, 8, 9, 10], "seen": 13, "select": [3, 4, 10], "self": 10, "sep": [3, 4, 10], "separ": [4, 6, 13], "seri": [3, 4, 10], "serv": 13, "set": [1, 3, 4, 5, 6, 10, 12], "setup": 9, "shape": [1, 3, 4, 6, 10], "shouuld": [1, 4], "show": [4, 6, 9, 13], "shown": [8, 9, 13], "side": [3, 4, 6, 10, 13], "sigma": 10, "sigma_i": 10, "sigma_x": 10, "signatur": 10, "simluat": [1, 3, 4, 6], "simpl": [1, 3, 5], "simple_psf": [4, 5, 10], "simplepsf": [1, 3, 4, 5, 6], "simpler": [4, 6], "simpli": [8, 10], "simplifi": 12, "simul": [1, 3, 4, 6], "simulate_observ": [1, 3, 4, 6], "sinc": 8, "size": [1, 3, 4, 6, 10, 13], "slow": [3, 4, 8, 10], "slowli": 12, "smaller": 8, "smooth": 8, "so": [8, 11, 13], "societi": 7, "softwar": 7, "someon": 11, "somewhat": 10, "sourc": [1, 3, 4, 6, 8, 9, 13], "space": [8, 13], "span": [4, 6], "speak": 11, "specif": [3, 6, 7], "specifi": [3, 4, 6], "speed": [8, 12], "sphinx": [0, 9], "spread": [1, 3, 5, 7, 8, 12], "squar": [1, 3, 4, 6, 10], "standard": 8, "star": [1, 3, 4, 6, 8, 10, 12], "star_mask": [3, 4, 10], "star_threshold": [3, 4, 10], "starfield": 12, "start": 11, "static": [3, 4], "step": [3, 4, 6, 13], "store": [1, 4, 10], "str": [1, 3, 4, 5, 6, 10], "style": 9, "subpixel": [3, 4, 10], "subtract": [10, 13], "suffici": 13, "suggest": [1, 3, 4, 6], "summari": 9, "support": 11, "symmetr": 10, "synthet": 12, "system": [8, 10], "take": 10, "target": [3, 4, 6, 12, 13], "target_evalu": [1, 3, 4, 6, 10, 13], "target_fwhm": 10, "target_model": [1, 4], "techniqu": [10, 12], "test": 12, "than": [3, 4, 6, 8, 10, 11, 13], "thank": 11, "them": [9, 13], "thi": [0, 1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13], "thorough": 8, "those": 13, "thought": 13, "threshold": [3, 4, 10], "through": 10, "thu": [8, 10], "time": [9, 10], "titl": 7, "to_array_corrector": [3, 4, 10, 13], "togeth": [3, 4, 6], "too": 11, "tool": 8, "transfer": [4, 6, 10, 12], "transit": [1, 3, 4, 6, 8, 10], "treatment": 8, "tricki": 10, "true": [1, 3, 4, 5, 6, 10], "tupl": [1, 3, 4, 6], "turn": [3, 4, 10], "tutori": 10, "two": 13, "txt": 9, "type": [1, 3, 4, 5, 6, 10], "typic": 8, "u": 9, "understand": [8, 13], "unevaluatedpointerror": [1, 2], "uniform": [8, 10, 13], "up": [4, 6, 7, 8, 11, 12], "updat": 9, "url": 7, "us": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13], "user": 11, "util": [4, 6, 8, 9, 13], "v1": [3, 4, 10], "valid": [3, 4], "validate_at_cal": [1, 5], "validationerror": [1, 2, 3, 5], "valu": [1, 3, 4, 5, 6, 10], "vari": [1, 3, 4, 5, 8, 10, 12], "variabl": 7, "variat": 13, "varied_psf": [4, 5], "variedpsf": [1, 4, 5], "variedpsfparametermismatcherror": [2, 5], "vary_funct": [1, 5], "venv": 9, "veri": 8, "version": [1, 4, 7, 10], "view": [1, 4, 5], "virtual": 9, "visibl": 13, "visual": [0, 4, 8, 10, 12], "visualize_patch_count": [4, 6, 13], "visualize_psf": [4, 6, 13], "visualize_transfer_kernel": [4, 6, 13], "vmax": 13, "vmin": 13, "volum": 7, "wa": [8, 12], "walk": 10, "want": [1, 3, 4, 11], "we": [1, 3, 4, 8, 9, 10, 11, 13], "well": 8, "were": [4, 6], "what": [1, 3, 4, 6], "when": [1, 3, 4, 6, 9, 10], "where": [1, 3, 4, 6, 10], "wherea": 10, "whether": 13, "which": [3, 4, 6, 9, 10], "while": 13, "white": [4, 6], "wide": 9, "width": [4, 6, 10], "window": 10, "within": [4, 6, 10], "without": 8, "work": 9, "would": [4, 6], "x": [1, 3, 4, 5, 6, 10], "x0": 10, "xy": [1, 3, 4, 6], "y": [1, 3, 4, 5, 6, 10], "y0": 10, "year": 7, "yield": [3, 4, 10, 13], "you": [4, 6, 7, 8, 9, 10, 11], "your": [4, 6, 10, 11, 13], "zenodo": 7}, "titles": ["API Reference", "regularizepsf.corrector", "regularizepsf.exceptions", "regularizepsf.fitter", "regularizepsf", "regularizepsf.psf", "regularizepsf.visualize", "Citation", "Concepts", "Development", "Examples", "Help", "Welcome to regularizepsf!", "Visualization"], "titleterms": {"api": 0, "arraycorrector": 10, "attribut": [3, 6], "build": [9, 10], "citat": 7, "class": [1, 3, 4, 5, 6], "commit": 9, "concept": 8, "content": [1, 2, 3, 4, 5, 6, 12], "correct": [10, 13], "corrector": 1, "dash": 10, "data": 10, "defin": 10, "demo": 10, "develop": 9, "distribut": 13, "doc": 9, "exampl": 10, "except": [1, 2, 3, 5], "extract": 13, "fitter": 3, "function": [1, 3, 4, 5, 6], "help": 11, "identifi": 13, "imag": 10, "indic": 12, "input": 10, "kernel": 13, "modul": [1, 2, 3, 5, 6], "overview": 8, "packag": [4, 8], "paramet": 10, "perform": 10, "pre": 9, "psf": [5, 8, 10, 13], "punch": 10, "purpos": 8, "refer": 0, "regularizepsf": [1, 2, 3, 4, 5, 6, 12], "run": 9, "set": 9, "star": 13, "submodul": 4, "tabl": 12, "target": [8, 10], "techniqu": 8, "test": 9, "transfer": 13, "up": 9, "visual": [6, 13], "welcom": 12}}) \ No newline at end of file +Search.setIndex({"alltitles": {"API Reference": [[0, "api-reference"]], "Attributes": [[3, "attributes"], [6, "attributes"]], "Build the target PSF": [[10, "build-the-target-psf"]], "Building the ArrayCorrector": [[10, "building-the-arraycorrector"]], "Building the docs": [[9, "building-the-docs"]], "Citation": [[7, "citation"]], "Classes": [[1, "classes"], [3, "classes"], [4, "classes"], [5, "classes"]], "Concepts": [[8, "concepts"]], "Contents:": [[12, null]], "Defining input parameters": [[10, "defining-input-parameters"]], "Demo: Correction PUNCH Data": [[10, "demo-correction-punch-data"]], "Demo: correcting DASH image": [[10, "demo-correcting-dash-image"]], "Development": [[9, "development"]], "Distribution of identified stars": [[13, "distribution-of-identified-stars"]], "Examples": [[10, "examples"]], "Exceptions": [[2, "exceptions"]], "Extracted PSFs": [[13, "extracted-psfs"]], "Extracted and Corrected PSFs": [[13, "extracted-and-corrected-psfs"]], "Functions": [[1, "functions"], [4, "functions"], [5, "functions"], [6, "functions"]], "Help": [[11, "help"]], "Indices and tables": [[12, "indices-and-tables"]], "Module Contents": [[1, "module-contents"], [2, "module-contents"], [3, "module-contents"], [5, "module-contents"], [6, "module-contents"]], "Overview of the package": [[8, "overview-of-the-package"]], "Overview of the technique": [[8, "overview-of-the-technique"]], "Package Contents": [[4, "package-contents"]], "Performing the correction": [[10, "performing-the-correction"]], "Purpose of the target PSF": [[8, "purpose-of-the-target-psf"]], "Running tests": [[9, "running-tests"]], "Setting up pre-commit": [[9, "setting-up-pre-commit"]], "Submodules": [[4, "submodules"]], "Transfer Kernels": [[13, "transfer-kernels"]], "Visualization": [[13, "visualization"]], "Welcome to regularizepsf!": [[12, "welcome-to-regularizepsf"]], "regularizepsf": [[4, "module-regularizepsf"]], "regularizepsf.corrector": [[1, "module-regularizepsf.corrector"]], "regularizepsf.exceptions": [[2, "module-regularizepsf.exceptions"]], "regularizepsf.fitter": [[3, "module-regularizepsf.fitter"]], "regularizepsf.psf": [[5, "module-regularizepsf.psf"]], "regularizepsf.visualize": [[6, "module-regularizepsf.visualize"]]}, "docnames": ["autoapi/index", "autoapi/regularizepsf/corrector/index", "autoapi/regularizepsf/exceptions/index", "autoapi/regularizepsf/fitter/index", "autoapi/regularizepsf/index", "autoapi/regularizepsf/psf/index", "autoapi/regularizepsf/visualize/index", "cite", "concepts", "development", "examples", "help", "index", "visualization"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["autoapi/index.rst", "autoapi/regularizepsf/corrector/index.rst", "autoapi/regularizepsf/exceptions/index.rst", "autoapi/regularizepsf/fitter/index.rst", "autoapi/regularizepsf/index.rst", "autoapi/regularizepsf/psf/index.rst", "autoapi/regularizepsf/visualize/index.rst", "cite.rst", "concepts.rst", "development.rst", "examples.rst", "help.rst", "index.rst", "visualization.rst"], "indexentries": {"__call__() (regularizepsf.psf.pointspreadfunctionabc method)": [[5, "regularizepsf.psf.PointSpreadFunctionABC.__call__", false]], "__call__() (regularizepsf.psf.simplepsf method)": [[5, "regularizepsf.psf.SimplePSF.__call__", false]], "__call__() (regularizepsf.psf.variedpsf method)": [[5, "regularizepsf.psf.VariedPSF.__call__", false]], "__contains__() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.__contains__", false]], "__getitem__() (regularizepsf.arraycorrector method)": [[4, "regularizepsf.ArrayCorrector.__getitem__", false]], "__getitem__() (regularizepsf.corrector.arraycorrector method)": [[1, "regularizepsf.corrector.ArrayCorrector.__getitem__", false]], "__getitem__() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.__getitem__", false]], "__len__() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.__len__", false]], "_calculate_pad_shape() (regularizepsf.coordinatepatchcollection method)": [[4, "regularizepsf.CoordinatePatchCollection._calculate_pad_shape", false]], "_calculate_pad_shape() (regularizepsf.fitter.coordinatepatchcollection method)": [[3, "regularizepsf.fitter.CoordinatePatchCollection._calculate_pad_shape", false]], "_colormap (in module regularizepsf.visualize)": [[6, "regularizepsf.visualize._colormap", false]], "_fit_lmfit() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC._fit_lmfit", false]], "_generate_colormap() (in module regularizepsf.visualize)": [[6, "regularizepsf.visualize._generate_colormap", false]], "_validate_average_mode() (regularizepsf.coordinatepatchcollection static method)": [[4, "regularizepsf.CoordinatePatchCollection._validate_average_mode", false]], "_validate_average_mode() (regularizepsf.fitter.coordinatepatchcollection static method)": [[3, "regularizepsf.fitter.CoordinatePatchCollection._validate_average_mode", false]], "_varied_psf() (in module regularizepsf.psf)": [[5, "regularizepsf.psf._varied_psf", false]], "add() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.add", false]], "arraycorrector (class in regularizepsf)": [[4, "regularizepsf.ArrayCorrector", false]], "arraycorrector (class in regularizepsf.corrector)": [[1, "regularizepsf.corrector.ArrayCorrector", false]], "average() (regularizepsf.coordinatepatchcollection method)": [[4, "regularizepsf.CoordinatePatchCollection.average", false]], "average() (regularizepsf.fitter.coordinatepatchcollection method)": [[3, "regularizepsf.fitter.CoordinatePatchCollection.average", false]], "average() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.average", false]], "calculate_covering() (in module regularizepsf)": [[4, "regularizepsf.calculate_covering", false]], "calculate_covering() (in module regularizepsf.corrector)": [[1, "regularizepsf.corrector.calculate_covering", false]], "coordinateidentifier (in module regularizepsf.fitter)": [[3, "regularizepsf.fitter.CoordinateIdentifier", false]], "coordinatepatchcollection (class in regularizepsf)": [[4, "regularizepsf.CoordinatePatchCollection", false]], "coordinatepatchcollection (class in regularizepsf.fitter)": [[3, "regularizepsf.fitter.CoordinatePatchCollection", false]], "correct_image() (in module regularizepsf.corrector.arraycorrector)": [[10, "regularizepsf.corrector.ArrayCorrector.correct_image", false]], "correct_image() (regularizepsf.arraycorrector method)": [[4, "regularizepsf.ArrayCorrector.correct_image", false]], "correct_image() (regularizepsf.corrector.arraycorrector method)": [[1, "regularizepsf.corrector.ArrayCorrector.correct_image", false]], "correct_image() (regularizepsf.corrector.correctorabc method)": [[1, "regularizepsf.corrector.CorrectorABC.correct_image", false]], "correct_image() (regularizepsf.corrector.functionalcorrector method)": [[1, "regularizepsf.corrector.FunctionalCorrector.correct_image", false]], "correct_image() (regularizepsf.functionalcorrector method)": [[4, "regularizepsf.FunctionalCorrector.correct_image", false]], "correctorabc (class in regularizepsf.corrector)": [[1, "regularizepsf.corrector.CorrectorABC", false]], "evaluate_to_array_form() (regularizepsf.corrector.functionalcorrector method)": [[1, "regularizepsf.corrector.FunctionalCorrector.evaluate_to_array_form", false]], "evaluate_to_array_form() (regularizepsf.functionalcorrector method)": [[4, "regularizepsf.FunctionalCorrector.evaluate_to_array_form", false]], "evaluatedmodelinconsistentsizeerror": [[2, "regularizepsf.exceptions.EvaluatedModelInconsistentSizeError", false]], "evaluation_points (regularizepsf.arraycorrector property)": [[4, "regularizepsf.ArrayCorrector.evaluation_points", false]], "evaluation_points (regularizepsf.corrector.arraycorrector property)": [[1, "regularizepsf.corrector.ArrayCorrector.evaluation_points", false]], "evaluations (regularizepsf.arraycorrector property)": [[4, "regularizepsf.ArrayCorrector.evaluations", false]], "evaluations (regularizepsf.corrector.arraycorrector property)": [[1, "regularizepsf.corrector.ArrayCorrector.evaluations", false]], "extract() (regularizepsf.coordinatepatchcollection class method)": [[4, "regularizepsf.CoordinatePatchCollection.extract", false]], "extract() (regularizepsf.fitter.coordinatepatchcollection class method)": [[3, "regularizepsf.fitter.CoordinatePatchCollection.extract", false]], "extract() (regularizepsf.fitter.patchcollectionabc class method)": [[3, "regularizepsf.fitter.PatchCollectionABC.extract", false]], "find_stars_and_average() (in module regularizepsf.fitter.coordinatepatchcollection)": [[10, "regularizepsf.fitter.CoordinatePatchCollection.find_stars_and_average", false]], "find_stars_and_average() (regularizepsf.coordinatepatchcollection class method)": [[4, "regularizepsf.CoordinatePatchCollection.find_stars_and_average", false]], "find_stars_and_average() (regularizepsf.fitter.coordinatepatchcollection class method)": [[3, "regularizepsf.fitter.CoordinatePatchCollection.find_stars_and_average", false]], "fit() (regularizepsf.coordinatepatchcollection method)": [[4, "regularizepsf.CoordinatePatchCollection.fit", false]], "fit() (regularizepsf.fitter.coordinatepatchcollection method)": [[3, "regularizepsf.fitter.CoordinatePatchCollection.fit", false]], "fit() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.fit", false]], "functionalcorrector (class in regularizepsf)": [[4, "regularizepsf.FunctionalCorrector", false]], "functionalcorrector (class in regularizepsf.corrector)": [[1, "regularizepsf.corrector.FunctionalCorrector", false]], "invalidsizeerror": [[2, "regularizepsf.exceptions.InvalidSizeError", false]], "is_variable (regularizepsf.corrector.functionalcorrector property)": [[1, "regularizepsf.corrector.FunctionalCorrector.is_variable", false]], "is_variable (regularizepsf.functionalcorrector property)": [[4, "regularizepsf.FunctionalCorrector.is_variable", false]], "items() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.items", false]], "keys() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.keys", false]], "load() (regularizepsf.arraycorrector class method)": [[4, "regularizepsf.ArrayCorrector.load", false]], "load() (regularizepsf.coordinatepatchcollection class method)": [[4, "regularizepsf.CoordinatePatchCollection.load", false]], "load() (regularizepsf.corrector.arraycorrector class method)": [[1, "regularizepsf.corrector.ArrayCorrector.load", false]], "load() (regularizepsf.corrector.correctorabc class method)": [[1, "regularizepsf.corrector.CorrectorABC.load", false]], "load() (regularizepsf.corrector.functionalcorrector class method)": [[1, "regularizepsf.corrector.FunctionalCorrector.load", false]], "load() (regularizepsf.fitter.coordinatepatchcollection class method)": [[3, "regularizepsf.fitter.CoordinatePatchCollection.load", false]], "load() (regularizepsf.fitter.patchcollectionabc class method)": [[3, "regularizepsf.fitter.PatchCollectionABC.load", false]], "load() (regularizepsf.functionalcorrector class method)": [[4, "regularizepsf.FunctionalCorrector.load", false]], "module": [[1, "module-regularizepsf.corrector", false], [2, "module-regularizepsf.exceptions", false], [3, "module-regularizepsf.fitter", false], [4, "module-regularizepsf", false], [5, "module-regularizepsf.psf", false], [6, "module-regularizepsf.visualize", false]], "parameters (regularizepsf.psf.pointspreadfunctionabc property)": [[5, "regularizepsf.psf.PointSpreadFunctionABC.parameters", false]], "parameters (regularizepsf.psf.simplepsf property)": [[5, "regularizepsf.psf.SimplePSF.parameters", false]], "parameters (regularizepsf.psf.variedpsf property)": [[5, "regularizepsf.psf.VariedPSF.parameters", false]], "patchcollectionabc (class in regularizepsf.fitter)": [[3, "regularizepsf.fitter.PatchCollectionABC", false]], "pointspreadfunctionabc (class in regularizepsf.psf)": [[5, "regularizepsf.psf.PointSpreadFunctionABC", false]], "psfparametervalidationerror": [[2, "regularizepsf.exceptions.PSFParameterValidationError", false]], "regularizepsf": [[4, "module-regularizepsf", false]], "regularizepsf.corrector": [[1, "module-regularizepsf.corrector", false]], "regularizepsf.exceptions": [[2, "module-regularizepsf.exceptions", false]], "regularizepsf.fitter": [[3, "module-regularizepsf.fitter", false]], "regularizepsf.psf": [[5, "module-regularizepsf.psf", false]], "regularizepsf.visualize": [[6, "module-regularizepsf.visualize", false]], "save() (regularizepsf.arraycorrector method)": [[4, "regularizepsf.ArrayCorrector.save", false]], "save() (regularizepsf.coordinatepatchcollection method)": [[4, "regularizepsf.CoordinatePatchCollection.save", false]], "save() (regularizepsf.corrector.arraycorrector method)": [[1, "regularizepsf.corrector.ArrayCorrector.save", false]], "save() (regularizepsf.corrector.correctorabc method)": [[1, "regularizepsf.corrector.CorrectorABC.save", false]], "save() (regularizepsf.corrector.functionalcorrector method)": [[1, "regularizepsf.corrector.FunctionalCorrector.save", false]], "save() (regularizepsf.fitter.coordinatepatchcollection method)": [[3, "regularizepsf.fitter.CoordinatePatchCollection.save", false]], "save() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.save", false]], "save() (regularizepsf.functionalcorrector method)": [[4, "regularizepsf.FunctionalCorrector.save", false]], "simple_psf() (in module regularizepsf)": [[4, "regularizepsf.simple_psf", false]], "simple_psf() (in module regularizepsf.psf)": [[5, "regularizepsf.psf.simple_psf", false]], "simplepsf (class in regularizepsf.psf)": [[5, "regularizepsf.psf.SimplePSF", false]], "simulate_observation() (regularizepsf.arraycorrector method)": [[4, "regularizepsf.ArrayCorrector.simulate_observation", false]], "simulate_observation() (regularizepsf.corrector.arraycorrector method)": [[1, "regularizepsf.corrector.ArrayCorrector.simulate_observation", false]], "simulate_observation() (regularizepsf.corrector.correctorabc method)": [[1, "regularizepsf.corrector.CorrectorABC.simulate_observation", false]], "simulate_observation() (regularizepsf.corrector.functionalcorrector method)": [[1, "regularizepsf.corrector.FunctionalCorrector.simulate_observation", false]], "simulate_observation() (regularizepsf.functionalcorrector method)": [[4, "regularizepsf.FunctionalCorrector.simulate_observation", false]], "to_array_corrector() (regularizepsf.coordinatepatchcollection method)": [[4, "regularizepsf.CoordinatePatchCollection.to_array_corrector", false]], "to_array_corrector() (regularizepsf.fitter.coordinatepatchcollection method)": [[3, "regularizepsf.fitter.CoordinatePatchCollection.to_array_corrector", false]], "unevaluatedpointerror": [[2, "regularizepsf.exceptions.UnevaluatedPointError", false]], "validationerror": [[2, "regularizepsf.exceptions.ValidationError", false]], "values() (regularizepsf.fitter.patchcollectionabc method)": [[3, "regularizepsf.fitter.PatchCollectionABC.values", false]], "varied_psf() (in module regularizepsf)": [[4, "regularizepsf.varied_psf", false]], "varied_psf() (in module regularizepsf.psf)": [[5, "regularizepsf.psf.varied_psf", false]], "variedpsf (class in regularizepsf.psf)": [[5, "regularizepsf.psf.VariedPSF", false]], "variedpsfparametermismatcherror": [[2, "regularizepsf.exceptions.VariedPSFParameterMismatchError", false]], "visualize_patch_counts() (in module regularizepsf)": [[4, "regularizepsf.visualize_patch_counts", false]], "visualize_patch_counts() (in module regularizepsf.visualize)": [[6, "regularizepsf.visualize.visualize_patch_counts", false]], "visualize_psfs() (in module regularizepsf)": [[4, "regularizepsf.visualize_PSFs", false]], "visualize_psfs() (in module regularizepsf.visualize)": [[6, "regularizepsf.visualize.visualize_PSFs", false]], "visualize_transfer_kernels() (in module regularizepsf)": [[4, "regularizepsf.visualize_transfer_kernels", false]], "visualize_transfer_kernels() (in module regularizepsf.visualize)": [[6, "regularizepsf.visualize.visualize_transfer_kernels", false]]}, "objects": {"": [[4, 0, 0, "-", "regularizepsf"]], "regularizepsf": [[4, 1, 1, "", "ArrayCorrector"], [4, 1, 1, "", "CoordinatePatchCollection"], [4, 1, 1, "", "FunctionalCorrector"], [4, 4, 1, "", "calculate_covering"], [1, 0, 0, "-", "corrector"], [2, 0, 0, "-", "exceptions"], [3, 0, 0, "-", "fitter"], [5, 0, 0, "-", "psf"], [4, 4, 1, "", "simple_psf"], [4, 4, 1, "", "varied_psf"], [6, 0, 0, "-", "visualize"], [4, 4, 1, "", "visualize_PSFs"], [4, 4, 1, "", "visualize_patch_counts"], [4, 4, 1, "", "visualize_transfer_kernels"]], "regularizepsf.ArrayCorrector": [[4, 2, 1, "", "__getitem__"], [4, 2, 1, "", "correct_image"], [4, 3, 1, "", "evaluation_points"], [4, 3, 1, "", "evaluations"], [4, 2, 1, "", "load"], [4, 2, 1, "", "save"], [4, 2, 1, "", "simulate_observation"]], "regularizepsf.CoordinatePatchCollection": [[4, 2, 1, "", "_calculate_pad_shape"], [4, 2, 1, "", "_validate_average_mode"], [4, 2, 1, "", "average"], [4, 2, 1, "", "extract"], [4, 2, 1, "", "find_stars_and_average"], [4, 2, 1, "", "fit"], [4, 2, 1, "", "load"], [4, 2, 1, "", "save"], [4, 2, 1, "", "to_array_corrector"]], "regularizepsf.FunctionalCorrector": [[4, 2, 1, "", "correct_image"], [4, 2, 1, "", "evaluate_to_array_form"], [4, 3, 1, "", "is_variable"], [4, 2, 1, "", "load"], [4, 2, 1, "", "save"], [4, 2, 1, "", "simulate_observation"]], "regularizepsf.corrector": [[1, 1, 1, "", "ArrayCorrector"], [1, 1, 1, "", "CorrectorABC"], [1, 1, 1, "", "FunctionalCorrector"], [1, 4, 1, "", "calculate_covering"]], "regularizepsf.corrector.ArrayCorrector": [[1, 2, 1, "", "__getitem__"], [10, 4, 1, "", "correct_image"], [1, 3, 1, "", "evaluation_points"], [1, 3, 1, "", "evaluations"], [1, 2, 1, "", "load"], [1, 2, 1, "", "save"], [1, 2, 1, "", "simulate_observation"]], "regularizepsf.corrector.CorrectorABC": [[1, 2, 1, "", "correct_image"], [1, 2, 1, "", "load"], [1, 2, 1, "", "save"], [1, 2, 1, "", "simulate_observation"]], "regularizepsf.corrector.FunctionalCorrector": [[1, 2, 1, "", "correct_image"], [1, 2, 1, "", "evaluate_to_array_form"], [1, 3, 1, "", "is_variable"], [1, 2, 1, "", "load"], [1, 2, 1, "", "save"], [1, 2, 1, "", "simulate_observation"]], "regularizepsf.exceptions": [[2, 5, 1, "", "EvaluatedModelInconsistentSizeError"], [2, 5, 1, "", "InvalidSizeError"], [2, 5, 1, "", "PSFParameterValidationError"], [2, 5, 1, "", "UnevaluatedPointError"], [2, 5, 1, "", "ValidationError"], [2, 5, 1, "", "VariedPSFParameterMismatchError"]], "regularizepsf.fitter": [[3, 6, 1, "", "CoordinateIdentifier"], [3, 1, 1, "", "CoordinatePatchCollection"], [3, 1, 1, "", "PatchCollectionABC"]], "regularizepsf.fitter.CoordinatePatchCollection": [[3, 2, 1, "", "_calculate_pad_shape"], [3, 2, 1, "", "_validate_average_mode"], [3, 2, 1, "", "average"], [3, 2, 1, "", "extract"], [10, 4, 1, "", "find_stars_and_average"], [3, 2, 1, "", "fit"], [3, 2, 1, "", "load"], [3, 2, 1, "", "save"], [3, 2, 1, "", "to_array_corrector"]], "regularizepsf.fitter.PatchCollectionABC": [[3, 2, 1, "", "__contains__"], [3, 2, 1, "", "__getitem__"], [3, 2, 1, "", "__len__"], [3, 2, 1, "", "_fit_lmfit"], [3, 2, 1, "", "add"], [3, 2, 1, "", "average"], [3, 2, 1, "", "extract"], [3, 2, 1, "", "fit"], [3, 2, 1, "", "items"], [3, 2, 1, "", "keys"], [3, 2, 1, "", "load"], [3, 2, 1, "", "save"], [3, 2, 1, "", "values"]], "regularizepsf.psf": [[5, 1, 1, "", "PointSpreadFunctionABC"], [5, 1, 1, "", "SimplePSF"], [5, 1, 1, "", "VariedPSF"], [5, 4, 1, "", "_varied_psf"], [5, 4, 1, "", "simple_psf"], [5, 4, 1, "", "varied_psf"]], "regularizepsf.psf.PointSpreadFunctionABC": [[5, 2, 1, "", "__call__"], [5, 3, 1, "", "parameters"]], "regularizepsf.psf.SimplePSF": [[5, 2, 1, "", "__call__"], [5, 3, 1, "", "parameters"]], "regularizepsf.psf.VariedPSF": [[5, 2, 1, "", "__call__"], [5, 3, 1, "", "parameters"]], "regularizepsf.visualize": [[6, 6, 1, "", "_colormap"], [6, 4, 1, "", "_generate_colormap"], [6, 4, 1, "", "visualize_PSFs"], [6, 4, 1, "", "visualize_patch_counts"], [6, 4, 1, "", "visualize_transfer_kernels"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "function", "Python function"], "5": ["py", "exception", "Python exception"], "6": ["py", "data", "Python data"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:function", "5": "py:exception", "6": "py:data"}, "terms": {"": [3, 4, 9, 10, 11, 13], "0": [1, 3, 4, 6, 10, 13], "05": [1, 4, 10], "1": [0, 1, 3, 4, 6, 10, 13], "10": [3, 4, 7, 10], "100": [3, 4, 10], "10066960": 7, "1538": 7, "16": 13, "165": 7, "2": [1, 4, 10, 13], "2023": [7, 10], "204": 7, "25": 10, "256": [10, 13], "256x256": 10, "2d": [1, 4, 10], "3": [3, 4, 10, 13], "32": 10, "32x32": 10, "355": 10, "3847": 7, "3881": 7, "4": [10, 13], "5": [1, 4, 7, 10, 13], "6": 13, "8": 13, "A": [1, 3, 4, 6, 8, 10, 13], "As": 10, "By": 13, "For": [1, 4, 8, 10], "If": [3, 4, 6, 7, 9, 10, 11], "In": [10, 13], "It": [7, 9, 10, 12, 13], "The": [3, 4, 6, 7, 8, 9, 10, 12, 13], "Then": [8, 9], "These": [4, 6, 8, 10], "To": [4, 6, 7, 8, 9], "__call__": 5, "__contains__": 3, "__getitem__": [1, 3, 4], "__len__": 3, "_calculate_pad_shap": [3, 4], "_colormap": 6, "_fit_lmfit": 3, "_generate_colormap": 6, "_validate_average_mod": [3, 4], "_varied_psf": 5, "about": 10, "abstract": [1, 3, 4, 5], "abstractmethod": [1, 3, 4, 5], "acc578": 7, "accept": [4, 6, 13], "access": 3, "accompani": 10, "accord": [1, 4, 10], "across": [1, 4, 6, 8, 10, 13], "activ": 9, "actual": [1, 4, 13], "ad": 8, "add": 3, "addit": [4, 6], "adequ": 13, "after": [4, 6, 10], "again": 13, "aim": 10, "airglow": 10, "align": [3, 4, 10], "all": [2, 3, 4, 6, 9, 10, 11, 13], "all_patch": [4, 6], "alpha": [1, 4, 6, 10, 13], "also": [4, 6, 7, 8, 10, 13], "alwai": 7, "american": 7, "amplif": [1, 4, 10], "amplitud": [4, 6], "an": [1, 3, 4, 6, 8, 10, 11, 12, 13], "ani": [1, 3, 4, 5, 8, 9], "apart": [3, 4], "api": [3, 4, 10, 12], "appear": 13, "appli": [1, 3, 4, 6, 8, 10, 13], "applic": 10, "apr": 7, "ar": [1, 3, 4, 6, 8, 9, 10, 12, 13], "arang": 10, "arg": [4, 5], "argument": [4, 6, 13], "arrai": [1, 3, 4, 10], "array_corrector": [10, 13], "arraycorrector": [1, 3, 4, 6, 8, 13], "articl": 7, "artifact": 13, "assist": 8, "associ": [7, 8], "astronom": [7, 8, 12], "astropi": 10, "astyp": [10, 13], "attenu": [1, 4, 10], "author": 7, "auto": 0, "autoapi": 0, "avail": 13, "averag": [3, 4, 10], "average_mod": [3, 4, 10], "ax": [4, 6, 13], "axis_border_color": [4, 6], "b": [7, 12], "back": 13, "background": 13, "base": [1, 2, 3, 4, 5, 9], "base_psf": [3, 4, 5], "baselin": 9, "basic": 8, "becaus": [8, 10], "been": [1, 3, 4, 10, 13], "befor": [4, 6, 10], "begin": 8, "behav": 8, "being": [3, 4, 6, 10, 13], "below": [8, 12], "benefit": 11, "better": 8, "big": [1, 4, 10], "bin": 9, "black": [4, 6], "bool": [1, 3, 4, 5, 6], "boolean": [4, 6], "both": [4, 6, 10], "box": [1, 4, 10], "bracket": 3, "break": 10, "bright": [4, 6], "bug": 11, "build": [3, 4, 12], "build_ext": 9, "built": [3, 4, 9, 10], "c": 12, "calcul": 8, "calculate_cov": [1, 4], "call": [4, 6], "callabl": 5, "can": [3, 4, 6, 8, 9, 10, 11, 13], "case": 10, "center": [8, 10], "central": [4, 6], "chang": [1, 4], "check": 9, "citat": 12, "cite": 7, "class": 2, "classmethod": [1, 3, 4], "code": [9, 11], "collect": [3, 4, 6, 10], "color": [4, 6], "colorbar": [4, 6], "colorbar_label": [4, 6], "column": 13, "coma": 7, "combin": [3, 4, 10, 13], "command": 9, "commit": 12, "common": [2, 3, 4, 10], "commonli": 8, "compact": 10, "compar": 9, "comparison": [9, 13], "compon": [8, 10], "compress": [3, 4, 10], "comput": [4, 6, 8, 10, 13], "concept": [10, 12], "confer": 10, "consist": 9, "construct": [3, 4, 10], "contact": 9, "contain": [0, 4, 6], "contribut": [9, 10], "control": [1, 4, 10], "conveni": [4, 6], "convert": [3, 4, 8, 10, 13], "convolut": [8, 12, 13], "convolv": [8, 13], "coordin": [1, 3, 4, 5], "coordinate_patch_collect": 10, "coordinateidentifi": [3, 4], "coordinatepatchcollect": [3, 4, 6, 8, 10, 13], "corner": [3, 4], "correct": [1, 3, 4, 6, 8, 12], "correct_imag": [1, 4, 6, 8, 10, 13], "corrector": [0, 3, 4, 6, 8, 10], "correctorabc": [1, 4], "correspond": [3, 4, 10, 13], "could": [3, 4, 8, 10], "count": [3, 4, 13], "cover": [4, 6], "cpc": 13, "cpc_after": 13, "craig": 7, "creat": [0, 1, 4, 6, 8, 9, 10], "cryptic": 10, "cython": [8, 12], "d": 12, "daniel": 7, "dash": 12, "data": [3, 4, 12], "date": 7, "de": 13, "decor": 10, "deepnot": 10, "def": [10, 13], "default": [3, 4, 10, 13], "deforest": 7, "degre": 13, "demand": 13, "demo": 12, "demonstr": [8, 10], "deriv": [8, 10], "describ": 8, "descript": 10, "detail": [3, 4, 10], "determin": [1, 3, 4, 10, 12], "develop": 12, "diagnos": [4, 6, 13], "dict": [1, 3, 4, 5, 6, 13], "dictionari": 3, "differ": 8, "dimens": [1, 3, 4, 5], "dimension": 13, "direct": 12, "directli": [8, 10], "directori": 9, "discuss": 11, "disk": 13, "displai": 13, "distribut": 12, "do": [4, 6, 8, 9, 10], "doc": 12, "document": [0, 9, 12], "doi": 7, "done": [8, 10, 13], "down": [3, 4, 6, 10], "dramat": [3, 4, 10], "dtype": 10, "dure": [3, 4, 10], "dx": 7, "e": [7, 8, 10], "each": [3, 4, 6, 10, 13], "easili": 13, "edg": [4, 6, 8], "effect": 13, "effici": 10, "either": [3, 4, 10], "els": [10, 11], "email": 11, "empti": [4, 6], "en": [3, 4, 10], "encount": 11, "encourag": [9, 11], "end": 9, "endian": 10, "entir": [4, 6], "environ": 9, "epsilon": [1, 4, 6, 10, 13], "equat": 10, "error": 10, "estim": [4, 6, 13], "etc": 13, "evalu": [1, 3, 4, 5, 10], "evaluate_to_array_form": [1, 4], "evaluatedmodelinconsistentsizeerror": 2, "evaluation_point": [1, 4], "evelop": 9, "everi": [4, 6, 13], "everyon": 11, "everyth": 10, "everytim": 9, "everywher": 8, "exampl": [8, 12, 13], "except": [0, 4], "execut": [3, 4, 10], "exercis": 13, "exhibit": 10, "exit": 2, "exp": 10, "extens": [1, 4], "extract": [3, 4, 10, 12], "factor": [3, 4, 6, 10], "fail": 9, "fals": [1, 3, 4, 6], "far": [3, 4], "faster": 8, "few": 8, "fft": 8, "field": [1, 4, 5], "fig": [4, 6], "fig_scal": [4, 6, 13], "figsiz": 13, "figur": [4, 6, 13], "file": [1, 3, 4, 8, 9, 13], "filenam": [3, 4, 10], "fill": 10, "final": [8, 10, 12], "find": [3, 4, 10, 13], "find_stars_and_averag": [3, 4, 6, 8, 10, 13], "first": [1, 3, 4, 5, 9, 10, 11], "fit": [3, 4, 8, 10, 13], "fitter": [0, 4, 6, 8, 10], "float": [1, 3, 4, 6, 10, 13], "fname": 13, "follow": [9, 13], "form": [1, 4, 10], "four": [4, 6, 13], "fourier": [8, 13], "fourth": [4, 6], "friendli": 11, "from": [1, 3, 4, 8, 10, 11, 13], "full": 10, "function": [7, 8, 10, 12, 13], "functionalcorrector": [1, 4, 10], "futur": 10, "fwhm": 10, "g": 8, "gamma": [10, 12], "gaussian": [8, 10], "gca": 13, "gener": [0, 3, 4, 6, 9, 10, 13], "get": [3, 9], "getdata": 13, "github": 11, "given": 3, "grid": [1, 3, 4, 6], "guess": 3, "guid": 9, "guidelin": 9, "ha": [1, 3, 4, 7, 8, 10, 13], "half": 10, "hand": 13, "handl": 10, "hard": [1, 4, 8, 10], "have": [10, 13], "hdu": [3, 4, 10], "hdu_choic": [3, 4, 10], "hdul": 10, "heliospher": 10, "help": [12, 13], "helper": 8, "here": [9, 10], "highlight": [10, 12], "histogram": 13, "homogen": 8, "how": [1, 3, 4, 8, 10], "howev": 10, "html": [3, 4, 9, 10], "http": [3, 4, 7, 10], "hugh": 7, "hughes_2023": 7, "i": [1, 3, 4, 6, 8, 9, 10, 11, 12, 13], "identifi": [3, 4, 6, 12], "illustr": [4, 6, 13], "imag": [1, 3, 4, 6, 8, 9, 12, 13], "image_fn": [10, 13], "image_shap": [1, 4], "implement": 3, "import": [10, 13], "improv": [10, 12], "imshow": [4, 6], "imshow_arg": [4, 6, 13], "includ": [8, 9, 13], "index": 12, "indic": 10, "initi": [3, 12], "initial_guess": 3, "inplac": 9, "input": 13, "inquiri": 11, "insid": [3, 4], "instal": 9, "instead": [8, 10], "instrument": [10, 13], "int": [1, 3, 4, 6, 10], "interpolation_scal": [3, 4, 10], "invalidsizeerror": 2, "invers": 8, "invert": 8, "io": [3, 4, 10], "iop": 7, "iopscienc": 7, "is_vari": [1, 3, 4], "issu": [9, 11], "item": 3, "iter": 3, "its": 13, "j": 7, "journal": [7, 8, 12], "kei": 3, "kernel": [4, 6, 12], "kind": [3, 4], "know": 10, "kwarg": 5, "label": [4, 6], "label_pixel_bound": [4, 6], "larg": [1, 3, 4, 10, 13], "larger": 13, "least": 10, "left": [3, 4, 10], "length": 10, "less": [4, 6], "light": [8, 10], "like": [1, 3, 4, 11], "line": [4, 6, 9], "list": [1, 3, 4, 5, 10], "listedcolormap": 6, "littl": 10, "ll": [9, 10], "lmfit": 3, "load": [1, 3, 4, 10], "loader": 13, "local": 8, "locat": [9, 13], "look": [1, 4], "lower": [3, 4], "ly": [3, 4], "m": 9, "mai": [4, 6, 13], "main": 8, "make": [1, 4, 8, 9, 10, 11], "mani": [8, 10], "marcu": 7, "mask": [3, 4, 10], "match": [10, 12], "mathemat": 8, "matplotlb": [4, 6], "matplotlib": [4, 6], "maximum": [1, 4, 10], "mean": [3, 4, 10], "median": [3, 4, 10], "meshgrid": 10, "method": [8, 10], "might": 8, "minim": 3, "minimizerresult": 3, "mission": [8, 12], "mode": [3, 4], "model": [1, 3, 4, 5, 8, 10, 12], "modul": 12, "month": 7, "more": [3, 4, 8, 10, 13], "most": [3, 4, 7, 8, 10], "mpl": 9, "much": [8, 13], "multipli": 8, "must": [1, 4, 9, 10], "n_imag": [3, 4, 10], "navig": 9, "ndarari": 5, "ndarrai": [1, 3, 4, 5, 10], "necessari": 8, "need": [8, 9, 10, 11], "neighbor": 13, "neighborhood": [1, 4, 10], "new": [3, 4, 6, 8], "non": 2, "none": [1, 3, 4, 5, 6, 10], "normal": [4, 6], "note": [1, 3, 4, 10, 13], "notic": 11, "now": [9, 10], "np": [1, 3, 4, 5, 10], "number": [3, 4, 5, 6, 7, 13], "numpi": [1, 3, 4, 5, 10], "nx": [3, 4, 10], "nx2": [1, 3, 4], "ny": [3, 4, 10], "object": [4, 6, 10], "observ": [1, 4, 8, 12], "off": 7, "omit": [4, 6], "onc": 13, "one": [3, 4, 6, 10], "onli": [1, 4, 6, 8, 10, 13], "open": [10, 11], "oper": [3, 4, 8], "optic": 8, "option": 3, "org": 7, "origin": [10, 12], "other": [3, 4, 6, 9, 10, 11, 13], "otherwis": [1, 3, 4, 10], "our": [8, 9], "outlin": 8, "output": [9, 10], "outsid": 10, "over": [1, 3, 4, 5, 10], "overlap": [1, 4, 6, 8, 10, 13], "overview": 12, "packag": [7, 9, 11, 12], "page": [0, 7, 9, 12], "panel": [10, 12], "paper": [7, 8, 10, 12], "paramet": [1, 3, 4, 5, 6], "part": 10, "pass": [4, 6], "patch": [1, 3, 4, 6, 10, 13], "patch_collect": [4, 6], "patch_siz": [3, 4, 6, 10, 13], "patchcollect": [3, 4], "patchcollectionabc": [3, 4, 6], "path": [1, 3, 4, 9], "path_to_sav": 10, "pathlib": [1, 4], "percentil": [3, 4, 10], "peripheri": [10, 12], "pip": 9, "pixel": [1, 3, 4, 6, 10], "plan": [1, 4], "plane": 13, "pleas": [7, 9, 11], "plot": [4, 6, 9, 13], "plt": [4, 6, 13], "point": [1, 4, 5, 7, 8, 12], "pointspreadfunctionabc": [1, 3, 4, 5], "posit": 13, "possibl": 11, "pre": 12, "premis": 8, "prepar": 10, "previou": 10, "problem": 10, "process": [3, 4, 10], "produc": [4, 6, 10, 13], "project": 9, "properti": [1, 4, 5], "provid": [3, 4, 6, 10, 13], "psf": [0, 1, 3, 4, 6, 12], "psf_size": [3, 4, 6, 10, 13], "psfparametervalidationerror": 2, "publish": 7, "punch": [8, 12], "purpos": 10, "py": 9, "pytest": 9, "python": [9, 10, 12, 13], "pyx": 8, "quickstart": 10, "r": 9, "rang": [4, 6], "rather": [11, 13], "re": [9, 10, 11, 13], "read": [9, 10, 13], "readthedoc": [3, 4, 10], "real": [3, 5], "reason": [10, 13], "receiv": 10, "reciproc": [4, 6], "recommend": [9, 10], "record": 7, "refer": [9, 12], "region": [4, 6, 8, 10], "region_s": [4, 6, 13], "regular": [4, 6, 7, 10, 12, 13], "regularizepsf": [0, 8, 10, 13], "repeat": 13, "repositori": 9, "represent": [3, 4], "requir": [9, 10, 13], "result": [3, 4, 8, 10, 13], "return": [1, 3, 4, 5, 6, 10], "right": 10, "robust": 13, "routin": 8, "row": 13, "run": [4, 6, 10, 12], "same": [4, 6, 8], "sampl": [3, 4, 13], "save": [1, 3, 4, 9, 10, 13], "scale": [3, 4, 6, 10], "search": 12, "seaton": 7, "second": [1, 4, 5, 13], "section": 10, "see": [1, 3, 4, 8, 9, 10], "seen": 13, "select": [3, 4, 10], "self": 10, "sep": [3, 4, 10], "separ": [4, 6, 13], "seri": [3, 4, 10], "serv": 13, "set": [1, 3, 4, 5, 6, 10, 12], "setup": 9, "shape": [1, 3, 4, 10], "shouuld": [1, 4], "show": [4, 6, 9, 13], "shown": [8, 9, 13], "side": [3, 4, 10, 13], "sigma": 10, "sigma_i": 10, "sigma_x": 10, "signatur": 10, "simluat": [1, 4], "simpl": 5, "simple_psf": [4, 5, 10], "simplepsf": [1, 3, 4, 5], "simpler": [4, 6], "simpli": [8, 10], "simplifi": 12, "simul": [1, 4], "simulate_observ": [1, 4], "sinc": 8, "size": [1, 3, 4, 10, 13], "slow": [3, 4, 8, 10], "slowli": 12, "smaller": 8, "smooth": 8, "so": [8, 11, 13], "societi": 7, "softwar": 7, "someon": 11, "somewhat": 10, "sourc": [1, 4, 8, 9, 13], "space": [8, 13], "span": [4, 6], "speak": 11, "specif": [3, 7], "specifi": [3, 4], "speed": [8, 12], "sphinx": [0, 9], "spread": [5, 7, 8, 12], "squar": [1, 3, 4, 10], "standard": 8, "star": [1, 3, 4, 6, 8, 10, 12], "star_mask": [3, 4, 10], "star_threshold": [3, 4, 10], "starfield": 12, "start": 11, "static": [3, 4], "step": [3, 4, 13], "store": [1, 4, 10], "str": [1, 3, 4, 5, 6, 10], "style": 9, "subpixel": [3, 4, 10], "subtract": [10, 13], "suffici": 13, "suggest": [1, 4], "summari": 9, "support": 11, "symmetr": 10, "synthet": 12, "system": [8, 10], "take": 10, "target": [3, 4, 6, 12, 13], "target_evalu": [1, 3, 4, 10, 13], "target_fwhm": 10, "target_model": [1, 4], "techniqu": [10, 12], "test": 12, "than": [3, 4, 6, 8, 10, 11, 13], "thank": 11, "them": [9, 13], "thi": [0, 1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13], "thorough": 8, "those": 13, "thought": 13, "threshold": [3, 4, 10], "through": 10, "thu": [8, 10], "time": [9, 10], "titl": 7, "to_array_corrector": [3, 4, 10, 13], "togeth": [3, 4], "too": 11, "tool": 8, "transfer": [4, 6, 10, 12], "transit": [1, 4, 8, 10], "treatment": 8, "tricki": 10, "true": [1, 3, 4, 5, 6, 10], "tupl": [1, 3, 4], "turn": [3, 4, 10], "tutori": 10, "two": 13, "txt": 9, "type": [1, 3, 4, 5, 6, 10], "typic": 8, "u": 9, "understand": [8, 13], "unevaluatedpointerror": 2, "uniform": [8, 10, 13], "up": [4, 6, 7, 8, 11, 12], "updat": 9, "url": 7, "us": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13], "user": 11, "util": [4, 6, 8, 9, 13], "v1": [3, 4, 10], "valid": [3, 4], "validate_at_cal": 5, "validationerror": 2, "valu": [3, 4, 5, 6, 10], "vari": [1, 4, 5, 8, 10, 12], "variabl": 7, "variat": 13, "varied_psf": [4, 5], "variedpsf": [4, 5], "variedpsfparametermismatcherror": 2, "vary_funct": 5, "venv": 9, "veri": 8, "version": [1, 4, 7, 10], "view": [1, 4, 5], "virtual": 9, "visibl": 13, "visual": [0, 4, 8, 10, 12], "visualize_patch_count": [4, 6, 13], "visualize_psf": [4, 6, 13], "visualize_transfer_kernel": [4, 6, 13], "vmax": 13, "vmin": 13, "volum": 7, "wa": [8, 12], "walk": 10, "want": [1, 4, 11], "we": [1, 4, 8, 9, 10, 11, 13], "well": 8, "were": [4, 6], "what": [1, 4], "when": [1, 4, 9, 10], "where": [1, 3, 4, 10], "wherea": 10, "whether": 13, "which": [3, 4, 6, 9, 10], "while": 13, "white": [4, 6], "wide": 9, "width": [4, 6, 10], "window": 10, "within": [4, 6, 10], "without": 8, "work": 9, "would": [4, 6], "x": [1, 3, 4, 5, 6, 10], "x0": 10, "xy": [1, 4], "y": [1, 4, 5, 6, 10], "y0": 10, "year": 7, "yield": [3, 4, 10, 13], "you": [4, 6, 7, 8, 9, 10, 11], "your": [4, 6, 10, 11, 13], "zenodo": 7}, "titles": ["API Reference", "regularizepsf.corrector", "regularizepsf.exceptions", "regularizepsf.fitter", "regularizepsf", "regularizepsf.psf", "regularizepsf.visualize", "Citation", "Concepts", "Development", "Examples", "Help", "Welcome to regularizepsf!", "Visualization"], "titleterms": {"api": 0, "arraycorrector": 10, "attribut": [3, 6], "build": [9, 10], "citat": 7, "class": [1, 3, 4, 5], "commit": 9, "concept": 8, "content": [1, 2, 3, 4, 5, 6, 12], "correct": [10, 13], "corrector": 1, "dash": 10, "data": 10, "defin": 10, "demo": 10, "develop": 9, "distribut": 13, "doc": 9, "exampl": 10, "except": 2, "extract": 13, "fitter": 3, "function": [1, 4, 5, 6], "help": 11, "identifi": 13, "imag": 10, "indic": 12, "input": 10, "kernel": 13, "modul": [1, 2, 3, 5, 6], "overview": 8, "packag": [4, 8], "paramet": 10, "perform": 10, "pre": 9, "psf": [5, 8, 10, 13], "punch": 10, "purpos": 8, "refer": 0, "regularizepsf": [1, 2, 3, 4, 5, 6, 12], "run": 9, "set": 9, "star": 13, "submodul": 4, "tabl": 12, "target": [8, 10], "techniqu": 8, "test": 9, "transfer": 13, "up": 9, "visual": [6, 13], "welcom": 12}}) \ No newline at end of file