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. The photometry package wcc_phot has its own page at the end.

Top-level public API

simulate_field	Simulate one WCC detector image of the Gaia field at (ra, dec).
SimulatedField

Modules

• End-to-end pipeline (wcc_sim.pipeline)
  • SimulatedField
  • simulate_field()
• Gaia catalogs (wcc_sim.catalog)
  • GAIA_EPOCH
  • SYNC_ROW_CAP
  • CACHE_ROUND_ARCSEC
  • build_adql()
  • query_gaia()
• Bright-star supplement (wcc_sim.brightcat)
  • XHIP_CATALOG
  • XHIP_EPOCH
  • query_bright()
  • to_gaia_like()
  • merge()
• Epoch propagation and cross-matching (wcc_sim.astrometry)
  • as_time()
  • propagate()
  • crossmatch()
• Count rates (wcc_sim.starflux)
  • gaia_bandpass()
  • gaia_g_bandpass()
  • column_floats()
  • 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()
  • log_rate_at_bp_rp()
  • bp_rp_from_catalog()
  • color_fallback()
  • rates_for_catalog()
  • sky_and_dark_rates()
• PSF rendering (wcc_sim.psf)
  • make_psf_source()
  • centroid_offset()
  • recenter_on_centroid()
  • render_oversampled_psf()
• Chromatic effective PSFs (wcc_sim.chromatic)
  • band_support()
  • effective_wavelength_m()
  • band_nodes()
  • effective_psf()
  • effective_psf_for_spt()
  • effective_wavelength_nm_for_spt()
  • attenuation_factor()
• PSF wing extension (wcc_sim.wings)
  • WingModel
  • fit_wing_model()
  • CombinedWing
• Scattered-light halo (wcc_sim.scatter)
  • Why a 1D profile and not a 2D kernel
  • PROFILE_PATH
  • ScatterHalo
  • build_scatter_table()
  • load_scatter_table()
  • scatter_halo()
  • halo_for_sensorfilter()
• 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()
  • saturation_level_e()
  • get_geometry()
• WCS construction (wcc_sim.wcsutil)
  • build_wcs()
• FITS output (wcc_sim.fitswriter)
  • build_hdulist()
  • write_fits()
• Plotting helpers (wcc_sim.plotting)
  • STYLE_PATH
  • TEAL
  • TARGET_COLOR
  • style_context()
  • use_style()
  • axes()
  • block_max()
  • azimuthal_average()
  • radial_profile()
  • encircled_energy()
  • plot_image()
  • plot_radial_profile()
  • plot_stamp()
  • plot_encircled_energy()
• PSF report (wcc_sim.psfreport)
  • psf_decomposition()
  • reproduction_settings()
  • reproduction_call()
  • select_image()
  • plot_cutout()
  • plot_satmask()
  • plot_psf_profile()
  • build_psf_figure()
  • make_psf_report()
• Command-line interface (wcc_sim.cli)
  • build_parser()
  • main()
• wcc_phot: differential photometry
  • Orchestration: run_photometry and PhotometryResult (wcc_phot.pipeline)
  • Loading frames (wcc_phot.io)
  • Aperture and centroid geometry (wcc_phot.geometry)
  • Target and reference selection (wcc_phot.select)
  • Centroiding (wcc_phot.centroid)
  • Aperture photometry (wcc_phot.apphot)
  • PSF photometry (wcc_phot.psfphot)
  • The differential light curve (wcc_phot.lightcurve)
  • Quality flags (wcc_phot.flags)
  • Diagnostic report and plot panels (wcc_phot.report)
  • Live viewer (wcc_phot.live)
  • ETC cross-check (wcc_phot.validation)
  • Command line (wcc_phot.cli)