_ND_CaptureTimelapseManually, _ND_CreateTimeExp, _ND_FastTimelapse, ND_AppendTimePhase, ND_AppendTimePhaseEx, ND_Concatenate1DT, ND_FastTimelapse, ND_FastTimelapsePrepare, ND_FastTimelapsePrepare_EX, ND_GetTimeExp, ND_GetTimeExpPhase, ND_GetTimeLapsePhaseCount, ND_GetTimePhase, ND_GetTimePhaseSchedule, ND_ResetTimeExp, ND_ReverseTimelapseDirection, ND_RunTimeExp, ND_SetTimeExp, ND_SetTimeExpPhase, ND_StartTimePhase

ND_AppendTimePhase

Description 

 ND_AppendTimePhase(
   double  ND_TimeInterval,
   double  ND_TimeDuration,
   char *ND_TimeCommand
);

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

Parameters

double ND_TimeInterval

The interval value in [ms]

0.0

No Delay

double ND_TimeDuration

Phase duration [ms].

-1	Continuous

char *ND_TimeCommand

A macro command to be performed before the loop.

ND_AppendTimePhaseEx

Description 

 ND_AppendTimePhaseEx(
   double  ND_TimeInterval,
   int  ND_TimeCount,
   char *ND_TimeCommand,
   char  ND_PhaseName
);

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

Parameters

double ND_TimeInterval

The interval value in [ms]

0.0

No Delay

int ND_TimeCount

Number of loops to be performed within the time phase.

char *ND_TimeCommand

A macro command to be performed before the loop.

char ND_PhaseName

Name of the phase

ND_Concatenate1DT

Description 

 ND_Concatenate1DT();

This function converts a multi-frame 1DT (X or Y dimension + Time) document to a single-frame 1DT document.

Note

The multi-frame 1DT documents are created by Nikon A1 line-scan operation. When being created, the 2 dimensional document is automatically cut into frames and put into an ND2 file for easier browsing.

ND_FastTimelapse

Description 

 ND_FastTimelapse();

This function is runs the fast timelapse acquisition according to the predefined settings. The ND_FastTimelapsePrepare function must be called beforehand to specify the settings and make the application ready.

See Also 
ND_FastTimelapsePrepare, _ND_FastTimelapse

ND_FastTimelapsePrepare

Description 

 ND_FastTimelapsePrepare(
   char *Filename,
   int  Frames,
   int  LineIndex,
   int  ND_FastTimelapseFlags
);

This function enables you to prepare the system for performing Fast Timelapse Acquisition. The ND_FastTimelapse function should be called afterwards.

Parameters

char *Filename

File name of the destination ND2 image.

int Frames

Number of frames.

int LineIndex

Index number of the TTL (or analog) line.

int ND_FastTimelapseFlags

The following values and their combinations may be used

0	Save to file: NO, Start Acquisition: Manually, Sample Storing: Memory Only
1	Save to File: YES
2	Start Acquisition: on TTL signal
4	Sample Storing: Memory and Disk

See Also 
ND_FastTimelapse

ND_FastTimelapsePrepare_EX

Description 

 ND_FastTimelapsePrepare_EX(
   char *Filename,
   int  Frames,
   int  LineIndex,
   int  ND_FastTimelapseFlags,
   int  Flag
);

This function is for internal purposes only.

Parameters

char *Filename

File name of the destination ND2 image.

int Frames

Number of frames.

int LineIndex

Index number of the TTL (or analog) line.

int ND_FastTimelapseFlags

The following values and their combinations may be used

0	Save to file: NO, Start Acquisition: Manually, Sample Storing: Memory Only
1	Save to File: YES
2	Start Acquisition: on TTL signal
4	Sample Storing: Memory and Disk

int Flag

Internal flag.

ND_GetTimeExp

Description 

 ND_GetTimeExp(
   int *ND_GetTimeCloseShutter,
   int *ND_GetControlLight,
   int *ND_GetPerformTimeMeas,
   char *ND_TimeCommandBefore,
   char *ND_TimeCommandAfter,
   int *ND_GetTimeAFType,
   int *ND_GetTimeAFWhen,
   double *ND_GetTimeAFArg1,
   double *ND_GetTimeAFArg2
);

The ND_GetTimeExp function retrieves parameters of the current timelapse experiment setting in the ND Acquisition dialog box. It is inverse function to the ND_SetTimeExp function.

Parameters

int *ND_GetTimeCloseShutter

Retrieves state of the “Close active Shutter when Idle” checkbox.

1	Close Shutter is enabled
0	Close Shutter is disabled

int *ND_GetControlLight

Retrieves state of the “Switch Transmitted Lamp off when Idle” checkbox.

1	Switch Lamp off is enabled
0	Switch Lamp off is disabled

int *ND_GetPerformTimeMeas

Retrieves state of the “Perform Time Measurement” checkbox.

1	Perform Time Measurement is enabled
0	Perform Time Measurement is disabled

char *ND_TimeCommandBefore

A macro command to be performed before each loop.

char *ND_TimeCommandAfter

A macro command to be performed after each loop.

int *ND_GetTimeAFType

Retrieves type of Autofocus.

0	None
1	Steps in Range
2	Adaptive
3	Continuous in Range

int *ND_GetTimeAFWhen

Retrieves when to perform autofocus.

0	At the Beginning
1	Before each Capture
2	Before each Phase

double *ND_GetTimeAFArg1

Gets autofocus step size (for Steps in Range) in µm or Z drive speed (for Continuous in Range).

double *ND_GetTimeAFArg2

Gets range of focusing in µm (only for Steps in Range or Continuous in Range).

See Also 
ND_SetTimeExp

ND_GetTimeExpPhase

Description 

 ND_GetTimeExpPhase(
   char *ND_Filename,
   int  ND_TimePhase,
   char *ND_TimeCommandBefore,
   char  ND_GetPhaseName
);

This function retrieves the command executed at the beginning of specified time phase. If the Filename parameter is empty, the current ND Experiment definition is used as the data source.

It is the inverse function to the ND_SetTimeExpPhase function.

Parameters

char *ND_Filename

File name of the source ND2 image.

int ND_TimePhase

Index of the time phase. This index represents line number in the ND Acquisition time schedule table.

char *ND_TimeCommandBefore

A macro command to be performed before each loop.

char ND_GetPhaseName

Name of the phase

See Also 
ND_SetTimeExpPhase

ND_GetTimeLapsePhaseCount

Description 

int ND_GetTimeLapsePhaseCount();

This function returns number of time phases in the current ND experiment.

Return Values

int

Number of time phases.

ND_GetTimePhase

Description 

int ND_GetTimePhase(
   int  ND_TimeIndex
);

This function returns time phase position for given image frame in the ND Acquisition experiment time schedule table.

Parameters

int ND_TimeIndex

Time index represents position of a frame in the time loop.

Return Values

int

The function returns index of the time phase.

ND_GetTimePhaseSchedule

Description 

 ND_GetTimePhaseSchedule(
   int  ND_TimePhase,
   double *ND_GetTimeInterval,
   double *ND_GetTimeDuration,
   int *ND_GetTimeLoopCnt
);

This function retrieves parameters of the current timelapse experiment table.

Parameters

int ND_TimePhase

Index of the time phase. This index represents line number in the ND Acquisition time schedule table.

double *ND_GetTimeInterval

Interval value in [ms] of the specified time phase.

double *ND_GetTimeDuration

Duration of the specified time phase in [ms].

int *ND_GetTimeLoopCnt

Number of images in the specified time phase.

See Also 
ND_AppendTimePhase

ND_ResetTimeExp

Description 

 ND_ResetTimeExp();

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

ND_ReverseTimelapseDirection

Description 

 ND_ReverseTimelapseDirection();

This function reverses run of a timelapse document. All frames are re-ordered so the last frame becomes the first.

ND_RunTimeExp

Description 

 ND_RunTimeExp();

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

ND_SetTimeExp

Description 

 ND_SetTimeExp(
   int  ND_TimeCloseShutter,
   int  ND_ControlLight,
   int  ND_PerformTimeMeas,
   char *ND_TimeCommandBefore,
   char *ND_TimeCommandAfter,
   int  ND_TimeAFType,
   int  ND_TimeAFWhen,
   double  ND_TimeAFArg1,
   double  ND_TimeAFArg2
);

This function initializes the current timelapse experiment and activates the time dimension of the current ND experiment.

Parameters

int ND_TimeCloseShutter

0	The shutter does not close while waiting for the next loop.
1	The shutter closes while waiting for the next loop.

int ND_ControlLight

Sets whether to “Switch Transmitted Lamp off when Idle” or not.

int ND_PerformTimeMeas

Perform Time Measurement.

1	Perform Time Measurement is enabled
0	Perform Time Measurement is disabled

char *ND_TimeCommandBefore

A macro command to be performed before each loop.

char *ND_TimeCommandAfter

A macro command to be performed after each loop.

int ND_TimeAFType

The auto focus method type.

0	No auto focus.
1	Steps in range auto focus method.
3	Continuous in range auto focus method.

int ND_TimeAFWhen

Sets when to perform the auto focus.

0	At the beginning.
1	Before each capture.
2	Before each phase.

double ND_TimeAFArg1

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

double ND_TimeAFArg2

The Z drive range of focusing in micron.

ND_SetTimeExpPhase

Description 

 ND_SetTimeExpPhase(
   int  ND_TimePhase,
   char *ND_TimeCommandBefore,
   char  ND_PhaseName
);

This function sets a command which will be executed at the beginning of the specified time phase (Advanced setting for Time Lapse Acquisition).

Parameters

int ND_TimePhase

Index of the time phase. This index represents line number in the ND Acquisition time schedule table.

char *ND_TimeCommandBefore

A macro command to be performed before each loop.

char ND_PhaseName

Name of the phase

See Also 
ND_GetTimeExpPhase

ND_StartTimePhase

Description 

 ND_StartTimePhase(
   int  ND_TimePhase
);

This function starts selected time phase.

Parameters

int ND_TimePhase

Index of the time phase. This index represents line number in the ND Acquisition time schedule table.

_ND_CaptureTimelapseManually

This function runs the Acquire > Capture Timelapse > Capture Manually command.

Description 

 _ND_CaptureTimelapseManually();

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

_ND_CreateTimeExp

This function runs the Acquire > Capture Timelapse > Capture Automatically command.

Description 

 _ND_CreateTimeExp();

This function displays the Time Sequence Acquisition dialog window.

_ND_FastTimelapse

Description 

 _ND_FastTimelapse();

This function opens the Fast Timelapse dialog window.

See Also 
ND_FastTimelapse