Skip to content

API reference

The reference is generated from the installed package, so signatures, defaults, and docstrings always match the code. Domain guides explain why and when; reference pages carry the contracts.

Quick paths

Goal Entry point Guide
Transform pixels and sky coordinates torchsky.wcs.WCS coordinates
Use catalog frames and space motion torchsky.coords.transform frames
Crossmatch catalogs at scale torchsky.catalogs.crossmatch_sky crossmatch
HEALPix indexing, queries, regions, MOC torchsky.sphere.ang2pix healpix
Spherical harmonic transforms torchsky.sphere.anafast sht
Plan and coadd images torchsky.map.coadd coadds
Build spectral cubes torchsky.map.coadd_cube cubes
Compose scenes and operator bundles torchsky.scene.render scenes
Fit continuous field models torchsky.field.fit fields
Spectral axes, cubes, Doppler shifts torchsky.spectral.SpectralAxis spectral-axes
Synthetic photometry and dust laws torchsky.spectrophotometry.synthetic_photometry photometry
FLRW distances and AP scaling torchsky.cosmology.comoving_distance cosmology
Display and training transforms torchsky.transforms.Compose encoders
Quality and inverse-variance contracts torchsky.quality.build_weight_product coadds
Native likelihood and forced photometry torchsky.map.likelihood.GaussianLikelihoodFactor likelihoods
Browser viewer torchsky.viz.serve viz

Namespaces

Namespace Tier Names Reference
torchsky core 18 reference
torchsky.catalogs core 34 reference
torchsky.coords core 16 reference
torchsky.cosmology core 21 reference
torchsky.extinction core 18 reference
torchsky.log_lambda core 3 reference
torchsky.map core 41 reference
torchsky.quality core 10 reference
torchsky.redshift core 28 reference
torchsky.spectral core 14 reference
torchsky.spectrophotometry core 13 reference
torchsky.sphere core 134 reference
torchsky.transforms core 20 reference
torchsky.wcs core 141 reference
torchsky.encoders experimental 8 reference
torchsky.field experimental 52 reference
torchsky.filter_profiles experimental 6 reference
torchsky.map.evidence experimental 1 reference
torchsky.map.field.chromatic experimental 4 reference
torchsky.map.field.gaussian experimental 1 reference
torchsky.map.field.joint_native_likelihood experimental 1 reference
torchsky.map.field.native_integrated_read experimental 2 reference
torchsky.map.field.native_response experimental 3 reference
torchsky.map.likelihood experimental 4 reference
torchsky.map.operators.continuous_response experimental 3 reference
torchsky.map.operators.detector_response experimental 4 reference
torchsky.map.operators.epsf experimental 6 reference
torchsky.map.operators.nuisance experimental 2 reference
torchsky.map.operators.pixel_calibration experimental 1 reference
torchsky.map.query experimental 2 reference
torchsky.map.solvers experimental 18 reference
torchsky.scene experimental 36 reference
torchsky.viz experimental 10 reference

Public modules

Module Tier Reference
torchsky.sphere.compat compatibility reference
torchsky.sphere.healpix core reference
torchsky.map.operators.noise experimental reference

Every public name in these namespaces is listed exactly once. The api-manifest.json artifact is the frozen name-level contract checked in CI.

See also: errors and exceptions, runtime contract, and concepts.