lsst.pipe.tasks  13.0-29-g7046ce1+1
 All Classes Namespaces Files Functions Variables Groups Pages
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.mocks.mockObservation.MockObservationTask Class Reference
Inheritance diagram for lsst.pipe.tasks.mocks.mockObservation.MockObservationTask:

Public Member Functions

def __init__
 
def run
 
def makePointings
 
def buildWcs
 
def buildCalib
 
def buildPsf
 
def buildApCorrMap
 

Public Attributes

 schema
 
 ccdKey
 
 visitKey
 
 pointingKey
 
 rng
 

Static Public Attributes

 ConfigClass = MockObservationConfig
 

Detailed Description

Task to generate mock Exposure parameters (Wcs, Psf, Calib), intended for use as a subtask
of MockCoaddTask.

@todo:
- document "pa" in detail; angle of what to what?
- document the catalog parameter of the run method

Definition at line 78 of file mockObservation.py.

Constructor & Destructor Documentation

def lsst.pipe.tasks.mocks.mockObservation.MockObservationTask.__init__ (   self,
  kwds 
)

Definition at line 89 of file mockObservation.py.

Member Function Documentation

def lsst.pipe.tasks.mocks.mockObservation.MockObservationTask.buildApCorrMap (   self,
  detector 
)
Build an ApCorrMap with random linearly-varying fields for all
flux fields registered for aperture correction.

These flux field names are used only as strings; there is no
connection to any actual algorithms with those names or the PSF model.

Definition at line 225 of file mockObservation.py.

def lsst.pipe.tasks.mocks.mockObservation.MockObservationTask.buildCalib (   self)
Build a simple Calib object with exposure time fixed by config, fluxMag0 drawn from
a Gaussian defined by config, and mid-time set to DateTime.now().

Definition at line 182 of file mockObservation.py.

def lsst.pipe.tasks.mocks.mockObservation.MockObservationTask.buildPsf (   self,
  detector 
)
Build a simple Gaussian Psf with linearly-varying ellipticity and size.

The Psf pattern increases sigma_x linearly along the x direction, and sigma_y
linearly along the y direction.

@param[in] detector: detector information (an lsst.afw.cameraGeom.Detector)
@return a psf (an instance of lsst.meas.algorithms.KernelPsf)

Definition at line 193 of file mockObservation.py.

def lsst.pipe.tasks.mocks.mockObservation.MockObservationTask.buildWcs (   self,
  position,
  pa,
  detector 
)
Build a simple TAN Wcs with no distortion and exactly-aligned CCDs.

@param[in] position: object position on sky (an lsst.afw.coord.Coord)
@param[in] pa: position angle (an lsst.afw.geom.Angle)
@param[in] detector: detector information (an lsst.afw.cameraGeom.Detector)

Definition at line 165 of file mockObservation.py.

def lsst.pipe.tasks.mocks.mockObservation.MockObservationTask.makePointings (   self,
  n,
  tractInfo 
)
Generate (celestial) positions and rotation angles that define field locations.

Default implementation draws random pointings that are uniform in the tract's image
coordinate system.

@param[in] n: number of pointings
@param[in] tractInfo: skymap tract (a lsst.skymap.TractInfo)
@return a Python iterable over (coord, angle) pairs:
- coord is an object position (an lsst.afw.coord.Coord)
- angle is a position angle (???) (an lsst.afw.geom.Angle)

The default implementation returns an iterator (i.e. the function is a "generator"),
but derived-class overrides may return any iterable.

Definition at line 139 of file mockObservation.py.

def lsst.pipe.tasks.mocks.mockObservation.MockObservationTask.run (   self,
  butler,
  n,
  tractInfo,
  camera,
  catalog = None 
)
Driver that generates an ExposureCatalog of mock observations.

@param[in] butler: a data butler
@param[in] n: number of pointings
@param[in] camera: camera geometry (an lsst.afw.cameraGeom.Camera)
@param[in] catalog: catalog to which to add observations (an ExposureCatalog);
    if None then a new catalog is created.

@todo figure out what `pa` is and use that knowledge to set `boresightRotAng` and `rotType`

Definition at line 97 of file mockObservation.py.

Member Data Documentation

lsst.pipe.tasks.mocks.mockObservation.MockObservationTask.ccdKey

Definition at line 92 of file mockObservation.py.

lsst.pipe.tasks.mocks.mockObservation.MockObservationTask.ConfigClass = MockObservationConfig
static

Definition at line 87 of file mockObservation.py.

lsst.pipe.tasks.mocks.mockObservation.MockObservationTask.pointingKey

Definition at line 94 of file mockObservation.py.

lsst.pipe.tasks.mocks.mockObservation.MockObservationTask.rng

Definition at line 95 of file mockObservation.py.

lsst.pipe.tasks.mocks.mockObservation.MockObservationTask.schema

Definition at line 91 of file mockObservation.py.

lsst.pipe.tasks.mocks.mockObservation.MockObservationTask.visitKey

Definition at line 93 of file mockObservation.py.


The documentation for this class was generated from the following file: