SIDX 7
Functions
SIDXRoot.h File Reference

File containing SIDX root usage for reference. More...

#include "SIDXConstants.h"

Go to the source code of this file.

Functions

 SIDXRootOpen (integer SIDXroot, string license, integer status)
 The function returns a handle used to control SIDX. More...
 
 SIDXRootClose (integer SIDXroot, integer status)
 Close SIDX. More...
 
 SIDXRootGetLastError (integer SIDXroot, string message)
 The function translates the last error into a text string. More...
 
 SIDXRootEnableCapabilities (integer SIDXroot, integer capability, integer status)
 Enable a special camera capability. More...
 
 SIDXRootArchiveOpen (integer SIDXroot, string path, integer SIDXarchive, integer status)
 Open a file as an image archive. More...
 
 SIDXRootCameraScan (integer SIDXroot, integer status)
 This operation scans the computer system to locate any available cameras. More...
 
 SIDXRootCameraScanGetReport (integer SIDXroot, string report, integer status)
 Obtain a detailed report of all available cameras on the system. More...
 
 SIDXRootCameraScanGetCount (integer SIDXroot, integer count, integer status)
 Return the number of connected camera count as the result of SIDXRootCameraScan. More...
 
 SIDXRootCameraScanGetName (integer SIDXroot, integer index, string name, integer status)
 Obtain the name of the camera corresponding to the index. More...
 
 SIDXRootCameraScanGetLabel (integer SIDXroot, integer index, string label, integer status)
 Obtain the label representing the camera. More...
 
 SIDXRootCameraOpenName (integer SIDXroot, string name, integer SIDXcamera, integer status)
 Connect to the specified camera by name. More...
 
 SIDXRootSoftwareGetDescription (integer SIDXroot, string description, integer status)
 Obtain the software description as a text string. More...
 
 SIDXRootSoftwareGetLicense (integer SIDXroot, string license, integer status)
 Obtain the software license string. More...
 
 SIDXRootSoftwareGetSerial (integer SIDXroot, string serial, integer status)
 Obtain the software serial number as a text string. More...
 
 SIDXRootSoftwareIsLicensed (integer SIDXroot, integer licensed, integer status)
 Verify if the SIDX software license is valid. More...
 
 SIDXRootSoftwareSetLicense (integer SIDXroot, string license, integer status)
 Sets an SIDX license. More...
 
 SIDXRootStageOpen (integer SIDXroot, string name, string port, integer SIDXstage, integer status)
 Open the stage controller, by name, on the specified port. More...
 

Detailed Description

File containing SIDX root usage for reference.

Function Documentation

SIDXRootArchiveOpen ( integer  SIDXroot,
string  path,
integer  SIDXarchive,
integer  status 
)

Open a file as an image archive.

Parameters
SIDXrootA handle value that references the SIDX root context.
pathThe path to the image file to open.
SIDXarchiveA variable to receive a handle value used to control the image file.
statusNon-zero if the function failed, zero if it succeeded.
SIDXRootCameraOpenName ( integer  SIDXroot,
string  name,
integer  SIDXcamera,
integer  status 
)

Connect to the specified camera by name.

The camera name string can be only a driver name, for example, "PCO pixelfly" or "Andor Technology". In the case that a driver owns multiple cameras, the camera name string must include the the index value.

Parameters
SIDXrootA handle value that references the SIDX root context.
nameA name string of the camera to open.
SIDXcameraA variable to receive a handle value that references the open camera.
statusNon-zero if the function failed, zero if it succeeded.
SIDXRootCameraScan ( integer  SIDXroot,
integer  status 
)

This operation scans the computer system to locate any available cameras.

The operation cannot be performed if SIDX has any cameras open. The number of available cameras may be zero or more. Use SIDXRootCameraScanGetCount to obtain the number of cameras found on the computer system. This value may be zero. The operation creates a text report that may be useful if unexpected results occur. Use SIDXRootCameraScanGetReport to obtain this report.

Parameters
SIDXrootA handle value that references the SIDX root context.
statusNon-zero if the function failed, zero if it succeeded.
SIDXRootCameraScanGetCount ( integer  SIDXroot,
integer  count,
integer  status 
)

Return the number of connected camera count as the result of SIDXRootCameraScan.

Parameters
SIDXrootA handle value that references the SIDX root context.
countA variable to receive an integer count of connected cameras, including any simulated cameras
statusNon-zero if the function failed, zero if it succeeded.
SIDXRootCameraScanGetLabel ( integer  SIDXroot,
integer  index,
string  label,
integer  status 
)

Obtain the label representing the camera.

The label is intended to be human readable.

Parameters
SIDXrootA handle value that references the SIDX root context.
indexThe index of the camera in the connected camera list.
labelA text string to receive the text label of camera given the index.
statusNon-zero if the function failed, zero if it succeeded.
SIDXRootCameraScanGetName ( integer  SIDXroot,
integer  index,
string  name,
integer  status 
)

Obtain the name of the camera corresponding to the index.

This name is used to open the camera.

Parameters
SIDXrootA handle value that references the SIDX root context.
indexThe index of the camera in the connected camera list.
nameA text string to receive the text name of camera given the index.
statusNon-zero if the function failed, zero if it succeeded.
SIDXRootCameraScanGetReport ( integer  SIDXroot,
string  report,
integer  status 
)

Obtain a detailed report of all available cameras on the system.

Parameters
SIDXrootA handle value that references the SIDX root context.
reportA text string to receive the text report of camera scan result.
statusNon-zero if the function failed, zero if it succeeded.
SIDXRootClose ( integer  SIDXroot,
integer  status 
)

Close SIDX.

This should be the last call to SIDX before the object is discarded.

Parameters
SIDXrootA handle value that references the SIDX root context.
statusNon-zero if the function failed, zero if it succeeded.
SIDXRootEnableCapabilities ( integer  SIDXroot,
integer  capability,
integer  status 
)

Enable a special camera capability.

The supported capabilities are: 1000: Enable Photometrics PVCAM support 1001: Enable Princeton Instruments PVCAM support By default, Photometrics PVCAM support is enabled.

Parameters
SIDXrootA handle value that references the SIDX root context.
capabilityThe capability to enable.
statusNon-zero if the function failed, zero if it succeeded.
SIDXRootGetLastError ( integer  SIDXroot,
string  message 
)

The function translates the last error into a text string.

Parameters
SIDXrootA handle value that references the SIDX root context.
messageA text string to receive the text associated with the last error.
SIDXRootOpen ( integer  SIDXroot,
string  license,
integer  status 
)

The function returns a handle used to control SIDX.

Parameters
SIDXrootA variable to receive a handle value that references the SIDX root context.
licenseA text string containing a valid SIDX license. If the string is null or invalid, SIDX will look for the license file.
statusNon-zero if the function failed, zero if it succeeded.
SIDXRootSoftwareGetDescription ( integer  SIDXroot,
string  description,
integer  status 
)

Obtain the software description as a text string.

The software description includes the product and version, for example: 'SIDX 7.0.1'.

Parameters
SIDXrootA handle value that references the SIDX root context.
descriptionA text string to receive the text description of the software.
statusNon-zero if the function failed, zero if it succeeded.
SIDXRootSoftwareGetLicense ( integer  SIDXroot,
string  license,
integer  status 
)

Obtain the software license string.

Parameters
SIDXrootA handle value that references the SIDX root context.
licenseA text string to receive the text license of the software.
statusNon-zero if the function failed, zero if it succeeded.
SIDXRootSoftwareGetSerial ( integer  SIDXroot,
string  serial,
integer  status 
)

Obtain the software serial number as a text string.

Parameters
SIDXrootA handle value that references the SIDX root context.
serialA text string to receive the text serial number of the software.
statusNon-zero if the function failed, zero if it succeeded.
SIDXRootSoftwareIsLicensed ( integer  SIDXroot,
integer  licensed,
integer  status 
)

Verify if the SIDX software license is valid.

If the software is not licensed all SIDX calls will return an invalid operation status code.

Parameters
SIDXrootA handle value that references the SIDX root context.
licensedA value to receive a boolean value, true if the software is licensed, otherwise false.
statusNon-zero if the function failed, zero if it succeeded.
SIDXRootSoftwareSetLicense ( integer  SIDXroot,
string  license,
integer  status 
)

Sets an SIDX license.

If there is an existing license it will be overwritten.

Parameters
SIDXrootA handle value that references the SIDX root context.
licenseA text string software license code.
statusNon-zero if the function failed, zero if it succeeded.
SIDXRootStageOpen ( integer  SIDXroot,
string  name,
string  port,
integer  SIDXstage,
integer  status 
)

Open the stage controller, by name, on the specified port.

Parameters
SIDXrootA handle value that references the SIDX root context.
nameA text string containing the name of the stage. An empty string will return an error.
portA string specifying the serial port to be used. An empty string will return an error.
SIDXstageA variable to receive a handle value that references the open stage.
statusNon-zero if the function failed, zero if it succeeded.