_ExportImagesToTIFF, _ND_BatchExport, _ND_BioStationNex_Import, _ND_Convert, _ND_CreateExperiment, _ND_CreateJsonSequence, _ND_CreateMultipointSet, _ND_CreateNDAdvanced, _ND_Crop, _ND_Dicom_Import, _ND_ExchangeDimensions, _ND_Export, _ND_ExportToTIFF, _ND_SplitMultipoints, _OpenSequence, ExportImagesToTIFF, GetSuggestedZStep, ModifyZStep, ND_BioStationNex_Import, ND_ConvertAddWaveLength, ND_ConvertAddWaveLength2, ND_ConvertAllocXYCoors, ND_ConvertFinish, ND_ConvertFreeXYCoors, ND_ConvertInit, ND_ConvertSequenceToSpectral, ND_ConvertSetMicSettings, ND_ConvertSetTimeLoop, ND_ConvertSetXYLoop, ND_ConvertSetZStackLoop, ND_CropAllocMask, ND_CropFinish, ND_CropFreeMask, ND_CropInit, ND_CropSetBinary, ND_CropSetChannelCropXYZ, ND_CropSetChannelCropXYZArb, ND_CropSetProjections, ND_CropSpectLoop, ND_CropTimeLoop, ND_CropXYLoop, ND_CropZStackLoop, ND_DefineExperiment, ND_ExchangeDimensions, ND_Export, ND_ExportToTIFF, ND_FinishExperiment, ND_GetCurrentPosIndexes, ND_GetExperimentLoopSize, ND_GetPictureMetadata, ND_GetPositionInExperiment, ND_GetRecordingDataDouble, ND_GetRecordingDataInt, ND_GetRecordingDataString, ND_GetSelectionRange, ND_InsertEvent, ND_LoadExperiment, ND_LoadMultipointSet, ND_LoadNDAdvanced, ND_LoadSequence, ND_MergeFiles, ND_MoveExperimentBackward, ND_MoveExperimentForward, ND_MoveInExperiment, ND_MoveInExperimentSeq, ND_MoveRangeBackward, ND_MoveRangeForward, ND_MoveToNextEvent, ND_MoveToPreviousEvent, ND_PauseExperiment, ND_RecordedDataDefault, ND_RedefineAbsZ, ND_RemoveEvent, ND_RemoveExperiment, ND_RemoveRecordingData, ND_ResumeExperiment, ND_ReuseExperiment, ND_ReuseZIntensityCorr, ND_RunExperiment, ND_RunExperimentNoProgressBar, ND_RunExperimentWithZIntensityCorrection, ND_RunMultipointSet, ND_RunNDAdvanced, ND_SaveExperiment, ND_SetRecordingDataDouble, ND_SetRecordingDataInt, ND_SetRecordingDataString, ND_SetSelectionMode, ND_SetSelectionRange, ND_SplitMultipoints, OpenStackedTiff

ExportImagesToTIFF

Interactive command to this function: File > Save/Export to TIFF Files

Description 

 ExportImagesToTIFF(
   int  ExportToTiffImageSource,
   char *ND_SrcFileNames,
   char  ExportToTiffPath,
   char  ExportToTiffPreset
);

Exports selected files into TIFF. The ND_SrcFileNames parameter defining the file names of images that will be exported to TIFF is used only if the ExportToTiffImageSource parameter is set to 2.

Parameters

int ExportToTiffImageSource

Determines which images will be exported to TIFF.

0	Current Document
1	All Opened Documents
2	Multiple Files

char *ND_SrcFileNames

Defines the list of files. Enter full paths to the files separated by a semicolon.

char ExportToTiffPath

Output folder path for storing the new TIFF files. If this folder is not specified, “Same as Input” option is used instead.

char ExportToTiffPreset

Name of the dialog window settings (preset) saved into the database. If no preset is entered, the last one used or a default setting is applied.

GetSuggestedZStep

Description 

 GetSuggestedZStep();

This function returns optimal Z step size in micrometers. It is the same Suggested Z Step value which is used within the Capture Z-Series (or Define/Run Experiment) control window.

ModifyZStep

Description 

 ModifyZStep(
   double  ND_StepDbl
);

Modifies Z-Step value of the current ND document.

Parameters

double ND_StepDbl

Step size in micrometers.

ND_BioStationNex_Import

Interactive command to this function: File > Import/Export > Create ND File from BioStation NEX

Description 

 ND_BioStationNex_Import(
   char *Filename
);

Imports the Biostation NEX File.

Parameters

char *Filename

The path and the name of the file.

See Also

• _ND_BioStationNex_Import

ND_ConvertAddWaveLength

Description 

 ND_ConvertAddWaveLength(
   int  ND_ConvertHandle,
   int  Color,
   char *WaveLengthName,
   char *OptConfigName
);

This function adds new wavelength specification parameters for WaveLength loop which will be used in ND Convert process.

Parameters

int ND_ConvertHandle

A value returned by the ND_ConvertInit function.

int Color

The RGB color as a 32bit integer. Use the RGB function to get the value.

char *WaveLengthName

Name of new WaveLength.

char *OptConfigName

Optical configuration name selected with new WaveLength.

See Also

• ND_ConvertFinish

ND_ConvertAddWaveLength2

Description 

 ND_ConvertAddWaveLength2(
   int64  ND_ConvertHandle,
   char *WaveLengthName,
   char *ModalityFlags,
   int  ExcitationNm,
   int  EmissionNm,
   int  Color
);

Used for alternative setting of wavelength without OC, when having TIFF files.

Parameters

int64 ND_ConvertHandle

A value returned by the ND_ConvertInit function.

char *WaveLengthName

Name of new WaveLength.

char *ModalityFlags

Modality flags is a combination (separated ','):

“fluorescence”

“bright field”

“phaseContrast”

“diContrast”

“camera”

“laserScanConfocal”

“spinningDiskConfocal”

“sweptFieldConfocalSlit”

“sweptFieldConfocalPinhole”

“dsdConfocal”

“SIM”

“iSIM”

“RCM”

“VCS”

“sora”

“liveSR”

“multiphoton”

“TIRF”

“pmt”

“spectral”

“vaasIF”

“vaasNF”

“transmitDetector”

“nonDescannedDetector”

“virtualFilter”

“gaasp”

“remainder”

“aux”

“custom”

int ExcitationNm

Excitation in nm.

int EmissionNm

Emission in nm.

int Color

The RGB color as a 32bit integer. Use the RGB function to get the value.

See Also

• ND_ConvertFinish

ND_ConvertAllocXYCoors

Description 

 ND_ConvertAllocXYCoors(
   int  Count
);

This function allocates memory (Count parameter) for coordinates which can be passed to the ND_ConvertSetXYLoop function. When the memory is no longer needed it should be freed by calling the ND_ConvertFreeXYCoors function.

Parameters

int Count

Number of iterations.

Return Values

double* XYCoors - This can be used as pointer to properly allocated memory for desired coordinates count.

See Also 
ND_ConvertFreeXYCoors

ND_ConvertFinish

Description 

 ND_ConvertFinish(
   int  ND_ConvertHandle,
   char *DestFile
);

This function finally performs the ND Convert process previously defined by set of NDConvert functions. DesFile parameter represents the output file name with its full path.

Parameters

int ND_ConvertHandle

A value returned by the ND_ConvertInit function.

char *DestFile

Destination file.

double *pXYCoords;
int NDConvertHandle;
pXYCoords = ND_ConvertAllocXYCoors(4); // Four values are used (X1, Y1, X2, Y2)
NDConvertHandle = ND_ConvertInit("C:\images\convert\serie.tif",-1,1,0,2);
pXYCoords[0] = 1000; // X1
pXYCoords[1] = 1500; // Y1
pXYCoords[2] = 2000; // X2
pXYCoords[3] = 2500; // Y2
ND_ConvertSetXYLoop(NDConvertHandle, 2, 0, pXYCoords);
ND_ConvertSetZStackLoop(NDConvertHandle, 3, 10);
ND_ConvertAddWaveLength(NDConvertHandle,RGB(255, 0, 0),"Red","");
ND_ConvertAddWaveLength(NDConvertHandle,RGB(0, 255, 0),"Green","");
ND_ConvertAddWaveLength(NDConvertHandle,RGB(0, 0, 255),"Blue","");
ND_ConvertFinish(NDConvertHandle, "c:\result.nd2");
ND_ConvertFreeXYCoors(pXYCoords);

Note

If product of all LoopCnt parameters of the ND_ConvertSet... functions is greater than the number of images found in the specified directory, no conversion will be performed.

See Also 
ND_ConvertInit, ND_ConvertAllocXYCoors, ND_ConvertFreeXYCoors, ND_ConvertAddWaveLength, ND_ConvertSetXYLoop, ND_ConvertSetZStackLoop

ND_ConvertFreeXYCoors

Description 

 ND_ConvertFreeXYCoors(
   double *XYCoors
);

This function should be used to free memory previously allocated by ND_ConvertAllocXYCoors.

Parameters

double *XYCoors

Pointer to allocated memory returned by ND_ConvertAllocXYCoors

See Also 
ND_ConvertAllocXYCoors

ND_ConvertInit

Description 

int64 ND_ConvertInit(
   char *Filename,
   int  TimeIdx,
   int  ZStackIdx,
   int  XYIdx,
   int  WaveLengthIdx
);

This function initializes the process of converting a file sequence to a single ND document. Filename specifies the first file of the input file sequence.

Parameters

char *Filename

The path and the name of the file.

int TimeIdx

Index of the position within the ND2 document structure.

-1	The dimension is not present.
0	Time dimension is included in the first position (can not be anywhere else).

int ZStackIdx

Index of the position within the ND2 document structure.

-1	The dimension is not present.
0	Z dimension is included in the first position. (if Time is missing).
1	Z dimension is included in the second position (if Time is present).

int XYIdx

Index of the position within the ND2 document structure.

-1	The dimension is not present.
0, 1, 2, 3	The position of the dimension within the ND2 document. However, cannot precede the Time and XY dimensions = [0], [1] values can be used only when the Time or/and XY is missing.

int WaveLengthIdx

Index of the position within the ND2 document structure.

-1	The dimension is not present.
0, 1, 2, 3	The position of the dimension within the ND2 document. However, cannot precede the Time and XY dimensions = [0], [1] values can be used only when the Time or/and XY is missing.

Return Values

int64

NDConvertHandle - This must be passed to other functions to complete ND Convert process.

double *pXYCoords;
int64 NDConvertHandle;
pXYCoords = ND_ConvertAllocXYCoors(4); // Four values are used (X1, Y1, X2, Y2)
NDConvertHandle = ND_ConvertInit("C:\images\convert\serie.tif",-1,1,0,2);
pXYCoords[0] = 1000; // X1
pXYCoords[1] = 1500; // Y1
pXYCoords[2] = 2000; // X2
pXYCoords[3] = 2500; // Y2
ND_ConvertSetXYLoop(NDConvertHandle, 2, 0, pXYCoords);
ND_ConvertSetZStackLoop(NDConvertHandle, 3, 10);
ND_ConvertAddWaveLength(NDConvertHandle,RGB(255, 0, 0),"Red","");
ND_ConvertAddWaveLength(NDConvertHandle,RGB(0, 255, 0),"Green","");
ND_ConvertAddWaveLength(NDConvertHandle,RGB(0, 0, 255),"Blue","");
ND_ConvertFinish(NDConvertHandle, "c:\result.nd2");
ND_ConvertFreeXYCoors(pXYCoords);

See Also 
ND_ConvertFinish, ND_ConvertAllocXYCoors, ND_ConvertFreeXYCoors, ND_ConvertAddWaveLength, ND_ConvertSetXYLoop, ND_ConvertSetZStackLoop

ND_ConvertSequenceToSpectral

Description 

 ND_ConvertSequenceToSpectral(
   int  ND_LambdaCount,
   double *ND_LambdaWavelength,
   double *ND_LambdaBandwidth,
   char *ND_LambdaNames
);

This function takes the current grayscale + timelapse ND document and converts the given number of frames in this document into another no delay timelapse, or a single image with a given number of spectral channels.

Parameters

int ND_LambdaCount

Number of spectral channels of the resulting file.

double *ND_LambdaWavelength

Array of wavelengths of the spectral channels to be created.

double *ND_LambdaBandwidth

Array of bandwidths of the spectral channels to be created.

char *ND_LambdaNames

A string that contains spectral channel names. Length of 16 characters is reserved for each channel name.

int main()
   {
   double dWavelength[4];
   double dBandwidth[4];
   char sChannel[64];
   int iLambdaCount;
   iLambdaCount = 4;
   dWavelength[0] = 450;
   dWavelength[1] = 500;
   dWavelength[2] = 600;
   dWavelength[3] = 700;
   dBandwidth[0] = 10;
   dBandwidth[1] = 15;
   dBandwidth[2] = 20;
   dBandwidth[3] = 25;
   strcpy(sChannel, "a00");
   strcpy(sChannel+16, "a01");
   strcpy(sChannel+32, "a02");
   strcpy(sChannel+48, "a03");
   ND_ConvertSequenceToSpectral(iLambdaCount, dWavelength, dBandwidth, sChannel);
   }

ND_ConvertSetMicSettings

Description 

 ND_ConvertSetMicSettings(
   int64  ND_ConvertHandle,
   double  ND_Calibration,
   double  ND_ObjMagnification,
   double  ND_ObjNumericalAperture,
   double  ND_ProjectiveMagnification,
   double  ND_ZoomMagnification,
   double  ND_ImmersionRefraciveIndex,
   double  ND_PinholeDiameterUm
);

Sets important metadata, especially those used for Deconvolution.

Parameters

int64 ND_ConvertHandle

A value returned by the ND_ConvertInit function.

double ND_Calibration

ND Calibration.

double ND_ObjMagnification

Objective Magnification.

double ND_ObjNumericalAperture

Objective numerical aperture.

double ND_ProjectiveMagnification

Projective magnification.

double ND_ZoomMagnification

Zoom magnification.

double ND_ImmersionRefraciveIndex

Immersion refractive index.

double ND_PinholeDiameterUm

Pinhole diameter.

ND_ConvertSetTimeLoop

Description 

 ND_ConvertSetTimeLoop(
   int  ND_ConvertHandle,
   int  LoopCnt,
   int  Period
);

This function sets parameters for the Time loop which will be used in the ND Convert process.

Parameters

int ND_ConvertHandle

A value returned by the ND_ConvertInit function.

int LoopCnt

Size of the loop (Time, XY, ZStack).

int Period

Period of Time loop in ms.

ND_ConvertSetXYLoop

Description 

 ND_ConvertSetXYLoop(
   int  ND_ConvertHandle,
   int  LoopCnt,
   int  UseZCoord,
   double *XYCoors
);

This function sets parameters for the XY loop which will be used in the ND Convert process.

Parameters

int ND_ConvertHandle

A value returned by the ND_ConvertInit function.

int LoopCnt

Size of the loop (Time, XY, ZStack).

int UseZCoord

If nonzero then the Z coordinate is included in XYCoors.

double *XYCoors

Array with exactly LoopCnt count of XY (and possibly Z) coordinates.

ND_ConvertSetZStackLoop

Description 

 ND_ConvertSetZStackLoop(
   int  ND_ConvertHandle,
   int  LoopCnt,
   double  Step
);

This function sets parameters for ZStack loop which will be used in the ND Convert process.

Parameters

int ND_ConvertHandle

A value returned by the ND_ConvertInit function.

int LoopCnt

Size of the loop (Time, XY, ZStack).

double Step

Defines Z-drive step for focusing in micrometers.

ND_CropAllocMask

Description 

 ND_CropAllocMask(
   int  ValuesCnt
);

This function allocates memory for mask values which can be passed to the ND_CropSpectLoop function. When the memory is no longer needed it should be freed by calling the ND_CropFreeMask function.

Parameters

int ValuesCnt

Mask values count stored in allocated memory.

Return Values

BYTE* MaskValues - This can be used as pointer to properly allocated memory (used for mask values)

ND_CropFinish

Description 

 ND_CropFinish(
   int64  ND_CropHandle
);

This function finally performs the NDCrop process previously defined by set of NDCrop functions.

Parameters

int64 ND_CropHandle

Value returned by the ND_CropInit function.

See Also 
ND_CropInit

ND_CropFreeMask

Description 

 ND_CropFreeMask(
   char8 *MaskValues
);

This function should be used to free memory previously allocated by the ND_CropAllocMask function.

Parameters

char8 *MaskValues

Array that represents mask values for the loop. Use nonzero values for coordinates which should remain and zero for which should be removed.

See Also 
ND_CropAllocMask

ND_CropInit

Description 

 ND_CropInit(
   int  DestFile,
   int  Left,
   int  Top,
   int  Width,
   int  Height
);

This function initializes process of cropping ND document by setting its basic parameters.

Parameters

int DestFile

Output filename with full path.

int Left

Left margin in pixels.

int Top

Top margin in pixels.

int Width

Image width in pixels.

int Height

Image height in pixels.

Return Values

int64 NDCropHandle - This must be passed to other functions to complete the NDCrop process.

ND_CropSetBinary

Description 

 ND_CropSetBinary(
   int64  ND_CropHandle,
   int  BinLayerID,
   char *BinaryConnected,
   int  BinLayerColor,
   int  BinLayerColorMode,
   int  Channel ID
);

Defines cropping parameters of the binary layer before the cropping function is called.

Parameters

int64 ND_CropHandle

Value returned by the ND_CropInit function.

int BinLayerID

Binary layer unique identifier.

char *BinaryConnected

Defines whether the binary objects are connected together in 3D.

0	Does not connect objects after cropping
1	Connects objects after cropping

int BinLayerColor

Color value.

int BinLayerColorMode

This parameter defines type of color mapping of image channels.

0	True Color
1	Custom Color
2	Gray Scale

int Channel ID

Channel ID

ND_CropSetChannelCropXYZ

Description 

 ND_CropSetChannelCropXYZ(
   int64  ND_CropHandle,
   int  Channel,
   double  XMin,
   double  XMax,
   double  YMin,
   double  YMax,
   double  ZMin,
   double  ZMax
);

This function crops the selected channel based on XYZ dimensions.

Parameters

int64 ND_CropHandle

Value returned by the ND_CropInit function.

int Channel

Index number of the channel.

double XMin

Minimum X.

double XMax

Maximum X.

double YMin

Minimum Y.

double YMax

Maximum Y.

double ZMin

Minimum Z.

double ZMax

Maximum Z.

ND_CropSetChannelCropXYZArb

Description 

 ND_CropSetChannelCropXYZArb(
   int64  ND_CropHandle,
   int  Channel,
   int  FactorA,
   int  FactorB,
   int  FactorC,
   int  FactorD
);

Arbitrary crop of the channel.

Parameters

int64 ND_CropHandle

Value returned by the ND_CropInit function.

int Channel

Index number of the channel.

int FactorA

Factor A.

int FactorB

Factor B.

int FactorC

Factor C.

int FactorD

Factor D.

ND_CropSetProjections

Description 

 ND_CropSetProjections(
   int64  ND_CropHandle,
   int  ProjectionWanted,
   int  ProjectionsAvailable,
   int  ZIndex
);

Projections cropping parameter setting.

Parameters

int64 ND_CropHandle

Value returned by the ND_CropInit function.

int ProjectionWanted

Wanted projection.

int ProjectionsAvailable

Available projections.

int ZIndex

Index in ZStack loop of desired picture frame.

0	Z1
1	Z2
2	Z1, Z2

ND_CropSpectLoop

Description 

 ND_CropSpectLoop(
   int64  ND_CropHandle,
   char8 *MaskValues,
   int  ValuesCount
);

This function defines which Wavelengths in Spectral loop should be cropped in NDCrop.

Parameters

int64 ND_CropHandle

Value returned by the ND_CropInit function.

char8 *MaskValues

Array that represents mask values for the loop. Use nonzero values for coordinates which should remain and zero for which should be removed.

int ValuesCount

Size of the MaskValues array.

See Also 
ND_CropInit

ND_CropTimeLoop

Description 

 ND_CropTimeLoop(
   int64  ND_CropHandle,
   int  First,
   int  Last,
   int  Step
);

This functions sets parameters of the NDCrop for the Time loop.

Parameters

int64 ND_CropHandle

Value returned by the ND_CropInit function.

int First

Index of the first frame in the range where NDCrop starts within the loop.

int Last

Index of last frame in range where NDCrop ends within the loop.

int Step

The step to be used within the range defined by previous parameters.

See Also 
ND_CropInit

ND_CropXYLoop

Description 

 ND_CropXYLoop(
   int64  ND_CropHandle,
   char8 *MaskValues,
   int  ValuesCount
);

This function sets which XY coordinates in Multipoint loop should be cropped in NDCrop.

Parameters

int64 ND_CropHandle

Value returned by the ND_CropInit function.

char8 *MaskValues

Array that represents mask values for the loop. Use nonzero values for coordinates which should remain and zero for which should be removed.

int ValuesCount

Size of the MaskValues array.

See Also 
ND_CropInit

ND_CropZStackLoop

Description 

 ND_CropZStackLoop(
   int64  ND_CropHandle,
   int  First,
   int  Last,
   int  Step
);

This functions sets parameters of the NDCrop for the ZStack loop.

Parameters

int64 ND_CropHandle

Value returned by the ND_CropInit function.

int First

Index of the first frame in the range where NDCrop starts within the loop.

int Last

Index of last frame in range where NDCrop ends within the loop.

int Step

The step to be used within the range defined by previous parameters.

See Also 
ND_CropInit

ND_DefineExperiment

Description 

 ND_DefineExperiment(
   bool  ND_TExp,
   bool  ND_XYExp,
   bool  ND_ZExp,
   bool  ND_LExp,
   bool  ND_NormalZOrder,
   char *Filename,
   char *Prefix,
   int  ND_FileType,
   bool  ND_UseTIFF,
   bool  ND_UsePFS,
   bool  ND_EnableTMeas
);

This function defines parameters for ND experiment.

Parameters

bool ND_TExp

TRUE if acquiring Time experiment else FALSE

bool ND_XYExp

TRUE if acquiring XYMultipoint experiment else FALSE

bool ND_ZExp

TRUE if acquiring ZStack experiment else FALSE

bool ND_LExp

TRUE if acquiring WaveLength experiment else FALSE

bool ND_NormalZOrder

TRUE if order of experiments is Z->L FALSE if it is L->Z

char *Filename

The path and the name of the destination file.

char *Prefix

Text to be used as prefix.

int ND_FileType

Reserved for future use.

bool ND_UseTIFF

TRUE if output is not a single ND file but a TIFF sequence, else FALSE (should be always FALSE). This parameter affects appearance of the [

bool ND_UsePFS

TRUE if Perfect Focus System will be used during acquisition else FALSE

bool ND_EnableTMeas

TRUE if Time Measurement will be enabled during acquisition else FALSE.

Note

You can set capturing to *.tif series by setting the ND_UseTIFF parameter to 1, and capturing to a single *.nd2 file by setting it to 0. Other parameters can be omitted by setting them to -1 as in the following example: ND_DefineExperiment(-1,-1,-1,-1,-1,"","",-1,1,-1,-1); // sets the TIFF mode ND_DefineExperiment(-1,-1,-1,-1,-1,"","",-1,0,-1,-1); // sets the ND2 mode There is a naming convention for the *.tif series. The format of the naming convention is: prefix[t][index1][xy][index2][z][index3][c][index4].tif t, xy, z, c with appropriate index will be omitted if the dimension is not acquired. Indexes are integer values counted from 1. For example, time loop with z-stack in two channels with prefix "nd" will produce: ndt1z1c1.tif ndt1z1c2.tif ndt1z2c1.tif ndt1z2c2.tif ndt1z3c1.tif ndt1z3c2.tif

ND_ExchangeDimensions

Interactive command to this function: Image > ND Processing > Exchange Dimensions

Description 

 ND_ExchangeDimensions(
   int  ND_TimeCount,
   int  StgArrayCount,
   int  ND_ZSeriesCount,
   double  ND_TimeInterval,
   double *StgArrayX,
   double *StgArrayY,
   double *StgArrayZ,
   char *StgArrayNames,
   double  ZSeriesStep
);

Changes the dimensions in the current ND document.

Parameters

int ND_TimeCount

Number of loops to be performed within the time phase.

int StgArrayCount

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

int ND_ZSeriesCount

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.

double ND_TimeInterval

The interval value in [ms]

0.0

No Delay

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...

double ZSeriesStep

Number of steps, i.e. number of source images for creating focused image

ND_Export

Interactive command to this function: File > Import/Export > Export ND Document

Description 

 ND_Export(
   char *Filename,
   char *Dest_Directory,
   char *Prefix,
   char *FileExtension,
   int  ChannelExportType,
   int  ApplyLuts,
   int  InsertOverlay
);

This function performs conversion from an ND document to a sequence of images.

Parameters

char *Filename

File name of the source ND2 image.

char *Dest_Directory

This parameter describes path to the resulting files (destination directory).

char *Prefix

Text to be used as prefix.

char *FileExtension

Output image files extension.

tif	Tagged Image Format (TIFF)
mptif	Multi-page TIFF
jp2	JPEG2000

int ChannelExportType

Defines how channels will be exported:

0	Mono image for each channel
1	RGB image for each channel in channel color
2	Merge channels to RGB image
3	Keep image as multichannel

int ApplyLuts

Use a non-zero value if LUTs should be applied to the output images.

int InsertOverlay

Use nonzero value if the Overlay layer should be burned in output images.

ND_ExportToTIFF

Interactive command to this function: File > Import/Export > ND Export to TIFF

Description 

 ND_ExportToTIFF(
   char *Filename,
   char *Dest_Directory,
   char *Prefix,
   int  ChannelExportType,
   int  ApplyLuts,
   char *uiSaveAsMCH,
   char *iMultiPageMask
);

This function performs conversion from an ND document to a TIFF file.

Parameters

char *Filename

File name of the source ND2 image.

char *Dest_Directory

This parameter describes path to the resulting files (destination directory).

char *Prefix

Text to be used as prefix.

int ChannelExportType

Defines how channels will be exported:

0	Mono image for each channel
1	RGB image for each channel in channel color
2	Merge channels to RGB image
3	Keep image as multichannel

int ApplyLuts

Use a non-zero value if LUTs should be applied to the output images. This option is accessible only with the Merge channels to RGB image option.

char *uiSaveAsMCH

Defines how channels are saved into the TIFF file respecting the TIFF file properties and compatibility.

0	per plane
1	per pixel

char *iMultiPageMask

Defines the Multi page mask - a way dimensions of multi-dimensional nd2 files are treated during the export into a TIFF file. Select which dimension(s) will form the basis of the Multi-page TIFF file. For example if you choose t+z, all exported TIFF files will have both time and Z dimensions. Dimension combo boxes are used to sort the remaining dimensions to define the file naming of all exported images. The number of exported multi-page TIFF files can be calculated as multiplication of all dimensions except those selected in the Multi-page combo box.

Example 22. 

Our nd2 file has 10 timelapse frames, 3 multi-points and 5 Z slices. We want to create multi-page TIFF files having only a Z stack dimension. Thus we select z from the Multi-page combo box. To define the file naming we can adjust the dimension order in the Dimension combo box. After clicking Export, the remaining dimensions (t and XY) are automatically incorporated into our 30 (10x3) new Z-stack TIFF files.

0	none
1	t
16	xy
256	z
17	t+xy
257	t+z
272	xy+z
273	t+xy+z

ND_FinishExperiment

Description 

 ND_FinishExperiment();

This function aborts the running ND experiment at the end of the currently running time loop. The ND file will be created from the frames captured so far.

ND_GetCurrentPosIndexes

Description 

 ND_GetCurrentPosIndexes(
   int *pTIndex,
   int *pXYIndex,
   int *pZIndex
);

This function returns the position of a selected image frame within the current ND2 document.

Parameters

int *pTIndex

Time index of the selected frame

int *pXYIndex

Multipoint index of the selected frame

int *pZIndex

Current position in the ZStack dimension (-1 if not present).

ND_GetExperimentLoopSize

Description 

 ND_GetExperimentLoopSize(
   int  ND_ExperimentType,
   int  ND_ExperimentByType
);

This function retrieves the size or position of specified experiment loop from the open document.

Parameters

int ND_ExperimentType

Type of the experiment loop or its position (depends on the ND_ExperimentByType parameter). If the ND_ExperimentByType is set to 1, the values from the table below will be used. If it is 0, just define the placing of the dimension within the whole experiment.

1	Time loop - us this value if the experiment contains just one time phase. Otherwise it returns 0.
2	XY Multipoint loop
4	Z Stack loop
6	Lambda (multichannel) loop
8	NE Time loop (NE = Non-Equidistant) - use this value if the experiment consists of more than one time phase.

int ND_ExperimentByType

0	The ND_ExperimentType parameter determines the position of the loop.
1	The ND_ExperimentType parameter determines the type of the loop.

ND_GetPictureMetadata

Description 

 ND_GetPictureMetadata(
   int  ND_PosAbsolute,
   void *ND_Metadata,
   dword  ND_MetadataFlags
);

This function retrieves desired metadata from specified picture frame.

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.

void *ND_Metadata

Pointer to memory where metadata will be stored.

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*)

Return Values

0 on success, otherwise <> 0.

ND_GetPositionInExperiment

Description 

 ND_GetPositionInExperiment(
   int  TIndex,
   int  XYIndex,
   int  ZIndex,
   int  ND_PosAbsolute,
   double *XPos,
   double *YPos,
   double *ZPos,
   double *TPos
);

This function retrieves values of Time and XYZ positions in the specified picture frame.

Parameters

int TIndex

Index in Time loop of desired picture frame.

int XYIndex

Index in XY Multipoint loop of desired picture frame.

int ZIndex

Index in ZStack loop of desired picture frame.

0	Z1
1	Z2
2	Z1, Z2

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.

double *XPos

X Position

double *YPos

Y Position

double *ZPos

Z Position

double *TPos

Time Position

ND_GetRecordingDataDouble

Description 

 ND_GetRecordingDataDouble(
   char *RecordID,
   int  SeqIndex,
   char *RecordDescription,
   double *RecordDoubleP,
   char *RecordUnit
);

This function retrieves information about additionally set floating point number Recorded data during ND Acquisition.

Parameters

char *RecordID

This parameter is a string identifier of Recorded data inserted in previous call of ND_SetRecordingDataDouble function or one of the predefined values described bellow.

X	X coordinate of the current frame
Y	Y coordinate of the current frame
Z	Z coordinate of the current frame
Z1	Z coordinate of the first Z device in case of multiple Z devices
Z2	Z coordinate of the second Z device in case of multiple Z devices
HEATSTAGE_T	Temperature of a heatstage
ADC_VOLTAGE_n	Voltage of a device number n

int SeqIndex

This parameter sets a sequence index of the recorded frame. If the SeqIndex equals -1, index of the currently acquired frame is assigned to this value. Use -2 for a global value.

char *RecordDescription

Short text description of Recorded data can be retrieved by this parameter. Minimum length of the string buffer is 256 characters.

double *RecordDoubleP

Double value of Recorded data assigned to the acquired frame is returned by this parameter.

char *RecordUnit

Measuring unit in string form can be retrieved by this parameter. Minimum length of the string buffer is 16 characters.

See Also 
ND_GetRecordingDataInt, ND_GetRecordingDataString

ND_GetRecordingDataInt

Description 

 ND_GetRecordingDataInt(
   char *RecordID,
   int  SeqIndex,
   char *RecordDescription,
   int *RecordIntP,
   char *RecordUnit
);

This function retrieves information about additionally set integer number Recorded data during ND Acquisition.

Parameters

char *RecordID

This parameter is a string identifier of Recorded data inserted in previous call of ND_SetRecordingDataInt function or one of the predefined values described bellow.

PFS_OFFSET

PFS offset recorded with the current frame

int SeqIndex

This parameter sets a sequence index of the recorded frame. If the SeqIndex equals -1, index of the currently acquired frame is assigned to this value. Use -2 for a global value.

char *RecordDescription

Short text description of Recorded data can be retrieved by this parameter. Minimum length of the string buffer is 256 characters.

int *RecordIntP

Integer value of Recorded data assigned to the acquired frame is returned by this parameter.

char *RecordUnit

Measuring unit in string form can be retrieved by this parameter. Minimum length of the string buffer is 16 characters.

See Also 
ND_GetRecordingDataDouble, ND_GetRecordingDataString

ND_GetRecordingDataString

Description 

 ND_GetRecordingDataString(
   char *RecordID,
   int  SeqIndex,
   char *RecordDescription,
   char *RecordStringP,
   char *RecordUnit
);

This function retrieves information about additionally set string Recorded data during ND Acquisition.

Parameters

char *RecordID

This parameter is a string identifier of Recorded data inserted in previous call of ND_SetRecordingDataString function.

int SeqIndex

This parameter sets a sequence index of the recorded frame. If the SeqIndex equals -1, index of the currently acquired frame is assigned to this value. Use -2 for a global value.

char *RecordDescription

Short text description of Recorded data can be retrieved by this parameter. Minimum length of the string buffer is 256 characters.

char *RecordStringP

String value of Recorded data assigned to the acquired frame is returned by this parameter. Minimum length of the string buffer is 256 characters.

char *RecordUnit

Measuring unit in string form can be retrieved by this parameter. Minimum length of the string buffer is 16 characters.

See Also 
ND_GetRecordingDataDouble, ND_GetRecordingDataInt

ND_GetSelectionRange

Description 

 ND_GetSelectionRange(
   int  LoopIndex,
   int *NDSelection,
   int  NDSelectionSize
);

Returns the size of the selected loop. pFrames is an array of INTs of the iFrameCount size. When the function is called, it is filled with zeros or ones depending on the ND selection.

Example:

int selection[10];
int loopSize;
char msg[256];

loopSize = ND_GetSelectionRange(0, selection, 10);
sprintf(msg, "Loop %i - loopSize: %i, selection: %i, %i, %i, %i, %i, %i, %i, %i, %i, %i, "0, loopSize, selection[0], selection[1], selection[2], selection [3], selection[4], selection[5], selection[6], selection[7], selection[8], selection[9]");

WaitText(0, msg);

loopSize = ND_GetSelectionRange(1, selection, 10);
sprintf(msg, "Loop %i - loopSize: %i, selection: %i, %i, %i, %i, %i, %i, %i, %i, %i, %i, "1, loopSize, selection[0], selection[1], selection[2], selection [3], selection[4], selection[5], selection[6], selection[7], selection[8], selection[9]");

WaitText(0, msg);

Parameters

int LoopIndex

Index number of the loop (dimension).

-1	The most recently modified loop.
0	Time loop
1	Multipoint loop
2	Z Stack loop

int *NDSelection

ND selection name.

int NDSelectionSize

ND selection size.

ND_InsertEvent

Description 

int ND_InsertEvent(
   int  EventType,
   double  EventTime,
   char  EventDescription
);

This function inserts user-defined event into the current ND document.

Parameters

int EventType

The parameter describes the event type and it is one of the following:

0	Default User event type. This parameter inserts currently selected user event (from ND Navigation bar).
2	User event type #1.
3	User event type #2.
4	User event type #3.
5	User event type #4.

double EventTime

Event time in milliseconds from the beginning of an acquisition. If the inserted time is 0, the time of the currently selected frame is entered.

char EventDescription

Additional text description.

Return Values

int

Returned value is an event ID. This value can serve as an identification in event modifying functions. If the value is negative an error occurred.

See Also 
ND_RemoveEvent

ND_LoadExperiment

Description 

 ND_LoadExperiment(
   char *ND_ExperimentName
);

This function loads a previously saved experiment settings from registry.

Parameters

char *ND_ExperimentName

The name of the experiment to be saved/loaded/removed.

ND_LoadMultipointSet

Description 

 ND_LoadMultipointSet(
   char *ND_MultipointSetName,
   char *ND_MultipointExpName
);

This function imports the multi-point set to the ND experiment.

Parameters

char *ND_MultipointSetName

Name of the multi point set.

char *ND_MultipointExpName

Name of the multi point ND experiment.

ND_LoadNDAdvanced

Description 

 ND_LoadNDAdvanced(
   char *ND_SequenceName
);

This function loads specified ND sequence.

Parameters

char *ND_SequenceName

name of the ND sequence

ND_LoadSequence

Description 

 ND_LoadSequence(
   char *ND_SequenceName
);

This function loads selected ND sequence.

Parameters

char *ND_SequenceName

name of the ND sequence

ND_MergeFiles

Description 

 ND_MergeFiles(
   char *ND_SrcFileNames,
   char *ND_Filename,
   int *ND_Groups,
   int  ND_MergeFlags
);

This function merges ND documents. The ND_SrcFileNames parameter defines the list of images which can be merged.

Parameters

char *ND_SrcFileNames

Defines the list of files. Enter full paths to the files separated by a semicolon.

char *ND_Filename

File name of the source ND2 image.

int *ND_Groups

Field of integers where each document has one field item (one integer). Documents having different dimensions can be grouped based on the coincident dimensions.

int ND_MergeFlags

Additional merging options.

2	Stretch - all images are stretched to the same size
8	Verbose - message is shown if the merge cannot be completed
16	Outerloop - this parameter value equals the dialog option Merge Documents into an Outer Loop

ND_MoveExperimentBackward

Description 

0 ND_MoveExperimentBackward(
   int  LoopIndex
);

This function displays the previous frame of the selected dimension of the current ND2 document. Use “-1” to select the dimension which has been moved as last.

Parameters

int LoopIndex

Index number of the loop (dimension).

-1	The most recently modified loop.
0	Time loop
1	Multipoint loop
2	Z Stack loop

Return Values

0

When performed successfully.

Value < 0

Procedure failed. E.g. when the current frame was the first in the dimension so it could not be moved backwards.

ND_MoveExperimentForward

Description 

0 ND_MoveExperimentForward(
   int  LoopIndex
);

This function displays the next frame of the selected dimension of the current ND2 document. Use “-1” to select the dimension which has been moved as last.

Parameters

int LoopIndex

Index number of the loop (dimension).

-1	The most recently modified loop.
0	Time loop
1	Multipoint loop
2	Z Stack loop

Return Values

0

When performed successfully.

Value < 0

Procedure failed. E.g. when the current frame was the last in the dimension so it could not be moved forwards.

ND_MoveInExperiment

Description 

0 ND_MoveInExperiment(
   int  ND_ExperimentType,
   int  ND_ExperimentPos,
   int  ND_PosAbsolute,
   int  ND_ExperimentByType
);

This function changes the currently displayed frame of the opened nd file.

Parameters

int ND_ExperimentType

Type of the experiment loop or its position (depends on the ND_ExperimentByType parameter). If the ND_ExperimentByType is set to 1, the values from the table below will be used. If it is 0, just define the placing of the dimension within the whole experiment.

1	Time loop - us this value if the experiment contains just one time phase. Otherwise it returns 0.
2	XY Multipoint loop
4	Z Stack loop
6	Lambda (multichannel) loop
8	NE Time loop (NE = Non-Equidistant) - use this value if the experiment consists of more than one time phase.

int ND_ExperimentPos

The position of the frame.

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_ExperimentByType

0	The dimension type is determined by the actual order of dimensions of the current nd file.
1	The dimension type is determined by the table values above (ND_ExperimentType)

Return Values

0

When performed successfully.

Value < 0

Procedure failed. E.g. when the current frame was the last/first in the dimension so it could not be moved.

ND_MoveInExperimentSeq

Description 

 ND_MoveInExperimentSeq(
   int  ND_ExperimentPos
);

This function displays a frame of the current ND document. The frame is specified by its absolute position (the frames are ordered as they were captured).

Parameters

int ND_ExperimentPos

The position of the frame.

ND_MoveRangeBackward

Description 

int ND_MoveRangeBackward(
   int  LoopIndex
);

This function moves left a range of selected frames on the ND Navigation bar of the current ND Document.

Parameters

int LoopIndex

Index number of the loop (dimension).

-1	The most recently modified loop.
0	Time loop
1	Multipoint loop
2	Z Stack loop

Return Values

int

Return value indicates, if it was possible to move the selection.

0	Selection was not moved
1	Selection was moved

See Also 
ND_MoveRangeForward

ND_MoveRangeForward

Description 

int ND_MoveRangeForward(
   int  LoopIndex
);

This function moves right a range of selected frames on the ND Navigation bar of the current ND Document.

Parameters

int LoopIndex

Index number of the loop (dimension).

-1	The most recently modified loop.
0	Time loop
1	Multipoint loop
2	Z Stack loop

Return Values

int

Return value indicates, if it was possible to move the selection.

0	Selection was not moved
1	Selection was moved

See Also 
ND_MoveRangeBackward

ND_MoveToNextEvent

Description 

 ND_MoveToNextEvent();

Important frames in an ND experiment can be marked by events. This function displays the frame marked with the closest onward event.

ND_MoveToPreviousEvent

Description 

 ND_MoveToPreviousEvent();

Important frames in an ND experiment can be marked by events. This function displays the frame marked with the closest backward event.

ND_PauseExperiment

Description 

 ND_PauseExperiment();

This function pauses ND experiment. Run the ND_ResumeExperiment function to continue with the experiment.

ND_RecordedDataDefault

Description 

 ND_RecordedDataDefault(
   int  ND_RecordedDataDefault
);

The function selects what hardware data to record during ND experiment acquisition.

Parameters

int ND_RecordedDataDefault

Hardware data to record.

0	No data will be recorded.
1	All available data will be recorded.

ND_RedefineAbsZ

Description 

 ND_RedefineAbsZ();

This function sets a new Z drive position to the current XY position during a Time+XY experiment. The Z drive will move to the redefined Z position during the next time phase.

Note

If the ND_RedefineAbsZAfterPFS is turned ON, this function is called after the autofocus or the PFS system detected a shift of the specimen compared to the previous time loop. This ensures that the specimen will not get out of the PFS/autofocus range during long-lasting experiments.

See Also 
ND_RedefineAbsZAfterPFS

ND_RemoveEvent

Description 

 ND_RemoveEvent(
   int  EventID
);

This function deletes an event from the ND Navigation bar of the current document.

Parameters

int EventID

Event ID is the returned value from the function ND_InsertEvent.

ND_RemoveExperiment

Description 

 ND_RemoveExperiment(
   char *ND_ExperimentName
);

This function removes a saved experiment from registry.

Parameters

char *ND_ExperimentName

The name of the experiment to be saved/loaded/removed.

ND_RemoveRecordingData

Description 

 ND_RemoveRecordingData(
   char *RecordID
);

This function removes selected Recorded data.

Parameters

char *RecordID

Each Recorded data record is represented by a string identifier.

X	X coordinate of the current frame
Y	Y coordinate of the current frame
Z	Z coordinate of the current frame
Z1	Z coordinate of the first Z device in case of multiple Z devices
Z2	Z coordinate of the second Z device in case of multiple Z devices
HEATSTAGE_T	Temperature of a heatstage
ADC_VOLTAGE_n	Voltage of a device number n

ND_ResumeExperiment

Description 

 ND_ResumeExperiment();

This function resumes paused ND experiment.

ND_ReuseExperiment

This function runs the Reuse ND Setup command.

Description 

 ND_ReuseExperiment(
   char *Filename
);

Sets the ND setup to match the settings of the specified ND image file. The *.tif and *.nd2 file formats are supported. This function is invoked on context menu in the Auto Capture Folder and Opened Images control windows and also on the Reuse button in the Image Properties dialog box.

Parameters

char *Filename

The path and the name of the file.

See Also 
ImageReuseCameraSettings

ND_ReuseZIntensityCorr

Description 

 ND_ReuseZIntensityCorr(
   char *Filename
);

This function loads intensity correction settings from the specified image to the Z Intensity Correction control panel.

If the parameter is NULL, the function tries to load settings from the current (active) document.

Parameters

char *Filename

The path and the name of the file.

ND_RunExperiment

Description 

 ND_RunExperiment(
   bool  ND_OpenExperiment
);

This function starts the current ND experiment.

Parameters

bool ND_OpenExperiment

0	The resulting file is just saved to disk after the experiment finishes.
1	The resulting file is opened after the experiment finishes.

ND_RunExperimentNoProgressBar

Description 

 ND_RunExperimentNoProgressBar(
   bool  ND_OpenExperiment
);

This function starts the current ND experiment without displaying the ND Experiment Acquisition Status window.

Parameters

bool ND_OpenExperiment

0	The resulting file is just saved to disk after the experiment finishes.
1	The resulting file is opened after the experiment finishes.

ND_RunExperimentWithZIntensityCorrection

Description 

 ND_RunExperimentWithZIntensityCorrection(
   bool  ND_OpenExperiment
);

This function starts the current ND experiment with Z Intensity Correction.

Parameters

bool ND_OpenExperiment

0	The resulting file is just saved to disk after the experiment finishes.
1	The resulting file is opened after the experiment finishes.

ND_RunMultipointSet

Description 

 ND_RunMultipointSet();

This function runs the previously defined multi-point experiment. To define the experiment run the _ND_CreateMultipointSet function.

See Also 
_ND_CreateMultipointSet

ND_RunNDAdvanced

Description 

 ND_RunNDAdvanced();

This function runs advanced ND documents acquisition.

See Also 
_ND_CreateNDAdvanced

ND_SaveExperiment

Description 

 ND_SaveExperiment(
   char *ND_ExperimentName
);

This function saves the current experiment settings to registry under a specified name.

Parameters

char *ND_ExperimentName

The name of the experiment to be saved/loaded/removed.

ND_SetRecordingDataDouble

Description 

 ND_SetRecordingDataDouble(
   char *RecordID,
   int  SeqIndex,
   char *RecordDescription,
   double  RecordDoubleP,
   char *RecordUnit
);

This function sets additional double-precession floating point number Recorded data during ND Acquisition.

Parameters

char *RecordID

Each Recorded data record is represented by a string identifier. If you set values for multiple frames of the same record, you should enter the same identifier on each call.

int SeqIndex

This parameter sets a sequence index of the recorded frame. If the SeqIndex equals -1, index of the currently acquired frame is assigned to this value. Use -2 for a global value.

char *RecordDescription

Short text description of Recorded data should be specified by this parameter. The parameter can be specified only once for each RecordID, next calls with the same RecordID can set this parameter to NULL (0).

double RecordDoubleP

Double value of Recorded data assigned to the acquired frame.

char *RecordUnit

Measuring unit in string form. The parameter can be specified only once for each RecordID, next calls with the same RecordID can set this parameter to NULL (0).

See Also 
ND_SetRecordingDataInt, ND_SetRecordingDataString

ND_SetRecordingDataInt

Description 

 ND_SetRecordingDataInt(
   char *RecordID,
   int  SeqIndex,
   char *RecordDescription,
   int  RecordIntP,
   char *RecordUnit
);

This function sets additional integer number Recorded data during ND Acquisition.

Parameters

char *RecordID

Each Recorded data record is represented by a string identifier. If you set values for multiple frames of the same record, you should enter the same identifier on each call.

int SeqIndex

This parameter sets a sequence index of the recorded frame. If the SeqIndex equals -1, index of the currently acquired frame is assigned to this value. Use -2 for a global value.

char *RecordDescription

Short text description of Recorded data should be specified by this parameter. The parameter can be specified only once for each RecordID, next calls with the same RecordID can set this parameter to NULL (0).

int RecordIntP

Integer value of Recorded data assigned to the acquired frame.

char *RecordUnit

Measuring unit in string form. The parameter can be specified only once for each RecordID, next calls with the same RecordID can set this parameter to NULL (0).

// this macro can be executed during "Execute after capture"
int t, xy, z;
ND_GetCurrentPosIndexes(&t, &xy, &z);
ND_SetRecordingDataInt("MyTime", -1, "Time", t+1, "index");

See Also 
ND_SetRecordingDataDouble, ND_SetRecordingDataString

ND_SetRecordingDataString

Description 

 ND_SetRecordingDataString(
   char *RecordID,
   int  SeqIndex,
   char *RecordDescription,
   char *RecordStringP,
   char *RecordUnit
);

This function sets additional string Recorded data during ND Acquisition.

Parameters

char *RecordID

Each Recorded data record is represented by a string identifier. If you set values for multiple frames of the same record, you should enter the same identifier on each call.

int SeqIndex

This parameter sets a sequence index of the recorded frame. If the SeqIndex equals -1, index of the currently acquired frame is assigned to this value. Use -2 for a global value.

char *RecordDescription

Short text description of Recorded data should be specified by this parameter. The parameter can be specified only once for each RecordID, next calls with the same RecordID can set this parameter to NULL (0).

char *RecordStringP

String value of Recorded data assigned to the acquired frame is returned by this parameter. Minimum length of the string buffer is 256 characters.

char *RecordUnit

Measuring unit in string form. The parameter can be specified only once for each RecordID, next calls with the same RecordID can set this parameter to NULL (0).

See Also 
ND_SetRecordingDataDouble, ND_SetRecordingDataInt

ND_SetSelectionMode

Description 

 ND_SetSelectionMode(
   int  SelectionMode
);

This function allows you to change a selection mode of the ND Navigation control of the current image.

Parameters

int SelectionMode

Frame selection.

0	No selection
1	Select frames individually in all loops
2	Select frames in time loop according to defined user events

ND_SetSelectionRange

Description 

 ND_SetSelectionRange(
   int  LoopIndex,
   int  RangeFrom,
   int  RangeTo,
   int  RangeSelect
);

This function enables you to specify selection of frames of the current ND image. Other frames than range specified by parameters will not be affected (selected/de-selected).

Parameters

int LoopIndex

Index number of the loop (dimension).

-1	The most recently modified loop.
0	Time loop
1	Multipoint loop
2	Z Stack loop

int RangeFrom

Index of the first frame to be (de)selected.

int RangeTo

Index of the last frame to be (de)selected

int RangeSelect

Operation to be performed on the specified range.

0	Deselect
1	Select

ND_SplitMultipoints

Interactive command to this function: File > Import/Export > Split Multipoints

Description 

 ND_SplitMultipoints(
   char *Filename,
   char *Dest_Directory,
   char *Prefix,
   int  ND_UseTIFF
);

This function performs splitting of an ND Image with the multi-point dimension into several ND Images. Each resulting ND Image represents one point in the multi-point loop.

If the Filename parameter is NULL the function will be applied to the active image.

Parameters

char *Filename

File name of the source ND2 image.

char *Dest_Directory

This parameter describes path to the resulting files (destination directory).

char *Prefix

Text to be used as prefix.

int ND_UseTIFF

Set whether to save the split images to ND2 or TIFF format

0	Save the split images as ND2
1	Save the images as TIFF

Note

Resulting images will be stored into the Dest_Directory directory. Filenames of these images will have the following format : Prefix(index in multipoint loop).nd2.

OpenStackedTiff

Description 

 OpenStackedTiff(
   char *Image,
   int  LoopType,
   double  LoopParam,
   int  SaveModified
);

This function can open a stacked tiff file and convert it to the ND2 format.

Parameters

char *Image

Complete path to the image.

int LoopType

The type of ND document to be created.

1	Time
2	XY multipoint
4	Z-Series

double LoopParam

Step between the frames. Units depend on the previous parameter: Time [ms], Z-step[microns]. The parameter is irrelevant for the XY multipoint type of document.

int SaveModified

Specifies whether to save an opened document when it has been modified.

0, QUERYSAVE_ASK	Asks whether to save changes or not. Ask before overwriting.
1, QUERYSAVE_YES	Changes are saved automatically. Overwrite existing file.
2, QUERYSAVE_NO	Changes are not saved. Always discard the image. Do not save (handled in macro).
SAVE_DIFFDIR	Save into different folder.
QUERYSAVE_CANCEL	Cancels the operation.

Note

If number of opened images exceeds the number, defined in the General Options dialog box, firstly opened images will be closed. If the images have been changed and not saved, the SaveModified parameter allows to save them.

_ExportImagesToTIFF

This function runs the File > Save/Export to TIFF Files command.

Description 

 _ExportImagesToTIFF();

This function opens the Export Images to TIFF dialog window.

See Also 
ExportImagesToTIFF

_ND_BatchExport

This function runs the File > Import/Export > Export Multiple ND Files command.

Description 

 _ND_BatchExport();

This function opens the Export Multiple ND Files window.

_ND_BioStationNex_Import

This function runs the File > Import/Export > Create ND File from BioStation NEX command.

Description 

 _ND_BioStationNex_Import();

This function opens the Import Biostation NEX File dialog window.

See Also

• ND_BioStationNex_Import

_ND_Convert

This function runs the File > Import/Export > Create ND File from File Sequence command.

Description 

 _ND_Convert();

This function displays the Convert To ND dialog window.

_ND_CreateExperiment

This function runs the Applications > 6D > Define/Run ND Acquisition command.

Description 

 _ND_CreateExperiment();

This function displays the Multidimensional Acquisition dialog window.

_ND_CreateJsonSequence

This function runs the File > Import/Export > Create JSON File Sequence Description command.

Description 

 _ND_CreateJsonSequence();

Opens the Create JSON File Sequence Description dialog widow.

_ND_CreateMultipointSet

This function runs the Applications > 6D > Define/Run ND Multipoint Set Acquisition command.

Description 

 _ND_CreateMultipointSet();

This function displays the ND Multipoint Set Acquisition window.

_ND_CreateNDAdvanced

Description 

 _ND_CreateNDAdvanced();

This function opens the ND Advanced Acquisition dialog window which sets advanced ND document acquisitions.

_ND_Crop

This function runs the File > Import/Export > Crop ND Document command.

Description 

 _ND_Crop();

This function displays the Multidimensional Crop dialog window.

_ND_Dicom_Import

This function runs the File > Import/Export > Create ND File from DICOM command.

Description 

 _ND_Dicom_Import();

This function opens the DICOM Import window which creates a DICOM file from an ND document.

_ND_ExchangeDimensions

This function runs the Image > ND Processing > Exchange Dimensions command.

Description 

 _ND_ExchangeDimensions();

Opens the Exchange Dimensions dialog window which is used to transform an existing dimension into a different one. You can for example create a timelapse image sequence from a Z-Stack.

_ND_Export

This function runs the File > Import/Export > Export ND Document command.

Description 

 _ND_Export();

This function displays the ND Export dialog window.

_ND_ExportToTIFF

This function runs the File > Import/Export > ND Export to TIFF command.

Description 

 _ND_ExportToTIFF();

This function opens a dialog for exporting the current ND file to TIFF file(s).

_ND_SplitMultipoints

This function runs the File > Import/Export > Split Multipoints command.

Description 

 _ND_SplitMultipoints();

This function displays the dialog window for ND multipoints splitting. This dialog will appear only if multipoint dimension is present in the current ND document. Then you can specify destination directory and prefix for output files.

_OpenSequence

Description 

 _OpenSequence(
   char *Image,
   int  SeqFilename,
   int  SeqFilenameMaxLen,
   int *SeqSize,
   int *SeqType,
   int  SaveModified
);

This function displays a dialog box for opening file sequences. The same dialog box opens when you are trying to open a file (File > Open) that is a part of an image sequence.

The SaveModified parameter is for internal use only and must be set to 0.

Parameters

char *Image

Complete path to the image.

int SeqFilename

For internal use only. Must be 0

int SeqFilenameMaxLen

For internal use only. Must be 0

int *SeqSize

For internal use only. Must be NULL (0)

int *SeqType

For internal use only. Must be NULL (0)

int SaveModified

Specifies whether to save an opened document when it has been modified.

0, QUERYSAVE_ASK	Asks whether to save changes or not. Ask before overwriting.
1, QUERYSAVE_YES	Changes are saved automatically. Overwrite existing file.
2, QUERYSAVE_NO	Changes are not saved. Always discard the image. Do not save (handled in macro).
SAVE_DIFFDIR	Save into different folder.
QUERYSAVE_CANCEL	Cancels the operation.

Note

If number of opened images exceeds the number, defined in the General Options dialog box, firstly opened images will be closed.