API Documentation

Information on specific functions, classes, and methods.

• satsim package
  • Subpackages
    • satsim.dataset package
      • Submodules
      • satsim.dataset.augment module
        • augment_satnet_with_satsim()
    • satsim.generator package
      • Subpackages
        • satsim.generator.obs package
          • Submodules
          • satsim.generator.obs.breakup module
            • breakup_from_tle()
            • collision_from_tle()
          • satsim.generator.obs.cso module
            • one()
          • satsim.generator.obs.geometry module
            • circle()
            • cone()
            • sphere()
          • satsim.generator.obs.io module
            • tle_file()
          • satsim.generator.obs.rpo module
            • rpo_from_tle()
    • satsim.geometry package
      • Submodules
      • satsim.geometry.astrometric module
        • GreatCircle
        • angle_between()
        • angle_from_los()
        • apparent()
        • create_topocentric()
        • gen_track()
        • gen_track_from_wcs()
        • get_los()
        • get_los_azel()
        • lambertian_sphere_to_mv()
        • load_earth()
        • load_moon()
        • load_sun()
        • query_by_los()
        • wcs_from_observer_fixed()
        • wcs_from_observer_rate()
        • wcs_from_observer_sidereal()
      • satsim.geometry.csvsc module
        • query_by_los()
      • satsim.geometry.draw module
        • gen_curve_from_points()
        • gen_line()
        • gen_line_from_endpoints()
      • satsim.geometry.ephemeris module
        • EphemerisObject
          • EphemerisObject.center
        • create_ephemeris_object()
      • satsim.geometry.random module
        • gen_random_points()
      • satsim.geometry.sgp4 module
        • create_sgp4()
        • load_tle()
      • satsim.geometry.sprite module
        • load_sprite_from_file()
      • satsim.geometry.sstr7 module
        • get_star_mv()
        • load_index()
        • load_stars_for_zone()
        • load_zone()
        • query_by_los()
        • query_by_min_max()
        • read_star()
        • select_zone()
      • satsim.geometry.transform module
        • apply_wrap_around()
        • rotate_and_translate()
      • satsim.geometry.twobody module
        • EarthTwoBodySatellite
          • EarthTwoBodySatellite.center
        • create_twobody()
        • create_twobody_from_tle()
      • satsim.geometry.wcs module
        • get_min_max_ra_dec()
        • get_wcs()
    • satsim.image package
      • Submodules
      • satsim.image.augment module
        • crop_and_resize()
        • flip()
        • load_from_file()
        • null()
        • pow()
        • resize()
        • rotate()
        • scatter_shift()
        • scatter_shift_polar()
        • scatter_shift_random()
      • satsim.image.fpa module
        • add_counts()
        • add_patch()
        • analog_to_digital()
        • crop()
        • downsample()
        • mv_to_pe()
        • pe_to_mv()
        • transform_and_add_counts()
        • transform_and_fft()
      • satsim.image.model module
        • astropy_model2d()
        • polygrid2d()
        • radial_cos2d()
        • sin2d()
      • satsim.image.noise module
        • add_photon_noise()
        • add_read_noise()
      • satsim.image.psf module
        • eod_to_sigma()
        • gen_from_poppy()
        • gen_from_poppy_configuration()
        • gen_gaussian()
      • satsim.image.render module
        • render_full()
        • render_piecewise()
    • satsim.io package
      • Submodules
      • satsim.io.czml module
        • CZMLExtractor
          • CZMLExtractor.add_ground_station()
          • CZMLExtractor.add_object()
          • CZMLExtractor.get_document()
        • save_czml()
      • satsim.io.fits module
        • save()
      • satsim.io.image module
        • save()
        • save_apng()
      • satsim.io.satnet module
        • init_annotation()
        • set_frame_annotation()
        • write_frame()
    • satsim.math package
      • Submodules
      • satsim.math.angle module
        • diff_degrees()
        • interp_degrees()
        • mean_degrees()
      • satsim.math.conv module
        • conv2()
      • satsim.math.fft module
        • fftconv2()
        • fftconv2p()
        • fftshift()
      • satsim.math.interpolate module
        • lagrange()
      • satsim.math.random module
        • gen_sample()
        • gen_samples_from_bins()
        • lognormal()
      • satsim.math.stats module
        • signal_to_noise_ratio()
    • satsim.pipeline package
      • constant()
      • cos()
      • glint()
      • poly()
      • polyt()
      • sin()
      • sin_add()
    • satsim.time package
      • TimeWrapper
      • delta_sec()
      • from_astropy()
      • from_datetime()
      • linspace()
      • to_astropy()
      • to_utc_list()
      • utc()
      • utc_from_list()
      • utc_from_list_or_scalar()
    • satsim.util package
      • Submodules
      • satsim.util.system module
        • configure_eager()
        • configure_multi_gpu()
        • configure_single_gpu()
        • get_semantic_version()
      • satsim.util.thread module
        • MultithreadedTaskQueue
          • MultithreadedTaskQueue.has_tag()
          • MultithreadedTaskQueue.stop()
          • MultithreadedTaskQueue.task()
          • MultithreadedTaskQueue.waitUntilEmpty()
        • ThreadedTaskQueue
          • ThreadedTaskQueue.busy()
          • ThreadedTaskQueue.has_tag()
          • ThreadedTaskQueue.stop()
          • ThreadedTaskQueue.task()
          • ThreadedTaskQueue.waitUntilEmpty()
      • satsim.util.timer module
        • get_timing()
        • tic()
        • toc()
  • Submodules
  • satsim.cli module
  • satsim.config module
    • dict_merge()
    • has_key_deep()
    • load_json()
    • load_yaml()
    • parse_cache()
    • parse_function()
    • parse_function_pipeline()
    • parse_generator()
    • parse_import()
    • parse_param()
    • parse_random_sample()
    • save_cache()
    • save_debug()
    • save_json()
    • transform()
  • satsim.satsim module
    • gen_images()
    • gen_multi()
    • image_generator()