Other

_MergeNDDocuments, IncubationInterfaceSetActive, ND_AddCustomMetadataDefinition, ND_AddCustomMetadataField, ND_CreateViewProjection, ND_CustomCapture, ND_CustomFinish, ND_CustomSequenceConvertToMultipoint, ND_CustomSequenceConvertToTime, ND_CustomSequenceConvertToZStack, ND_CustomSetSettings, ND_GetCustomMetadataDefinition, ND_GetCustomMetadataDefinitionCount, ND_GetCustomMetadataFieldCount, ND_GetCustomMetadataFieldInfo, ND_GetCustomMetadataFieldName, ND_GetCustomMetadataFieldText, ND_GetCustomMetadataFieldValue, ND_RefreshView, ND_RemoveCustomMetadataDefinition, ND_RemoveCustomMetadataField, ND_SelectViewProjection, ND_SelectViewProjectionEx, ND_SetAuthentication, ND_SetCustomMetadataFieldText, ND_SetCustomMetadataFieldValue, ND_SetOpenViewsToNewWindow, ND_SetPlateLabeling, ND_SetZeroBasedTime, NDEnableSaveToTIFF, Stimulate, StimulationDeviceSetActive

IncubationInterfaceSetActive

This function runs the Applications > Temperature/Gas > Temperature/Gas Interface command.

Description 

 IncubationInterfaceSetActive(
   char *IncubationInterfaceName
);

This function selects alternative (3rd party) interface for controlling incubation phases of ND experiments.

Parameters

char *IncubationInterfaceName

A unique name of the interface (default: lim_incubation).

NDEnableSaveToTIFF

Description 

 NDEnableSaveToTIFF(
   bool  ND_EnableSaveToTIFF
);

This function enables / disables saving to TIF file format in ND Acquisition.

Parameters

bool ND_EnableSaveToTIFF

If this parameter is set to TRUE (1), storing to TIF file format will be enabled in ND Acquisition.

ND_AddCustomMetadataDefinition

Description 

 ND_AddCustomMetadataDefinition(
   int  MetadataSource,
   char *DefinitionName
);

Defines the metadata set.

Parameters

int MetadataSource

Defines the metadata source:

0

Current file

1

ND Acquisition Definition

2

Jobs

char *DefinitionName

Name of the definition.

ND_AddCustomMetadataField

Description 

 ND_AddCustomMetadataField(
   int  MetadataSource,
   char *DefinitionName,
   int  FieldName,
   int  FieldType,
   char *FieldDescription,
   char *FieldOptions,
   int  FieldFlags
);

Adds a custom metadata field into the Edit Custom Metadata dialog.

Parameters

int MetadataSource

Defines the metadata source:

0

Current file

1

ND Acquisition Definition

2

Jobs

char *DefinitionName

Name of the definition.

int FieldName

Metadata item “Name”.

int FieldType

Metadata item “Type”.

0

none

1

label (check box)

2

number

3

text

4

selection from a list

5

long text

char *FieldDescription

Metadata item “Description”.

char *FieldOptions

Defines the comma separated values for the FieldType “Selection from a list”.

int FieldFlags

Field flags.

ND_CreateViewProjection

This function runs the Edit > Create New Document from Current View command.

Description 

 ND_CreateViewProjection();

Creates the new document with the projection of the current ND document. This function has no effect on single documents and the ND documents with only one dimension. It can be applied only to slices view, volume view, maximum and minimum intensity views, and EDF views (focused image, anaglyph, surface view). The resulting document will not contain the z-dimesion (or time dimension for time-only documents in Max/Min intensity view).

ND_CustomCapture

Description 

 ND_CustomCapture();

This function performs the Capture operation according to the Custom Acquisition control window settings. One frame of the custom ND2 document to-be is captured.

ND_CustomFinish

Description 

 ND_CustomFinish();

This function performs the Finish operation and creates a new custom ND2 document according to the Custom Acquisition control window settings. The document is either opened within the application window or saved to disk.

ND_CustomSequenceConvertToMultipoint

This function runs the Image > ND Processing > Convert Custom Acquisition to Multipoint command.

Description 

 ND_CustomSequenceConvertToMultipoint(
   int  Number
);

This function converts the current (active) custom image sequence to multipoint-type.

Parameters

int Number

0

The conversion is performed at once.

1

A confirmation window appears before the conversion.

ND_CustomSequenceConvertToTime

This function runs the Image > ND Processing > Convert Custom Acquisition to Time-lapse command.

Description 

 ND_CustomSequenceConvertToTime(
   int  Number
);

This function converts the current (active) custom image sequence to timelapse-type.

Parameters

int Number

0

The conversion is performed at once.

1

A confirmation window appears before the conversion.

ND_CustomSequenceConvertToZStack

This function runs the Image > ND Processing > Convert Custom Acquisition to ZStack command.

Description 

 ND_CustomSequenceConvertToZStack(
   int  Number,
   double  ND_ZSeriesStep
);

This function converts the current (active) custom image sequence to Z-stack-type.

Parameters

int Number

0

The conversion is performed at once.

1

A confirmation window appears before the conversion.

double ND_ZSeriesStep

Z-step size in micrometers.

ND_CustomSetSettings

Description 

 ND_CustomSetSettings(
   char *Filename,
   int  Number
);

This function enables you to change some of the settings of the Custom Acquisition control window.

The Filename parameter is used In case the Save to File option is selected within the control window.

Parameters

char *Filename

File name of the destination ND2 image.

int Number

Select what to do if the camera format (image resolution) changes during the acquisition.

-1

Do not decide, leave the previous settings

0

Create new document

1

Resize images

ND_GetCustomMetadataDefinition

Description 

 ND_GetCustomMetadataDefinition(
   int  MetadataSource,
   int  DefinitionIdx,
   char *DefinitionName,
   int  MaxChars
);

Returns the name of the metadata set.

Parameters

int MetadataSource

Defines the metadata source:

0

Current file

1

ND Acquisition Definition

2

Jobs

int DefinitionIdx

Metadata definition identifier.

char *DefinitionName

Name of the definition.

int MaxChars

Allocated character space for the name.

ND_GetCustomMetadataDefinitionCount

Description 

 ND_GetCustomMetadataDefinitionCount(
   int  MetadataSource
);

Returns the number of metadata sets.

Parameters

int MetadataSource

Defines the metadata source:

0

Current file

1

ND Acquisition Definition

2

Jobs

ND_GetCustomMetadataFieldCount

Description 

 ND_GetCustomMetadataFieldCount(
   int  MetadataSource,
   char *DefinitionName
);

Returns the number of items in the metadata set.

Parameters

int MetadataSource

Defines the metadata source:

0

Current file

1

ND Acquisition Definition

2

Jobs

char *DefinitionName

Name of the definition.

ND_GetCustomMetadataFieldInfo

Description 

 ND_GetCustomMetadataFieldInfo(
   int  MetadataSource,
   int  FieldIdx,
   char *DefinitionName,
   int *GetFieldType,
   char *FieldDescription,
   int  MaxChars,
   int *GetFieldFlags
);

Returns custom metadata field information.

Note

DefinitionName string is ignored when MetadataSource value is set to 0 (current file).

Parameters

int MetadataSource

Defines the metadata source:

0

Current file

1

ND Acquisition Definition

2

Jobs

int FieldIdx

Order of the metadata item in the metadata set.

char *DefinitionName

Name of the definition.

int *GetFieldType

Returns the field type.

char *FieldDescription

Metadata item “Description”.

int MaxChars

Allocated character space for the name.

int *GetFieldFlags

Defines whether the item is mandatory or not.

1

not mandatory

3

mandatory

ND_GetCustomMetadataFieldName

Description 

 ND_GetCustomMetadataFieldName(
   int  MetadataSource,
   int  FieldIdx,
   char *DefinitionName,
   char *FieldName,
   int  MaxChars
);

Returns the name of the metadata field.

Note

DefinitionName string is ignored when MetadataSource value is set to 0 (current file).

Parameters

int MetadataSource

Defines the metadata source:

0

Current file

1

ND Acquisition Definition

2

Jobs

int FieldIdx

Order of the metadata item in the metadata set.

char *DefinitionName

Name of the definition.

char *FieldName

Name or unique name of the field.

int MaxChars

Allocated character space for the name.

ND_GetCustomMetadataFieldText

Description 

 ND_GetCustomMetadataFieldText(
   int  MetadataSource,
   int  FieldIdx,
   char *DefinitionName,
   char *FieldText,
   int  MaxChars,
   int  FieldDefault
);

Returns texts of a metadata item.

Parameters

int MetadataSource

Defines the metadata source:

0

Current file

1

ND Acquisition Definition

2

Jobs

int FieldIdx

Order of the metadata item in the metadata set.

char *DefinitionName

Name of the definition.

char *FieldText

Metadata item field text.

int MaxChars

Allocated character space for the name.

int FieldDefault

Name of the Default field in the metadata set.

ND_GetCustomMetadataFieldValue

Description 

 ND_GetCustomMetadataFieldValue(
   int  MetadataSource,
   int  FieldIdx,
   char *DefinitionName,
   int  FieldDefault
);

Returns a metadata field number for data types different than text.

Parameters

int MetadataSource

Defines the metadata source:

0

Current file

1

ND Acquisition Definition

2

Jobs

int FieldIdx

Order of the metadata item in the metadata set.

char *DefinitionName

Name of the definition.

int FieldDefault

Name of the Default field in the metadata set.

ND_RefreshView

Description 

 ND_RefreshView();

Refreshes the contents of the current view. This function is useful for maximum/minimum intensity projection views after any processing made on the ND document.

ND_RemoveCustomMetadataDefinition

Description 

 ND_RemoveCustomMetadataDefinition(
   int  MetadataSource,
   char *DefinitionName
);

Removes the custom metadata set.

Parameters

int MetadataSource

Defines the metadata source:

0

Current file

1

ND Acquisition Definition

2

Jobs

char *DefinitionName

Name of the definition.

ND_RemoveCustomMetadataField

Description 

 ND_RemoveCustomMetadataField(
   int  MetadataSource,
   int  FieldIdx,
   char *DefinitionName
);

Removes the custom metadata field.

Parameters

int MetadataSource

Defines the metadata source:

0

Current file

1

ND Acquisition Definition

2

Jobs

int FieldIdx

Order of the metadata item in the metadata set.

char *DefinitionName

Name of the definition.

ND_SelectViewProjection

This function runs the Z command.

Description 

 ND_SelectViewProjection(
   int  ND_ViewProjectionType
);

Changes the projection used for viewing the ND2 file. Can be used on maximum/minimum intensity views, Slices view and Tiled view. Not all projection types are available on each view.

Parameters

int ND_ViewProjectionType

Type of the projection. Can be on of the following values.

0

Automatically select the best projection

1

Z-series

2

Time

3

Multi point

4

Custom

ND_SelectViewProjectionEx

Description 

 ND_SelectViewProjectionEx(
   int  ND_ViewProjectionType,
   int  ND_ViewSecondaryProjectionType
);

In views which support multi-dimensional projection (tiled view), this function sets the primary and secondary dimension to be displayed.

Parameters

int ND_ViewProjectionType

Type of the projection. Can be on of the following values.

0

Automatically select the best projection

1

Z-series

2

Time

3

Multi point

4

Custom

int ND_ViewSecondaryProjectionType

0

No secondary projection

1

Z-series

2

Time

3

Multi point

ND_SetAuthentication

Description 

 ND_SetAuthentication(
   int  Authentication
);

This function sets the ND image authentication.

Parameters

int Authentication

Turns the image authentication on/off.

0

Authentication off.

1

Authentication on.

ND_SetCustomMetadataFieldText

Description 

 ND_SetCustomMetadataFieldText(
   int  MetadataSource,
   int  FieldIdx,
   char *DefinitionName,
   char *FieldText,
   int  FieldDefault
);

Sets the custom metadata field text.

Parameters

int MetadataSource

Defines the metadata source:

0

Current file

1

ND Acquisition Definition

2

Jobs

int FieldIdx

Order of the metadata item in the metadata set.

char *DefinitionName

Name of the definition.

char *FieldText

Metadata item field text.

int FieldDefault

Name of the Default field in the metadata set.

ND_SetCustomMetadataFieldValue

Description 

 ND_SetCustomMetadataFieldValue(
   int  MetadataSource,
   int  FieldIdx,
   char *DefinitionName,
   double  dblValue,
   int  FieldDefault
);

Sets the custom metadata field value.

Parameters

int MetadataSource

Defines the metadata source:

0

Current file

1

ND Acquisition Definition

2

Jobs

int FieldIdx

Order of the metadata item in the metadata set.

char *DefinitionName

Name of the definition.

double dblValue

Value of the variable.

int FieldDefault

Name of the Default field in the metadata set.

ND_SetOpenViewsToNewWindow

Description 

 ND_SetOpenViewsToNewWindow(
   int  OpenToNewWindow
);

This function sets a behavior of switching views of the opened image (Main View, Slices View, Volume View, ...).

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_SetPlateLabeling

Description 

 ND_SetPlateLabeling(
   char *DocumentName,
   char *Filename
);

Sets the well plate labeling.

Parameters

char *DocumentName

Document file name.

char *Filename

Path to the .json file.

ND_SetZeroBasedTime

Description 

 ND_SetZeroBasedTime(
   int  ZeroBasedTime
);

Sets one of the application options (Edit > Options ).

Parameters

int ZeroBasedTime

0

The first frame of a captured time-sequence will start at the time the frame was actually received.

1

Ensure that the first frame of a time sequence will always start at 0.0s. When the option is ON, the real acquisition times are shifted accordingly.

Stimulate

Description 

 Stimulate(
   double  ND_TimeDuration,
   char *StimConfiguration,
   int  StimFinish
);

Stimulates the experiment for a defined time interval.

Parameters

double ND_TimeDuration

Phase duration [ms].

-1

Continuous

char *StimConfiguration

This parameter selects lasers to be used for stimulation.

-1

all lasers (default value)

int StimFinish

For Nikon A1 confocal microscope, this parameter can either finish the stimulation of prepare the laser(s) for another stimulation phase.

0

Prepare for further stimulation

1

Finish scanning

StimulationDeviceSetActive

This function runs the Applications > 6D > Device for Stimulation: [Device Name] command.

Description 

 StimulationDeviceSetActive(
   char *StimulationDeviceName
);

Sets the selected stimulation device active.

Parameters

char *StimulationDeviceName

ID of the stimulation device.

See List of stimulation devices.

_MergeNDDocuments

This function runs the File > Merge ND Documents command.

Description 

 _MergeNDDocuments();

Opens the Merge ND Documents dialog window. Please see ND_MergeFiles for more information.

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