API Reference

This section provides detailed API documentation for all SPXQuery modules.

The package is organized into four main module groups:

Core Modules

Pipeline orchestration, data acquisition, and configuration.

• Core Modules - Query execution, downloads, pipeline management, and configuration classes

Processing Modules

Scientific data extraction and analysis.

• Processing Modules - FITS handling, photometry, light curves, and magnitude conversions

Visualization Modules

Publication-quality plotting with quality control.

• Visualization Modules - Combined spectral and temporal plots

Utility Modules

Shared utilities and parameter management.

• Utility Modules - Logging, JSON I/O, parameter export/import

Drizzle3D Module

3D spectral image drizzle for combining SPHEREx observations into data cubes.

• Drizzle3D API Reference - Configuration, spatial/spectral mapping, accumulation, and FITS I/O

Batch Module

Multi-source batch photometry over sky regions.

• Batch Module - Region-based queries, multi-source extraction, and aggregation

• Core Modules
  • Source
  • PhotometryConfig
  • VisualizationConfig
  • DownloadConfig
  • QueryConfig
  • AdvancedConfig
  • ObservationInfo
  • QueryResults
  • PhotometryResult
  • DownloadResult
  • PipelineState
  • query_spherex_observations()
  • query_spherex_region()
  • print_query_summary()
  • download_file()
  • parallel_download()
  • print_download_summary()
  • SPXQueryPipeline
  • run_pipeline()
• Drizzle3D API Reference
  • Drizzle3DConfig
  • drizzle()
  • DrizzleCube
  • Submodules
• Processing Modules
  • repair_variance_for_flagged_pixels()
  • extract_aperture_photometry()
  • process_flags_in_aperture()
  • extract_aperture_photometry_with_background()
  • extract_source_photometry()
  • process_all_observations()
  • fast_sigma_clip()
  • estimate_window_background()
  • determine_annulus_radii()
  • create_annulus_mask()
  • estimate_local_background()
  • generate_lightcurve_dataframe()
  • save_lightcurve_csv()
  • summarize_lightcurve()
  • load_lightcurve_from_csv()
  • print_lightcurve_summary()
  • flux_jy_to_ab_magnitude()
  • calculate_ab_magnitude_from_jy()
  • magnitude_to_flux_jy()
• Visualization Modules
  • calculate_smart_ylimits()
  • apply_sigma_clipping()
  • create_spectrum_plot()
  • create_lightcurve_plot()
  • create_combined_plot()
  • plot_summary_statistics()
• Utility Modules
  • setup_logging()
  • save_yaml()
  • load_yaml()
  • format_file_size()
  • validate_directory()
  • get_file_list()
  • validate_cutout_size()
  • validate_cutout_center()
  • format_cutout_url_params()
  • estimate_cutout_size_mb()
  • create_flag_mask()
  • check_flag_bits()
  • apply_quality_filters()
  • ClassifiedPhotometry
  • classify_photometry_by_quality()
  • export_default_parameters()
  • load_advanced_config()
  • suppress_astropy_info()
  • SPHERExMEF
  • read_spherex_mef()
  • get_pixel_coordinates()
  • get_wavelength_at_position()
  • get_pixel_scale_at_position()
  • get_flag_info()
  • format_flag_binary()
  • create_background_mask()
  • estimate_zodiacal_scaling()
  • subtract_zodiacal_background()
• Batch Module
  • BatchConfig
  • load_catalog()
  • query_region_observations()
  • process_single_image()
  • run_extraction()
  • aggregate_lightcurves()
  • load_query_summary()
  • BatchPipeline
  • run_batch()