LSSTApplications  18.1.0
LSSTDataManagementBasePackage
Functions
lsst.afw.image.makeVisitInfo Namespace Reference

Functions

def makeVisitInfo (kwargs)
 

Function Documentation

◆ makeVisitInfo()

def lsst.afw.image.makeVisitInfo.makeVisitInfo (   kwargs) 
Make a VisitInfo from keyword arguments

@deprecated This function is superseded by a VisitInfo constructor with the same call signature.
Calling this function will create a VisitInfo, but it will also print a deprecation warning.

@param[in] exposureId  exposure ID (int, defaults to 0)
@param[in] exposureTime  exposure duration (shutter open time); (float, sec, defaults to NaN)
@param[in] darkTime  time from CCD flush to readout, including shutter open time (despite the name);
                (float, sec, defaults to NaN)
@param[in] date  TAI (international atomic time) MJD date at middle of exposure
                (lsst.daf.base.DateTime; defaults to date of unix epoch)
@param[in] ut1  UT1 (universal time) MJD date at middle of exposure (float, defaults to Nan)
@param[in] era  earth rotation angle at middle of exposure
                (lsst.geom.Angle, defaults to Angle(Nan))
@param[in] boresightRaDec  ICRS RA/Dec of boresight at middle of exposure
                (lsst.geom.SpherePoint; defaults to SpherePoint(Nan, Nan))
@param[in] boresightAzAlt  refracted apparent topocentric Az/Alt of boresight at middle of exposure;
                (lsst.geom.SpherePoint; defaults to SpherePoint(Nan, Nan))
@param[in] boresightAirmass  airmass at the boresight, relative to zenith at sea level
                (float, defaults to Nan)
@param[in] boresightRotAngle  rotation angle at boresight at middle of exposure;
                see getBoresightRotAngle for details
                (lsst.geom.Angle, defaults to Angle(Nan))
@param[in] rotType  rotation type; one of the lsst.afw.image.RotType constants,
                defaults to RotType.UNKNOWN
@param[in] observatory  observatory longitude, latitude and altitude,
                (lsst.afw.coord.Observatory, defaults to Observatory(Angle(Nan), Angle(Nan), Nan))
@param[in] weather  basic weather information for computing air mass,
                (lsst.afw.coord.Weather, defaults to Weather(NaN, NaN, NaN))

Definition at line 30 of file makeVisitInfo.py.

30 def makeVisitInfo(**kwargs):
31  """Make a VisitInfo from keyword arguments
32 
33  @deprecated This function is superseded by a VisitInfo constructor with the same call signature.
34  Calling this function will create a VisitInfo, but it will also print a deprecation warning.
35 
36  @param[in] exposureId exposure ID (int, defaults to 0)
37  @param[in] exposureTime exposure duration (shutter open time); (float, sec, defaults to NaN)
38  @param[in] darkTime time from CCD flush to readout, including shutter open time (despite the name);
39  (float, sec, defaults to NaN)
40  @param[in] date TAI (international atomic time) MJD date at middle of exposure
41  (lsst.daf.base.DateTime; defaults to date of unix epoch)
42  @param[in] ut1 UT1 (universal time) MJD date at middle of exposure (float, defaults to Nan)
43  @param[in] era earth rotation angle at middle of exposure
44  (lsst.geom.Angle, defaults to Angle(Nan))
45  @param[in] boresightRaDec ICRS RA/Dec of boresight at middle of exposure
46  (lsst.geom.SpherePoint; defaults to SpherePoint(Nan, Nan))
47  @param[in] boresightAzAlt refracted apparent topocentric Az/Alt of boresight at middle of exposure;
48  (lsst.geom.SpherePoint; defaults to SpherePoint(Nan, Nan))
49  @param[in] boresightAirmass airmass at the boresight, relative to zenith at sea level
50  (float, defaults to Nan)
51  @param[in] boresightRotAngle rotation angle at boresight at middle of exposure;
52  see getBoresightRotAngle for details
53  (lsst.geom.Angle, defaults to Angle(Nan))
54  @param[in] rotType rotation type; one of the lsst.afw.image.RotType constants,
55  defaults to RotType.UNKNOWN
56  @param[in] observatory observatory longitude, latitude and altitude,
57  (lsst.afw.coord.Observatory, defaults to Observatory(Angle(Nan), Angle(Nan), Nan))
58  @param[in] weather basic weather information for computing air mass,
59  (lsst.afw.coord.Weather, defaults to Weather(NaN, NaN, NaN))
60  """
61  warnings.warn(
62  "makeVisitInfo is deprecated; use VisitInfo directly, instead", DeprecationWarning, 2)
63  return VisitInfo(**kwargs)
64 
Generated on Thu Aug 8 2019 20:20:46 for LSSTApplications by   doxygen 1.8.13