LargeImage

_LargeImageGrabbing, _LargeImageGrabbingFreeShape, _ManualLargeImage, _SplitLargeImage, _StitchLargeImage, LargeImageGrabbingWithName, SplitLargeImage, StitchLargeImage, StitchLargeImageEx

LargeImageGrabbingWithName

Description 

 LargeImageGrabbingWithName(
   char *DocumentName
);

This function displays the Large Image Grabbing dialog box. Name of the large image to be created is pre-filled according to the parameter.

Parameters

char *DocumentName

Name of the image (displayed in the image caption).

SplitLargeImage

Interactive command to this function: Image > Split Image

Description 

 SplitLargeImage(
   char *Filepath,
   int  Width,
   int  Height,
   int  TileCountX,
   int  TileCountY,
   double  OverlapX,
   double  OverlapY,
   int  Background,
   int  PreferND2,
   int  PreferMultipointND,
   char *FilePrefix,
   int  SplitShowFrame
);

This function splits one large image into several smaller ones.

Parameters

char *Filepath

Folder into which the splitted files are saved (when splitting to the single files, not to multipoint ND).

int Width

Image width in pixels.

int Height

Image height in pixels.

int TileCountX

Number of tiles in X.

≤ 0

Value is ignored.

≥1

Tile width size is ignored (computed).

int TileCountY

Number of tiles in Y.

≤ 0

Value is ignored.

≥1

Tile height size is ignored (computed).

double OverlapX

X overlap in percent.

0 to 50 [%]

double OverlapY

Y overlap in percent.

0 to 50 [%]

int Background

Color of the background.

-1

Tiled background (default)

0

Black

1

White

RGB value

Color as an integer value, (hexadecimal form: 0xRRGGBB)

int PreferND2

Flag which defines the saving file format (ND2 or TIFF) in case of splitting to the single files.

1

ND2

0

TIFF

int PreferMultipointND

Defines the splitting (single files or multi-point ND).

1

multi-point ND

0

single files

char *FilePrefix

Prefix used for splitting into a special file. If empty, name of the splitted file is used.

int SplitShowFrame

Defines whether the measurement frame is shown after split to MP is performed (single ND file). For multipoint ND only. Measurement frame is calculated according to the defined overlap.

1

Measurement frame is shown.

0

Measurement frame is not shown.

StitchLargeImage

Interactive command to this function: File > Stitch Large Image from Files

Description 

 StitchLargeImage(
   char *FileFilter,
   int  ColCount,
   int  Geometry,
   int  Overlap,
   int  UseRegistration,
   int  CropBorder
);

Creates a Large Image from a sequence of files that were captured separately.

Parameters

char *FileFilter

Specification of the source images for stitching. For example "c:\images\stitching\Series*.jp2"

int ColCount

Number of image columns in captured images.

int Geometry

Tells about layout of captured images. Must be one of the following values:

0

Meander

1

Rows

int Overlap

Image overlap in [%].

0

OFF

1-100

Defines how much the images overlap.

int UseRegistration

Use image registration? Image registration tries to find the perfect match of the overlapping parts of images. However, this takes some time to compute.

0

No registration

1

Use registration

int CropBorder

When the stitching is finished, the resulting large image can be cropped by a rectangle inscribed in its borders.

0

Do not crop the image.

1

Crop the image.

StitchLargeImageEx

Description 

 StitchLargeImageEx(
   char *Filepath,
   int  LargeImageDirection,
   int  LargeImageFirstFramePlacement,
   int  ColCount,
   int  Geometry,
   int  Overlap,
   int  UseRegistration,
   int  CropBorder,
   int  LargeImageBkgCorrect,
   int  LargeImageBlendingMode
);

Creates a Large Image from a sequence of files that were captured separately.

Parameters

char *Filepath

Defines the complete path to the folder of interest.

Note

If the parameter is used to load images, use e.g.: C:\Images\*.tif

int LargeImageDirection

Direction in which to arrange images.

0

Vertical

1

Horizontal

int LargeImageFirstFramePlacement

Placement of the first image within the large image matrix.

0

top left

1

top right

2

bottom left

3

bottom right

int ColCount

Number of columns/rows. It depends on the LargeImageDirection whether the number stands for rows or columns.

int Geometry

Layout of the images within the large image matrix.

0

Meander

1

Directional - frames will be placed one after another in one direction.

int Overlap

Image overlap in [%].

0

OFF

1-100

Defines how much the images overlap.

int UseRegistration

Use image registration? Image registration tries to find the perfect match of the overlapping parts of images. However, this takes some time to compute.

0

No registration

1

Use registration

int CropBorder

When the stitching is finished, the resulting large image can be cropped by a rectangle inscribed in its borders.

0

Do not crop the image.

1

Crop the image.

int LargeImageBkgCorrect

The background correction post-processing compares all fields of the to-be large image and creates an image of inaccuracies of the optical path. Afterwards, this image is is used for background correction on each field.

0

Do not use the computed background correction.

1

Use the computed background correction.

int LargeImageBlendingMode

Specifies the image margin blending method.

0

Optimal Path - A contour where two overlapping images are least different will be computed. The images will be stitched copying this contour.

1

Blending - Overlapping image parts will be blended.

_LargeImageGrabbing

Description 

 _LargeImageGrabbing();

The function displays the Large Image Grabbing dialog box.

_LargeImageGrabbingFreeShape

Description 

 _LargeImageGrabbingFreeShape();

This command opens a control window which can be used to capture and create large images by stitching.

Note

If the amount of acquired data exceeds a certain value, the large image can be saved only in ND2, Tiff, or Jpeg 2000 formats. Multichannel images can only be saved in ND2 and Tiff formats. This restriction differs depending on the actual image format.

Stitch

Use this button to create the large image once the whole pattern is captured. The stitching will be performed and the Large Image Grabbing window will be closed. The resulting large image will remain opened as a common image.

Grab Next

If the pattern is scheduled (e.g. via the scheduling mode) but the tiles are empty, this button will capture a single tile and move the selection to another empty tile. This button shall be used if you would like to change e.g. exposure during the grabbing.

Grab All

All tiles of the grabbing pattern - even the ones already captured - will be (re)captured automatically after you press this button.

Grab empty

This button will capture only the tiles of the pattern which have not been captured yet.

Reset All Already Grabbed Tiles

The captured tiles will be cleared So that the whole pattern will be empty.

Remove All Tiles

Removes the grabbing pattern.

Optimize path

Rearranges the sequence of tiles to minimize the XY stage movements.

Pause

When you are using the large image grabbing window, other actions can not be performed in the main screen. This button pauses large image grabbing and removes this restriction. Press the Continue button to resume the grabbing.

Note

Note, that the intention of this function is to let you change exposure settings of the camera. Using other NIS-Elements functions shall be avoided. For example, changing of optical configurations is not permitted during large image grabbing.

Import grid layout

Imports a grabbing pattern. Choose the XML file with a pattern in a standard Open window.

Export Grid Layout

Saves the grabbing pattern to an XML file.

Live

Run live image from the camera within the preview image.

Freeze

Freezes the live image within the preview image.

Overlap

Press this button to capture the images with overlapping borders. Set the percentage of overlap from the nearby pull down menu.

Select Background Color

For the case where some tiles within a rectangular grabbing pattern are not scheduled for capturing, you can specify a color to be used in the empty space. Click this button and select a color.

Scheduling mode

Press this button to start the scheduling mode. In this mode, you can easily draft the grabbing pattern.

AF - Use Autofocus Before Grab

Press this button to perform the auto focus before each grabbing.

AF - Autofocus Setup

This button opens the Auto Focus Setup window.

See Devices > Auto Focus Setup for more information about this window.

Context Menu

Delete File

When you have selected a tile (is highlighted by a red border) and press the secondary mouse button, appears a context menu. Choose this command to delete the single selected tile.

Move to Tile

This command moves the camera to another location without grabbing an image at the current location. So if you want to skip the current tile, move the mouse cursor to another tile which you want to grab and run this command from the context menu.

How it works

  • When you start the command, the window appears and the first tile is displayed. The live image is started automatically.

  • Define other tiles by clicking to the neighborhood. Once another tile is clicked, the first tile is captured and the stage is moved to display live image in the current tile. If you do not want to capture the current tile (with the live image), you can right-click on another tile and select the Move to tile command.

  • To grab a large image quickly, either use the scheduling mode to define the grabbing pattern without the live preview and then run the Grab all command, or use the Grab tile context-menu command to capture each tile quickly omitting the Live image.

_ManualLargeImage

This function runs the Acquire > Manual Large Image command.

Description 

 _ManualLargeImage();

Opens the Manual Large Image Grabbing dialog window.

_SplitLargeImage

This function runs the Image > Split Image command.

Description 

 _SplitLargeImage();

This function displays the Split large Image dialog window enabling to split one image to several smaller images.

_StitchLargeImage

This function runs the File > Stitch Large Image from Files command.

Description 

 _StitchLargeImage();

This function displays the Large Image Stitching dialog window.