Inheritance diagram for lsst.ip.diffim.imageMapReduce.ImageMapper:
Public Member Functions | |
| run (self, subExposure, expandedSubExposure, fullBBox, **kwargs) | |
Static Public Attributes | |
| ConfigClass = ImageMapperConfig | |
Static Protected Attributes | |
| str | _DefaultName = "ip_diffim_ImageMapper" |
Detailed Description
Abstract base class for any task that is to be used as `ImageMapReduceConfig.mapper`. Notes ----- An `ImageMapper` is responsible for processing individual sub-exposures in its `run` method, which is called from `ImageMapReduceTask.run`. `run` may return a processed new sub-exposure which can be be "stitched" back into a new resulting larger exposure (depending on the configured `ImageReducer`); otherwise if it does not return an lsst.afw.image.Exposure, then the `ImageReducer.config.reducer.reduceOperation` should be set to 'none' and the result will be propagated as-is.
Definition at line 89 of file imageMapReduce.py.
Member Function Documentation
◆ run()
| lsst.ip.diffim.imageMapReduce.ImageMapper.run | ( | self, | |
| subExposure, | |||
| expandedSubExposure, | |||
| fullBBox, | |||
| ** | kwargs ) |
Perform operation on `subExposure`.
To be implemented by subclasses. See class docstring for more
details. This method is given the `subExposure` which
is to be operated upon, and an `expandedSubExposure` which
will contain `subExposure` with additional surrounding
pixels. This allows for, for example, convolutions (which
should be performed on `expandedSubExposure`), to prevent the
returned sub-exposure from containing invalid pixels.
This method may return a new, processed sub-exposure which can
be be "stitched" back into a new resulting larger exposure
(depending on the paired, configured `ImageReducer`);
otherwise if it does not return an lsst.afw.image.Exposure, then the
`ImageReducer.config.mapper.reduceOperation`
should be set to 'none' and the result will be propagated
as-is.
Parameters
----------
subExposure : `lsst.afw.image.Exposure`
the sub-exposure upon which to operate
expandedSubExposure : `lsst.afw.image.Exposure`
the expanded sub-exposure upon which to operate
fullBBox : `lsst.geom.Box2I`
the bounding box of the original exposure
kwargs :
additional keyword arguments propagated from
`ImageMapReduceTask.run`.
Returns
-------
result : `lsst.pipe.base.Struct`
A structure containing the result of the `subExposure` processing,
which may itself be of any type. See above for details. If it is an
`lsst.afw.image.Exposure` (processed sub-exposure), then the name in
the Struct should be 'subExposure'. This is implemented here as a
pass-through example only.
Reimplemented in lsst.ip.diffim.imageDecorrelation.DecorrelateALKernelMapper.
Definition at line 110 of file imageMapReduce.py.
110 def run(self, subExposure, expandedSubExposure, fullBBox, **kwargs):
111 """Perform operation on `subExposure`.
112
113 To be implemented by subclasses. See class docstring for more
114 details. This method is given the `subExposure` which
115 is to be operated upon, and an `expandedSubExposure` which
116 will contain `subExposure` with additional surrounding
117 pixels. This allows for, for example, convolutions (which
118 should be performed on `expandedSubExposure`), to prevent the
119 returned sub-exposure from containing invalid pixels.
120
121 This method may return a new, processed sub-exposure which can
122 be be "stitched" back into a new resulting larger exposure
123 (depending on the paired, configured `ImageReducer`);
124 otherwise if it does not return an lsst.afw.image.Exposure, then the
125 `ImageReducer.config.mapper.reduceOperation`
126 should be set to 'none' and the result will be propagated
127 as-is.
128
129 Parameters
130 ----------
131 subExposure : `lsst.afw.image.Exposure`
132 the sub-exposure upon which to operate
133 expandedSubExposure : `lsst.afw.image.Exposure`
134 the expanded sub-exposure upon which to operate
135 fullBBox : `lsst.geom.Box2I`
136 the bounding box of the original exposure
137 kwargs :
138 additional keyword arguments propagated from
139 `ImageMapReduceTask.run`.
140
141 Returns
142 -------
143 result : `lsst.pipe.base.Struct`
144 A structure containing the result of the `subExposure` processing,
145 which may itself be of any type. See above for details. If it is an
146 `lsst.afw.image.Exposure` (processed sub-exposure), then the name in
147 the Struct should be 'subExposure'. This is implemented here as a
148 pass-through example only.
149 """
150 return pipeBase.Struct(subExposure=subExposure)
151
152
Member Data Documentation
◆ _DefaultName
|
staticprotected |
Definition at line 107 of file imageMapReduce.py.
◆ ConfigClass
|
static |
Definition at line 106 of file imageMapReduce.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/ip_diffim/g1470d8bcf6+cbe83ee85a/python/lsst/ip/diffim/imageMapReduce.py
