MultiExcitationEnable Description
MultiExcitationEnable(
int MultiExcitation_Enable
);
This function turns multi excitation ON/OFF.
Parameters
int MultiExcitation_Enable
0 | Turn Multiexcitation OFF. |
1 | Turn Multiexcitation ON. |
MultiExcitationEnabled Description
MultiExcitationEnabled();
This function returns TRUE or FALSE depending on if the multiexcitation is ON/OFF.
MultiExcitationSequenceSet Description
int MultiExcitationSequenceSet(
int *MultiExcitation_Active
,
int MultiExcitation_Count
);
This function defines the sequence of filter positions to be used by wavelength switcher device (e.g.DG4).
Parameters
int *MultiExcitation_Active
Multiexcitation filter sequence. Filter positions are zero-based. For example, if user specifies the sequence '0, 2' (array of length 2) then the result will be the two component image where the first component is acquired with the filter on the 1st position and the second component with the filter on the 3rd position.
int MultiExcitation_Count
Specifies the multiexcitation sequence length (and the size of the MultiExcitation_Active input array).
See Also
_MultiExcitationSequenceDefine, MultiExcitationEnable, MultiExcitationEnabled, MultiExcitationSwitch
MultiExcitationSwitch Description
MultiExcitationSwitch();
This function toggles the multi excitation status. When OFF, it turns it ON and vice versa.
TrigAcq_AddChannel Description
TrigAcq_AddChannel(
char *ChannelName
,
int eDeviceType
,
char *DeviceName
,
int LaserLine
,
double Power
,
double Exposure
,
double FocusOffset
,
int ImagingChannel
);
Appends a channel to the Triggered Acquisition window.
Parameters
char *ChannelName
Pointer to buffer that is filled with the name of the channel.
int eDeviceType
Logical device type.
0 | Multilaser |
1 | Analog Output |
2 | Calibrated Analog Output |
3 | TTL Output |
4 | Shutter |
5 | Switcher |
6 | Filter Wheel |
char *DeviceName
Name of the logical device.
int LaserLine
Index number of the laser line.
double Power
Laser power [%].
double Exposure
Exposure time in [ms]
double FocusOffset
Z-offset compensation in micrometers.
int ImagingChannel
Is the channel an “imaging” channel? “Channel” in triggered acquisition is called “imaging” if an image is acquired during its exposure time. So called “non-imaging” channels are used typically for excitation - no image is acquired during its exposure time.
TrigAcq_AddLine Description
TrigAcq_AddLine(
int LaserLine
);
Appends the specified line to the list of laser lines within the Triggered Acquisition control panel.
Parameters
int LaserLine
Index number of the laser line.
See Also
TrigAcq_AddLineEx
TrigAcq_AddLineEx Description
TrigAcq_AddLineEx(
int Channel
,
int eDeviceType
,
char *DeviceName
,
int LaserLine
,
double Power
);
This function adds a laser line to the specified channel in the Triggered Acquisition control panel.
Parameters
int Channel
Index number of the channel.
int eDeviceType
Logical device type.
0 | Multilaser |
1 | Analog Output |
2 | Calibrated Analog Output |
3 | TTL Output |
4 | Shutter |
5 | Switcher |
6 | Filter Wheel |
char *DeviceName
Name of the logical device.
int LaserLine
Index number of the laser line.
double Power
Laser power [%].
See Also
TrigAcq_AddLine
TrigAcq_DeleteAllItems Description
TrigAcq_DeleteAllItems();
This function removes all channels from the Triggered Acquisition.
See Also
TrigAcq_AddLine, TrigAcq_AddLineEx
TrigAcq_DeleteChannel Description
TrigAcq_DeleteChannel(
int Channel
);
Deletes a channel from the Triggered Acquisition control panel.
Parameters
int Channel
Index number of the channel.
TrigAcq_DeleteLine Description
TrigAcq_DeleteLine(
int Channel
,
int Line
);
Deletes the specified laser line from the specified channel within the Triggered Acquisition window.
Parameters
int Channel
Index number of the channel.
int Line
Index number of the line.
TrigAcq_GetChannel Description
TrigAcq_GetChannel(
int Channel
,
char *ChannelName
,
int BufferSize
,
double *pExposure
,
double *pFocusOffset
,
int *pImagingChannel
);
Retrieves specification of the selected Triggered Acquisition channel.
Parameters
int Channel
Index number of the channel.
char *ChannelName
Pointer to buffer that is filled with the name of the channel.
int BufferSize
Size of the memory allocated for the previous parameter (number of characters).
double *pExposure
Exposure time in milliseconds.
double *pFocusOffset
Focus offset value in micrometers.
int *pImagingChannel
0 | Non-imaging channel (no image frame is acquired). |
1 | Imaging channel (image frame is received). |
TrigAcq_GetLine Description
TrigAcq_GetLine(
int Channel
,
int Line
,
int *peDeviceType
,
char *DeviceName
,
int BufferSize
,
int *pLaserLine
,
double *pPower
);
Retrieves specification of the specified Triggered Acquisition line.
Parameters
int Channel
Index number of the channel.
int Line
Index number of the line.
int *peDeviceType
Logical device type.
0 | Multilaser |
1 | Analog Output |
2 | Calibrated Analog Output |
3 | TTL Output |
4 | Shutter |
5 | Switcher |
6 | Filter Wheel |
char *DeviceName
Name of the logical device.
int BufferSize
Size of the memory allocated for the previous parameter (number of characters).
int *pLaserLine
Index number of the laser line used.
double *pPower
Laser Power in %.
TrigAcq_GetParameters Description
TrigAcq_GetParameters(
int *piUseFocusOffset
,
int *piUseMoreLines
,
int *piUseDontSyncPower
,
int *piUseNonImaging
,
int *piUseChannelSeries
,
int *piUseDifferentExposures
);
Returns settings of the Triggered Acquisition control window.
Parameters
int *piUseFocusOffset
If a piezo Z is available, this option adds a column to the channels setup.
0 | Do not add column |
1 | Add column |
int *piUseMoreLines
Enables the user to add more lines (lasers/output signals) to a single channel.
0 | Do not add more lines |
1 | Add more lines |
int *piUseDontSyncPower
Do you want to change the setting in all channels?
0 | Do not change the setting in all channels |
1 | Change the setting in all channels |
int *piUseNonImaging
Do you want to start triggering signal from other action?
int *piUseChannelSeries
The first excitation channel is used with the first camera channel, the second with the second etc.
int *piUseDifferentExposures
This option turns on/off the possibility to select different exposures for each channel.
0 | Turn exposures off |
1 | Turn exposures on |
TrigAcq_GetUsedCustomDevices Description
TrigAcq_GetUsedCustomDevices(
int eDeviceType
,
char *DeviceName
,
int *pUse
);
Returns whether the specified custom device is allowed within the Triggered Acquisition Advanced Settings... window.
Parameters
int eDeviceType
Logical device type.
0 | Multilaser |
1 | Analog Output |
2 | Calibrated Analog Output |
3 | TTL Output |
4 | Shutter |
5 | Switcher |
6 | Filter Wheel |
char *DeviceName
Name of the logical device.
int *pUse
0 | The device is disabled. |
1 | The device is enabled. |
TrigAcq_ModifyChannel Description
TrigAcq_ModifyChannel(
int Channel
,
char *ChannelName
,
double Exposure
,
double FocusOffset
,
int ImagingChannel
);
Modifies the specified channel settings.
Parameters
int Channel
Index number of the channel.
char *ChannelName
Pointer to buffer that is filled with the name of the channel.
double Exposure
Exposure time in [ms]
double FocusOffset
Z-offset compensation in micrometers.
int ImagingChannel
Is the channel an “imaging” channel? “Channel” in triggered acquisition is called “imaging” if an image is acquired during its exposure time. So called “non-imaging” channels are used typically for excitation - no image is acquired during its exposure time.
TrigAcq_ModifyLine Description
TrigAcq_ModifyLine(
int Channel
,
int Line
,
int eDeviceType
,
char *DeviceName
,
int LaserLine
,
double Power
);
Modifies the specified laser line settings.
Parameters
int Channel
Index number of the channel.
int Line
Index number of the line.
int eDeviceType
Logical device type.
0 | Multilaser |
1 | Analog Output |
2 | Calibrated Analog Output |
3 | TTL Output |
4 | Shutter |
5 | Switcher |
6 | Filter Wheel |
char *DeviceName
Name of the logical device.
int LaserLine
Index number of the laser line.
double Power
Laser power [%].
TrigAcq_SelectDevice Description
TrigAcq_SelectDevice(
char *MultiLaserName
);
This function defines which Multi-laser device is used for Triggered Acquisition.
Parameters
char *MultiLaserName
Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
See Also
TrigAcq_SelectDeviceEx
TrigAcq_SelectDeviceEx Description
TrigAcq_SelectDeviceEx(
char *MultiLaserName
,
char *MultiLaserName2
);
This function defines which combination of Multi-laser devices is used for Triggered Acquisition.
Parameters
char *MultiLaserName
Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
char *MultiLaserName2
Name of the Multilaser device.
See Also
TrigAcq_SelectDevice
TrigAcq_SetParameters Description
TrigAcq_SetParameters(
int UseFocusOffset
,
int UseMoreLines
,
int UseDontSyncPower
,
int UseNonImaging
,
int UseChannelSeries
,
int UseDifferentExposures
);
Adjusts advanced settings for the Triggered Acquisition control panel.
Parameters
int UseFocusOffset
If enabled in the Advanced Settings... window, it specifies the Z-offset for each channel.
0 | Do not specify Z-Offset for each channel |
1 | Specify Z-Offset for each channel |
int UseMoreLines
0 | Do not use more lines |
1 | Enable one channel to contain two or more lines |
int UseDontSyncPower
0 | One line uses always the same power. |
1 | Allow the same line to use different power value when it is used twice (e.g. in different channels). |
int UseNonImaging
0 | Only Imaging channels can be used. |
1 | Allow non-imaging channels. |
int UseChannelSeries
Enable channel series for dual-camera/dual-view setups.
int UseDifferentExposures
0 | Exposure time is synchronized between laser lines. |
1 | Allow different exposure time for each laser line. |
TrigAcq_UseCustomDevices Description
TrigAcq_UseCustomDevices(
int eDeviceType
,
char *DeviceName
,
int Use
);
This function selects your custom devices.
Parameters
int eDeviceType
Logical device type.
0 | Multilaser |
1 | Analog Output |
2 | Calibrated Analog Output |
3 | TTL Output |
4 | Shutter |
5 | Switcher |
6 | Filter Wheel |
char *DeviceName
Name of the logical device.
int Use
This function turns the selected device ON/OFF.
0 | device is turned OFF |
1 | device is turned ON |
_MultiExcitationSequenceDefine Description
_MultiExcitationSequenceDefine();
This function displays the Sequence Settings dialog window. The window selects filters that will be used by DG4 filter changer to create a multichannel image.
_TriggeredAcquisition This function runs the Acquire > Triggered Acquisition command.
Description
_TriggeredAcquisition();
This function displays the Triggered Acquisition control window.