Skip to main content
Ctrl+K

SkySim 0.1.0

  • Installation & Usage
  • Examples
    • API Documentation
    • Developer Documentation
  • GitHub
  • Installation & Usage
  • Examples
  • API Documentation
  • Developer Documentation
  • GitHub

Section Navigation

  • __main__
    • parse_cli_args
    • confirm_config_file
    • handle_overwrite
    • check_for_overwrite
  • settings
    • AIRY_DISK_RADIUS
    • MAXIMUM_LIGHT_SPREAD
    • ConfigValue
    • ConfigMapping
    • TOMLConfig
    • SettingsPair
    • Settings
    • ImageSettings
    • PlotSettings
    • load_from_toml
    • toml_to_dicts
    • split_nested_key
    • access_nested_dictionary
    • check_key_exists
    • check_mandatory_toml_keys
    • parse_angle_dict
    • time_to_timedelta
    • get_config_option
    • angle_to_dms
  • query
    • SOLARSYSTEM_BODIES
    • BASIC_TABLE
    • FALLBACK_SPECTRAL_TYPE
    • get_body_locations
    • get_planet_table
    • get_star_table
    • get_spectral_types
    • run_simbad_query
    • get_planet_magnitude
    • get_star_name_column
    • get_child_stars
    • remove_child_stars
    • get_single_spectral_type
    • simplify_spectral_types
    • clean_simbad_table_columns
  • populate
    • MINIMUM_BRIGHTNESS
    • create_image_matrix
    • get_empty_image
    • get_seconds_from_midnight
    • get_timed_background_colour
    • get_timed_magnitude
    • fill_frame_background
    • filter_objects_brightness
    • filter_objects_fov
    • magnitude_to_flux
    • linear_rescale
    • get_scaled_brightness
    • pixel_in_frame
    • add_object_to_frame
    • fill_frame_objects
    • prepare_object_table
  • plot
    • create_plot
    • create_single_plot
    • create_multi_plot
    • display_frame
    • save_frame
    • construct_ffmpeg_call
    • run_ffmpeg
    • movie_cleanup
  • colours
    • RGB
    • InputColour
    • RGBTuple
    • convert_colour
  • utils
    • TEMPFILE_SUFFIX
    • FloatArray
    • IntArray
    • round_columns
    • get_tempfile_path
    • read_pyproject
  • API Documentation
  • populate
  • get_empty_image

get_empty_image#

skysim.populate.get_empty_image(frames, image_pixels)[source]#

Initialize an empty image array.

Parameters:
framespydantic.PositiveInt

The number of frames to include.

image_pixelspydantic.PositiveInt

The width/height of the image in pixels.

Returns:
FloatArray

An array of zeros.

previous

create_image_matrix

next

get_seconds_from_midnight

Show rST page source

© Copyright 2025, Tai Withers.

Created using Sphinx 8.2.3.

Built with the PyData Sphinx Theme 0.16.1.