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

Detailed Description

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()`

Definition at line 70 of file utils.py.

Constructor & Destructor Documentation

◆ init()

lsst.afw.display.utils.Mosaic.__init__	(	self,
		gutter = 3,
		background = 0,
		mode = "square" )

Definition at line 120 of file utils.py.

Member Function Documentation

◆ append()

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.

◆ drawLabels()

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.

◆ getBBox()

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.

◆ makeMosaic()

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.

◆ nImage()

lsst.afw.display.utils.Mosaic.nImage ( self )

Number of images

Definition at line 340 of file utils.py.

◆ reset()

lsst.afw.display.utils.Mosaic.reset ( self )

Reset the list of images to be mosaiced

Definition at line 129 of file utils.py.

◆ setBackground()

lsst.afw.display.utils.Mosaic.setBackground	(		self,
			background )

Set the value in the gutters

Definition at line 259 of file utils.py.

◆ setGutter()

lsst.afw.display.utils.Mosaic.setGutter	(		self,
			gutter )

Set the number of pixels between panels in a mosaic

Definition at line 254 of file utils.py.

◆ setMode()

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.

Member Data Documentation

◆ background

lsst.afw.display.utils.Mosaic.background = background

Definition at line 122 of file utils.py.

◆ gutter

lsst.afw.display.utils.Mosaic.gutter = gutter

Definition at line 121 of file utils.py.

◆ images

lsst.afw.display.utils.Mosaic.images = []

Definition at line 131 of file utils.py.

◆ labels

list lsst.afw.display.utils.Mosaic.labels = []

Definition at line 132 of file utils.py.

◆ mode

lsst.afw.display.utils.Mosaic.mode = mode

Definition at line 283 of file utils.py.

◆ nImage

int lsst.afw.display.utils.Mosaic.nImage = 0:

Definition at line 178 of file utils.py.

◆ nx

lsst.afw.display.utils.Mosaic.nx = 1

Definition at line 221 of file utils.py.

◆ ny

lsst.afw.display.utils.Mosaic.ny = nx, ny