Size

_AddImageBorders, _CanvasSize, _ImageBinning, _ImageCrop, _ImageCropEx, _ImageCropProj, _ImageResize, _ImageResizeForExport, _RadonTransform, AddImageBorders, AddImageBordersND, CanvasSize, CanvasSizeND, ImageBinning, ImageBinningND, ImageCrop, ImageCropND, ImageCropVSL, ImageResize, ImageResizeForExport, ImageResizeND, ImageResizeVSL, RadonTransform, RadonTransformND, SetRescalingMethod

AddImageBorders

Interactive command to this function: Image > Size > Add Borders

Description 

 AddImageBorders(
   int  Left,
   int  Top,
   int  Right,
   int  Bottom,
   unsigned int  BackgroundColor
);

This function adds a border around the current picture.

Parameters

int Left

Left margin in pixels.

int Top

Top margin in pixels.

int Right

Right margin in pixels.

int Bottom

Bottom margin in pixels.

unsigned int BackgroundColor

Color of the border. For RGB images, the best way how to get the proper RGB color value is to use the RGB function. Particular RGB values are then rescaled to the output image bit depth and copied to the corresponding RGB components of the image border area. For other types of images (intensity and multichannel), the lower 8-bit value of this parameter is taken, rescaled to the output image bit depth and copied to every component of the image border area.

See Also 
AddImageBordersND, RGB

AddImageBordersND

Description 

 AddImageBordersND(
   int  Left,
   int  Top,
   int  Right,
   int  Bottom,
   unsigned int  BackgroundColor
);

This function adds border around all frames of an ND2 document.

Parameters

int Left

Left margin in pixels.

int Top

Top margin in pixels.

int Right

Right margin in pixels.

int Bottom

Bottom margin in pixels.

unsigned int BackgroundColor

Color of the border. For RGB images, the best way how to get the proper RGB color value is to use the RGB function. Particular RGB values are then rescaled to the output image bit depth and copied to the corresponding RGB components of the image border area. For other types of images (intensity and multichannel), the lower 8-bit value of this parameter is taken, rescaled to the output image bit depth and copied to every component of the image border area.

See Also 
AddImageBorders, RGB

CanvasSize

Interactive command to this function: Image > Size > Canvas Size

Description 

 CanvasSize(
   int  New_Width,
   int  New_Height,
   int  New_OffsetX,
   int  New_OffsetY,
   int  BgColor
);

The CanvasSize function resizes envelope of the current image. Margins will be filled with BgColor. The current image is NOT stretched but positioned in new modified image.

Parameters

int New_Width

New image width.

int New_Height

New image height.

int New_OffsetX

Specifies x-offset of new canvas in original image.

int New_OffsetY

Specifies y-offset of new canvas in original image.

int BgColor

Graph background color.

CanvasSizeND

Description 

 CanvasSizeND(
   int  New_Width,
   int  New_Height,
   int  New_OffsetX,
   int  New_OffsetY,
   int  BgColor
);

The CanvasSizeND function resizes current image. The current image is NOT stretched but positioned in new modified image.

Parameters

int New_Width

New image width.

int New_Height

New image height.

int New_OffsetX

Specifies x-offset of new canvas in original image.

int New_OffsetY

Specifies y-offset of new canvas in original image.

int BgColor

Graph background color.

ImageBinning

Interactive command to this function: Image > Size > Binning

Description 

 ImageBinning(
   int  Width,
   int  Height,
   int  StretchMode,
   int  ResizeFlags
);

This function applies the Image Binning.

Parameters

int Width

Image width in pixels.

int Height

Image height in pixels.

int StretchMode

Interpolation mode used for image resizing.

1, STRETCH_QUICK

Quick mode using constant interpolation. Low quality, but fast.

2, STRETCH_SPLINES

Advanced mode using spline interpolation. Best quality, but slower.

3, STRETCH_LINEAR

Intermediate mode using linear interpolation. Average quality and speed.

int ResizeFlags

Which layer will be resized.

1

Current color/mono image (not floating-point).

2

Binary layer.

4

Annotation layer.

32

Floating-point image

Note

If you have a floating-point image it is recognized by the application as a separate layer.

ImageBinningND

Description 

 ImageBinningND(
   int  Width,
   int  Height,
   int  StretchMode,
   int  ResizeFlags
);

This function applies Image Binning to the current ND2 image.

Parameters

int Width

Image width in pixels.

int Height

Image height in pixels.

int StretchMode

Interpolation mode used for image resizing.

1, STRETCH_QUICK

Quick mode using constant interpolation. Low quality, but fast.

2, STRETCH_SPLINES

Advanced mode using spline interpolation. Best quality, but slower.

3, STRETCH_LINEAR

Intermediate mode using linear interpolation. Average quality and speed.

int ResizeFlags

Which layer will be resized.

1

Current color/mono image (not floating-point).

2

Binary layer.

4

Annotation layer.

32

Floating-point image

Note

If you have a floating-point image it is recognized by the application as a separate layer.

ImageCrop

Interactive command to this function: Image > Crop

Description 

 ImageCrop(
   int  Left,
   int  Top,
   int  Width,
   int  Height
);

The ImageCrop function crops current image to the specified dimensions.

Parameters

int Left

Left margin in pixels.

int Top

Top margin in pixels.

int Width

Image width in pixels.

int Height

Image height in pixels.

Note

This function is typically called, when you invoke the _ImageCrop command (Edit menu). An interactive equivalent is the _ImageCrop function.

See Also 
_ImageCrop

ImageCropND

Description 

 ImageCropND(
   int  Left,
   int  Top,
   int  Width,
   int  Height
);

This function crops the current image to the specified dimensions.

Parameters

int Left

Left margin in pixels.

int Top

Top margin in pixels.

int Width

Image width in pixels.

int Height

Image height in pixels.

Note

This function is typically called, when you invoke the _ImageCrop command (Edit menu). An interactive equivalent is the _ImageCrop function.

See Also 
_ImageCrop

ImageCropVSL

Description 

 ImageCropVSL(
   int  Left,
   int  Top,
   int  Width,
   int  Height
);

This function crops the current image to the specified dimensions. This function operates on large .VSL images that do not fit into memory.

Parameters

int Left

Left margin in pixels.

int Top

Top margin in pixels.

int Width

Image width in pixels.

int Height

Image height in pixels.

Note

This function is typically called, when you invoke the Crop... command (Edit menu). An interactive equivalent is the _ImageCrop function.

See Also 
_ImageCrop

ImageResize

Interactive command to this function: Image > Size > Resize

Description 

 ImageResize(
   int  Width,
   int  Height,
   int  StretchMode,
   int  ResizeFlags
);

The ImageResize function resizes current image according to the specified parameters.

Parameters

int Width

Image width in pixels.

int Height

Image height in pixels.

int StretchMode

Interpolation mode used for image resizing.

1, STRETCH_QUICK

Quick mode using constant interpolation. Low quality, but fast.

2, STRETCH_SPLINES

Advanced mode using spline interpolation. Best quality, but slower.

3, STRETCH_LINEAR

Intermediate mode using linear interpolation. Average quality and speed.

int ResizeFlags

Which layer will be resized.

1

Current color/mono image (not floating-point).

2

Binary layer.

4

Annotation layer.

32

Floating-point image

Note

If you have a floating-point image it is recognized by the application as a separate layer.

See Also 
_ImageResize

ImageResizeForExport

Interactive command to this function: Edit > Resize for Export

Description 

 ImageResizeForExport(
   int  Left,
   int  Top,
   int  Width,
   int  Height,
   int  New_Width,
   int  New_Height,
   int  StretchMode,
   int  ResizeFlags
);

Creates a new image by stretching the current image to the defined size. The Left, Top, Width, and Height parameters specify a rectangle of the original image to be used

Parameters

int Left

Left margin in pixels.

int Top

Top margin in pixels.

int Width

Image width in pixels.

int Height

Image height in pixels.

int New_Width

New image width.

int New_Height

New image height.

int StretchMode

Interpolation mode used for image resizing.

1, STRETCH_QUICK

Quick mode using constant interpolation. Low quality, but fast.

2, STRETCH_SPLINES

Advanced mode using spline interpolation. Best quality, but slower.

3, STRETCH_LINEAR

Intermediate mode using linear interpolation. Average quality and speed.

int ResizeFlags

Which layer will be resized.

1

Current color/mono image (not floating-point).

2

Binary layer.

4

Annotation layer.

32

Floating-point image

Note

If you have a floating-point image it is recognized by the application as a separate layer.

ImageResizeND

Description 

 ImageResizeND(
   int  Width,
   int  Height,
   int  StretchMode,
   int  ResizeFlags
);

The ImageResizeND function resizes current image according to the specified parameters.

Parameters

int Width

Image width in pixels.

int Height

Image height in pixels.

int StretchMode

Interpolation mode used for image resizing.

1, STRETCH_QUICK

Quick mode using constant interpolation. Low quality, but fast.

2, STRETCH_SPLINES

Advanced mode using spline interpolation. Best quality, but slower.

3, STRETCH_LINEAR

Intermediate mode using linear interpolation. Average quality and speed.

int ResizeFlags

Which layer will be resized.

1

Current color/mono image (not floating-point).

2

Binary layer.

4

Annotation layer.

32

Floating-point image

Note

If you have a floating-point image it is recognized by the application as a separate layer.

See Also 
_ImageResize

ImageResizeVSL

Description 

 ImageResizeVSL(
   int  Width,
   int  Height,
   int  StretchMode,
   int  ResizeFlags
);

The ImageResize function resizes current image according to the specified parameters. Operates on large .VSL images that do not fit into memory.

Parameters

int Width

Image width in pixels.

int Height

Image height in pixels.

int StretchMode

Interpolation mode used for image resizing.

1, STRETCH_QUICK

Quick mode using constant interpolation. Low quality, but fast.

2, STRETCH_SPLINES

Advanced mode using spline interpolation. Best quality, but slower.

3, STRETCH_LINEAR

Intermediate mode using linear interpolation. Average quality and speed.

int ResizeFlags

Which layer will be resized.

1

Current color/mono image (not floating-point).

2

Binary layer.

4

Annotation layer.

32

Floating-point image

Note

If you have a floating-point image it is recognized by the application as a separate layer.

See Also 
_ImageResize

RadonTransform

Description 

 RadonTransform(
   int  AngleFrom,
   int  AngleTo,
   int  StepsPerDegree
);

Applies the Radon Transformation.

Parameters

int AngleFrom

Low angle value [°].

int AngleTo

High angle value [°].

int StepsPerDegree

Number of steps per one degree.

RadonTransformND

Description 

 RadonTransformND(
   int  AngleFrom,
   int  AngleTo,
   int  StepsPerDegree,
   int  NDTLoop,
   int  NDMPLoop,
   int  NDZLoop
);

Applies the Radon Transformation to the current ND2 image.

Parameters

int AngleFrom

Low angle value [°].

int AngleTo

High angle value [°].

int StepsPerDegree

Number of steps per one degree.

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

SetRescalingMethod

This function runs the Rescaling Method command.

Description 

 SetRescalingMethod(
   int  Method
);

This function sets current type of picture rescaling method (1 = Quick method, 2 = Spline method, 3 = Linear method).

Parameters

int Method

Selects a method.

_AddImageBorders

This function runs the Image > Size > Add Borders command.

Description 

 _AddImageBorders();

This function displays the Add Borders dialog window.

_CanvasSize

This function runs the Image > Size > Canvas Size command.

Description 

 _CanvasSize();

This function displays the Canvas Size dialog window.

_ImageBinning

This function runs the Image > Size > Binning command.

Description 

 _ImageBinning();

Opens the Image Binning dialog window enabling to bin the current image based on the binning factor and binning method.

_ImageCrop

This function runs the Image > Crop command.

Description 

 _ImageCrop();

This function reduces the dimensions of the current image. The function displays the copy-rectangle cursor and enables you to select an appropriate rectangular image part for cropping.

See Also 
ImageCrop

_ImageCropEx

Description 

 _ImageCropEx(
   int  Left,
   int  Top,
   int  Width,
   int  Height
);

This function enables the user to enter the image cropping rectangle dimensions and position before the cropping dialog is opened and the image it is actually cropped.

Parameters

int Left

Left margin in pixels.

int Top

Top margin in pixels.

int Width

Image width in pixels.

int Height

Image height in pixels.

_ImageCropProj

Description 

 _ImageCropProj(
   int  ProjectionType
);

This function crops an image while applying the selected intensity projection.

Parameters

int ProjectionType

Type of intensity projection.

0

Minimum Intensity Projection

1

Maximum Intensity Projection

_ImageResize

This function runs the Image > Size > Resize command.

Description 

 _ImageResize();

This function resizes the current image. The function displays the Resize dialog box for setting of parameters .

See Also 
ImageResize

_ImageResizeForExport

This function runs the Edit > Resize for Export command.

Description 

 _ImageResizeForExport();

This function opens the Resize Image for Export dialog window. Define parameters of exported image within this window.

_RadonTransform

Description 

 _RadonTransform();

Opens the Radon Transform dialog window.