plot_image_montage

laserbeamsize.display.plot_image_montage(images, z=None, cols=3, pixel_size=None, vmax=None, vmin=None, units='µm', crop=False, cmap='gist_ncar', corner_fraction=0.035, nT=3, iso_noise=True, **kwargs)[source]

Create a beam size montage for a set of images.

If crop is a two parameter list [v, h] then v and h are interpreted as the vertical and horizontal sizes of the rectangle. The size is in pixels unless pixel_size is specified. In that case the rectangle sizes are in whatever units pixel_size is .

If crop==True then the displayed image is cropped to the ISO 11146 integration rectangle.

All cropping is done after analysis and therefosre only affects what is displayed. If the image needs to be cropped before analysis then that must be done before calling this function.

Parameters:

  • images – array of 2D images of the laser beam

  • z – (optional) array of axial positions of images (always in meters!)

  • cols – (optional) number of columns in the montage

  • pixel_size – (optional) size of pixels

  • vmax – (optional) maximum gray level to use

  • units – (optional) string used for units used on axes

  • crop – (optional) crop image to integration rectangle

  • cmap – (optional) colormap to use

Returns:

dx – semi-major diameter dy: semi-minor diameter