MultiPoint

_ND_CaptureMultipointManually, _ND_CreateMultipointExp, ND_AppendMultipointPoint, ND_AppendMultipointPointPFS, ND_GetMultipointEnabled, ND_GetMultipointName, ND_KeepPFSOnDuringStageMove, ND_LoadMultipoint, ND_MP_GetCount, ND_MP_MoveToIndex, ND_OffsetAllMultipoints, ND_RedefineAbsZAfterPFS, ND_ResetMultipointExp, ND_RunMultipointExp, ND_SaveMultipoint, ND_SetLambdaEnabled, ND_SetLargeImageEnabled, ND_SetMultipointEnabled, ND_SetMultipointExp, ND_SetMultiPoints, ND_SetMultiPointsEx, ND_SetPictureMetadata, ND_SetTimeEnabled, ND_SetXYEnabled, ND_SetZStackEnabled

ND_AppendMultipointPoint

Description 

 ND_AppendMultipointPoint(
   double  ND_MultipointXCoord,
   double  ND_MultipointYCoord,
   double  ND_MultipointZCoord,
   char *ND_MultipointName
);

This function appends a line to the current multipoint experiment table.

Parameters

double ND_MultipointXCoord

The absolute X position of the new point (µm)

double ND_MultipointYCoord

The absolute Y position of the new point (µm)

double ND_MultipointZCoord

The absolute Z position of the new point (µm)

char *ND_MultipointName

The name of the variable which will contain the multipoint phase name.

ND_AppendMultipointPointPFS

This function runs the Add this Point to ND Acquisition menu command.

Description 

 ND_AppendMultipointPointPFS(
   double  ND_MultipointXCoord,
   double  ND_MultipointYCoord,
   double  ND_MultipointZCoord,
   double  ND_MultipointPFSOffset,
   char *ND_MultipointName
);

This function appends a line to the current multipoint experiment table including the PFS offset.

Parameters

double ND_MultipointXCoord

The absolute X position of the new point (µm)

double ND_MultipointYCoord

The absolute Y position of the new point (µm)

double ND_MultipointZCoord

The absolute Z position of the new point (µm)

double ND_MultipointPFSOffset

The PFS offset value.

char *ND_MultipointName

The name of the variable which will contain the multipoint phase name.

ND_GetMultipointEnabled

Description 

 ND_GetMultipointEnabled(
   int  ND_MultipointIndex
);

Returns whether multi-points are enabled.

Parameters

int ND_MultipointIndex

The index number of the multipoint phase (0-N)

ND_GetMultipointName

Description 

 ND_GetMultipointName(
   int  ND_UseCurrentDocument,
   int  ND_MultipointIndex,
   char *ND_MultipointName
);

This function retrieves the name of one multipoint loop.

Parameters

int ND_UseCurrentDocument

Set the data source of the multipoint phase.

0

Load the name from the current ND experiment definition.

1

Load the name from the current ND2 file.

int ND_MultipointIndex

The index number of the multipoint phase (0-N)

char *ND_MultipointName

The name of the variable which will contain the multipoint phase name.

ND_KeepPFSOnDuringStageMove

Description 

 ND_KeepPFSOnDuringStageMove(
   int  ND_KeepPFSOn
);

This function sets whether to leave the PFS device on during XY movements of the motorized stage.

Parameters

int ND_KeepPFSOn

Keep PFS on?

0

Turn PFS OFF while moving in XY.

1

Keep PFS ON while moving in XY.

ND_LoadMultipoint

Description 

 ND_LoadMultipoint(
   char *Filepath,
   int  FileType
);

Loads multipoints from a xml file.

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 FileType

File type.

ND_MP_GetCount

Description 

 ND_MP_GetCount();

This function returns the number of positions defined within the Multipoint (XY) ND experiment.

ND_MP_MoveToIndex

Description 

 ND_MP_MoveToIndex(
   int  Index,
   int  MoveZ
);

The function moves the motorized XY stage to a certain point of the Multipoint (XY) experiment.

Index parameter is the position of the point to move to within the defined experiment (starting with 0).

Parameters

int Index

Index number (zero-based).

int MoveZ

Selects whether to follow the defined Z coordinates or whether to keep the current Z position.

0

Do not move Z

1

Move Z

ND_OffsetAllMultipoints

Description 

 ND_OffsetAllMultipoints(
   int  ND_XYIndex
);

This function transforms XYZ coordinates used in ND Experiment. Reference XYZ point will be transformed to the current XYZ position and other points will be transformed in the same way.

Parameters

int ND_XYIndex

Reference XY index.

Note

This function only works while ND Acquisition experiment is running.

ND_RedefineAbsZAfterPFS

Description 

 ND_RedefineAbsZAfterPFS(
   int  ND_Redefine
);

This function turns ON/OFF the continuous correction of Z positions during long-lasting ND experiments. If turned ON, the ND_RedefineAbsZ function is called at the end of each Multipoint phase of an ND experiment after either the PFS or the autofocus function was performed.

Parameters

int ND_Redefine

0

Turn the Z positions correction OFF.

1

Turn the Z positions correction ON.

Note

The principle of PFS and AutoFocus is searching through a small range of Z positions.

See Also 
ND_RedefineAbsZ

ND_ResetMultipointExp

Description 

 ND_ResetMultipointExp();

The last used settings of the experiment are stored in memory. This function removes the settings of the current multipoint experiment. The experiment definition table becomes blank.

ND_RunMultipointExp

Description 

 ND_RunMultipointExp();

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

ND_SaveMultipoint

Description 

 ND_SaveMultipoint(
   char *Filepath,
   int  FileType
);

This function saves the multipoints to a xml file.

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 FileType

File type.

ND_SetLambdaEnabled

Description 

 ND_SetLambdaEnabled(
   int  Enabled
);

This function enables lambda channels.

Parameters

int Enabled

0

Disabled.

1

Enabled.

ND_SetLargeImageEnabled

Description 

 ND_SetLargeImageEnabled(
   int  Enabled
);

This function enables large image.

Parameters

int Enabled

0

Disabled.

1

Enabled.

ND_SetMultipointEnabled

Description 

 ND_SetMultipointEnabled(
   int  ND_MultipointIndex,
   int  ND_MultipointEnabled
);

This function enables multi-points.

Parameters

int ND_MultipointIndex

The index number of the multipoint phase (0-N)

int ND_MultipointEnabled

Is multi-point enabled.

ND_SetMultiPoints

Description 

 ND_SetMultiPoints(
   int  StgArrayCount,
   double *StgArrayX,
   double *StgArrayY,
   double *StgArrayZ,
   char *StgArrayNames
);

This function sets multiple points in the current ND experiment. It sets names, X, Y and Z coordinates (if enabled) of these points.

Parameters

int StgArrayCount

Total number of points in multipoint loop of the current ND experiment.

double *StgArrayX

Array of minimum StgArrayCount double values that represents X coordinates (in microns) of points in ND experiment. If this parameter equals NULL (0), all X values are set to zero.

double *StgArrayY

Array of minimum StgArrayCount double values that represents Y coordinates (in microns) of points in ND experiment. If this parameter equals NULL (0), all Y values are set to zero.

double *StgArrayZ

Array of minimum StgArrayCount double values that represents Z coordinates of points in ND experiment. If the current ND experiment contains multipoint loop without Z position this parameter will be ignored.

char *StgArrayNames

String buffer containing at least StgArrayCount 64 character strings. For example first 64 characters are a name of the first point, character 64 - 127 represents a name of the second point etc...

See Also 
ND_SetMultipointExp

ND_SetPictureMetadata

Description 

 ND_SetPictureMetadata(
   int  ND_PosAbsolute,
   int *ND_Metadata,
   dword  ND_MetadataFlags
);

This function sets picture metadata.

Parameters

int ND_PosAbsolute

Absolute position of the frame.

0

The position is determined relatively to the current frame.

1

The frame position is absolute within one dimension.

int *ND_Metadata

Pointer to the ND metadata.

dword ND_MetadataFlags

Defines Metadata type and can be one of following:

1

Time (double)

2

X pos (double)

4

Y pos (double)

8

Row (unsigned int)

16

Column (unsigned int)

32

Is Z absolute (int)

64

Z pos (double)

128

Angle (double)

256

Temperature (double)

512

Calibration (double)

1024

Aspect (double)

2048

Is calibrated (int)

4096

Objective name (char*)

8192

Objective magnification (double)

16384

Objective NA (double)

32768

Refract index1 (double)

65536

Refract index2 (double)

131072

Pinhole radius (double)

262144

Zoom (double)

524288

Projective magnification (double)

1048576

Custom data (char*)

ND_SetMultiPointsEx

Description 

 ND_SetMultiPointsEx(
   int  StgArrayCount,
   double *StgArrayX,
   double *StgArrayY,
   double *StgArrayZ,
   char *StgArrayNames,
   char *StgArrayPFS
);

This function sets multiple points in the current ND experiment. It sets names, X, Y and Z coordinates (if enabled) of these points.

Parameters

int StgArrayCount

Total number of points in multipoint loop of the current ND experiment.

double *StgArrayX

Array of minimum StgArrayCount double values that represents X coordinates (in microns) of points in ND experiment. If this parameter equals NULL (0), all X values are set to zero.

double *StgArrayY

Array of minimum StgArrayCount double values that represents Y coordinates (in microns) of points in ND experiment. If this parameter equals NULL (0), all Y values are set to zero.

double *StgArrayZ

Array of minimum StgArrayCount double values that represents Z coordinates of points in ND experiment. If the current ND experiment contains multipoint loop without Z position this parameter will be ignored.

char *StgArrayNames

String buffer containing at least StgArrayCount 64 character strings. For example first 64 characters are a name of the first point, character 64 - 127 represents a name of the second point etc...

char *StgArrayPFS

Array of strings representing PFS offset settings.

ND_SetMultipointExp

Description 

 ND_SetMultipointExp(
   int  ND_MultipointCloseShutter,
   int  ND_MultipointUseZCoord,
   char *ND_MultipointCommandBefore,
   char *ND_MultipointCommandAfter,
   int  ND_MultipointAFType,
   double  ND_MultipointAFArg1,
   double  ND_MultipointAFArg2
);

This function initializes the current multi-point experiment and activates the multi-point dimension of the current ND experiment.

Parameters

int ND_MultipointCloseShutter

0

The shutter does not close during stage movement.

1

The shutter closes during stage movement.

int ND_MultipointUseZCoord

0

The Z dimension will not be taken into account.

1

The Z dimension will not be taken into account.

char *ND_MultipointCommandBefore

The macro command to be performed before each multipoint loop.

char *ND_MultipointCommandAfter

The macro command to be performed after each multipoint loop.

int ND_MultipointAFType

The auto focus method type.

0

No auto focus.

1

Steps in Range auto focus method.

3

Continuous in Range auto focus method.

double ND_MultipointAFArg1

Step size(Steps in Range) in micron or the Z drive speed (Continuous in Range).

double ND_MultipointAFArg2

The Z drive range of focusing in micron.

ND_SetTimeEnabled

Description 

 ND_SetTimeEnabled(
   int  Enabled
);

This function enables the time dimension.

Parameters

int Enabled

0

Disabled.

1

Enabled.

ND_SetXYEnabled

Description 

 ND_SetXYEnabled(
   int  Enabled
);

This function enables the XY dimension.

Parameters

int Enabled

0

Disabled.

1

Enabled.

ND_SetZStackEnabled

Description 

 ND_SetZStackEnabled(
   int  Enabled
);

This function enables the Z Stack.

Parameters

int Enabled

0

Disabled.

1

Enabled.

_ND_CaptureMultipointManually

This function runs the Acquire > Capture Multipoint > Capture Manually menu command.

Description 

 _ND_CaptureMultipointManually();

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

_ND_CreateMultipointExp

This function runs the Acquire > Capture Multipoint > Capture Automatically menu command.

Description 

 _ND_CreateMultipointExp();

This function displays the Multipoint Acquisition dialog window.

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