CameraCmd_AutoExposure Description
CameraCmd_AutoExposure();
This function adjusts grabber gain value and camera exposure time to get optimal exposure of the image.
Note
This function is called e.g. by pressing the Auto Exposure button in the Input Setup dialog box.
See Also
CameraCmd_AutoWhite
CameraCmd_AutoWhite Description
CameraCmd_AutoWhite();
The CameraCmd_AutoWhite function balances and adjusts red, green and blue components to get the white color. The function changes grabber color gains.
Note
This function is called e.g. by pressing the AWB or Auto White button in the camera settings dialog box.
See Also
CameraCmd_AutoExposure
CameraCmd_AverageReset Description
CameraCmd_AverageReset();
If the camera averaging is set to infinite, this function resets the averaging and begins a new frame.
See Also
CameraSet_Average
CameraCmd_OnePushWB Description
CameraCmd_OnePushWB();
Activates white balance on the live image from color cameras.
CameraCmd_SetDefaults Description
CameraCmd_SetDefaults();
Sets all camera settings into default.
CameraCmd_TurnFanOff Description
CameraCmd_TurnFanOff();
Turns the fan of an Andor camera off.
CameraCmd_TurnFanOn Description
CameraCmd_TurnFanOn();
Turns the fan of an Andor camera on.
CameraGet_Average Description
CameraGet_Average(
int CameraPropMode,
int *CameraPropLpIntParam
);
Gets the current camera averaging value. This function corresponds to the main application toolbar button.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
int *CameraPropLpIntParam Is filled with the result on the function return.
See Also
CameraSet_Average, CameraGet_AverageToQuality, CameraSet_AverageToQuality, CameraGet_Integrate, CameraSet_Integrate, CameraGet_IntegrateToQualityCH, CameraSet_IntegrateToQualityCH, CameraGet_Rotate, CameraSet_Rotate
CameraGet_AverageCH Description
CameraGet_AverageCH(
int CameraPropMode,
char *CameraPropStrParam
);
This function retrieves the set camera averaging parameter.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
char *CameraPropStrParam Pointer to the camera property value being set / retrieved.
CameraGet_AverageToQuality Description
CameraGet_AverageToQuality(
int CameraPropMode,
double *CameraLpDblParam
);
Gets the current camera averaging quality value. The quality value is defined as average difference per pixel per component scaled in Decibels. Averaging is performed until the specified quality is reached.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
double *CameraLpDblParam Is filled with the result on the function return.
CameraGet_AverageToQualityCH Description
CameraGet_AverageToQualityCH(
int CameraPropMode,
char *CameraPropStrParam
);
This function retrieves the set averaging parameter (signal to noise ratio).
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
char *CameraPropStrParam Pointer to the camera property value being set / retrieved.
CameraGet_Exposure Description
CameraGet_Exposure(
int CameraPropMode,
double CameraPropDblParam
);
This function retrieves a camera exposure time of a specified property mode.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
double CameraPropDblParam Time in milliseconds.
CameraGet_FileName Description
CameraGet_FileName(
int CameraPropMode,
char *CameraPropStrParam
);
This function retrieves the name of the used simulator.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
char *CameraPropStrParam Pointer to the camera property value being set / retrieved.
CameraGet_FlexibleHeight Description
CameraGet_FlexibleHeight(
int CameraPropMode,
int *CameraPropLpIntParam
);
Retrieves the flexible height.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
int *CameraPropLpIntParam Is filled with the result on the function return.
CameraGet_FrameDuration Description
CameraGet_FrameDuration(
int CameraPropMode,
char *CameraPropStrParam
);
This function returns the frame duration.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
char *CameraPropStrParam Pointer to the camera property value being set / retrieved.
CameraGet_HWTrgInEnabled Description
CameraGet_HWTrgInEnabled(
int CameraPropMode,
int *CameraPropLpIntParam
);
Returns whether the receiving of hardware triggers is enabled.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
int *CameraPropLpIntParam Is filled with the result on the function return.
CameraGet_HWTrgOutEnabled Description
CameraGet_HWTrgOutEnabled(
int CameraPropMode,
int *CameraPropLpIntParam
);
Returns whether the sending of hardware triggers is enabled.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
int *CameraPropLpIntParam Is filled with the result on the function return.
CameraGet_Integrate Description
CameraGet_Integrate(
int CameraPropMode,
int *CameraPropLpIntParam
);
Gets the current camera integrating value. This function corresponds to the main application toolbar button.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
int *CameraPropLpIntParam Is filled with the result on the function return.
CameraGet_IntegrateCH Description
CameraGet_IntegrateCH(
int CameraPropMode,
char *CameraPropStrParam
);
Returns the set camera integrating parameter.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
char *CameraPropStrParam Pointer to the camera property value being set / retrieved.
CameraGet_IntegrateToQualityCH Description
CameraGet_IntegrateToQualityCH(
int CameraPropMode,
char *CameraPropStrParam
);
This function retrieves the set integrating parameter (signal to noise ratio).
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
char *CameraPropStrParam Pointer to the camera property value being set / retrieved.
CameraGet_Negate Description
CameraGet_Negate(
int CameraPropMode,
int *CameraPropLpIntParam
);
Returns the information whether the output negation is enabled.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
int *CameraPropLpIntParam Is filled with the result on the function return.
CameraGet_Rotate Description
CameraGet_Rotate(
int CameraPropMode,
double *CameraPropLpDblParam
);
Gets the current camera rotation angle. The camera rotation can be managed also in the camera selection dialog.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
double *CameraPropLpDblParam Is filled with the result on the function return.
CameraGet_StimulationTime Description
CameraGet_StimulationTime(
int CameraPropMode,
double *CameraPropLpDblParam
);
This function retrieves a stimulation time of a specified property mode.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
double *CameraPropLpDblParam Is filled with the result on the function return.
CameraGet_ToRGB Description
CameraGet_ToRGB(
int CameraPropMode,
int *CameraPropIntParam
);
This function returns the status of conversion of the camera image to RGB.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
int *CameraPropIntParam Is filled with the result on the function return.
CameraGet_UseDriverMetadata Description
CameraGet_UseDriverMetadata(
int CameraPropMode,
int *CameraPropLpIntParam
);
This function retrieves the camera driver metadata use.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
int *CameraPropLpIntParam Is filled with the result on the function return.
CameraSet_Average This function runs the Acquire > Average > Average (N) command.
Description
CameraSet_Average(
int CameraPropMode,
int CameraPropIntParam
);
Sets the averaging parameter of the acquisition. The averaging will be applied during every acquisition (live, capture, ND acquisition, RAM capturing etc.). The “rolling” concept is used only during live - if the input frame sequence is A, B, C, D then the first output frame is averaged from A and B, the second from B and C, etc.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
int CameraPropIntParam Sets the number of frames used for the processing.
-1 | Infinite (cumulative) processing from the first frame until stopped. |
1 | No processing. |
2, ... | the resulting frame is averaged from 2 source frames, etc. |
See Also
CameraSet_Integrate, CameraCmd_AverageReset
CameraSet_AverageCH Description
CameraSet_AverageCH(
int CameraPropMode,
char *CameraPropStrParam
);
This function sets the camera averaging.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
char *CameraPropStrParam Pointer to the camera property value being set / retrieved.
CameraSet_AverageToQuality This function runs the Acquire > Average > Average to Quality command.
Description
CameraSet_AverageToQuality(
int CameraPropMode,
double CameraDblParam
);
Sets the current camera averaging quality value. The quality value is defined as an average difference per pixel per component scaled in Decibels. Averaging is performed until the specified quality is reached.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
double CameraDblParam Requested averaging quality.
CameraSet_AverageToQualityCH Description
CameraSet_AverageToQualityCH(
int CameraPropMode,
char *CameraPropStrParam
);
This function sets the averaging parameter using the signal to noise ratio. When the systems reaches the ratio, the averaging procedure quits.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
char *CameraPropStrParam Pointer to the camera property value being set / retrieved.
CameraSet_Exposure Description
CameraSet_Exposure(
int CameraPropMode,
int CameraPropLpIntParam
);
This function sets the camera exposure time of the specified property mode.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
int CameraPropLpIntParam The exposure time in milliseconds.
CameraSet_FileName Description
CameraSet_FileName(
int CameraPropMode,
char *CameraPropStrParam
);
Sets the simulator.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
char *CameraPropStrParam Pointer to the camera property value being set / retrieved.
CameraSet_FlexibleHeight Description
CameraSet_FlexibleHeight(
int CameraPropMode,
int CameraPropIntParam
);
Sets the flexible height
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
int CameraPropIntParam Flexible height
CameraSet_FlipH Description
CameraSet_FlipH(
int CameraPropMode,
int CameraPropIntParam
);
Flips the camera image along the horizontal axis.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
CameraSet_FlipV Description
CameraSet_FlipV(
int CameraPropMode,
int CameraPropIntParam
);
Flips the camera image along the vertical axis.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
CameraSet_FrameDuration Description
CameraSet_FrameDuration(
int CameraPropMode,
char *CameraPropStrParam
);
This function sets the frame duration.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
char *CameraPropStrParam Pointer to the camera property value being set / retrieved.
CameraSet_HWTrgInEnabled Description
CameraSet_HWTrgInEnabled(
int CameraPropMode,
int CameraPropIntParam
);
On a camera simulator, this function sets support of trigger in.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
CameraSet_HWTrgOutEnabled Description
CameraSet_HWTrgOutEnabled(
int CameraPropMode,
int CameraPropIntParam
);
On a camera simulator, this function sets support of trigger out.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
CameraSet_Integrate This function runs the Acquire > Integrate > Integrate (N) command.
Description
CameraSet_Integrate(
int CameraPropMode,
int CameraPropIntParam
);
Sets the processing parameter for frame integration.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
int CameraPropIntParam Sets the number of frames used for the processing.
-1 | Infinite (cumulative) processing from the first frame until stopped. |
1 | No processing. |
2, ... | the resulting frame is averaged from 2 source frames, etc. |
CameraSet_IntegrateCH Description
CameraSet_IntegrateCH(
int CameraPropMode,
char *CameraPropStrParam
);
This function sets the camera integrating parameter.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
char *CameraPropStrParam Pointer to the camera property value being set / retrieved.
CameraSet_IntegrateToQualityCH Description
CameraSet_IntegrateToQualityCH(
int CameraPropMode,
char *CameraPropStrParam
);
This function sets the integrating parameter using the signal to noise ratio. When the systems reaches the ratio, the integrating procedure quits.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
char *CameraPropStrParam Pointer to the camera property value being set / retrieved.
CameraSet_Negate Description
CameraSet_Negate(
int CameraPropMode,
int CameraPropIntParam
);
Inverts intensities of the camera image.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
CameraSet_Rotate Description
CameraSet_Rotate(
int CameraPropMode,
double CameraPropDblParam
);
Sets the current camera rotation angle. The rotation can also be managed in the camera selection dialog.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
double CameraPropDblParam The angle in degrees.
CameraSet_StimulationTime Description
CameraSet_StimulationTime(
int CameraPropMode,
double CameraPropDblParam
);
This function sets a stimulation time of a specified property mode.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
double CameraPropDblParam Time in milliseconds.
CameraSet_ToRGB Description
CameraSet_ToRGB(
int CameraPropMode,
int CameraPropIntParam
);
This function converts any camera image to an RGB image.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.
CameraSet_UseDriverMetadata Description
CameraSet_UseDriverMetadata(
int CameraPropMode,
int CameraPropIntParam
);
This function sets the camera driver metadata use.
Parameters
int CameraPropMode The camera mode.
1 | Live - Fast |
2 | Quality - Capture |
Note
This parameter is used only with functions where its usage makes sense. Otherwise it is ignored.