_NDInformationProperties, AddNDInformation, RemoveNDInformation, ShowNDInformation, ToggleNDInformation

AddNDInformation

Description 

 AddNDInformation(
   char *NDInformationType
);

This function adds an ND information object to the current ND image. User can specify which information will be displayed.

Parameters

char *NDInformationType

This parameter specifies what ND information will be displayed. The information always relates to current frame. If the selected information is not available within the ND or LIVE image, it will not be displayed.

IMAGEINFO_TIME	Acquisition Time
IMAGEINFO_LIVETIME	Time from the start of live image (LIVE)
IMAGEINFO_X	X coordinate
IMAGEINFO_Y	Y coordinate
IMAGEINFO_Z	Z coordinate
X	Current X coordinate (ND/LIVE)
Y	Current Y coordinate (ND/LIVE)
Z	Current position of the Z drive (ND/LIVE)
Z1	Current position of a primary Z drive (ND/LIVE)
Z2	Current position of a secondary Z drive (ND/LIVE)
PFS_OFFSET	PFS offset value
PFS_STATUS	PFS status
... and other	See below

Note

Other information can be displayed depending on what peripheral devices are connected. To see all info available for display, right-click the image and select [Show ND Information], right-click on the ND information area and select [ND Info Properties]. A window appears where all available items are listed. If added to the top field, the name of the info and the NDInformationType parameter are displayed in the following form, for example: Live Time: <link:NDInfo IMAGEINFO_LIVETIME>. Use the "IMAGEINFO_LIVETIME" as the parameter of this function to display Live Time: AddNDInformation("IMAGEINFO_LIVETIME");

See Also 
ND_SetRecordingDataDouble, ND_SetRecordingDataInt, ND_SetRecordingDataString

RemoveNDInformation

Description 

 RemoveNDInformation(
   int  NDInformationID
);

Removes ND information.

Parameters

int NDInformationID

Object identification

ShowNDInformation

This function runs the Show ND Information command.

Description 

 ShowNDInformation(
   int  ShowNDInformation
);

This function displays available ND information (information about current frame of an ND2 document or live image).

Parameters

int ShowNDInformation

ND information visibility

0	hidden
1	displayed

ToggleNDInformation

Description 

 ToggleNDInformation();

This function displays/hides available ND information (information about current frame of an ND2 document or live image).

_NDInformationProperties

Description 

 _NDInformationProperties(
   int  NDInformationID
);

This function shows the properties for one vector object with ND information. It is for internal use only, you should not call it directly.

Parameters

int NDInformationID

Object identification