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.analytic_obs module
        • generate()
      • satsim.geometry.astrometric module
        • angle_between()
        • angle_from_los()
        • apparent()
        • create_topocentric()
        • distance_between()
        • eci_to_ecr()
        • eci_to_radec()
        • gen_track()
        • gen_track_from_wcs()
        • get_analytical_los()
        • get_los()
        • get_los_azel()
        • load_earth()
        • load_moon()
        • load_sun()
        • optimized_angle_from_los_cosine()
        • query_by_los()
        • radec_to_eci()
        • 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.greatcircle module
        • GreatCircle
          • GreatCircle.center
      • satsim.geometry.observation module
        • EarthObservation
        • create_observation()
      • satsim.geometry.photometric module
        • lambertian_sphere_model_to_mv()
        • lambertian_sphere_to_mv()
        • model_to_mv()
      • 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.analytical module
        • save()
      • satsim.io.czml module
        • CZMLExtractor
          • CZMLExtractor.add_ground_station()
          • CZMLExtractor.add_object()
          • CZMLExtractor.add_space_station()
          • 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_annotation()
        • write_frame()
    • satsim.math package
      • Submodules
      • satsim.math.angle module
        • diff_degrees()
        • interp_degrees()
        • mean_degrees()
      • satsim.math.const module
      • 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.tfa package
      • Subpackages
        • satsim.tfa.image package
          • Submodules
          • satsim.tfa.image.transform_ops module
            • angles_to_projective_transforms()
            • compose_transforms()
            • flat_transforms_to_matrices()
            • matrices_to_flat_transforms()
            • rotate()
            • shear_x()
            • shear_y()
            • transform()
          • satsim.tfa.image.translate_ops module
            • translate()
            • translate_xy()
            • translations_to_projective_transforms()
          • satsim.tfa.image.utils module
            • from_4D_image()
            • get_ndims()
            • to_4D_image()
            • unwrap()
            • wrap()
        • satsim.tfa.utils package
          • Submodules
          • satsim.tfa.utils.test_utils module
            • assert_allclose_according_to_type()
            • assert_not_allclose()
          • satsim.tfa.utils.types module
    • satsim.time package
      • TimeWrapper
      • delta_sec()
      • from_astropy()
      • from_datetime()
      • linspace()
      • mid()
      • to_astropy()
      • to_utc_list()
      • utc()
      • utc_from_list()
      • utc_from_list_or_scalar()
    • satsim.util package
      • Submodules
      • satsim.util.python module
        • merge_dicts()
      • satsim.util.system module
        • configure_eager()
        • configure_multi_gpu()
        • configure_single_gpu()
        • get_semantic_version()
        • is_tensorflow_running_on_cpu()
      • 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()
    • satsim.vecmath package
      • Submodules
      • satsim.vecmath.Cartesian2 module
        • Cartesian2
          • Cartesian2.ONE()
          • Cartesian2.UNIT_X()
          • Cartesian2.UNIT_Y()
          • Cartesian2.ZERO()
          • Cartesian2.abs()
          • Cartesian2.add()
          • Cartesian2.angleBetween()
          • Cartesian2.clamp()
          • Cartesian2.clone()
          • Cartesian2.cross()
          • Cartesian2.distance()
          • Cartesian2.distanceSquared()
          • Cartesian2.divideByScalar()
          • Cartesian2.divideComponents()
          • Cartesian2.dot()
          • Cartesian2.equals()
          • Cartesian2.equalsEpsilon()
          • Cartesian2.fromArray()
          • Cartesian2.fromCartesian3()
          • Cartesian2.fromCartesian4()
          • Cartesian2.fromElements()
          • Cartesian2.lerp()
          • Cartesian2.magnitude()
          • Cartesian2.magnitudeSquared()
          • Cartesian2.maximumByComponent()
          • Cartesian2.maximumComponent()
          • Cartesian2.minimumByComponent()
          • Cartesian2.minimumComponent()
          • Cartesian2.mostOrthogonalAxis()
          • Cartesian2.multiplyByScalar()
          • Cartesian2.multiplyComponents()
          • Cartesian2.negate()
          • Cartesian2.normalize()
          • Cartesian2.subtract()
      • satsim.vecmath.Cartesian3 module
        • Cartesian3
          • Cartesian3.ONE()
          • Cartesian3.UNIT_X()
          • Cartesian3.UNIT_Y()
          • Cartesian3.UNIT_Z()
          • Cartesian3.ZERO()
          • Cartesian3.abs()
          • Cartesian3.add()
          • Cartesian3.angleBetween()
          • Cartesian3.clamp()
          • Cartesian3.clone()
          • Cartesian3.cross()
          • Cartesian3.distance()
          • Cartesian3.distanceSquared()
          • Cartesian3.divideByScalar()
          • Cartesian3.divideComponents()
          • Cartesian3.dot()
          • Cartesian3.equals()
          • Cartesian3.equalsEpsilon()
          • Cartesian3.fromArray()
          • Cartesian3.fromCartesian4()
          • Cartesian3.fromElements()
          • Cartesian3.fromSpherical()
          • Cartesian3.lerp()
          • Cartesian3.magnitude()
          • Cartesian3.magnitudeSquared()
          • Cartesian3.maximumByComponent()
          • Cartesian3.maximumComponent()
          • Cartesian3.midpoint()
          • Cartesian3.minimumByComponent()
          • Cartesian3.minimumComponent()
          • Cartesian3.mostOrthogonalAxis()
          • Cartesian3.multiplyByScalar()
          • Cartesian3.multiplyComponents()
          • Cartesian3.negate()
          • Cartesian3.normalize()
          • Cartesian3.projectVector()
          • Cartesian3.subtract()
      • satsim.vecmath.Cartesian4 module
        • Cartesian4
          • Cartesian4.ONE()
          • Cartesian4.UNIT_W()
          • Cartesian4.UNIT_X()
          • Cartesian4.UNIT_Y()
          • Cartesian4.UNIT_Z()
          • Cartesian4.ZERO()
          • Cartesian4.abs()
          • Cartesian4.add()
          • Cartesian4.clamp()
          • Cartesian4.clone()
          • Cartesian4.distance()
          • Cartesian4.distanceSquared()
          • Cartesian4.divideByScalar()
          • Cartesian4.divideComponents()
          • Cartesian4.dot()
          • Cartesian4.equals()
          • Cartesian4.equalsEpsilon()
          • Cartesian4.fromArray()
          • Cartesian4.fromElements()
          • Cartesian4.lerp()
          • Cartesian4.magnitude()
          • Cartesian4.magnitudeSquared()
          • Cartesian4.maximumByComponent()
          • Cartesian4.maximumComponent()
          • Cartesian4.minimumByComponent()
          • Cartesian4.minimumComponent()
          • Cartesian4.mostOrthogonalAxis()
          • Cartesian4.multiplyByScalar()
          • Cartesian4.multiplyComponents()
          • Cartesian4.negate()
          • Cartesian4.normalize()
          • Cartesian4.subtract()
      • satsim.vecmath.Matrix2 module
        • Matrix2
          • Matrix2.COLUMN0ROW0
          • Matrix2.COLUMN0ROW1
          • Matrix2.COLUMN1ROW0
          • Matrix2.COLUMN1ROW1
          • Matrix2.IDENTITY()
          • Matrix2.ZERO()
          • Matrix2.abs()
          • Matrix2.add()
          • Matrix2.clone()
          • Matrix2.equalsEpsilon()
          • Matrix2.fromArray()
          • Matrix2.fromColumnMajorArray()
          • Matrix2.fromRotation()
          • Matrix2.fromRowMajorArray()
          • Matrix2.fromScale()
          • Matrix2.fromUniformScale()
          • Matrix2.getColumn()
          • Matrix2.getElementIndex()
          • Matrix2.getMaximumScale()
          • Matrix2.getRotation()
          • Matrix2.getRow()
          • Matrix2.getScale()
          • Matrix2.multiply()
          • Matrix2.multiplyByScalar()
          • Matrix2.multiplyByScale()
          • Matrix2.multiplyByUniformScale()
          • Matrix2.multiplyByVector()
          • Matrix2.negate()
          • Matrix2.packedLength
          • Matrix2.setColumn()
          • Matrix2.setRotation()
          • Matrix2.setRow()
          • Matrix2.setScale()
          • Matrix2.setUniformScale()
          • Matrix2.subtract()
          • Matrix2.toArray()
          • Matrix2.transpose()
      • satsim.vecmath.Matrix3 module
        • Matrix3
          • Matrix3.COLUMN0ROW0
          • Matrix3.COLUMN0ROW1
          • Matrix3.COLUMN0ROW2
          • Matrix3.COLUMN1ROW0
          • Matrix3.COLUMN1ROW1
          • Matrix3.COLUMN1ROW2
          • Matrix3.COLUMN2ROW0
          • Matrix3.COLUMN2ROW1
          • Matrix3.COLUMN2ROW2
          • Matrix3.IDENTITY()
          • Matrix3.ZERO()
          • Matrix3.abs()
          • Matrix3.add()
          • Matrix3.clone()
          • Matrix3.computeEigenDecomposition()
          • Matrix3.computeFrobeniusNorm()
          • Matrix3.determinant()
          • Matrix3.equals()
          • Matrix3.equalsEpsilon()
          • Matrix3.fromArray()
          • Matrix3.fromColumnMajorArray()
          • Matrix3.fromCrossProduct()
          • Matrix3.fromHeadingPitchRoll()
          • Matrix3.fromQuaternion()
          • Matrix3.fromRotationX()
          • Matrix3.fromRotationY()
          • Matrix3.fromRotationZ()
          • Matrix3.fromRowMajorArray()
          • Matrix3.fromScale()
          • Matrix3.fromUniformScale()
          • Matrix3.getColumn()
          • Matrix3.getElementIndex()
          • Matrix3.getMaximumScale()
          • Matrix3.getRotation()
          • Matrix3.getRow()
          • Matrix3.getScale()
          • Matrix3.inverse()
          • Matrix3.inverseTranspose()
          • Matrix3.multiply()
          • Matrix3.multiplyByScalar()
          • Matrix3.multiplyByScale()
          • Matrix3.multiplyByUniformScale()
          • Matrix3.multiplyByVector()
          • Matrix3.negate()
          • Matrix3.offDiagonalFrobeniusNorm()
          • Matrix3.packedLength
          • Matrix3.setColumn()
          • Matrix3.setRotation()
          • Matrix3.setRow()
          • Matrix3.setScale()
          • Matrix3.setUniformScale()
          • Matrix3.shurDecomposition()
          • Matrix3.subtract()
          • Matrix3.toArray()
          • Matrix3.transpose()
      • satsim.vecmath.Matrix4 module
        • Matrix4
          • Matrix4.COLUMN0ROW0
          • Matrix4.COLUMN0ROW1
          • Matrix4.COLUMN0ROW2
          • Matrix4.COLUMN0ROW3
          • Matrix4.COLUMN1ROW0
          • Matrix4.COLUMN1ROW1
          • Matrix4.COLUMN1ROW2
          • Matrix4.COLUMN1ROW3
          • Matrix4.COLUMN2ROW0
          • Matrix4.COLUMN2ROW1
          • Matrix4.COLUMN2ROW2
          • Matrix4.COLUMN2ROW3
          • Matrix4.COLUMN3ROW0
          • Matrix4.COLUMN3ROW1
          • Matrix4.COLUMN3ROW2
          • Matrix4.COLUMN3ROW3
          • Matrix4.IDENTITY()
          • Matrix4.ZERO()
          • Matrix4.abs()
          • Matrix4.add()
          • Matrix4.clone()
          • Matrix4.computeInfinitePerspectiveOffCenter()
          • Matrix4.computeLookAt()
          • Matrix4.computeOrthographicOffCenter()
          • Matrix4.computePerspectiveFieldOfView()
          • Matrix4.computePerspectiveOffCenter()
          • Matrix4.computeView()
          • Matrix4.computeViewportTransformation()
          • Matrix4.equalsEpsilon()
          • Matrix4.fromArray()
          • Matrix4.fromCamera()
          • Matrix4.fromColumnMajorArray()
          • Matrix4.fromRotation()
          • Matrix4.fromRotationTranslation()
          • Matrix4.fromRowMajorArray()
          • Matrix4.fromScale()
          • Matrix4.fromTranslation()
          • Matrix4.fromTranslationQuaternionRotationScale()
          • Matrix4.fromTranslationRotationScale()
          • Matrix4.fromUniformScale()
          • Matrix4.getColumn()
          • Matrix4.getElementIndex()
          • Matrix4.getMatrix3()
          • Matrix4.getMaximumScale()
          • Matrix4.getRotation()
          • Matrix4.getRow()
          • Matrix4.getScale()
          • Matrix4.getTranslation()
          • Matrix4.inverse()
          • Matrix4.inverseTransformation()
          • Matrix4.inverseTranspose()
          • Matrix4.m
          • Matrix4.multiply()
          • Matrix4.multiplyByMatrix3()
          • Matrix4.multiplyByPoint()
          • Matrix4.multiplyByPointAsVector()
          • Matrix4.multiplyByScalar()
          • Matrix4.multiplyByScale()
          • Matrix4.multiplyByTranslation()
          • Matrix4.multiplyByUniformScale()
          • Matrix4.multiplyByVector()
          • Matrix4.multiplyTransformation()
          • Matrix4.negate()
          • Matrix4.packedLength
          • Matrix4.setColumn()
          • Matrix4.setRotation()
          • Matrix4.setRow()
          • Matrix4.setScale()
          • Matrix4.setTranslation()
          • Matrix4.setUniformScale()
          • Matrix4.subtract()
          • Matrix4.toArray()
          • Matrix4.transpose()
      • satsim.vecmath.Quaternion module
        • Quaternion
          • Quaternion.add()
          • Quaternion.clone()
          • Quaternion.computeAngle()
          • Quaternion.computeAxis()
          • Quaternion.computeInnerQuadrangle()
          • Quaternion.conjugate()
          • Quaternion.divideByScalar()
          • Quaternion.dot()
          • Quaternion.equals()
          • Quaternion.equalsEpsilon()
          • Quaternion.exp()
          • Quaternion.fastSlerp()
          • Quaternion.fastSquad()
          • Quaternion.fromAxisAngle()
          • Quaternion.fromHeadingPitchRoll()
          • Quaternion.fromRotationMatrix()
          • Quaternion.inverse()
          • Quaternion.lerp()
          • Quaternion.log()
          • Quaternion.magnitude()
          • Quaternion.magnitudeSquared()
          • Quaternion.multiply()
          • Quaternion.multiplyByScalar()
          • Quaternion.negate()
          • Quaternion.normalize()
          • Quaternion.slerp()
          • Quaternion.squad()
          • Quaternion.subtract()
          • Quaternion.toHeadingPitchRoll()
  • 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()