RawMockLSST¶
- class lsst.ip.isr.RawMockLSST(**kwargs)¶
Bases:
IsrMockLSST
Generate a raw exposure suitable for ISR.
Methods Summary
amplifierAddCT
(ampDataSource, ampDataTarget, ...)Add a scaled copy of an amplifier to another, simulating crosstalk.
amplifierAddFringe
(amp, ampData, scale[, x0, y0])Add a fringe-like ripple pattern to an amplifier's image data.
amplifierAddNoise
(ampData, mean, sigma)Add Gaussian noise to an amplifier's image data.
amplifierAddSource
(ampData, scale, x0, y0)Add a single Gaussian source to an amplifier.
amplifierAddXGradient
(ampData, start, end)Add a x-axis linear gradient to an amplifier's image data.
amplifierAddYGradient
(ampData, start, end)Add a y-axis linear gradient to an amplifier's image data.
amplifierMultiplyFlat
(amp, ampData, fracDrop)Multiply an amplifier's image data by a flat-like pattern.
applyGain
(ampData, gain)Apply gain to the amplifier's data.
Empty (clear) the metadata for this Task and all sub-Tasks.
Construct a test camera object.
Construct a test exposure.
Get metadata for all tasks.
Get the task name as a hierarchical name including parent task names.
getName
()Get the name of the task.
Get a dictionary of all tasks as a shallow copy.
getWcs
()Construct a dummy WCS object.
localCoordToExpCoord
(ampData, x, y)Convert between a local amplifier coordinate and the full exposure coordinate.
Generate a simple Gaussian brighter-fatter kernel.
Generate the simulated crosstalk coefficients.
makeData
()Generate simulated ISR data.
Generate a simple single-entry defect list.
makeField
(doc)Make a
lsst.pex.config.ConfigurableField
for this task.Generate a simulated ISR LSST image.
makeSubtask
(name, **keyArgs)Create a subtask as a new instance as the
name
attribute of this task.Generate a simulated flat transmission curve.
run
()Generate a mock ISR product following LSSTCam ISR, and return it.
timer
(name[, logLevel])Context manager to log performance data for an arbitrary block of code.
Methods Documentation
- amplifierAddCT(ampDataSource, ampDataTarget, scale)¶
Add a scaled copy of an amplifier to another, simulating crosstalk.
This method operates in the amplifier coordinate frame.
- Parameters:
- ampDataSource
lsst.afw.image.ImageF
Amplifier image to add scaled copy from.
- ampDataTarget
lsst.afw.image.ImageF
Amplifier image to add scaled copy to.
- scale
float
Flux scale of the copy to add to the target.
- ampDataSource
Notes
This simulates simple crosstalk between amplifiers.
- amplifierAddFringe(amp, ampData, scale, x0=100, y0=0)¶
Add a fringe-like ripple pattern to an amplifier’s image data.
- Parameters:
- amp
AmpInfoRecord
Amplifier to operate on. Needed for amp<->exp coordinate transforms.
- ampData
lsst.afw.image.ImageF
Amplifier image to operate on.
- scale
numpy.array
orfloat
Peak intensity scaling for the ripple.
- x0
numpy.array
orfloat
, optional Fringe center
- y0
numpy.array
orfloat
, optional Fringe center
- amp
Notes
This uses an offset sinc function to generate a ripple pattern. True fringes have much finer structure, but this pattern should be visually identifiable. The (x, y) coordinates are in the frame of the amplifier, and (u, v) in the frame of the full trimmed image.
- amplifierAddNoise(ampData, mean, sigma)¶
Add Gaussian noise to an amplifier’s image data.
This method operates in the amplifier coordinate frame.
- amplifierAddSource(ampData, scale, x0, y0)¶
Add a single Gaussian source to an amplifier.
This method operates in the amplifier coordinate frame.
- amplifierAddXGradient(ampData, start, end)¶
Add a x-axis linear gradient to an amplifier’s image data.
This method operates in the amplifier coordinate frame.
- amplifierAddYGradient(ampData, start, end)¶
Add a y-axis linear gradient to an amplifier’s image data.
This method operates in the amplifier coordinate frame.
- amplifierMultiplyFlat(amp, ampData, fracDrop, u0=100.0, v0=100.0)¶
Multiply an amplifier’s image data by a flat-like pattern.
- Parameters:
- amp
lsst.afw.ampInfo.AmpInfoRecord
Amplifier to operate on. Needed for amp<->exp coordinate transforms.
- ampData
lsst.afw.image.ImageF
Amplifier image to operate on.
- fracDrop
float
Fractional drop from center to edge of detector along x-axis.
- u0
float
Peak location in detector coordinates.
- v0
float
Peak location in detector coordinates.
- amp
Notes
This uses a 2-d Gaussian to simulate an illumination pattern that falls off towards the edge of the detector. The (x, y) coordinates are in the frame of the amplifier, and (u, v) in the frame of the full trimmed image.
- applyGain(ampData, gain)¶
Apply gain to the amplifier’s data. This method divides the data by the gain because the mocks need to convert the data in electron to ADU, so it does the inverse operation to applyGains in isrFunctions.
- Parameters:
- ampData
lsst.afw.image.ImageF
Amplifier image to operate on.
- gain
float
Gain value in e^-/DN.
- ampData
- getCamera()¶
Construct a test camera object.
- Returns:
- camera
lsst.afw.cameraGeom.camera
Test camera.
- camera
- getExposure()¶
Construct a test exposure.
The test exposure has a simple WCS set, as well as a list of unlikely header keywords that can be removed during ISR processing to exercise that code.
- Returns:
- exposure
lsst.afw.exposure.Exposure
Construct exposure containing masked image of the appropriate size.
- exposure
- getFullMetadata() TaskMetadata ¶
Get metadata for all tasks.
- Returns:
- metadata
TaskMetadata
The keys are the full task name. Values are metadata for the top-level task and all subtasks, sub-subtasks, etc.
- metadata
Notes
The returned metadata includes timing information (if
@timer.timeMethod
is used) and any metadata set by the task. The name of each item consists of the full task name with.
replaced by:
, followed by.
and the name of the item, e.g.:topLevelTaskName:subtaskName:subsubtaskName.itemName
using
:
in the full task name disambiguates the rare situation that a task has a subtask and a metadata item with the same name.
- getFullName() str ¶
Get the task name as a hierarchical name including parent task names.
- Returns:
- fullName
str
The full name consists of the name of the parent task and each subtask separated by periods. For example:
The full name of top-level task “top” is simply “top”.
The full name of subtask “sub” of top-level task “top” is “top.sub”.
The full name of subtask “sub2” of subtask “sub” of top-level task “top” is “top.sub.sub2”.
- fullName
- getName() str ¶
Get the name of the task.
- Returns:
- taskName
str
Name of the task.
- taskName
See also
getFullName
Get the full name of the task.
- getTaskDict() dict[str, weakref.ReferenceType[lsst.pipe.base.task.Task]] ¶
Get a dictionary of all tasks as a shallow copy.
- Returns:
- taskDict
dict
Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.
- taskDict
- getWcs()¶
Construct a dummy WCS object.
Taken from the deprecated ip_isr/examples/exampleUtils.py.
This is not guaranteed, given the distortion and pixel scale listed in the afwTestUtils camera definition.
- Returns:
- wcs
lsst.afw.geom.SkyWcs
Test WCS transform.
- wcs
- localCoordToExpCoord(ampData, x, y)¶
Convert between a local amplifier coordinate and the full exposure coordinate.
- Parameters:
- Returns:
Notes
The output is transposed intentionally here, to match the internal transpose between numpy and afw.image coordinates.
- makeBfKernel()¶
Generate a simple Gaussian brighter-fatter kernel.
- Returns:
- kernel
numpy.ndarray
Simulated brighter-fatter kernel.
- kernel
- makeCrosstalkCoeff()¶
Generate the simulated crosstalk coefficients.
- Returns:
- coeffs
numpy.ndarray
Simulated crosstalk coefficients.
- coeffs
- makeData()¶
Generate simulated ISR data.
Currently, only the class defined crosstalk coefficient matrix, brighter-fatter kernel, a constant unity transmission curve, or a simple single-entry defect list can be generated.
- Returns:
- dataProduct
Simulated ISR data product.
- makeDefectList()¶
Generate a simple single-entry defect list.
- Returns:
- defectList
lsst.meas.algorithms.Defects
Simulated defect list
- defectList
- classmethod makeField(doc: str) ConfigurableField ¶
Make a
lsst.pex.config.ConfigurableField
for this task.- Parameters:
- doc
str
Help text for the field.
- doc
- Returns:
- configurableField
lsst.pex.config.ConfigurableField
A
ConfigurableField
for this task.
- configurableField
Examples
Provides a convenient way to specify this task is a subtask of another task.
Here is an example of use:
class OtherTaskConfig(lsst.pex.config.Config): aSubtask = ATaskClass.makeField("brief description of task")
- makeImage()¶
Generate a simulated ISR LSST image.
- Returns:
- exposure
lsst.afw.image.Exposure
ordict
Simulated ISR image data.
- exposure
Notes
This method constructs a “raw” data image.
- makeSubtask(name: str, **keyArgs: Any) None ¶
Create a subtask as a new instance as the
name
attribute of this task.- Parameters:
- name
str
Brief name of the subtask.
- **keyArgs
Extra keyword arguments used to construct the task. The following arguments are automatically provided and cannot be overridden:
config
.parentTask
.
- name
Notes
The subtask must be defined by
Task.config.name
, an instance ofConfigurableField
orRegistryField
.
- makeTransmissionCurve()¶
Generate a simulated flat transmission curve.
- Returns:
- transmission
lsst.afw.image.TransmissionCurve
Simulated transmission curve.
- transmission
- run()¶
Generate a mock ISR product following LSSTCam ISR, and return it.
- Returns:
- image
lsst.afw.image.Exposure
Simulated ISR image with signals added.
- dataProduct
Simulated ISR data products.
- None
Returned if no valid configuration was found.
- image
- Raises:
- RuntimeError
Raised if both doGenerateImage and doGenerateData are specified.