BurnIn

_BurnScale, _BurnScaleND, _BurnSpectralBar, _CreateMontageView, _CreateViewSnapshotFullND, _CreateViewSnapshotInRect, _CreateViewSnapshotND, _InsertOverlayND, BurnScale, BurnScaleND, BurnVectorObjects, CreateDocumentAsSliceViewProjection, CreateDocumentAsSliceViewProjectionUnscaled, CreateViewSnapshot, CreateViewSnapshotFull, CreateViewSnapshotFullND, CreateViewSnapshotND, InsertOverlay, InsertOverlayND, InsertScale, InsertScaleEx

BurnScale

Interactive command to this function: Edit > Burn Scale (RGB)

Description

 BurnScale();

This function inserts the current scale layer into the color image. The scale becomes part of the image.

See Also
BurnScaleND, _BurnScale, _BurnScaleND

BurnScaleND

Interactive command to this function: Burn Scale

Description

 BurnScaleND(
   int  NDTLoop,
   int  NDMPLoop,
   int  NDZLoop
);

This function inserts the current scale layer into the color image. The scale becomes part of the image.

Parameters

int NDTLoop

0	apply to the current loop only
1	apply to the whole Time dimension

int NDMPLoop

Apply to Multi Point dimension.

0	apply to the current loop only
1	apply to the whole Multi Point dimension

int NDZLoop

Apply to Z dimension

0	apply to the current loop only
1	apply to the whole Z Series dimension

See Also
BurnScale, _BurnScale, _BurnScaleND

BurnVectorObjects

Description

 BurnVectorObjects(
   int  VectorLayer,
   int  OverlayLayer,
   int  ViewingComp
);

This function inserts current vector objects to the color image layer.

Parameters

int VectorLayer

Inserts the content of the annotation layer

0	The annotation layer will not be inserted.
1	The annotation layer will be inserted.

int OverlayLayer

Inserts the other currently displayed vector objects such as probe, graticules, scale, measurement frame, or intensity profile.

0	The vector objects will not be inserted.
1	The vector objects will be inserted.

int ViewingComp

The channel to insert the objects to.

1	1st channel
2	2nd channel
4	3rd channel
8	4th channel
2^(N-1)	Nth channel

CreateDocumentAsSliceViewProjection

Description

 CreateDocumentAsSliceViewProjection(
   char *NDNameView
);

If a document is displayed in the slices view, this function creates a new document from one of the views (XY, XZ, YZ, XT, YT). If two dimensions (T and Z) are present, an ND2 file will be the output.

Parameters

char *NDNameView

Define the view from which you would like to create the new file.

XY	The standard 2d image will be created
XZ	The XZ side (bottom) view will be used.
XT	The XZ side (bottom) view will be used.
YZ	The YZ side (right) view will be used.
YT	The YZ side (right) view will be used.

CreateDocumentAsSliceViewProjectionUnscaled

Description

 CreateDocumentAsSliceViewProjectionUnscaled(
   char *NDNameView
);

If a document is displayed in the slices view, this function creates a new document from one of the views (XY, XZ, YZ, XT, YT) and preserves the Z calibration. If two dimensions (T and Z) are present, an ND2 file will be the output.

Parameters

char *NDNameView

Define the view from which you would like to create the new file.

XY	The standard 2d image will be created
XZ	The XZ side (bottom) view will be used.
XT	The XZ side (bottom) view will be used.
YZ	The YZ side (right) view will be used.
YT	The YZ side (right) view will be used.

CreateViewSnapshot

Description

 CreateViewSnapshot();

This function creates a new color image from all visible image layers such as graticules, scale, etc. A new document window is opened and the new image is called “View Snapshot”.

CreateViewSnapshotFull

Description

 CreateViewSnapshotFull();

Creates a snapshot of the whole current image in full resolution. This function is called when the Edit > Create Full View Snapshot command is run on a non-ND image.

CreateViewSnapshotFullND

Interactive command to this function: Edit > Create Full View Snapshot (8bit RGB)

Description

 CreateViewSnapshotFullND(
   int  NDTLoop,
   int  NDMPLoop,
   int  NDZLoop
);

Creates a snapshot of the whole current image in full resolution. This function is called when the Edit > Create Full View Snapshot command is run on an ND image.

Parameters

int NDTLoop

0	apply to the current loop only
1	apply to the whole Time dimension

int NDMPLoop

Apply to Multi Point dimension.

0	apply to the current loop only
1	apply to the whole Multi Point dimension

int NDZLoop

Apply to Z dimension

0	apply to the current loop only
1	apply to the whole Z Series dimension

CreateViewSnapshotND

Interactive command to this function: Edit > Create View Snapshot (8bit RGB)

Description

 CreateViewSnapshotND(
   int  NDTLoop,
   int  NDMPLoop,
   int  NDZLoop
);

This function creates a new color image from all visible image layers such as graticules, scale, etc. A new document window is opened and the new image is called “View Snapshot”.

Parameters

int NDTLoop

0	apply to the current loop only
1	apply to the whole Time dimension

int NDMPLoop

Apply to Multi Point dimension.

0	apply to the current loop only
1	apply to the whole Multi Point dimension

int NDZLoop

Apply to Z dimension

0	apply to the current loop only
1	apply to the whole Z Series dimension

InsertOverlay

Description

 InsertOverlay();

This function copies contents of the overlay image to the color image.

Note

The overlay image displays simultaneously current color and binary images.

InsertOverlayND

Interactive command to this function: Edit > Burn Overlay (8bit RGB)

Description

 InsertOverlayND(
   int  NDTLoop,
   int  NDMPLoop,
   int  NDZLoop
);

This function copies contents of the overlay image to the color image.

Parameters

int NDTLoop

0	apply to the current loop only
1	apply to the whole Time dimension

int NDMPLoop

Apply to Multi Point dimension.

0	apply to the current loop only
1	apply to the whole Multi Point dimension

int NDZLoop

Apply to Z dimension

0	apply to the current loop only
1	apply to the whole Z Series dimension

Note

The overlay image displays simultaneously current color and binary images.

See Also
ViewOverlay

InsertScale

Description

 InsertScale(
   char *ScaleBar,
   int  Unit,
   int  Color,
   int  PosX,
   int  PosY,
   int  Describe
);

This function draws a rectangle into the current binary image.

PosX and PosY parameters specify the x and y coordinate of the scale start point. -1 value places the scale to the bottom-right corner of the image.

Parameters

char *ScaleBar

Text, that expresses the length of a scale bar.

int Unit

Calibration unit. Text, that along with ScaleBar parameters creates description.

0	Pixels
1	Nanometers
2	Micrometers
3	Millimeters
4	Centimeters
5	Decimeters
6	Meters
7	Kilometers
8	Mils
9	Inches

int Color

ScaleColor

0	Black
1	White
2	White - bordered
3	Red, 192 gray on mono images.
4	Brown, 128 gray on mono images
5	Green, 0 gray (black) on mono images
7	Blue

int PosX

X coordinate in [px].

int PosY

Y coordinate of start point.

-1	Places scale to the bottom-right corner of the image.
-3	All parameters describing InsertScale function are filled, only PosX and PosY parameters should be specified interactively. When calling this function, hold down primary mouse button - scale icon appears.

int Describe

Specifies whether to draw description or not.

1	Description on.
0	Description off.

InsertScaleEx

Description

 InsertScaleEx(
   char *ScaleBar,
   int  Unit,
   int  PosX,
   int  PosY,
   int  Describe
);

Draws a rectangle into the current binary image which can be used as a scale bar.

PosX and PosY parameters specify the x and y coordinate of the scale start point. -1 value places the scale to the bottom-right corner of the image.

Parameters

char *ScaleBar

Text, that expresses the length of a scale bar.

int Unit

Calibration unit. Text, that along with ScaleBar parameters creates description.

0	Pixels
1	Nanometers
2	Micrometers
3	Millimeters
4	Centimeters
5	Decimeters
6	Meters
7	Kilometers
8	Mils
9	Inches

int PosX

X coordinate in [px].

int PosY

Y coordinate in [px].

int Describe

Specifies whether to draw description or not.

1	Description on.
0	Description off.

_BurnScale

This function runs the Edit > Burn Scale (RGB) command.

Description

 _BurnScale();

This function displays the Burn Scale dialog window.

See Also
_BurnScaleND, BurnScale, BurnScaleND

_BurnScaleND

This function runs the Burn Scale command.

Description

 _BurnScaleND();

This function equals the BurnScale function except when performed on ND2 document you will be prompt to select whether to process the current image, selected dimension, or the whole ND document.

See Also
_BurnScale, BurnScale, BurnScaleND

_BurnSpectralBar

This function runs the Edit > Burn Spectral Bar (RGB) command.

Description

 _BurnSpectralBar();

Inserts a spectral scale bar into the current spectral image.

_CreateMontageView

This function runs the Edit > Create Montage (8bit RGB) command.

Description

 _CreateMontageView();

This function enables the user to create image montage containing the image, control panel screenshots or another opened images. It displays the Montage View window.

_CreateViewSnapshotFullND

This function runs the Edit > Create Full View Snapshot (8bit RGB) command.

Description

 _CreateViewSnapshotFullND();

Creates a snapshot of the whole current image in full resolution.

See Also
_CreateViewSnapshotND

_CreateViewSnapshotInRect

This function runs the Edit > Create View Snapshot in Rectangle (8bit RGB) command.

Description

 _CreateViewSnapshotInRect();

This function enables you to take a picture of a defined rectangular area. Draw the rectangle by mouse and confirm it by Enter. A new RGB document containing the snapshot of the selected part of the image is created.

_CreateViewSnapshotND

This function runs the Edit > Create View Snapshot (8bit RGB) command.

Description

 _CreateViewSnapshotND();

Opens the Create View Snapshot dialog window.

_InsertOverlayND

This function runs the Edit > Burn Overlay (8bit RGB) command.

Description

 _InsertOverlayND();

Merges all layers of the current image to one color image.

BurnIn🔗

Note

Note

BurnIn