SkySim¶

class lsst.ts.phosim.SkySim¶

Bases: object

Methods Summary

`addStarByChipPos`(sensorName, starId, ...[, ...])	Add the star based on the chip position.
`addStarByFile`(readFilePath[, skiprows])	Add the star data by reading the file.
`addStarByRaDecInDeg`(starId, raInDeg, ...)	Add the star information by (ra, dec) in degrees.
`exportSkyToFile`(outputFilePath)	Export the star information into the file.
`getRaDecInDeg`()	Get the star ra, decl in degree.
`getStarId`()	Get the star Id.
`getStarMag`()	Get the star magnitude.
`resetSky`()	Reset the sky information and delete all existed stars.
`setCamera`(instName)	Set the camera.
`setObservationMetaData`(ra, decl, rotSkyPos)	Set the observation meta data.
`setStarRaDecInDeg`(starId, raInDeg, ...)	Set the star information by (ra, dec) in degrees.

Methods Documentation

addStarByChipPos(sensorName, starId, xInpixelInCam, yInPixelInCam, starMag, epoch=None, includeDistortion=None)¶

Add the star based on the chip position.

Parameters:

sensorNamestr: Abbreviated sensor name (e.g. “R22_S11”).
starIdint: Star Id.
xInpixelInCamfloat: Pixel position x on camera coordinate.
yInPixelInCamfloat: Pixel position y on camera coordinate.
starMagfloat: Star magnitude.
epochNone, optional: Epoch is the mean epoch in years of the celestial coordinate system. (the default is None.) Note: This is a deprecated argument.
includeDistortionNone, optional: If True, then this method will expect the true pixel coordinates with optical distortion included. If False, this method will expect TAN_PIXEL coordinates, which are the pixel coordinates with estimated optical distortion removed. See the documentation in afw.cameraGeom for more details. (the default is None.) Note: This is a deprecated argument.

addStarByFile(readFilePath, skiprows=0)¶

Add the star data by reading the file.

Parameters:

readFilePathstr: Star data file path.
skiprowsint, optional: Skip the first “skiprows” lines. (the default is 0.)

addStarByRaDecInDeg(starId, raInDeg, declInDeg, mag)¶

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

Parameters:

starIdint, list[int], or numpy.ndarray[int]: Star Id.
raInDegfloat, list, or numpy.ndarray: Star ra in degree.
declInDegfloat, list, or numpy.ndarray: Star decl in degree.
magfloat, list, or numpy.ndarray: Star magnitude.

exportSkyToFile(outputFilePath)¶

Export the star information into the file.

Parameters:

outputFilePathstr: Output file path.

getRaDecInDeg()¶

Get the star ra, decl in degree.

RA: Right ascension. Decl: Declination.

Returns:

numpy.ndarray: Star ra.
numpy.ndarray: Star decl.

getStarId()¶

Get the star Id.

Returns:

numpy.ndarray[int]: Star Id.

getStarMag()¶

Get the star magnitude.

Returns:

numpy.ndarray: Star magnitude.

resetSky()¶: Reset the sky information and delete all existed stars.

setCamera(instName)¶

Set the camera.

Parameters:

instNamestr: Instrument name. Valid options are ‘comcam or ‘lsstfam’.

setObservationMetaData(ra, decl, rotSkyPos, mjd=None)¶

Set the observation meta data.

Parameters:

rafloat: Pointing ra in degree.
declfloat: Pointing decl in degree.
rotSkyPosfloat: The orientation of the telescope in degrees.
mjdNone, optional: Camera MJD. Note: This is a deprecated argument.

setStarRaDecInDeg(starId, raInDeg, declInDeg, mag)¶

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

Parameters:

starIdint, list[int], or numpy.ndarray[int]: Star Id.
raInDegfloat, list, or numpy.ndarray: Star ra in degree.
declInDegfloat, list, or numpy.ndarray: Star decl in degree.
magfloat, list, or numpy.ndarray: Star magnitude.

Navigation

SkySim¶