|
LSST Applications g013ef56533+63812263fb,g083dd6704c+a047e97985,g199a45376c+0ba108daf9,g1fd858c14a+fde7a7a78c,g210f2d0738+db0c280453,g262e1987ae+abed931625,g29ae962dfc+058d1915d8,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+64337f1634,g47891489e3+f459a6810c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+890c8e1e5d,g5a60e81ecd+d9e514a434,g64539dfbff+db0c280453,g67b6fd64d1+f459a6810c,g6ebf1fc0d4+8c5ae1fdc5,g7382096ae9+36d16ea71a,g74acd417e5+c70e70fbf6,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+f459a6810c,g8d7436a09f+1b779678e3,g8ea07a8fe4+81eaaadc04,g90f42f885a+34c0557caf,g97be763408+9583a964dd,g98a1a72a9c+028271c396,g98df359435+530b675b85,gb8cb2b794d+4e54f68785,gbf99507273+8c5ae1fdc5,gc2a301910b+db0c280453,gca7fc764a6+f459a6810c,gd7ef33dd92+f459a6810c,gdab6d2f7ff+c70e70fbf6,ge410e46f29+f459a6810c,ge41e95a9f2+db0c280453,geaed405ab2+e3b4b2a692,gf9a733ac38+8c5ae1fdc5,w.2025.43
LSST Data Management Base Package
|
Public Member Functions | |
| __init__ (self, gutter=3, background=0, mode="square") | |
| reset (self) | |
| append (self, image, label=None, ctype=None) | |
| makeMosaic (self, images=None, display="deferToFrame", mode=None, background=None, title="") | |
| setGutter (self, gutter) | |
| setBackground (self, background) | |
| setMode (self, mode) | |
| getBBox (self, ix, iy=None) | |
| drawLabels (self, labels=None, display="deferToFrame", frame=None) | |
| nImage (self) | |
Public Attributes | |
| gutter = gutter | |
| background = background | |
| int | xsize = 0 |
| int | ysize = 0 |
| list | images = [] |
| list | labels = [] |
| int | nImage = 0: |
| nx = 1 | |
| ny = nx, ny | |
| mode = mode | |
A class to handle mosaics of one or more identically-sized images
(or `~lsst.afw.image.Mask` or `~lsst.afw.image.MaskedImage`)
Notes
-----
Note that this mosaic is a patchwork of the input images; if you want to
make a mosaic of a set images of the sky, you probably want to use the coadd code
Examples
--------
.. code-block:: py
m = Mosaic()
m.setGutter(5)
m.setBackground(10)
m.setMode("square") # the default; other options are "x" or "y"
mosaic = m.makeMosaic(im1, im2, im3) # build the mosaic
display = afwDisplay.getDisplay()
display.mtv(mosaic) # display it
m.drawLabels(["Label 1", "Label 2", "Label 3"], display) # label the panels
# alternative way to build a mosaic
images = [im1, im2, im3]
labels = ["Label 1", "Label 2", "Label 3"]
mosaic = m.makeMosaic(images)
display.mtv(mosaic)
m.drawLabels(labels, display)
# Yet another way to build a mosaic (no need to build the images/labels lists)
for i in range(len(images)):
m.append(images[i], labels[i])
# You may optionally include a colour, e.g. afwDisplay.YELLOW, as a third argument
mosaic = m.makeMosaic()
display.mtv(mosaic)
m.drawLabels(display=display)
Or simply:
.. code-block:: py
mosaic = m.makeMosaic(display=display)
You can return the (ix, iy)th (or nth) bounding box (in pixels) with `getBBox()`
| lsst.afw.display.utils.Mosaic.__init__ | ( | self, | |
| gutter = 3, | |||
| background = 0, | |||
| mode = "square" ) |
Definition at line 120 of file utils.py.
| lsst.afw.display.utils.Mosaic.append | ( | self, | |
| image, | |||
| label = None, | |||
| ctype = None ) |
Add an image to the list of images to be mosaiced
Returns
-------
index
the index of this image (may be passed to `getBBox()`)
Notes
-----
Set may be cleared with ``Mosaic.reset()``
Definition at line 134 of file utils.py.
| lsst.afw.display.utils.Mosaic.drawLabels | ( | self, | |
| labels = None, | |||
| display = "deferToFrame", | |||
| frame = None ) |
Draw the list labels at the corners of each panel. Notes ----- If labels is None, use the ones specified by ``Mosaic.append()``
Definition at line 303 of file utils.py.
| lsst.afw.display.utils.Mosaic.getBBox | ( | self, | |
| ix, | |||
| iy = None ) |
Get the BBox for a panel
Parameters
----------
ix : `int`
If ``iy`` is not `None`, this is the x coordinate of the panel.
If ``iy`` is `None`, this is the number of the panel.
iy : `int`, optional
The y coordinate of the panel.
Definition at line 285 of file utils.py.
| lsst.afw.display.utils.Mosaic.makeMosaic | ( | self, | |
| images = None, | |||
| display = "deferToFrame", | |||
| mode = None, | |||
| background = None, | |||
| title = "" ) |
Return a mosaic of all the images provided. If none are specified, use the list accumulated with `Mosaic.append()`. If display is specified, display the mosaic
Definition at line 155 of file utils.py.
| lsst.afw.display.utils.Mosaic.nImage | ( | self | ) |
| lsst.afw.display.utils.Mosaic.reset | ( | self | ) |
| lsst.afw.display.utils.Mosaic.setBackground | ( | self, | |
| background ) |
| lsst.afw.display.utils.Mosaic.setGutter | ( | self, | |
| gutter ) |
| lsst.afw.display.utils.Mosaic.setMode | ( | self, | |
| mode ) |
Set mosaicing mode.
Parameters
----------
mode : {"square", "x", "y"}
Valid options:
square
Make mosaic as square as possible
x
Make mosaic one image high
y
Make mosaic one image wide
Definition at line 264 of file utils.py.