limTOD

Getting started

  • Installation
    • From source
  • Quick start
    • Simulate multi-frequency TOD
    • Make a map back from the TOD
    • The same chain, differentiable in JAX
    • Worked notebooks

User guide

  • TOD simulation with TODSim
    • Quick start
    • Beam and sky functions
    • Input parameters
      • Telescope configuration (TODSim.__init__)
      • Observation parameters (generate_TOD / simulate_sky_TOD)
      • Noise and calibration (generate_TOD only)
    • Outputs
    • MPI parallelism
    • Troubleshooting
  • Map-making
    • HPW_mapmaking: high-pass + Wiener
    • Estimator
    • Construction
    • Solving
    • GLS_mapmaking: full noise covariance (hydra-tod port)
    • JAX alternative
  • limTOD.patchbeam — patch-beam TOD path (MeerKLASS-optimal)
    • Algorithm (per pointing)
    • Quick start
    • Building blocks
    • Parallelism
    • Accuracy cross-check
  • limTOD.uvbeam — using pyuvdata UVBeam objects
    • 1. As a beam_func for the classic HEALPix path
    • 2. As a patch beam for the limTOD.patchbeam disc path
    • Conventions: UVBeam vs limTOD, and the adapter
    • Scope and limits
  • limTOD.cstbeam — using CST Studio far-field exports
    • Three entry points
    • Conventions
      • Phi, which the file does not contain
    • What a CST export looks like
    • API
      • Conventions
      • read_cst_farfield()
      • cst_frequency_table()
      • cst_beam_maps()
      • cst_beam_func()
  • limtod_jax — the differentiable JAX port
    • Quick start
    • Public API
    • Exactness contract
    • Precision: enable x64
    • Drift scans: skip the per-sample rotation
    • Performance notes
    • Conventions locked against healpy
  • Drift scans in harmonic space — the m-mode path
    • Formalism
    • Polarisation
      • Why it is free
      • Verification
      • Opt-in, and why it is never inferred
      • Coverage
      • The spin-2 trap (read before touching limtod_jax.hpx)
    • Usage
      • Uniform sampling: FFT synthesis
    • The horizon mask
      • How bad is the ringing? (and when to care)
    • Where the cost actually sits
    • When to use which path

Reference

  • Theory and conventions
    • Signal model
    • Beam coordinate convention
      • The convention as a mount motion
      • Formal definition (normative)
      • Practical reading
      • Special cases
      • Polarization: the basis follows, the handedness does not
    • Coordinate chain
    • Numerical conventions
    • Flicker (1/f) noise
  • API reference
    • limTOD.simulator
      • zyzyz2zyz()
      • zyz_of_pointing()
      • generate_LSTs_deg()
      • pointing_beam_in_eq_sys()
      • generate_TOD_sky()
      • example_beam_map()
      • example_symm_beam_map()
      • truncate_stacked_beam()
      • generate_sky2sys_projection()
    • Map-making
      • limTOD.HPW_filter — high-pass + Wiener
      • limTOD.gls_mapmaking — GLS (hydra-tod port)
    • limTOD.patchbeam
      • Sky TOD vs Full TOD
      • Public API
      • Simulator
      • Beam container
      • Sky integration
      • Projection and disc queries
      • Interpolation and Stokes
    • limTOD.uvbeam
      • Conventions
      • healpix_phi_to_uvbeam_az()
      • uvbeam_to_healpix_maps()
      • uvbeam_beam_func()
      • uvbeam_to_patch_beam()
    • Sky models and noise
      • limTOD.sky_model
      • limTOD.flicker_model
      • limTOD.visual
    • limtod_jax
      • Core sky→TOD chain
      • Polarisation
      • Spherical harmonics and HEALPix
      • Rotations
      • Map-space projection
      • Drift-scan m-modes
  • Changelog
  • Changelog
    • [1.10.0] - 2026-07-31
      • Added
      • Changed
      • Fixed
    • [1.9.0] - 2026-07-30
      • Added
      • Tests
    • [1.8.0] - 2026-07-26
      • Fixed
      • Performance
      • Fixed
      • Documentation
      • Documentation
      • Tests
    • [1.7.0] - 2026-07-26
      • Added
      • Fixed
      • Tests
      • Documentation
    • [1.6.0] - 2026-07-26
      • Added
      • Documentation
    • [1.5.3] - 2026-07-25
      • Documentation
      • Tests
    • [1.5.2] - 2026-07-25
      • Documentation
    • [1.5.1] - 2026-07-25
      • Documentation
      • Tests
    • [1.5.0] - 2026-07-25
      • Added
      • Changed
    • [1.4.0] - 2026-07-25
      • Added
      • Changed
    • [1.3.0] - 2026-07-25
      • Added
      • Code quality (post-review polish)
      • Documentation
      • Packaging
      • Changed
      • Fixed
    • [1.2.0] - 2025-10-06
      • Added
      • Changed
      • Improved
      • Fixed
    • [1.1.0] - 2025-10-05
      • Added
      • Changed
      • Fixed
    • [1.0.0] - 2025-09-01
      • Initial Release
      • Key Features
limTOD
  • API reference
  • Edit on GitHub

API reference

Generated from the docstrings of the installed package. The user guide pages explain how the pieces fit together; these pages are the per-function contract.

  • limTOD.simulator
    • zyzyz2zyz()
    • zyz_of_pointing()
    • generate_LSTs_deg()
    • pointing_beam_in_eq_sys()
    • generate_TOD_sky()
    • example_beam_map()
    • example_symm_beam_map()
    • truncate_stacked_beam()
    • generate_sky2sys_projection()
  • Map-making
    • limTOD.HPW_filter — high-pass + Wiener
    • limTOD.gls_mapmaking — GLS (hydra-tod port)
  • limTOD.patchbeam
    • Sky TOD vs Full TOD
    • Public API
    • Simulator
    • Beam container
    • Sky integration
    • Projection and disc queries
    • Interpolation and Stokes
  • limTOD.uvbeam
    • Conventions
    • healpix_phi_to_uvbeam_az()
    • uvbeam_to_healpix_maps()
    • uvbeam_beam_func()
    • uvbeam_to_patch_beam()
  • Sky models and noise
    • limTOD.sky_model
    • limTOD.flicker_model
    • limTOD.visual
  • limtod_jax
    • Core sky→TOD chain
    • Polarisation
    • Spherical harmonics and HEALPix
    • Rotations
    • Map-space projection
    • Drift-scan m-modes
Previous Next

© Copyright 2026, Zheng Zhang.

Built with Sphinx using a theme provided by Read the Docs.