lsst.ip.diffim  21.0.0-16-gec61338+4cc90aadf4
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.ip.diffim.imageMapReduce.ImageMapReduceTask Class Reference
Inheritance diagram for lsst.ip.diffim.imageMapReduce.ImageMapReduceTask:

Public Member Functions

def __init__ (self, *args, **kwargs)
 
def run (self, exposure, **kwargs)
 
def plotBoxes (self, fullBBox, skip=3)
 

Public Attributes

 boxes0
 
 boxes1
 

Static Public Attributes

 ConfigClass = ImageMapReduceConfig
 

Detailed Description

Split an Exposure into subExposures (optionally on a grid) and
perform the same operation on each.

Perform 'simple' operations on a gridded set of subExposures of a
larger Exposure, and then (by default) have those subExposures
stitched back together into a new, full-sized image.

Contrary to the expectation given by its name, this task does not
perform these operations in parallel, although it could be updatd
to provide such functionality.

The actual operations are performed by two subTasks passed to the
config. The exposure passed to this task's `run` method will be
divided, and those subExposures will be passed to the subTasks,
along with the original exposure. The reducing operation is
performed by the second subtask.

Definition at line 487 of file imageMapReduce.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.ip.diffim.imageMapReduce.ImageMapReduceTask.__init__ (   self,
args,
**  kwargs 
)
Create the image map-reduce task

Parameters
----------
args :
    arguments to be passed to
    `lsst.pipe.base.task.Task.__init__`
kwargs :
    additional keyword arguments to be passed to
    `lsst.pipe.base.task.Task.__init__`

Definition at line 508 of file imageMapReduce.py.

Member Function Documentation

◆ plotBoxes()

def lsst.ip.diffim.imageMapReduce.ImageMapReduceTask.plotBoxes (   self,
  fullBBox,
  skip = 3 
)
Plot both grids of boxes using matplotlib.

Will compute the grid via `_generateGrid` if
`self.boxes0` and `self.boxes1` have not already been set.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure whose bounding box is gridded by this task.
skip : `int`
    Plot every skip-ped box (help make plots less confusing)

Definition at line 761 of file imageMapReduce.py.

◆ run()

def lsst.ip.diffim.imageMapReduce.ImageMapReduceTask.run (   self,
  exposure,
**  kwargs 
)
Perform a map-reduce operation on the given exposure.

Split the exposure into sub-expposures on a grid (parameters
given by `ImageMapReduceConfig`) and perform
`config.mapper.run()` on each. Reduce the resulting
sub-exposures by running `config.reducer.run()`.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    the full exposure to process
kwargs :
    additional keyword arguments to be passed to
    subtask `run` methods

Returns
-------
output of `reducer.run()`

Definition at line 527 of file imageMapReduce.py.

Member Data Documentation

◆ boxes0

lsst.ip.diffim.imageMapReduce.ImageMapReduceTask.boxes0

Definition at line 522 of file imageMapReduce.py.

◆ boxes1

lsst.ip.diffim.imageMapReduce.ImageMapReduceTask.boxes1

Definition at line 522 of file imageMapReduce.py.

◆ ConfigClass

lsst.ip.diffim.imageMapReduce.ImageMapReduceTask.ConfigClass = ImageMapReduceConfig
static

Definition at line 505 of file imageMapReduce.py.


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