ZSeries

_ND_CaptureZManually, _ND_CreateZSeriesExp, _ND_ZIntensityControl, ND_CreateZStackFile, ND_GetZSeriesExp, ND_GetZSeriesType, ND_ResetZSeriesExp, ND_ReverseZStackDirection, ND_RunZSeriesExp, ND_RunZSeriesExpWithZIntensityCorrection, ND_SetZSeriesExp, ND_SetZSeriesType, ND_ShowEDFFocusedView, ND_ShowEDFToolbar, ND_ShowMainView, ND_ShowSlicesView, ND_ShowTiledView, ND_ShowVolumeView, ND_ShowVolumeViewDX11, ND_ShowVolumeViewVTK, ND_ToggleOrigFocImage, ND_VV_CreatePyramidFile, ND_VV_ManagePyramidFiles, ND_VV_Reset, ND_ZIntensityControlIsDataReady, ND_ZIntensityControlLoad, ND_ZIntensityControlSave

ND_CreateZStackFile

Description 

 ND_CreateZStackFile(
   char *Filename,
   int  ND_IsAbsolute,
   double  ND_ZSeriesStart,
   double  ND_ZSeriesStep,
   char *ND_FilenameList
);

This function creates an nd2 file from a sequence of images.

Parameters

char *Filename

File name of the destination ND2 image.

int ND_IsAbsolute

This parameter is there to emulate the information about the experiment procedure in the resulting file.

0

The file has been captured using Relative positions.

1

The file has been captured using Absolute positions.

double ND_ZSeriesStart

The Z position of the first frame of the z stack file.

double ND_ZSeriesStep

Z-step size in micrometers.

char *ND_FilenameList

List of files including a path separated by semicolon.

ND_GetZSeriesExp

Description 

 ND_GetZSeriesExp(
   int *ND_LpZSeriesType,
   double *ND_LpZSeriesTop,
   double *ND_LpZSeriesHome,
   double *ND_LpZSeriesBottom,
   double *ND_LpZSeriesStep,
   int *ND_LpZSeriesCount,
   int *ND_LpZSeriesHomeDefined,
   int *ND_LpZSeriesCloseShuter,
   char *ND_ZSeriesDevice,
   char *ND_TimeCommandBefore,
   char *ND_TimeCommandAfter
);

This function retrieves parameters of the current Z-series acquisition setting in the ND Acquisition dialog box. It is the inverse function to the ND_SetZSeriesExp function.

Parameters

int *ND_LpZSeriesType

Retrieves mode of capturing frames in Z-Series.

0

Defined by top and bottom.

2

Symmetrical mode defined by range.

3

Asymmetrical mode defined by range.

double *ND_LpZSeriesTop

Retrieves the upper range value in µm.

double *ND_LpZSeriesHome

Retrieves the home position in µm. This value is valid only if ZSeriesHomeDefined = 1.

double *ND_LpZSeriesBottom

Retrieves the bottom range value in µm.

double *ND_LpZSeriesStep

Retrieves the step between Z slices in µm.

int *ND_LpZSeriesCount

Retrieves the number of Z slices.

int *ND_LpZSeriesHomeDefined

This parameter indicates, that absolute home position is defined. The home position can be defined by pressing the Set home position button or by the ND_GetZSeriesExp function.

int *ND_LpZSeriesCloseShuter

Retrieves state of the “Close active Shutter during Z Movement” checkbox.

1

Close Shutter is enabled

0

Close Shutter is disabled

char *ND_ZSeriesDevice

Defines name of the Z drive device (from combobox in ZStack Cube). If it is blank, device is not set.

char *ND_TimeCommandBefore

A macro command to be performed before each loop.

char *ND_TimeCommandAfter

A macro command to be performed after each loop.

See Also 
ND_SetZSeriesExp

ND_GetZSeriesType

Description 

 ND_GetZSeriesType(
   int *ND_LpZSeriesType
);

This function retrieves method of capturing Z-series images. It is the inverse function to the ND_SetZSeriesType function.

Parameters

int *ND_LpZSeriesType

Retrieves mode of capturing frames in Z-Series.

0

Defined by top and bottom.

2

Symmetrical mode defined by range.

3

Asymmetrical mode defined by range.

See Also 
ND_SetZSeriesType

ND_ResetZSeriesExp

Description 

 ND_ResetZSeriesExp();

The last used settings of the experiment are stored in memory. This function removes the settings of the current Z-series experiment.

ND_ReverseZStackDirection

Description 

 ND_ReverseZStackDirection();

This function inverts the succession of frames of the Z dimension. Z-dimension must be present within the active ND2 document.

ND_RunZSeriesExp

Description 

 ND_RunZSeriesExp();

This function runs the current Z-series experiment according to the current settings. The system remembers the settings of a previously run experiment.

ND_SetZSeriesExp

Description 

 ND_SetZSeriesExp(
   int  ND_LpZSeriesType,
   double  ND_LpZSeriesTop,
   double  ND_LpZSeriesHome,
   double  ND_LpZSeriesBottom,
   double  ND_LpZSeriesStep,
   int  ND_LpZSeriesCount,
   int  ND_LpZSeriesHomeDefined,
   int  ND_LpZSeriesCloseShuter,
   char *ND_ZSeriesDevice,
   char *ND_TimeCommandBefore,
   char *ND_TimeCommandAfter
);

This function sets parameters of the current Z-series acquisition setting in the ND Acquisition dialog box.

Parameters

int ND_LpZSeriesType

Defines type of capturing frames in Z-Series.

0

Bottom-Top mode.

2

Mode with symmetrical range.

3

Mode with asymmetrical range.

double ND_LpZSeriesTop

Defines absolute top range value in µm (in case of Bottom-Top type), or relative top range above in µm (for range type) - same as top yellow box at ZStack Cube.

double ND_LpZSeriesHome

Defines absolute home position in µm (applicable only in range type experiments with ZSeriesHomeDefined = 1).

double ND_LpZSeriesBottom

Defines absolute bottom range value in µm (in case of Bottom-Top type), or relative bottom range below in µm (range type) - same as bottom yellow box at ZStack Cube.

double ND_LpZSeriesStep

Defines the step between Z slices in µm.

int ND_LpZSeriesCount

Defines number of Z slices. If equals zero, it is ignored ; for positive values, the range of experiment is changed according to the step size.

int ND_LpZSeriesHomeDefined

This parameter defines absolute home position. If equals zero, ZSeriesHome is ignored and range experiments are relative.

int ND_LpZSeriesCloseShuter

Defines state of the “Close active Shutter during Z Movement” checkbox.

1

Close Shutter is enabled

0

Close Shutter is disabled

char *ND_ZSeriesDevice

Defines name of the Z drive device (from combobox in ZStack Cube). If it is blank, device is not set.

char *ND_TimeCommandBefore

A macro command to be performed before each loop.

char *ND_TimeCommandAfter

A macro command to be performed after each loop.

See Also 
ND_GetZSeriesExp

ND_RunZSeriesExpWithZIntensityCorrection

Description 

 ND_RunZSeriesExpWithZIntensityCorrection();

This function runs the Z-stack acquisition using the Z Intensity Correction.

ND_SetZSeriesType

Description 

 ND_SetZSeriesType(
   int  ND_ZSeriesType
);

This function sets the type of capturing Z-series images.

Parameters

int ND_ZSeriesType

Defines mode of capturing frames in Z-Series.

0

Defined by top and bottom.

2

Symmetric mode defined by range.

3

Asymmetric mode defined by range.

See Also 
ND_GetZSeriesType

ND_ShowEDFFocusedView

Description 

 ND_ShowEDFFocusedView(
   int  iNewWindow
);

Activates the view with the focused image (EDF) of the current z-stack. If such window is not found, no action is performed. The window is created only if the focused image has been created before.

Parameters

int iNewWindow

Opens the 3D View in a new window.

0

Behaves according to what is set in Edit > Options > General > Open new ND views to new window

1

Behaves contrary to what is set in Edit > Options > General > Open new ND views to new window

ND_ShowEDFToolbar

Description 

 ND_ShowEDFToolbar(
   int  ShowEDFToolbar
);

Shows or hides the toolbar with EDF operations that can be performed on the current z-stack.

Parameters

int ShowEDFToolbar

Displays/hides the EDF toolbar.

0

Hide EDF tool bar.

1

Show EDF tool bar.

ND_ShowMainView

This function runs the View > Image > ND View > Main View command.

Description 

 ND_ShowMainView(
   int  iNewWindow
);

Activates the view with the original ND2 document when observing other views, such as maximum/minumum intensity projections, slices view and volume view.

Parameters

int iNewWindow

Opens the 3D View in a new window.

0

Behaves according to what is set in Edit > Options > General > Open new ND views to new window

1

Behaves contrary to what is set in Edit > Options > General > Open new ND views to new window

ND_ShowSlicesView

This function runs the View > Image > ND View > Slices View command.

Description 

 ND_ShowSlicesView(
   int  iNewWindow
);

This function displays the current ND2 document in the Slices View. Z or time dimension must be present in the ND2 file.

Parameters

int iNewWindow

Opens the 3D View in a new window.

0

Behaves according to what is set in Edit > Options > General > Open new ND views to new window

1

Behaves contrary to what is set in Edit > Options > General > Open new ND views to new window

ND_ShowVolumeViewVTK

Description 

 ND_ShowVolumeViewVTK(
   int  OpenToNewWindow
);

Displays the current ND2 document as a 3D model using the Visualization Toolkit (VTK). Z dimension must be present in the ND2 file.

Opens the volume

Parameters

int OpenToNewWindow

Open image in a new window.

0

behaves according to what is set in Edit > Options > General > Open new ND views to new window

1

behaves contrary to what is set in Edit > Options > General > Open new ND views to new window

ND_ToggleOrigFocImage

Description 

 ND_ToggleOrigFocImage();

After creating an EDF Focused Image, this function toggles between the Main View and the focused image.

ND_VV_CreatePyramidFile

Description 

 ND_VV_CreatePyramidFile();

Generates an AMR file from the current image so that this image can be viewed in the Full-res mode in Volume View.

See Also 
ND_VV_ManagePyramidFiles

ND_VV_ManagePyramidFiles

Description 

 ND_VV_ManagePyramidFiles();

Opens the Full-Res Acceleration Files dialog window containing a list of all AMR files.

See Also 
ND_VV_CreatePyramidFile

ND_ShowTiledView

This function runs the View > Image > ND View > Tiled View command.

Description 

 ND_ShowTiledView(
   int  iNewWindow
);

This function displays the current ND2 document in the Tiled View.

Parameters

int iNewWindow

Opens the 3D View in a new window.

0

Behaves according to what is set in Edit > Options > General > Open new ND views to new window

1

Behaves contrary to what is set in Edit > Options > General > Open new ND views to new window

ND_ShowVolumeView

This function runs the View > Image > ND View > Volume View command.

Description 

 ND_ShowVolumeView(
   int  iNewWindow
);

This function displays the current ND2 document as a 3D model. Z dimension must be present in the ND2 file.

Parameters

int iNewWindow

Opens the 3D View in a new window.

0

Behaves according to what is set in Edit > Options > General > Open new ND views to new window

1

Behaves contrary to what is set in Edit > Options > General > Open new ND views to new window

ND_ShowVolumeViewDX11

Description 

 ND_ShowVolumeViewDX11(
   int  OpenToNewWindow
);

This function displays the current ND2 document as a 3D model using DirectX 10 and newer. Z dimension must be present in the ND2 file.

Parameters

int OpenToNewWindow

Open image in a new window.

0

behaves according to what is set in Edit > Options > General > Open new ND views to new window

1

behaves contrary to what is set in Edit > Options > General > Open new ND views to new window

ND_VV_Reset

Description 

 ND_VV_Reset();

Performs reset of the current Volume View - all parameters are set to defaults as if you closed the image and opened it again.

ND_ZIntensityControlIsDataReady

Description 

 ND_ZIntensityControlIsDataReady();

This function is available only for A1 microscopes and multilasers. Different light intensities can be assigned to different Z stacks. This function checks if the different light intensities have been defined.

ND_ZIntensityControlLoad

Description 

 ND_ZIntensityControlLoad(
   char *Filename
);

This function loads an external .xml file with data of the previously defined Z stack and device settings.

Parameters

char *Filename

Full path to the XML file. E.g. “C:\backup\backup1.xml”

ND_ZIntensityControlSave

Description 

 ND_ZIntensityControlSave(
   char *Filename
);

This function saves an .xml file with data of the defined Z stack and device settings.

Parameters

char *Filename

Full path to the XML file. E.g. “C:\backup\backup1.xml”

_ND_CaptureZManually

This function runs the Acquire > Capture Z-Series > Capture Manually command.

Description 

 _ND_CaptureZManually();

This function displays the Z Series Manual Acquisition dialog window. The ND2 file can be captured manually.

_ND_CreateZSeriesExp

This function runs the Acquire > Capture Z-Series > Capture Automatically command.

Description 

 _ND_CreateZSeriesExp();

This function displays the Z-Series Acquisition dialog window.

_ND_ZIntensityControl

Description 

 _ND_ZIntensityControl();

This function displays the Z intensity control window.

Copyright 1991-2024 Laboratory Imaging s.r.o.