aopp_obs_toolchain::aopp_deconv_tool API Documentation Modules Classes Names
Clear Help

Module Index

  • aopp_deconv_tool - No package docstring; 22/23 modules, 6/15 packages documented
    • algorithm - No package docstring; 1/4 package documented
      • artefact_detection - Undocumented
      • bad_pixels - Routines for identifying and fixing bad pixels in observation data.
        • ssa_sum_prob - No module docstring; 0/1 variable, 4/5 functions documented
      • deconv - No package docstring; 1/3 module documented
        • base - Base class for all deconvolution algorithms
        • clean_modified - No module docstring; 0/1 variable, 1/1 class documented
        • lucy_richardson - No module docstring; 0/1 variable, 1/1 class documented
      • interpolate - No package docstring; 0/1 function, 1/1 module documented
        • ssa_interp - Uses SSA to get values for interpolation of data
    • arguments - Classes and functions for working with command-line arguments alongside the argparse module.
    • artefact_detection - Detects artefacts, returns a "badness map" that represents how much the algorithm thinks a particular pixel is an artefact.
    • astropy_helper - Undocumented
      • fits - No package docstring; 2/2 modules documented
        • header - Helper functions to operate on FITS headers.
        • specifier - Routine for parsing a string containing the path, extension, slices, and axes of a FITS file that we want to operate on.
    • cast - Contains routines for casting to and from types. Generally useful for simple data marshalling to and from text
    • cfg - Configuration for the package
      • logs - Logging setup for the package
      • settings - Setting for the package
    • context - Undocumented
      • alias - No module docstring; 1/1 class documented
      • next - No module docstring; 1/1 class documented
      • temp - No module docstring; 1/1 function, 0/1 class documented
    • create_bad_pixel_mask - Given a badness map, will apply a value cut (or possibly a range of interpolated value cuts) to the badness map to give a boolean mask that defines "bad" pixels
    • data_structures - Undocumented
      • bi_directional_map - No module docstring; 1/1 class documented
      • pointer - No module docstring; 1/1 class documented
    • deconvolve - Script that deconvolves the first argument with the second argument
    • estimate_noise - Provide various ways of estimating the noise in some data
    • extract_sources - No module docstring; 0/1 variable, 2/12 functions documented
    • fit_psf_model - Tool for fitting a PSF to a particular model
    • fits_copy_wcs - Copy the WCS information from one FITS file to another, useful when we know that two observations were taken with the same setup but one has no physical information.
    • fits_slice - Apply slices to a FITS file, reducing the number of entries across a set of axes.
    • fpath - Field-aware path class, can use format fields to create new paths based upon a template path.
    • geo_array - Routines for handing an array that knows it's physical size.
    • geometry - Routines useful for geometry
      • bounding_box - No module docstring; 0/4 type variable, 0/1 constant, 1/1 class documented
      • shape - Shapes for use with geometry package
    • graphical_frontends - No package docstring; 1/1 module documented
      • ssa_filtering - Graphical front end to SSA filtering of an image, should be usable for a cube and a 2d image
    • image_processing - No package docstring; 1/1 module documented
      • otsu_thresholding - Implements Otsu's method for thresholding images
    • interpolate - Tool for interpolating data in a FITS file, pixels to be interpolated are specified via a boolean map.
    • mfunc - Module containing small mathematical functions that are useful in lots of contexts
    • numpy_helper - No package docstring; 2/2 modules, 1/1 package documented
      • array - Helper routines that calculate values or give information about arrays
        • grid - Regrids a numpy array.
        • index - Helpers for array operations involving indexing
        • mask - Routines that use masks to assist in array operations
          • interp - ND interpolation for numpy arrays
        • pad - Padding operations
        • shift - Helpers for array operations
      • axes - Helper functions for axes operations on numpy arrays.
      • slice - Helper functions for slice operations on numpy arrays
    • optimise_compat - Classes and routines for wrangling PSF model into a format used by various 3rd party optimisation tools.
      • ultranest_compat - Contains classes and functions that aid compatibility with the ultranest package
    • plot_helper - Classes and routines that assist with plotting, specifically plotting the progress of algorithms.
      • base - Defines the public facing interface for plot classes, used to interface with hooks in aopp_deconv_tool.algorithm.deconv classes
      • plotters - Contains classes that assist with plotting histograms.
    • psf_data_ops - Module containing routines that operate on point spread function data
    • psf_model - Holds routines, classes, and variables associated with modelling a PSF
      • adaptive_optics_psf_model - Models an adaptive optics observation system in as much detail required to get a PSF.
      • dependency_injector - Dependency injectors for each psf model, consistent interface means they work well with psf_data_ops
        • adaptive_optics_psf_model_di - No module docstring; 1/1 class documented
        • gaussian_psf_model_di - No module docstring; 1/1 class documented
        • params_and_psf_model_di - Dependency injectors make communicating with the routines in psf_data_ops.py more managable by providing a consistent interface. As long as the dependency injector provides parameters and functions as specified in this file, the fitting functions should work.
        • radial_psf_model_di - No module docstring; 1/1 class documented
        • turbulence_psf_model_di - No module docstring; 1/1 class documented
      • gaussian_psf_model - Point spread function (PSF) model that is just a gaussian
      • radial_psf_model - No module docstring; 1/1 class documented
      • turbulence_psf_model - No module docstring; 0/1 variable, 0/6 type variable, 0/1 constant, 3/5 classes documented
    • psf_normalise - Quick tool for normalising a PSF in a FITS file
    • py_ssa - Implementation of Singular Spectrum Analysis.
    • py_svd - Implementation of Singular Value Decomposition
    • scipy_helper - No package docstring; 1/2 module documented
      • interp - Contains routines that are mostly wrappers around scipy interpolation functions
      • label_ops - Undocumented
    • spatial_rebin - Quick tool for spatially rebinning a FITS file, useful for reducing data volume when testing.
    • spectral_rebin - Quick tool for spectrally rebinning a FITS file, convolves a triangular function of bin_width with the input data and samples it every bin_step.
    • stats - No package docstring; 1/1 module documented
      • empirical - Operations on distributions derived from empirical data
    • task_strat - Contains support routines for holding data about "strategies" (i.e., different ways of doing things) that perform "tasks" (e.g., functions, operations, methods).
    • text - Text wrapping, filling, formatting, indenting etc.
    • to_fits - Convert an image to FITS format
    • typedef - Definitions of generic types so I can type hint more easily.

API Documentation for aopp_obs_toolchain::aopp_deconv_tool, generated by pydoctor 24.3.3 at 2024-10-23 16:10:12.