API reference

This reference is generated automatically from the docstrings in the source. It is organized by module. The public entry points are re-exported at the top level of the wcc_sim package, so wcc_sim.simulate_field and wcc_sim.pipeline.simulate_field are the same function.

Top-level public API

Modules

• End-to-end pipeline (wcc_sim.pipeline)
• Gaia catalogs (wcc_sim.catalog)
  • GAIA_EPOCH
  • build_adql()
  • query_gaia()
• Bright-star supplement (wcc_sim.brightcat)
• Epoch propagation and cross-matching (wcc_sim.astrometry)
• Count rates (wcc_sim.starflux)
  • gaia_g_bandpass()
  • spt_from_bp_rp()
  • spt_from_b_v()
  • g_minus_v()
  • g_minus_v_at_b_v()
  • bp_rp_for_spt()
  • make_star_simulation()
  • rate_for_spt()
  • rates_for_catalog()
  • sky_and_dark_rates()
• PSF rendering (wcc_sim.psf)
  • make_psf_source()
  • render_oversampled_psf()
• Chromatic effective PSFs (wcc_sim.chromatic)
  • band_support()
  • band_nodes()
  • effective_psf()
  • effective_psf_for_spt()
  • attenuation_factor()
• PSF wing extension (wcc_sim.wings)
• Scene rendering & noise (wcc_sim.render)
  • bin_oversampled()
  • StampBlend
  • wing_blend()
  • add_star()
  • render_scene()
  • star_saturated()
  • add_noise_and_digitize()
• Extended sources (wcc_sim.extended)
  • SersicComponent
  • sersic_total_over_amplitude()
  • component_amplitude()
  • render_component_profile()
  • render_extended()
• Detector geometry (wcc_sim.detectors)
  • DetectorGeometry
  • make_base_simulation()
  • get_geometry()
• WCS construction (wcc_sim.wcsutil)
• FITS output (wcc_sim.fitswriter)
  • build_hdulist()
  • write_fits()
• Command-line interface (wcc_sim.cli)