Camera - Other

_CameraSetAverageToQuality, _InputCameraEx, _InputDriver, _InputHWUnit, _InputHWUnitAndCamera, _InputHWUnitAndCamera2, _InputSetup, _ManualIntegration, Camera_AngleGet, Camera_AverageGet, Camera_AverageSet, Camera_ExposureGet, Camera_ExposureSet, Camera_GainBGet, Camera_GainBSet, Camera_GainRGet, Camera_GainRSet, Camera_IntegrateGet, Camera_IntegrateSet, Camera_RelayLensGet, Camera_RelayLensSet, Camera_RotateGet, Camera_RotateSet, Camera_SensorModeGet, Camera_SensorModeSet, Camera_TemperatureGet, Camera_TriggerModeGet, Camera_TriggerModeSet, CameraFormatGet, CameraFormatSet, CameraSettings_Load, CameraSettings_Remove, CameraSettings_RemoveAll, CameraSettings_Save, CameraUpdateGUI, ChangeFollowExposureMode, EnableFocusCriterium, EnableMouseXY, EnableTrackXY, GetCameraName, GetCameraResolution, GetCurrentCameraDriverName, GetCurrentCameraName, GetFollowExposureMode, InputCameraEx, InputHWUnit, LockCameraMagnification, ManualIntegration, ResetFocusCriteriumMax, ShowShadingCorrections, TestMacroToClipboard_CameraGet, TestMacroToClipboard_CameraGetAndSet, ToggleInputSetup, TrackXYSetup

CameraFormatGet

Description 

 CameraFormatGet(
   int  CameraPropMode,
   char *CameraFormatParam
);

This function retrieves a camera format 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.

char *CameraFormatParam

A buffer where the camera format string is stored.

CameraFormatSet

Description 

 CameraFormatSet(
   int  CameraPropMode,
   char *CameraFormatParam
);

This function sets a camera format in 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.

char *CameraFormatParam

A buffer where the camera format string is stored.

CameraSettings_Load

Description 

 CameraSettings_Load(
   char *SettingName
);

This function loads and activates a previously saved camera setting of the current camera.

Parameters

char *SettingName

Camera setting name

CameraSettings_Remove

Description 

 CameraSettings_Remove(
   char *SettingName
);

This function deletes a previously saved camera setting of the current camera.

Parameters

char *SettingName

Camera setting name

CameraSettings_RemoveAll

Description 

 CameraSettings_RemoveAll();

This function removes all the saved settings of the current camera.

CameraSettings_Save

Description 

 CameraSettings_Save(
   char *SettingName
);

This function saves the current camera setting under a defined name.

Parameters

char *SettingName

Camera setting name

CameraUpdateGUI

Description 

 CameraUpdateGUI();

This function updates values showed in the camera input setup dialog according to the values set in the camera.

Camera_AngleGet

Description 

 Camera_AngleGet(
   double *pdAngle
);

This function retrieves the camera rotation angle set in the Camera Light Path dialog window.

Parameters

double *pdAngle

Returns angle of the camera rotation.

Camera_AverageGet

Description 

 Camera_AverageGet(
   int *piAverage
);

This function returns the set averaging parameter of the acquisition.

Parameters

int *piAverage

Returns averaging parameter value

See Also 
Camera_AverageSet

Camera_AverageSet

Description 

 Camera_AverageSet(
   int  iAverage
);

Sets the averaging parameter of the acquisition.

Parameters

int iAverage

Sets averaging parameter.

See Also 
Camera_AverageGet

Camera_ExposureGet

Description 

 Camera_ExposureGet(
   double *pdExposureMs
);

Retrieves the set camera exposure time.

Parameters

double *pdExposureMs

Retrieves set exposure time.

Camera_ExposureSet

Description 

 Camera_ExposureSet(
   double  dExposureMs
);

Sets the camera exposure time.

Parameters

double dExposureMs

Set exposure time.

Camera_GainRGet

Description 

 Camera_GainRGet(
   double *pdExposureMs
);

Returns camera white balance gain for the red colour component.

Parameters

double *pdExposureMs

Retrieves set exposure time.

Camera_GainRSet

Description 

 Camera_GainRSet(
   double  dExposureMs
);

Sets the camera white balance gain for the red colour component.

Parameters

double dExposureMs

Set exposure time.

Camera_GainBGet

Description 

 Camera_GainBGet(
   double *pdExposureMs
);

Returns the camera white balance gain for the blue colour component.

Parameters

double *pdExposureMs

Retrieves set exposure time.

Camera_GainBSet

Description 

 Camera_GainBSet(
   double  dExposureMs
);

Sets the camera white balance gain for the blue colour component.

Parameters

double dExposureMs

Set exposure time.

Camera_IntegrateGet

Description 

 Camera_IntegrateGet(
   int *piIntegrate
);

This function retrieves the integrating parameter of the acquisition.

Parameters

int *piIntegrate

Returns the integrating parameter value

See Also 
Camera_IntegrateSet

Camera_IntegrateSet

Description 

 Camera_IntegrateSet(
   int  iIntegrate
);

This function sets the integrating parameter of the acquisition.

Parameters

int iIntegrate

Set the integrating parameter value.

See Also 
Camera_IntegrateGet

Camera_RelayLensGet

Description 

 Camera_RelayLensGet(
   double *pdRelayLens
);

Gets the information about the camera relay lens magnification.

Parameters

double *pdRelayLens

Pointer to information about relay lens magnification.

Camera_RelayLensSet

Description 

 Camera_RelayLensSet(
   double  dRelayLens
);

Sets the camera relay lens value.

Parameters

double dRelayLens

Relay lens magnification.

Camera_RotateGet

Description 

 Camera_RotateGet(
   double *pdAngleRotate
);

This function retrieves the angle of camera rotation.

Parameters

double *pdAngleRotate

Returns angle of the camera rotation.

Camera_RotateSet

Description 

 Camera_RotateSet(
   double  dAngleRotate
);

This function sets the proper angle of the camera rotation.

Parameters

double dAngleRotate

Set angle of the camera rotation.

Camera_SensorModeGet

Description 

 Camera_SensorModeGet(
   int *piSensorMode
);

This function retrieves the sensor mode.

Parameters

int *piSensorMode

Returns sensor mode.

See Also 
Camera_SensorModeSet

Camera_SensorModeSet

Description 

 Camera_SensorModeSet(
   int  iSensorMode
);

This function sets the sensor mode.

Parameters

int iSensorMode

Set sensor mode.

See Also 
Camera_SensorModeGet

Camera_TemperatureGet

Description 

 Camera_TemperatureGet(
   double *pdTemperature
);

This function gets the current camera temperature.

Parameters

double *pdTemperature

Returns camera temperature.

Camera_TriggerModeGet

Description 

 Camera_TriggerModeGet(
   int *piTriggerMode
);

This function retrieves the set camera trigger mode.

Parameters

int *piTriggerMode

Retrieves set camera trigger mode.

See Also 
Camera_TriggerModeSet

Camera_TriggerModeSet

Description 

 Camera_TriggerModeSet(
   int  iTriggerMode
);

This function sets the camera trigger mode.

Parameters

int iTriggerMode

Set camera trigger mode.

0

Timed trigger mode

1

Strobe trigger mode

See Also 
Camera_TriggerModeGet

ChangeFollowExposureMode

Description 

 ChangeFollowExposureMode(
   int  iCameraIndex
);

Switches the Follow Exposure Mode on/off. This equals the check box Enable Active Shutter Blanking on Live in Acquire > Camera Light Path.

Parameters

int iCameraIndex

Grabber (camera driver) index.

See Also 
GetFollowExposureMode

EnableFocusCriterium

Description 

 EnableFocusCriterium(
   int  CriteriumEnable
);

This function enables/disables appearance of the focus criteria in the System Information Graph.

Parameters

int CriteriumEnable

Focus Criteria enabled/disabled

0

Focus Criteria disabled

1

Focus Criteria enabled

EnableMouseXY

Description 

 EnableMouseXY(
   int  Enabled
);

This function turns the Mouse XY tool ON/OFF. The tool enables the user to move a motorized stage by dragging the live image via mouse.

Parameters

int Enabled

0

Disabled.

1

Enabled.

EnableTrackXY

Description 

 EnableTrackXY(
   int  Enabled
);

This function tracks an object on Live in real time when using a vector controlled stage.

Parameters

int Enabled

0

Disabled.

1

Enabled.

GetCameraName

Description 

int GetCameraName(
   char *Name,
   int  Index
);

Returns a unique camera name according to the index number.

Parameters

char *Name

The unique camera name.

int Index

Index number (zero-based).

Return Values

int

unused

char szCamName[256];
GetCameraName(szCamName, 0);
GetCameraName(szCamName, 1);

See Also 
GetCurrentCameraName

GetCameraResolution

Description 

 GetCameraResolution(
   int  iCameraMode,
   int *pCameraResolutionWidth,
   int *pCameraResolutionHeight,
   double *pCameraPixelSize
);

This function retrieves resolution of the Live/Quality mode of the current camera.

Parameters

int iCameraMode

Camera mode

1

Live Fast

2

Quality Capture

int *pCameraResolutionWidth

Width of the image in pixels.

int *pCameraResolutionHeight

Height of the image in pixels.

double *pCameraPixelSize

Size of one camera (chip) pixel in microns. If this value cannot be retrieved, it is 1,0 by default.

int x;
int y;
double d;
GetCameraResolution(1,&x,&y,&d); // first param: 1 for live 2 for quality
ShowVars("",2);

Note

Note the ampersand character denoting address of a variable to be filled by the function.

GetCurrentCameraDriverName

Description 

 GetCurrentCameraDriverName(
   char *DriverName
);

This function returns a unique name of the currently selected camera driver.

Parameters

char *DriverName

The driver name

GetCurrentCameraName

Description 

 GetCurrentCameraName(
   char *Name
);

This function returns a unique name of the currently selected camera.

Parameters

char *Name

The unique camera name.

GetFollowExposureMode

Description 

 GetFollowExposureMode(
   int  iCameraIndex,
   int *pEnable
);

Returns the state of the Follow Exposure mode.

Parameters

int iCameraIndex

Grabber (camera driver) index.

int *pEnable

Defines the grabber (camera driver) in case Multi Camera mode is enabled.

0

first grabber

1

second grabber

See Also 
ChangeFollowExposureMode

InputCameraEx

Interactive command to this function: Select Camera

Description 

 InputCameraEx(
   int  Index
);

This function sets a camera according to the specified index number.

Parameters

int Index

Index number (zero-based).

InputHWUnit

Description 

 InputHWUnit(
   char *HWUnitName,
   char *CameraName
);

This function makes selected HW unit and camera active for image acquisition.

Parameters

char *HWUnitName

Name of the HW unit.

char *CameraName

Name of the camera.

See Also 
_InputHWUnit, _InputDriver, _InputHWUnitAndCamera, _InputSetup

LockCameraMagnification

Description 

int LockCameraMagnification(
   int  LockMagnification
);

This function locks the picture view. E.g.: In Live-fast zoom to a cell, then call this function. Now if captured, you can see the same cell in a view. Camera magnification is also automatically locked when the live window is maximized.

Parameters

int LockMagnification

Enable/disable lock camera magnification.

0

unlocked magnification

1

locked magnification

Return Values

int

unused

ManualIntegration

Interactive command to this function: Acquire > Manual Integration

Description 

 ManualIntegration(
   int  iStopOnOversaturation
);

Opens a dialog window for manual integration of subsequent camera frames.

Parameters

int iStopOnOversaturation

Turn the Stop on oversaturation option ON/OFF.

ResetFocusCriteriumMax

Description 

 ResetFocusCriteriumMax();

This function discards the current maximum focus criterion value of the automatic camera focus criterion estimation algorithm. This estimation is indicated in the status bar.

ShowShadingCorrections

Description 

 ShowShadingCorrections();

Opens the Shading Corrections panel.

TestMacroToClipboard_CameraGet

Description 

 TestMacroToClipboard_CameraGet();

This function is only for testing purposes.

TestMacroToClipboard_CameraGetAndSet

Description 

 TestMacroToClipboard_CameraGetAndSet();

This function is only for testing purposes.

ToggleInputSetup

Description 

 ToggleInputSetup();

Toggles the visibility of camera input setup window.

Note

Toggles the visibility of camera input setup window. For directly specifying the input setup window visibility, use the ShowInputSetup function.

See Also 
ShowInputSetup

TrackXYSetup

Description 

 TrackXYSetup();

This function opens a Real Time Tracking window.

_CameraSetAverageToQuality

This function runs the Acquire > Average > Define Average to Quality command.

Description 

 _CameraSetAverageToQuality();

This function displays a window which sets the quality parameter for averaging.

See Also 
CameraSet_AverageToQuality

_InputCameraEx

This function runs the Select Camera command.

Description 

 _InputCameraEx();

This function displays the Select Camera dialog box.

See Also 
_InputDriver, _InputHWUnit, _InputHWUnitAndCamera, _InputSetup

_InputDriver

Description 

 _InputDriver();

This function displays the Driver Selection dialog window where it is possible to choose the active display driver.

_InputHWUnit

Description 

 _InputHWUnit();

This function shows a dialog where HW units can be managed (add, remove, edit, ...). The dialog appears only if there are more HW units available.

See Also 
_InputCameraEx, _InputDriver, _InputHWUnitAndCamera, _InputSetup

_InputHWUnitAndCamera

Description 

 _InputHWUnitAndCamera();

This function displays a window where it is possible to choose the type of the current camera. You can also select the rotation angle and flipping of image coming from the camera.

See Also 
_InputCameraEx, _InputDriver, _InputHWUnit, _InputSetup

_InputHWUnitAndCamera2

Description 

 _InputHWUnitAndCamera2(
   int  iActiveGrabber
);

This function displays a window where it is possible to choose the type of the camera specified by the parameter.

Parameters

int iActiveGrabber

Index number of a camera

0

The first (primary) camera

1

The second (secondary) camera

_InputSetup

This function runs the Acquire > Camera Settings command.

Description 

 _InputSetup();

This function displays the Input Setup camera dialog window.

See Also 
_Grabbing

_ManualIntegration

This function runs the Acquire > Manual Integration command.

Description 

 _ManualIntegration();

Opens a dialog window for manual integration of subsequent camera frames.

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