API Reference¶
Full auto-generated documentation for all public classes and functions in PSFCraft, grouped by topic.
How to read this
Each section below links to a dedicated page. Every page auto-renders docstrings from the source code via mkdocstrings. Click [source] on any item to jump straight to the code.
Sections¶
| Section | Contents |
|---|---|
| Telescope Models | GenericTelescope, NewtonianTelescope — build and configure telescope objects |
| Aperture & Optics | NewtonianTelescopeAperture — POPPY aperture geometries |
| Display & Metrics | display_psf, display_ee, measure_ee, measure_centroid |
| Source Building | build_polychromatic_star, filter constants |
| Batch Generation | build_wfe_budget, generate_coefficients, PSF_Generator |
| Constants | Filter cuts, detector parameters, stellar type tables |
Quick symbol index¶
| Symbol | Module | Description |
|---|---|---|
NewtonianTelescope |
psfcraft.psfcraft_core |
Main telescope class |
GenericTelescope |
psfcraft.psfcraft_core |
Abstract base class |
NewtonianTelescopeAperture |
psfcraft.optics |
POPPY CompoundAnalyticOptic |
display_psf |
psfcraft.utils |
Log-stretch PSF plot |
display_ee |
psfcraft.utils |
Encircled Energy curve |
measure_ee |
psfcraft (re-export) |
EE fraction at radius r |
measure_centroid |
psfcraft.utils |
PSF centroid position |
build_polychromatic_star |
psfcraft.utils |
Black-body source dict |
build_wfe_budget |
psfcraft.utils |
WFE budget list |
generate_coefficients |
psfcraft.utils |
Random Zernike draw |
PSF_Generator |
psfcraft.utils |
Batch PSF generation engine |
Optical_aberration_names |
psfcraft.utils |
Noll-indexed aberration names |
FILTER_Y_CUTS |
psfcraft.constants |
Y-band wavelength range (nm) |
FILTER_J_CUTS |
psfcraft.constants |
J-band wavelength range (nm) |
FILTER_H_CUTS |
psfcraft.constants |
H-band wavelength range (nm) |