SkySim

class lsst.ts.imsim.SkySim

Bases: object

Initialization of sky simulator class.

Methods Summary

add_star_by_file(read_file_path[, skip_rows])	Add the star data by reading the file.
add_star_by_ra_dec_in_deg(star_id, ...)	Add the star information by (ra, dec) in degrees.
export_sky_to_file(output_file_path)	Export the star information into the file.
set_camera(cam_type)	Set the camera.

Methods Documentation

add_star_by_file(read_file_path: str, skip_rows: int = 0) → None

Add the star data by reading the file.

Parameters

read_file_pathstr

Star data file path.

skip_rowsint, optional

Skip the first “skiprows” lines. (the default is 0.)

add_star_by_ra_dec_in_deg(star_id: int | list[int] | numpy.ndarray, ra_in_deg: float | list[float] | numpy.ndarray, dec_in_deg: float | list[float] | numpy.ndarray, mag: float | list[float] | numpy.ndarray) → None

Add the star information by (ra, dec) in degrees.

Parameters

star_idint, list[int], or numpy.ndarray[int]

Star Id.

ra_in_degfloat, list, or numpy.ndarray

Star ra in degree.

dec_in_degfloat, list, or numpy.ndarray

Star dec in degree.

magfloat, list, or numpy.ndarray

Star magnitude.

export_sky_to_file(output_file_path: str) → None

Export the star information into the file.

Parameters

output_file_pathstr

Output file path.

set_camera(cam_type: CamType) → None

Set the camera.

Parameters

cam_typelsst.ts.imsim.utils.CamType

Camera type.