tabascal

General

  • Usage Guide
    • Installation
      • Create a conda environment with python-casacore installed
      • Install via pip (CPU-only)
      • Or with GPU support
      • Installing from a clone
    • Satellite orbital elements
  • Example Simulation and RFI Subtraction
    • Running Simulations
    • Subtracting Satellite-based RFI
      • GPU memory
      • Sharding across several GPUs
    • Extracting RFI light curves
      • Fitting the along-track time offset
    • Searching for the contaminating satellite
  • Example result
    • Reading the panels
    • Why the trajectory matters
  • Output from TABASCAL
    • Results .zarr files
    • MS file columns
      • Weights
      • Correlations
      • Writing results for a run that used a gain table
      • Multiple samples
      • Per-satellite RFI columns
      • Zero and non-finite gains
      • When the results do not match the MS
    • Calibration table
      • Writing the table somewhere else
      • Flagged in the table, substituted in the columns
      • Several samples
      • When no table is written
      • If the export fails
    • Light curves and the satellite search
  • Output Files
    • Directory Structure
    • Zarr Output (.zarr)
    • Measurement Set (.ms)
  • Configuration File
    • Model
      • Precision
    • Data
    • Plots
    • Inference
    • Optimisation
      • Optimiser trace
    • Astronomical Signal
      • A fixed sky of discrete sources
    • RFI signal
      • RFI light curve estimates
      • Estimating the light curves from the data
    • Satellites
    • Gains
      • The default prior widths
      • A constant gain per antenna
  • RFI-visibility kernels
    • Installation
    • Enabling them
    • Memory
    • Precision
    • The data-grid route
  • The data-grid RFI route and its kernel boundary
    • The three components
    • The kernel boundary
    • The compiled operator
    • Analytic integration for fast baselines
    • Quadrature-only variable sampling
    • What the reference is and is not
    • Accuracy
    • Configuration
  • Components
    • Base Component Class
    • Trajectory Components
    • RFI Signal Components
      • Fourier-domian - ComplexRFIVarAnt, ComplexRFIConstAnt
    • RFI Visibility Calculation Components
    • Astronomical Signal Components
    • Astronomical Visibility Components
    • Gain Components
      • Unitary Gains - UnitaryGains
      • Constant Gains - ConstGains
  • Concepts
    • Gaussian Process Models
      • Fourier-domain models
  • Satellite orbit records
    • Two archives, one handover
    • Resolution order
      • Which endpoint, and the fallback
    • Being a considerate client
    • Cache policy
    • Validation
    • Record age and suitability
    • Exact replay
    • Supplying records manually
      • Records with a fitted time offset
      • Obtaining compatible JSON from Space-Track
    • Distributed runs

Developer

  • Developer Install
    • pixi (recommended for development)
      • Install pixi
      • Available environments
      • Install an environment
      • Open a shell in the environment
    • Editable install without pixi
    • Running tests
    • Building the documentation
  • Pipeline tests
    • What is asserted
      • Reading bias_significance correctly
    • Re-recording the references
      • Filling in the GPU and x86 arch rows
      • Which architecture to record on
    • Adding a case
  • Performance regression checks
    • What is checked
    • Reproducing a regression locally
    • Running the checks directly
    • Updating the references
    • Benchmark history
  • API Reference
    • Component Base Class
      • Component
        • Component.build_constants()
        • Component.build_forward()
        • Component.build_set_params()
        • Component.require_double()
        • Component.setup()
        • Component.validate_state()
      • ComponentOrderError
      • MissingStateInput
      • component_outputs()
      • component_ref()
      • in_tree_components()
      • is_class()
      • state_key_producers()
      • validate_component_order()
    • Trajectory Components
      • FixedOrbit
        • FixedOrbit.build_constants()
        • FixedOrbit.build_forward()
        • FixedOrbit.build_set_params()
        • FixedOrbit.setup()
        • FixedOrbit.validate_and_test()
      • FixedOrbitCoarse
        • FixedOrbitCoarse.build_constants()
        • FixedOrbitCoarse.build_forward()
        • FixedOrbitCoarse.build_set_params()
        • FixedOrbitCoarse.setup()
        • FixedOrbitCoarse.validate_and_test()
      • NoDragOrbit
        • NoDragOrbit.build_constants()
        • NoDragOrbit.build_forward()
        • NoDragOrbit.build_set_params()
        • NoDragOrbit.setup()
        • NoDragOrbit.validate_and_test()
      • Orbit
        • Orbit.build_constants()
        • Orbit.build_forward()
        • Orbit.build_set_params()
        • Orbit.setup()
        • Orbit.validate_and_test()
      • PhaseCalculationRFI
        • PhaseCalculationRFI.build_constants()
        • PhaseCalculationRFI.build_forward()
        • PhaseCalculationRFI.build_set_params()
        • PhaseCalculationRFI.setup()
      • fetch_orbital_elements()
      • fetch_standard_orbital_elements()
      • get_satellite_elevations()
      • get_satellite_positions()
    • RFI Signal Components
      • BaseGPRFI
        • BaseGPRFI.build_mask_constants()
        • BaseGPRFI.build_masked_signal()
        • BaseGPRFI.default_gammas
        • BaseGPRFI.default_pk_cutoff
        • BaseGPRFI.gp_cov_params()
        • BaseGPRFI.setup()
      • ComplexRFIConstAnt
        • ComplexRFIConstAnt.build_constants()
        • ComplexRFIConstAnt.build_forward()
        • ComplexRFIConstAnt.build_set_params()
        • ComplexRFIConstAnt.default_gammas
        • ComplexRFIConstAnt.default_pk_cutoff
        • ComplexRFIConstAnt.setup()
        • ComplexRFIConstAnt.validate_and_test()
      • ComplexRFIVarAnt
        • ComplexRFIVarAnt.build_constants()
        • ComplexRFIVarAnt.build_forward()
        • ComplexRFIVarAnt.build_set_params()
        • ComplexRFIVarAnt.setup()
        • ComplexRFIVarAnt.supersample
        • ComplexRFIVarAnt.validate_and_test()
      • ComplexRFIVarAntCoarse
        • ComplexRFIVarAntCoarse.setup()
        • ComplexRFIVarAntCoarse.supersample
      • read_light_curves()
      • rfi_signal_config_validation()
    • RFI Visibility Calculation Components
      • PolyInterpVis
        • PolyInterpVis.build_constants()
        • PolyInterpVis.build_forward()
        • PolyInterpVis.build_set_params()
        • PolyInterpVis.setup()
      • PolyInterpVisFFI
        • PolyInterpVisFFI.build_forward()
        • PolyInterpVisFFI.setup()
      • PolyInterpVisHybrid
      • PolyInterpVisHybridFFI
        • PolyInterpVisHybridFFI.build_forward()
        • PolyInterpVisHybridFFI.setup()
      • PolyInterpVisVariable
        • PolyInterpVisVariable.build_forward()
      • PolyInterpVisVariableFFI
        • PolyInterpVisVariableFFI.build_forward()
        • PolyInterpVisVariableFFI.setup()
      • RiemannVis
        • RiemannVis.build_constants()
        • RiemannVis.build_forward()
        • RiemannVis.build_set_params()
        • RiemannVis.setup()
      • RiemannVisFFI
        • RiemannVisFFI.build_forward()
        • RiemannVisFFI.build_set_params()
        • RiemannVisFFI.setup()
      • RiemannVisVariable
        • RiemannVisVariable.build_constants()
        • RiemannVisVariable.build_forward()
        • RiemannVisVariable.build_set_params()
        • RiemannVisVariable.setup()
      • RiemannVisVariableFFI
        • RiemannVisVariableFFI.build_forward()
        • RiemannVisVariableFFI.build_set_params()
        • RiemannVisVariableFFI.setup()
    • The Data-Grid RFI Visibility (kernel boundary)
      • Inputs
      • The computation
      • Precision
      • Derivatives
      • Memory
      • analytic_rfi_vis()
      • cell_vis()
      • coarse_rfi_vis()
      • fine_phase()
      • fine_signal()
      • linear_phase_moments()
      • quadratic_phase_moments()
    • Interpolation Tables and Path Fits
      • DeviceGroup
        • DeviceGroup.n_padded
      • PolyTimeGroup
      • analytic_sampling_cut()
      • device_groups()
      • fine_offsets()
      • fit_path()
      • interp_tables()
      • lagrange_basis()
      • make_poly_time_group()
      • monomial_tables()
      • poly_sample_counts()
      • poly_time_groups()
      • split_group_over_devices()
    • Astronomical Signal Components
      • FixedDiscreteSky
        • FixedDiscreteSky.build_constants()
        • FixedDiscreteSky.build_forward()
        • FixedDiscreteSky.setup()
      • INLINE_FIELDS
      • OSKAR_COLUMNS
      • OSKAR_LEGACY_COLUMNS
      • POLARISATION_COLUMNS
      • read_oskar_sky_model()
    • Astronomical Visibility Components
      • DiscreteSkyVis
        • DiscreteSkyVis.build_constants()
        • DiscreteSkyVis.build_forward()
        • DiscreteSkyVis.setup()
      • GPVisAst
        • GPVisAst.build_block_signal()
        • GPVisAst.build_constants()
        • GPVisAst.build_forward()
        • GPVisAst.build_set_params()
        • GPVisAst.setup()
        • GPVisAst.validate_and_test()
      • GPVisAstDFT
        • GPVisAstDFT.build_block_signal()
      • radec_to_lmn()
    • Gain Components
      • ConstGains
        • ConstGains.build_constants()
        • ConstGains.build_forward()
        • ConstGains.build_set_params()
        • ConstGains.setup()
      • DEFAULT_AMP_STD_PERCENT
      • DEFAULT_PHASE_STD_DEGREES
      • UnitaryGains
        • UnitaryGains.build_forward()
        • UnitaryGains.setup()
      • antenna_connectivity()
      • component_class_names()
      • read_const_gain()
      • reduce_caltable_gains()
      • validate_gain_scales()
      • zero_sum_basis()
    • RFI Light-Curve Estimation
      • The estimator
      • Which baselines are coherent
      • Along-track time offset
      • Searching across candidates
      • Where it is used
        • DEFAULT_TAU_GRID
        • attach_offset_fits()
        • baseline_lengths()
        • candidates_from_norad_ids()
        • candidates_from_orbit_dir()
        • coherence_scores()
        • coherent_baseline_mask()
        • coverage_stats()
        • decohered_null()
        • enumerate_candidates()
        • extract_light_curves_from_ms()
        • extract_light_curves_from_zarr()
        • fine_time_offsets()
        • fit_time_offset()
        • fit_time_offsets()
        • fringe_rate_coherence_length()
        • has_noise_scale()
        • is_detection()
        • light_curves_from_config()
        • matched_filter_light_curves()
        • matched_filter_sums()
        • near_field_baseline_paths()
        • near_field_fringe_model()
        • offset_fit_summary()
        • plot_candidate_ranking()
        • plot_offset_diagnostics()
        • plot_z_spectrograms()
        • rayleigh_threshold()
        • rfi_phase_from_positions()
        • rfi_phase_from_records()
        • satellite_range_and_speed()
        • save_light_curves_npz()
        • search_candidates()
        • select_detections()
        • select_sources()
        • shift_orbit_record_epoch()
        • tau_scan()
        • tle_coherence_length()
        • write_config_fragment()
        • write_search_results()
        • write_shifted_orbits()
    • Time and Time Scales
      • Time scales
      • Normalising at the boundary
      • Day numbers that leave the observation
        • TIME_SCALES
        • datetime_to_jd()
        • gast_deg()
        • jd_to_datetime()
        • skyfield_time()
        • timescale()
        • to_utc_jd()
        • to_utc_mjd()
        • utc_offset_days()
    • Measurement Sets and Calibration Tables
      • Reading declarations rather than assuming them
      • CASA calibration tables
        • What may be deleted
        • Scope: one spectral window, one correlation
        • What a failed write leaves behind
  • Publishing the Documentation
    • Versions
      • Publishing a release version
      • Publishing another branch
    • One-time project setup
    • Building the docs locally
tabascal
  • API Reference
  • View page source

API Reference

  • Component Base Class
  • Trajectory Components
  • RFI Signal Components
  • RFI Visibility Calculation Components
  • The Data-Grid RFI Visibility (kernel boundary)
  • Interpolation Tables and Path Fits
  • Astronomical Signal Components
  • Astronomical Visibility Components
  • Gain Components
  • RFI Light-Curve Estimation
  • Time and Time Scales
  • Measurement Sets and Calibration Tables
Previous Next

© Copyright 2025-2026, Chris Finlay.

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