scopesim package

Subpackages

• scopesim.commands package
  • Submodules
    • scopesim.commands.user_commands module
      • UserCommands
  • Module contents
• scopesim.detector package
  • Submodules
    • scopesim.detector.detector module
      • Detector
    • scopesim.detector.detector_array module
      • DetectorArray
      • make_effects_hdu()
      • make_primary_hdu()
    • scopesim.detector.nghxrg module
  • Module contents
• scopesim.effects package
  • Submodules
    • scopesim.effects.apertures module
      • ApertureList
      • ApertureMask
      • RectangularApertureMask
      • SlitWheel
      • make_aperture_polygon()
      • mask_from_coords()
      • points_on_a_circle()
      • rotate()
    • scopesim.effects.data_container module
      • DataContainer
    • scopesim.effects.detector_list module
      • DetectorList
      • DetectorWindow
    • scopesim.effects.effects module
      • Effect
    • scopesim.effects.effects_utils module
      • combine_surface_effects()
      • empty_surface_list()
      • get_all_effects()
      • is_spectroscope()
      • make_effect()
      • scopesim_effect_classes()
      • z_order_in_range()
    • scopesim.effects.electronic module
      • AutoExposure
      • BasicReadoutNoise
      • Bias
      • BinnedImage
      • DarkCurrent
      • DetectorModePropertiesSetter
      • LinearityCurve
      • PoorMansHxRGReadoutNoise
      • Quantization
      • ReferencePixelBorder
      • ShotNoise
      • SummedExposure
      • UnequalBinnedImage
      • make_ron_frame()
      • pseudo_random_field()
    • scopesim.effects.fits_headers module
      • EffectsMetaKeywords
      • ExtraFitsKeywords
      • SimulationConfigFitsKeywords
      • SourceDescriptionFitsKeywords
      • flatten_dict()
      • get_relevant_extensions()
    • scopesim.effects.metis_lms_trace_list module
      • MetisLMSEfficiency
      • MetisLMSImageSlicer
      • MetisLMSSpectralTrace
      • MetisLMSSpectralTraceList
      • echelle_setting()
    • scopesim.effects.obs_strategies module
      • ChopNodCombiner
      • chop_nod_image()
    • scopesim.effects.psf_utils module
      • cutout_kernel()
      • get_bkg_level()
      • get_psf_wave_exts()
      • get_strehl_cutout()
      • get_total_wfe_from_table()
      • make_strehl_map_from_table()
      • nearest_index()
      • nmrms_from_strehl_and_wavelength()
      • rescale_kernel()
      • rotational_blur()
      • round_kernel_edges()
      • sigma2gauss()
      • strehl2sigma()
      • wfe2gauss()
      • wfe2strehl()
    • scopesim.effects.psfs module
      • AnalyticalPSF
      • AnisocadoConstPSF
      • DiscretePSF
      • FieldConstantPSF
      • FieldVaryingPSF
      • GaussianDiffractionPSF
      • NonCommonPathAberration
      • PSF
      • PoorMansFOV
      • SeeingPSF
      • SemiAnalyticalPSF
      • Vibration
    • scopesim.effects.rotation module
      • Rotate90CCD
    • scopesim.effects.shifts module
      • AtmosphericDispersion
      • AtmosphericDispersionCorrection
      • Shift3D
      • atmospheric_refraction()
      • get_pixel_border_waves_from_atmo_disp()
    • scopesim.effects.shutter module
      • Shutter
    • scopesim.effects.spectral_efficiency module
      • SpectralEfficiency
    • scopesim.effects.spectral_trace_list module
      • SpectralTraceList
      • SpectralTraceListWheel
    • scopesim.effects.spectral_trace_list_utils module
      • SpectralTrace
      • Transform2D
      • XiLamImage
      • fill_zeros()
      • fit2matrix()
      • get_affine_parameters()
      • make_image_interpolations()
      • rolling_median()
      • xilam2xy_fit()
      • xy2xilam_fit()
    • scopesim.effects.surface_list module
      • SurfaceList
    • scopesim.effects.ter_curves module
      • ADCWheel
      • AtmosphericTERCurve
      • DownloadableFilterCurve
      • FilterCurve
      • FilterWheel
      • FilterWheelBase
      • PupilTransmission
      • QuantumEfficiencyCurve
      • SkycalcTERCurve
      • SpanishVOFilterCurve
      • SpanishVOFilterWheel
      • TERCurve
      • TopHatFilterCurve
      • TopHatFilterWheel
    • scopesim.effects.ter_curves_utils module
      • add_edge_zeros()
      • apply_throughput_to_cube()
      • combine_two_spectra()
      • download_svo_filter()
      • download_svo_filter_list()
      • get_filter()
      • get_filter_effective_wavelength()
      • get_zero_mag_spectrum()
      • scale_spectrum()
      • zero_mag_flux()
  • Module contents
• scopesim.optics package
  • Submodules
    • scopesim.optics.fov module
      • FieldOfView
    • scopesim.optics.fov_manager module
      • FOVManager
      • FovVolumeList
    • scopesim.optics.fov_manager_utils module
      • combine_wavesets()
      • get_3d_shifts()
      • get_imaging_fovs()
      • get_imaging_headers()
      • get_imaging_waveset()
      • get_spectroscopy_fovs()
      • get_spectroscopy_headers()
    • scopesim.optics.fov_utils module
      • combine_imagehdu_fields()
      • combine_table_fields()
      • extract_area_from_imagehdu()
      • extract_area_from_table()
      • extract_common_field()
      • extract_range_from_spectrum()
      • get_cube_waveset()
      • is_field_in_fov()
      • make_cube_from_table()
      • make_flux_table()
      • sky2fp()
    • scopesim.optics.image_plane module
      • ImagePlane
    • scopesim.optics.image_plane_utils module
      • add_imagehdu_to_imagehdu()
      • add_table_to_imagehdu()
      • affine_map()
      • calc_footprint()
      • calc_table_footprint()
      • create_wcs_from_points()
      • det_wcs_from_sky_wcs()
      • get_canvas_header()
      • header_from_list_of_xy()
      • overlay_image()
      • pix2val()
      • reorient_imagehdu()
      • rescale_imagehdu()
      • sky_wcs_from_det_wcs()
      • split_header()
      • sub_pixel_fractions()
      • val2pix()
    • scopesim.optics.monochromatic_trace_curve module
      • MonochromeTraceCurve
    • scopesim.optics.optical_element module
      • OpticalElement
    • scopesim.optics.optical_train module
      • OpticalTrain
      • apply_fov_effects()
      • extract_source()
      • view_fov()
    • scopesim.optics.optics_manager module
      • OpticsManager
    • scopesim.optics.radiometry_utils module
      • add_surface_to_table()
      • combine_emissions()
      • combine_tables()
      • combine_throughputs()
      • string_to_table()
    • scopesim.optics.spectrograph module
    • scopesim.optics.surface module
      • PoorMansSurface
      • SpectralSurface
    • scopesim.optics.surface_utils module
      • is_flux_binned()
      • make_emission_from_array()
      • make_emission_from_emissivity()
      • normalise_binned_flux()
  • Module contents
• scopesim.reports package
  • Submodules
    • scopesim.reports.report_generator module
      • ReportGenerator
    • scopesim.reports.rst_utils module
      • latexify_rst_text()
      • plotify_rst_text()
      • process_code()
      • process_comment_code()
      • process_literal_code()
      • rstify_rst_text()
      • table_to_rst()
      • walk()
  • Module contents
• scopesim.server package
  • Submodules
    • scopesim.server.database module
      • PkgNotFoundError
      • crawl_server_dirs()
      • download_package()
      • download_packages()
      • get_all_latest()
      • get_all_package_versions()
      • get_all_packages_on_server()
      • get_all_stable()
      • get_base_url()
      • get_latest()
      • get_package_folders()
      • get_server_folder_package_names()
      • get_server_package_list()
      • get_stable()
      • group_package_versions()
      • list_packages()
    • scopesim.server.download_utils module
      • ServerError
      • create_client()
      • get_server_folder_contents()
      • handle_download()
      • handle_unzipping()
      • send_get()
    • scopesim.server.example_data_utils module
      • download_example_data()
      • get_server_elements()
      • list_example_data()
    • scopesim.server.github_utils module
      • create_github_url()
      • download_github_folder()
  • Module contents
• scopesim.source package
  • Submodules
    • scopesim.source.source module
      • Source
    • scopesim.source.source_templates module
      • ab_spectrum()
      • empty_sky()
      • st_spectrum()
      • star()
      • star_field()
      • uniform_illumination()
      • uniform_source()
      • vega_spectrum()
    • scopesim.source.source_utils module
      • convert_to_list_of_spectra()
      • make_imagehdu_from_table()
      • make_img_wcs_header()
      • photons_in_range()
      • scale_imagehdu()
      • validate_source_input()
  • Module contents

Submodules

• scopesim.base_classes module
  • DetectorBase
  • FOVSetupBase
  • FieldOfViewBase
  • ImagePlaneBase
  • PoorMansHeader
    • PoorMansHeader.as_header()
    • PoorMansHeader.items()
    • PoorMansHeader.keys()
    • PoorMansHeader.update()
    • PoorMansHeader.values()
  • SourceBase
• scopesim.rc module
• scopesim.utils module
  • add_keyword()
  • add_mags()
  • airmass2zendist()
  • airmass_to_zenith_dist()
  • angle_in_arcseconds()
  • bug_report()
  • bug_report_to_file()
  • change_table_entry()
  • check_keys()
  • clean_dict()
  • close_loop()
  • convert_table_comments_to_dict()
  • deg2rad()
  • deriv_polynomial2d()
  • dist_mod_from_distance()
  • distance_from_dist_mod()
  • empty_type()
  • extract_base_from_unit()
  • extract_type_from_unit()
  • figure_factory()
  • figure_grid_factory()
  • find_file()
  • from_currsys()
  • from_rc_config()
  • get_fits_type()
  • get_meta_quantity()
  • has_needed_keywords()
  • insert_into_ordereddict()
  • interp2()
  • is_fits()
  • log_bug_report()
  • log_to_file()
  • moffat()
  • nearest()
  • parallactic_angle()
  • poissonify()
  • power_vector()
  • pretty_print_dict()
  • quantify()
  • quantity_from_table()
  • rad2deg()
  • real_colname()
  • return_latest_github_actions_jobs_status()
  • seq()
  • set_console_log_level()
  • stringify_dict()
  • telescope_diffraction_limit()
  • top_level_catch()
  • transverse_distance()
  • unify()
  • unit_from_table()
  • update_logging()
  • write_report()
  • zendist2airmass()
  • zenith_dist_to_airmass()

Module contents

Generalised telescope observation simulator.