Home

functions sdk

1. ANDOR FUNCTIONS SetReadMode unsigned int WINAPI SetReadMode int mode Description Parameters Return See also This function will set the readout mode to be used on the subsequent acquisitions int mode readout mode Valid values 0 Full Vertical Binning 1 Multi Track 2 Random Track 3 Single Track 4 Image unsigned int DRV SUCCESS Readout mode set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress P1INVALID Invalid readout mode passed GetAcquisitionTimings SetAccumulationCycleTime SetAcquisitionMode SetExposureTime SetKineticCycleTime SetNumberAccumulations SetNumberKinetics SetReadoutRegisterPacking unsigned int WINAPI SetReadoutRegisterPacking int mode Description Parameters Return See also This function will configure whether data is packed into the readout register to improve frame rates for sub images Note It is important to ensure that no light falls outside of the sub image area otherwise the acquired data will be corrupted Only currently available on iXon and iXon3 int mode register readout mode Valid values 0 Packing Off 1 Packing On unsigned int DRV SUCCESS Readout mode set DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_P1INVALID Invalid readout mode passed GetAcquisitionTimings SetAccumulationCycleTime SetAcquisitionMode SetExposureTime SetKineticCycleTime SetNumberAc
2. ELE TEMPERATURE CONTROL SECTION 8 TEMPERATURE CONTROL The Andor camera incorporates a CCD which is fabricated using a process known as Multi Pin Phasing MPP As a result the dark current is reduced by a factor of approximately 100 compared to standard devices at the same temperature To reduce the dark current even further Andor SDK allows you to cool and monitor the CCD temperature through a number of functions The desired temperature is set via the SetTemperature function whilst the actual cooling mechanism is switched On and Off via the CoolerON and CoolerOFF functions The table below shows a typical example of temperatures attainable with the various systems available with and without the assistance of water cooling Please refer to the specification supplied with your particular model for full details The possible temperature range available to the SetTemperature function can be obtained using the GetTemperatureRange function Moderate Cooling High Cooling Ultra High Cooling Air Water Air Water Air Water 5 C 25 C 30 C 55 C 75 C 90 C NOTES 1 Because rapid cooling and heating can cause thermal stresses in the CCD the rate of cooling and heating is regulated to be lt 10 C per minute on some systems 2 While the system is cooling or heating you can acquire data but the Background Level WILL change with temperature The current temperature can be read using the GetTemperature function This functi
3. Shutter Output 1 gt m 1 I Hoy Fire Gate Output 1 Lu 1 Lu 1 I m i External Trigger Time to close The external trigger can be fed in a number of ways e EXT TRIG socket of the I O Box available separately model 10160 e Pin 13 of the Auxiliary Connector on the Andor PCI Card e The head in the case of iDus iXon External Trigger mode is suited to data acquisitions involving a pulsed source e g a laser where the source does NOT allow a trigger pulse to be sent to it but can generate one It is possible to increase the frame rate when in external trigger mode by enabling the Fast External Trigger option see SetFastExtTrigger When this option is enabled the system will not wait for a Keep Clean cycle to be completed before allowing an external trigger to initiate an acquisition This may cause the background to change from one scan to another SECTION 5 Page 57 ANDOR i TRIGGERING NOTES 1 If you have a shutter connected and are using an external trigger you must ensure that the shutter is open before the optical signal you want to measure occurs When a camera is operated in frame transfer mode the external trigger sequence is different Please refer to the camera user manual for a full description 2 Some cameras may support the iCam technology If they do it will be fully operational in external trigger mode It is very similar to the Software trigger functionality exce
4. Bit 3 1 Camera Initialized correctly Return unsigned int DRV_SUCCESS Driver status return DRV_VXDNOTINSTALLED Driver not installed DRV_USBERROR USB device error See also GetCameraHandle GetHeadModel GetCameraSerialNumber GetCapabilities NOTE Only available in iDus The index parameter is not used at present so should be set to 0 For any camera except the iDus The value of information following a call to this function will be zero GetCameraSerialNumber unsigned int WINAPI GetCameraSerialNumber int number Description This function will retrieve camera s serial number Parameters int number Serial Number Return unsigned int DRV_SUCCESS Serial Number returned DRV_NOT_INITIALIZED System not initialized See also GetCameraHandle GetHeadModel GetCameralnformation GetCapabilities SECTION 11 Page 112 ANDOR GetCapabilities unsigned int WINAPI GetCapabilities AndorCapabilities caps Description Parameters Return See also This function will fill in an AndorCapabilities structure with the capabilities associated with the connected camera Before passing the address of an AndorCapabilites structure to the function the ulSize member of the structure should be set to the size of the structure In C this can be done with the line caps ulSize z sizeof AndorCapabilities Individual capabilities are determined by examining certain bits and combinations of bits in the member variables of
5. command timed out DRV I2CDEVNOTFOUND device not present DRV ERROR ACK Unable to communicate with card P1INVALID Value for gating invalid See also SetMCPGain SetGateMode NOTE Available on some ICCD models SetMessageWindow unsigned int WINAPI SetMessageWindow HWND wnd Description This function is reserved SetMetaData unsigned int WINAPI SetMetaData int state Description This function activates the meta data option Parameters int state ON OFF switch for the meta data option Valid values 0 to switch meta data OFF 1 to switch meta data ON Return unsigned int DRV SUCCESS Meta data option accepted DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV P1INVALID Invalid state DRV NOT AVAILABLE Feature not available See also GetMetaDatalnfo SECTION 11 Page 267 ANDOR FUNCTIONS SetMultiTrack unsigned int WINAPI SetMultiTrack int number int height int offset int bottom int gap Description Parameters Return See also This function will set the multi Track parameters The tracks are automatically spread evenly over the detector Validation of the parameters is carried out in the following order e Number of tracks e Track height e Offset The first pixels row of the first track is returned via bottom The number of rows between each track is returned via gap int number number tracks Valid values 1 t
6. e Check that libUSB is available whereis libusb e Check that the Andor device is listed in the proc bus usb devices file Check that the relevant device under proc bus usb 00X 00Y has write access for all users SECTION 2 Page 33 ANDOR Sess READOUT MODES SECTION 3 READOUT MODES INTRODUCTION Andor systems are based on a detector known as a Charged Coupled Device CCD The detector is divided up as a 2 dimensional array of pixels each capable of detecting light For example systems based on an EEV 30 11 CCD chip have 1024 X 256 pixels where each pixel is 26um all examples given in this manual assume an EEV 30 11 based system This 2 dimensional nature allows the device to be operated using a number of different binning patterns We refer to these binning patterns as Readout Modes Andor has several different readout modes as follows e Full Vertical Binning FVB e Single Track e Multi Track e Random Track e Image e Cropped Figure 1 shows the binning patterns BINNING PATTERNS FULL VERTICAL BINNING SINGLE TRACK Track Centre Chip Height Row Height MULTI TRACK RANDOM HULTI TRACK Track I Height T 4 Offset 0 i FULL IMAGE Track IMAGE Number Figure 1 Binning patterns We will now look at each of these modes in more detail NOTE All of the patterns described can be simulated by the user in software but by carrying out the pattern in the camera greatly in
7. unsigned int DRV_SUCCESS Number of speeds returned DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress GetVerticalSpeed SetVerticalSpeed NOTE Deprecated by GetNumberVSSpeeds GetNumberVSAmplitudes unsigned int WINAPI GetNumberVSAmplitudes int number Description Parameters Return This function will normally return the number of vertical clock voltage amplitues that the camera has int number unsigned int DRV_SUCCESS Number returned DRV_NOT_INITIALIZED System not initialized DRV_NOT_AVAILABLE Your system does not support this feature GetNumberVSSpeeds unsigned int WINAPI GetNumberVSSpeeds int speeds Description Parameters Return See also As your Andor system may be capable of operating at more than one vertical shift speed this function will return the actual number of speeds available int speeds number of allowed vertical speeds unsigned int DRV_SUCCESS Number of speeds returned DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress GetVSSpeed SetVSSpeed GetFastestRecommendedVSSpeed SECTION 11 Page 172 ANDOR ee FUNCTIONS GetOldestlmage unsigned int WINAPI GetOldestlmage at 32 arr unsigned long size Description This function will update the data array with the oldest image in the circular buffer Once the oldest image has been retrieved it no longer is available The data are returned as long intege
8. 1 55 No of Accurnulations 3 Accumulated Cycle Time To set the acquisition mode to Accumulate call SetAcquisitionMode 2 To fully define an Accumulate acquisition you will need to supply the follow information Exposure Time This is the time in seconds during which the CCD sensor collects light prior to readout Set via the SetExposureTime function Number of Accumulations This is the number of scans to be acquired and accumulated in the memory of the PC Set via the SetNumberAccumulations function Accumulate Cycle Time This is the period in seconds between the start of each scan Set via the SetAccumulationCycleTime function This parameter is only applicable if you have selected Internal trigger Please refer to SECTION 6 TRIGGERING for further information NOTES 1 If the exposure time or the cycle time are set too low or are not permissible values the driver will automatically calculate the nearest appropriate value 2 The actual values used can be obtained via the GetAcquisitionTimings function this function should be called after the acquisition has been fully defined i e readout mode trigger mode etc have been set 3 In External Trigger mode the delay between each scan making up the acquisition is not under the control of the Andor system but is synchronized to an externally generated trigger pulse SECTION 4 Page 42 ANDOR C ACQUISITION MODES Kinetic Series Kinetic Seri
9. DRV_P2INVALID Invalid width See also GetCapabilities GetDDGGateTime SetDDGInsertionDelay unsigned int WINAPI SetDDGInsertionDelay int state Description This function controls the length of the insertion delay Parameters int state NORMAL FAST switch for insertion delay Valid values 0 to set normal insertion delay 1 to set fast insertion delay Return unsigned int DRV SUCCESS Value for delay accepted DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV I2CTIMEOUT 126 command timed out DRV I2CDEVNOTFOUND 12C device not present DRV ERROR ACK Unable to communicate with system See also GetCapabilities SetDDGlntelligate SECTION 11 Page 233 ANDOR ee FUNCTIONS SetDDGIntelligate unsigned int WINAPI SetDDGintelligate int state Description This function controls the MCP gating Not available when the fast insertion delay option is selected Parameters int state ON OFF switch for the MCP gating Valid values 0 to switch MCP gating OFF 1 to switch MCP gating ON Return unsigned int DRV SUCCESS Intelligate option accepted DRV NOT INITIALIZED System not initialized DRV ACQUIRING Acquisition in progress DRV I2CTIMEOUT 12C command timed out DRV I2CDEVNOTFOUND 12C device not present DRV ERROR ACK Unable to communicate with system See also GetCapabilities SetDDGInsertionDelay SetDDGIOC unsigned int WINAPI SetDDGIOC int state Description This function activates the in
10. USER S GUIDE TO ANDOR SDK www andor com Andor plc 2009 Software Version 2 95 ANDOR TABLE OF CONTENTS PAGE SECTION 1 INTRODUCTION 12 TECHNICAL SUPPORT 13 SOFTWARE IMPROVEMENTS AND ADDITIONAL FEATURES 13 SECTION 2 SOFTWARE INSTALLATIONS 28 PC requirements 28 SDK WINDOWS INSTALLATION 28 Windows Troubleshooting 30 SDK LINUX INSTALLATION 32 LABVIEW INSTALLATION 32 Linux Troubleshooting 33 SECTION 3 READOUT MODES 34 INTRODUCTION 34 Full Vertical Binning 35 Single Track 35 Multi Track 36 Random Track 37 Image 38 Cropped 39 SECTION 4 ACQUISITION MODES 40 ACQUISITION MODE TYPES 40 Single Scan 41 Accumulate 42 Kinetic Series 43 Run Till Abort 45 Fast Kinetics 48 Frame Transfer 49 SECTION 5 TRIGGERING 55 TRIGGER MODES 55 Internal 56 External 57 External Start 59 External Exposure 60 External FVB EM 62 Software 63 SECTION 6 SHIFT SPEEDS 64 TABLE OF CONTENTS Page 2 ANDOR SECTION 7 SHUTTER CONTROL 65 SHUTTER MODES 65 Fully Auto 65 Hold Open 65 Hold Closed 65 SHUTTER TYPE 66 SHUTTER TRANSFER TIME 67 SECTION 8 TEMPERATURE CONTROL 69 SECTION 9 SPECIAL GUIDES 70 CONTROLLING MULTIPLE CAMERAS 70 USING MULTIPLE CAMERA FUNCTIONS 71 DATA RETRIEVAL METHODS 73 How to determine when new data is available 73 Retrieving Image Data 75 DETERMINING CAMERA CAPABILITIES 76 Retrieving capabilities from the camera 76 Other Capabilities 80 Output Amplifiers 81 iCam 84 OptAcquire 86 SEC
11. at32 Outputlmage int OutputBufferSize int NumImages int Baseline int Mode int EmGain float QE float Sensitivity int Height int Width unsigned int DRV SUCCESS Return DRV NOT INITIALIZED DRV ACQUIRING DRV_P1INVALID DRV_P2INVALID DRV_P4INVALID DRV PSINVALID DRV_P6INVALID DRV_P7INVALID DRV_P8INVALID DRV_P9INVALID DRV_P10INVALID DRV_P11INVALID DRV_ERROR_BUFFSIZE See also The input image data to be processed The output buffer to return the processed image The size of the output buffer The number of images if a kinetic series is supplied as the input data The baseline associated with the image The mode to use to process the data Valid options are 1 Convert to Electrons 2 Convert to Photons The gain level of the input image The Quantum Efficiency of the sensor The Sensitivity value used to acquire the image The height of the image The width of the image Acquisition prepared System not initialized Acquisition in progress Invalid pointer i e NULL Invalid pointer i e NULL Number of images less than zero Baseline less than zero Invalid count convert mode EMGain less than zero QE less than zero Sensitivity less than zero Height less than zero Width less than zero Output buffer size too small PostProcessDataAveraging unsigned int WINAPI PostProcessDataAveraging at 32 plnputimage at 32 pOutputlmage int iOutputBufferSize int iNuml
12. AndorCapabilities Member ulFeatures Capability AC FEATURES POLLING Description The status of the current acquisition can be determined through the GetStatus function call Bit 0 State 1 Capability AC FEATURES EVENTS Description A Windows Event can be passed to the SDK to alert the user at certain stages of the Acquisition See SetDriverEvent Bit 1 State 1 Capability AC FEATURES SPOOLING Description Acquisition Data can be made to spool to disk using the SetSpool function Bit 2 State 1 Capability AC FEATURES SHUTTER Description Shutter settings can be adjusted through the SetShutter function Bit 3 State 1 Capability AC FEATURES SHUTTEREX Description Shutter settings can be adjusted through the SetShutterEx function Bit 4 State 1 Capability AC FEATURES EXTERNAL I2C Description The camera has its own dedicated external I2C bus Bit 5 State 1 Capability AC FEATURES SATURATIONEVENT Description Sensor saturation can be determined through the SetSaturationEvent function Bit 6 State 1 SECTION 11 Page 129 ANDOR ee FUNCTIONS GetCapabilities SDK Features Available Continued Capability AC FEATURES FANCONTROL Description Fan settings can be adjusted through the SetFanMode function Bit 7 State 1 Capability AC FEATURES MIDFANCONTROL Description It is possible to select a low fan setting through the SetFanMode function Bit 8 State 1 Capability
13. FUNCTIONS OA GetNumberOfAcqParams unsigned int WINAPI OA GetNumberOfAcqParams const char const ModeName unsigned int const NumberOfParams Description This function will return the parameters associated with a specified mode The mode must be present in either the Preset file or the User defined file Parameters const char const ModeName The mode to search for a list of acquisition parameters unsigned int const NumberOfParams The number of acquisition parameters for the specified mode Return unsigned int DRV SUCCESS All parameters accepted DRV P1INVALID Null mode name DRV P2INVALID Null number of parameters DRV OA NULL ERROR Invalid pointer See also OA GetModeAcgParams OA GetNumberOfPreSetModes unsigned int WINAPI OA GetNumberOfPreSetModes unsigned int const NumberOfModes Description must exist Parameters Return unsigned int DRV SUCCESS DRV P1INVALID DRV OA NULL ERROR DRV OA BUFFER FULL See also OA GetPreSetModeNames This function will return the number of modes defined in the Preset file The Preset file unsigned int const NumberOfModes The number of modes in the Andor file All parameters accepted Null number of modes Invalid pointer Number of modes exceeds limit OA GetNumberOfUserModes unsigned int WINAPI OA GetNumberOfUserModes unsigned int const NumberOfModes Description file must exist Parameters Return unsigned int DRV SUCCESS DRV P1INVALID DRV OA NULL ERROR DRV
14. GetAcquisitionTimings function SECTION 11 Page 248 ANDOR FUNCTIONS SetExternalTriggerTermination unsigned int WINAPI SetExternalTriggerTermination at_u32 Termination Description This function can be used to set the external trigger termination mode Parameters at_u32 Termination trigger termination option Valid values 0 50 ohm 1 hi Z Return unsigned int DRV SUCCESS Termination set DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Trigger termination not supported ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with system DRV_P1INVALID Invalid termination See also GetCapabilities GetExternalTriggerTermination SetFanMode unsigned int WINAPI SetFanMode int mode Description Allows the user to control the mode of the camera fan If the system is cooled the fan should only be turned off for short periods of time During this time the body of the camera will warm up which could compromise cooling capabilities If the camera body reaches too high a temperature depends on camera the buzzer will sound If this happens turn off the external power supply and allow the system to stabilize before continuing Parameters int mode fan on full 0 fan on low 1 fan off 2 Return unsigned int DRV SUCCESS DRV NOT INITIALIZED DRV_ACQUIRING DRV I2CTIMEOUT DRV I2CDEVNOTFOUND DRV ERROR ACK DRV_P1INVALID See also GetCapabilities Value for mode a
15. GetTemperatureRange GetStatus NOTE The temperature to which the detector will be cooled is set via SetTemperature The temperature stabilization is controlled via hardware and the current temperature can be obtained via GetTemperature The temperature of the sensor is gradually brought to the desired temperature to ensure no thermal stresses are set up in the sensor Can be called for certain systems during an acquisition This can be tested for using GetCapabilities SECTION 11 Page 99 ANDOR FUNCTIONS Demosaiclmage unsigned int WINAPI Demosaiclmage WORD grey WORD WORD green WORD blue ColorDemosaicInfo info Description Parameters Return See also For colour sensors only Demosaics an image taken with a CYMG CCD into RGB using the parameters stored in info Below is the ColorDemosaiclnfo structure definition and a description of its members typedef struct COLORDEMOSAICINFO int iX Number of X pixels Must be gt 2 intiY Number of Y pixels Must be gt 2 int iAlgorithm Algorithm to demosaic image int iXPhase First pixel in data Cyan or Yellow Magenta or Green int iYPhase First pixel in data Cyan or Yellow Magenta or Green int iBackground Background to remove from raw data when demosaicing ColorDemosaiclInfo e iX and iY are the image dimensions The number of elements in the input red green and blue arrays is iX x iY e iAlgorithm sets the
16. IO level returned System not initialized Acquisition in progress Invalid index Invalid parameter Feature not available GetNumberlO GetlODirection SetlODirection SetlOLevel SECTION 11 Page 157 ANDOR e FUNCTIONS GetlRQ unsigned int WINAPI GetIRQ int IRQ Description THIS FUNCTION IS RESERVED GetKeepCleanTime unsigned int WINAPI GetKeepCleanTime float KeepCleanTime Description This function will return the time to perform a keep clean cycle This function should be used after all the acquisitions settings have been set e g SetExposureTime SetKineticCycleTime and SetReadMode etc The value returned is the actual times used in subsequent acquisitions Parameters float KeepCleanTime valid readout time in seconds Return unsigned int DRV SUCCESS Timing information returned DRV NOT INITIALIZED System not initialized DRV ERROR CODES Error communicating with camera See also GetAcquisitionTimings GetReadOutTime NOTES NOTE Available on iDus iXon Luca amp Newton GetMaximumBinning unsigned int WINAPI GetMaximumBinning int ReadMode int HorzVert int MaxBinning Description This function will return the maximum binning allowable in either the vertical or horizontal dimension for a particular readout mode Parameters int ReadMode The readout mode for which to retrieve the maximum binning see SetReadMode for possible values int HorzVert 0 to retrieve horizontal binning limit 1 to retreiv
17. Only available with certain iKon M systems SECTION 11 Page 223 ANDOR FUNCTIONS SetComplexlmage unsigned int WINAPI SetComplexlmage int numAreas int areas Description This is a function that allows the setting up of random tracks with more options that the SetRandomTracks function The minimum number of tracks is 1 The maximum number of tracks is the number of vertical pixels There is a further limit to the number of tracks that can be set due to memory constraints in the camera It is not a fixed number but depends upon the combinations of the tracks For example 20 tracks of different heights will take up more memory than 20 tracks of the same height If attempting to set a series of random tracks and the return code equals DRV_RANDOM_TRACK_ERROR change the makeup of the tracks to have more repeating heights and gaps so less memory is needed Each track must be defined by a group of six integers The top and bottom positions of the tracks The left and right positions for the area of interest within each track The horizontal and vertical binning for each track The positions of the tracks are validated to ensure that the tracks are in increasing order The left and right positions for each track must be the same For iXon the range is between 8 and CCD width inclusive For idus the range must be between 257 and CCD width inclusive Horizontal binning must be an integer between 1 and 64 inclusive for iXon H
18. SECTION 11 Page 259 ANDOR ee FUNCTIONS Setlmage unsigned int WINAPI Setlmage int hbin int vbin int hstart int hend int vstart int vend Description This function will set the horizontal and vertical binning to be used when taking a full resolution image Parameters int hbin number of pixels to bin horizontally int vbin number of pixels to bin vertically int hstart Start column inclusive int hend End column inclusive int vstart Start row inclusive int vend End row inclusive Return unsigned int DRV SUCCESS All parameters accepted DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV P1INVALID Binning parameters invalid DRV P2INVALID Binning parameters invalid DRV PSINVALID Sub area co ordinate is invalid DRV PAINVALID Sub area co ordinate is invalid DRV_P5INVALID Sub area co ordinate is invalid DRV_P6INVALID Sub area co ordinate is invalid See also SetReadMode NOTE For iDus it is recommended that you set horizontal binning to 1 SECTION 11 Page 260 ANDOR e FUNCTIONS SetlmageFlip unsigned int WINAPI SetlmageFlip int iHFlip int iVFlip Description This function will cause data output from the SDK to be flipped on one or both axes This flip is not done in the camera it occurs after the data is retrieved and will increase processing overhead If flipping could be implemented by the user more efficiently then use of this function is not recome
19. This section details the detector head It is the most complex section in the file and contains 10 or more items Format Format x y Gives the active pixel dimensions as x y x is the number of pixels along the readout register axis y is the number of pixel perpendicular to the readout axis DummyPixels DummyPixels z a b c d Gives the number of columns and row that are present on the device but do not respond to light The dummy columns are a combination of dark columns which run the full height of the sensor and dummy pixels in the shift register where number of dummy columns at non amplifier end number of dummy columns at amplifier end number of dummy rows at top of CCD number of dummy rows at bottom of CCD DataHShiftSpeed DataHShiftSpeed b c d e Lists the speeds at which the charge can be moved in the shift register This is also equivalent to the digitization speed in microseconds Where a default speed b c d e allowed speeds fastest first DataVShiftSpeed DataVShiftSpeed b c This lists the speeds in microseconds at which the CCD rows can be vertically shifted These speeds are used during CCD readout Where a default speed b c allowed speeds fastest first SECTION 13 Page 305 ANDOR PAS DETECTOR INI DummyHShiftSpeed DummyHShiftSpeed a b c d e This lists the speeds in microseconds at which the charge can be moved in the shift reg
20. cquire function Initialize MyFile xml FileNameLength Get Number of Preset Modes GetNumber fPreSetModes Number fModes Get all the Mode Names available allocate enough space to retrieve all the mode names i e buffer to retrieve list of modes must be capable of storing the maximum number of characters allowed for a mode name 255 number of modes OA GetPreSetModeNames List fPresetModeNames Get the number of acquistion parameters associated with a particular mode GetNumber fAcqParams ModeName NumberOfParams Get the name of all the acquisition parameters for a particular mode i e buffer to retrieve list of modes must be capable of storing the maximum number of characters allowed for a parameter 255 number of params 0 GetModeAcqParams ModeName List fParams Get the details of each of the acquisition parameters for the mode GetInt ModeName electron multiplying gain IntValue OA GetFloat ModeName readout rate FloatValue OA GetString ModeName output amplifier StringValue StringLen Enable a Mode DA EnableMode ModeName Figure 16 Example of OptAcquire using Preset Modes S D K SECTION 9 Page 88 ANDOR SPECIAL GUIDES Adding a New Mode to a User File Initialise specifying a user xml file to use The file does not need to exist at this stage however a file name must be provided This must be t
21. int index speed required Valid values 0 NumberSpeeds 1 where NumberSpeeds is value returned in first parameter after a call to GetNumberHSSpeeds float speed speed in in MHz unsigned int DRV SUCCESS Speed returned DRV NOT INITIALIZED System not initialized DRV_P1INVALID Invalid channel DRV P2INVALID Invalid horizontal read mode PSINVALID Invalid index GetNumberHSSpeeds SetHSSpeed NOTE The speed is returned in microseconds per pixel shift for iStar and Classic systems GetHVflag unsigned int WINAPI GetHVflag int bFlag Description Parameters Return NOTE This function will retrieve the High Voltage flag from your USB iStar intensifier A 0 value indicates that the high voltage is abnormal int bFlag pointer to High Voltage flag unsigned int DRV SUCCESS HV flag returned DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV NOT AVAILABLE Not a USB iStar Available only on USB iStar SECTION 11 Page 153 ANDOR FUNCTIONS GetID unsigned int WINAPI GetID int devNum int id Description THIS FUNCTION IS RESERVED GetlmageFlip unsigned int WINAPI GetlmageFlip int iHFlip int iVFlip Description Parameters Return See also This function will obtain whether the acquired data output is flipped in either the horizontal or vertical direction int iHFlip Gets horizontal flipping int iVFlip Gets vertical fli
22. wavelength at which QE is required unsigned int mode Clara mode Normal 0 or Extended NIR 1 0 for all other systems float QE requested QE unsigned int DRV_SUCCESS QE returned DRV_NOT_INITIALIZED System not initialized GetHeadModel GetCapabilities SECTION 11 Page 176 ANDOR ee FUNCTIONS GetReadOutTime unsigned int WINAPI GetReadOutTime float ReadoutTime Description This function will return the time to readout data from a sensor This function should be used after all the acquisitions settings have been set e g SetExposureTime SetKineticCycleTime and SetReadMode etc The value returned is the actual times used in subsequent acquisitions Parameters float ReadoutTime valid readout time in seconds Return unsigned int DRV_SUCCESS Timing information returned DRV_NOT_INITIALIZED System not initialized DRV_ERROR_CODES Error communicating with camera See also GetAcquisitionTimings GetKeepCleanTime NOTES NOTE Available on iDus iXon Luca amp Newton GetRegisterDump unsigned int WINAPI GetRegisterDump int mode Description THIS FUNCTION IS RESERVED GetRelativelmageTimes unsigned int WINAPI GetRelativelmageTimes unsigned int first unsigned int last at_u64 arr unsigned int size Description This function will return an array of the start times in nanoseconds of a user defined number of frames relative to the initial frame Parameters unsigned int first Index of first frame
23. 2 logarithmic p1 log p2 n 3 linear p2 n 1 2 number in kinetic series Return unsigned int DRV SUCCESS Gate step mode coefficients set DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with system DRV_P1INVALID Gate step mode invalid See also StartAcquisition SetDDGStepMode GetDDGStepMode GetDDGStepCoefficients NOTE Available on iStar and USB iStar SECTION 11 Page 239 ANDOR e FUNCTIONS SetDDGStepMode unsigned int WINAPI SetDDGStepMode at u32 mode Description This function will set the current gate step mode Parameters at u32 mode the gate step mode Valid values 0 constant 1 exponential 2 logarithmic 3 linear 100 off Return unsigned int DRV SUCCESS Gate step mode set DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Gate step not supported DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with system P1INVALID Invalid gate step mode See also StartAcquisition GetDDGStepMode SetDDGStepCoefficients GetDDGStepCoefficients SetDDGTimes unsigned int WINAPI SetDDGTimes double t0 double t1 double t2 Description This function sets the properties of the gate pulse t0 has a resolution of 16 nanoseconds whilst t1 and t2 have a resolution of 25 picoseconds Parameters double t0 output A delay in nanoseconds double t1 gate delay in picoseconds double t2 p
24. AVAILABLE Function not supported for operating system GetPhosphorStatus SECTION 11 Page 273 ANDOR FUNCTIONS SetPhotonCounting unsigned int WINAPI SetPhotonCounting int state Description Parameters Return See also This function activates the photon counting option int state ON OFF switch for the photon counting option Valid values 0 to switch photon counting OFF 1 to switch photon counting ON unsigned int DRV SUCCESS photon counting option accepted DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with card SetPhotonCountingThreshold SetPhotonCountingDivisions unsigned int WINAPI SetPhotonCountingDivisions unsigned long noOfDivisions long divisions Description Parameters Return See also This function sets the thresholds for the photon counting option unsigned long noOfDivisions number of thresholds to be used long divisions threshold levels unsigned int DRV SUCCESS Thresholds accepted P1INVALID Number of thresholds outside valid range DRV P2INVALID Thresholds outside valid range DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with card DRV_NOT_SUPPORTED Feature not supported SetPhotonCounting GetNumberPhotonCountingDivisions SECTION 11 Page 274 ANDOR FUNCTIONS SetPhotonCountingThreshold u
25. As the clocks in the Image area are not actively shifting the charge the mobility of the charge will be low and you may not see any effect However when you consider that more than one pixel in any given column could be exposed to 10000 counts per 100us the chance of corrupting data is correspondingly increased Changing the readout rate to 1 microsecond per pixel will greatly decrease the possibility of data corruption due to the reduced time to read out the image Reducing the amount of light falling on the CCD and increasing the exposure time accordingly will also reduce the possibility of data corruption SECTION 4 Page 53 ANDOR ek ACQUISITION MODES By default the system is set to non Frame Transfer mode To set the chip operation mode to Frame Transfer call SetFrameTransferMode 1 To switch back to non frame transfer mode call SetFrameTransferMode 0 To fully define a Frame Transfer acquisition you will need to supply the following information e Exposure Time Time in seconds during which the CCD collects light prior to readout Set via the SetExposureTime function e Number of Accumulations Number of scans you want to add together to create each member of your kinetic series The default value of 1 means that each member of the kinetic series will consist of a single scan Set via the SetNumberAccumulations function e Number in Kinetic Series Number of scans or accumulated scans you specify to be in your
26. Gain mode Parameters Int gain current EM gain setting Return DRV_SUCCESS Gain returned DRV_NOT_INITIALIZED System not initialized DRV_ERROR_ACK Unable to communicate with card GetEMGainRange unsigned int WINAPI GetEMGainRange int low int high Description Returns the minimum and maximum values of the current selected EM Gain mode and temperature of the sensor Parameters int low lowest gain setting int high highest gain setting Return DRV_SUCCESS Gain range returned DRV_NOT_INITIALIZED System not initialized GetExternalTriggerTermination unsigned int WINAPI GetExternalTriggerTermination at_u32 Termination Description This function can be used to get the current external trigger termination mode Parameters at u32 Termination trigger termination option Valid values 0 50 ohm 1 hi Z SECTION 11 Page 146 ANDOR Ce FUNCTIONS Return unsigned int DRV_SUCCESS Termination returned DRV_NOT_INITIALIZED System not initialized DRV_NOT_SUPPORTED Trigger termination not supported DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with system DRV_P1INVALID Termination has invalid memory address See also GetCapabilities SetExternalTriggerTermination GetFastestRecommendedVSSpeed unsigned int WINAPI GetFastestRecommendedVSSpeed int index float speed Description As your Andor SDK system may be capable of operating at more than one vertical shift speed this function
27. IsCoolerOn 194 IsCountConvertModeAvailable 194 IsInternalMechanicalShutter 194 IsAmplifierAvailable 195 IsPreAmpGainAvailable 195 TABLE OF CONTENTS Page 6 ANDOR TABLE OF CONTENTS IsTriggerModeAvailable 196 Merge 196 OA_AddMode 197 OA_DeleteMode 197 OA_EnableMode 198 OA_GetFloat 198 OA Getlnt 199 OA GetModeAcqParams 199 OA GetNumberOfAcqParams 200 OA GetNumberOfPreSetModes 200 OA GetNumberOfUserModes 200 OA GetPreSetModeNames 201 OA GetsString 201 OA GetUserModeNames 202 OA Initialize 202 OA SetFloat 203 OA Setlnt 203 OA SetString 204 OA WriteToFile 204 OutAuxPort 205 PrepareAcquisition 206 PostProcessCountConvert 207 PostProcessDataAveraging 207 PostProcessNoiseFilter 209 PostProcessPhotonCounting 210 SaveAsBmp 211 SaveAsCommentedSif 212 SaveAsEDF 212 SaveAsFITS 213 SaveAsRaw 213 SaveAsSif 214 SaveAsSPC 215 SaveAsTiff 215 SaveAsTiffEx 216 SaveEEPROMTOoFile 217 SaveToClipBoard 217 SelectDevice 217 SendSoftwareTrigger 217 SetAccumulationCycleTime 218 SetAcqStatusEvent 218 SetAcquisitionMode 219 SetAcquisitionType 219 SetADChannel 219 SetAdvancedTriggerModeState 220 SetBackground 221 SetBaselineClamp 221 SetBaselineOffset 221 SetCameraLinkMode 222 SetCameraStatusEnable 223 SetChargeShifting 223 SetComplexlmage 224 SetCoolerMode 225 SetCountConvertMode 226 SetCountConvertWavelength 226 SetCropMode 227 SetCurrentCamera 228 SetCustomTrackHBin 228 TABLE OF CONTENTS Page 7 ANDOR TABLE
28. Linux Version 2 93 30005 0 New features e None Bug fixes e Fix for the SetDMAParameters function for USB systems e Fix for temperature rate control to ensure the temperature stabilizes Version 2 93 30004 0 New features e None Bug fixes SECTION 1 Page 14 ANDOR INTRODUCTION e Increased the cooling rate for DF8 cameras to 4 degrees min instead of 3 Added SetChargeShifting to C library e Fix for the GetReadOutTime being incorrect for iXon Ultra Version 2 93 30000 0 New features e Adding function GetShutterMinTimes to get minimum times allowed for shutter open and close operations e x64 shamrock SDK Bug fixes e Updated Labview Postprocessing Vis for 32 and 64 bit Compatible with 7 1 and greater e Change min shutter operation to ignore open and close times if Always open or always closed e Fixed temperature rate control to round the set temperature to the nearest whole number as it was causing difficulties when the rate was close to the tolerence Version 2 92 30008 0 New features e Added CameraLink Functionality for iXon Ultra Bug fixes e USBistar Calculation incorrect for minimum exposure time e Fix for horizontal image shift when taking subimages with Ultra e iXon Ultra fix for TTL IO control iXon Ultra multitrack fixes e Improvements to iXon Ultra FVB mode e Fix for isolated crop mode with iXon Ultra e Fixed acquisition delay with multiple iXon Ultra systems e Fixes for software trigger
29. MaximagesPerDMA float SecondsPerDMA Description Parameters Return In order to facilitate high image readout rates the controller card may wait for multiple images to be acquired before notifying the SDK that new data is available Without this facility there is a chance that hardware interrupts may be lost as the operating system does not have enough time to respond to each interrupt The drawback to this is that you will not get the data for an image until all images for that interrupt have been acquired There are 3 settings involved in determining how many images will be acquired for each notification DMA Interrupt of the controller card and they are as follows 1 The size of the DMA buffer gives an upper limit on the number of images that can be stored within it and is usually set to the size of one full image when installing the software This will usually mean that if you acquire full frames there will never be more than one image per DMA 2 A second setting that is used is the minimum amount of time SecondsPerDMA that should expire between interrupts This can be used to give an indication of the reponsiveness of the operating system to interrupts Decreasing this value will allow more interrupts per second and should only be done for faster pcs The default value is 0 035 30ms finding the optimal value for your pc can only be done through experimentation 3 The third setting is an overide to the number of imag
30. OA BUFFER FULL See also OA GetUserModeNames This function will return the number of modes defined in the User file The user defined unsigned int const NumberOfModes The number of modes in the user file All parameters accepted Null number of modes Invalid pointer Number of modes exceeds limit SECTION 11 Page 200 ANDOR FUNCTIONS OA_GetPreSetModeNames unsigned int WINAPI OA GetPreSetModeNames char ListOfModes Description Parameters Return See also This function will return the available mode names from the Preset file The mode and the Preset file must exist The user must allocate enough memory for all of the acquisition parameters char ListOfModes user allocated array of characters for storage of the mode names Mode names will be delimited by a unsigned int DRV SUCCESS All parameters accepted DRV P1INVALID Null list of modes DRV OA NULL ERROR Invalid pointer OA GetNumberOfPreSetModes OA GetString unsigned int WINAPI OA GetString const char const ModeName const char const ModeParam char StringValue const unsigned int StringLen Description Parameters Return See also This function is used to get the values for string type acquisition parameters Values are retrieved from memory for the specified mode name const char const ModeName The name of the mode for which an acquisition parameter will be retrieved const char const ModePa
31. OF CONTENTS SetDACOutputScale 229 SetDACOutput 229 SetDataType 230 SetDDGAddress 230 SetDDGExternalOutputEnabled 230 SetDDGExternalOutputPolarity 231 SetDDGExternalOutputStepEnabled 231 SetDDGExternalOutputTime 232 SetDDGGain 232 SetDDGGateStep 232 SetDDGGateTime 233 SetDDGInsertionDelay 233 SetDDGIntelligate 234 SetDDGIOC 234 SetDDGIOCFrequency 235 SetDDGlOCNumber 236 SetDDGIOCPeriod 236 SetDDGIOCTrigger 237 SetDDGLiteControlByte 237 SetDDGLiteGlobalControlByte 237 SetDDGLitelnitialDelay 237 SetDDGLitelnterPulseDelay 237 SetDDGLitePulsesPerExposure 237 SetDDGLitePulseWidth 237 SetDDGOpticalWidthEnabled 239 SetDDGStepCoefficients 239 SetDDGStepMode 240 SetDDGTimes 240 SetDDGTriggerMode 241 SetDDGVariableGateStep 241 SetDDGWidthStepCoefficients 242 SetDDGWidthStepMode 242 SetDelayGenerator 243 SetDMAParameters 244 SetDriverEvent 245 SetDualExposureMode 246 SetDualExposureTimes 246 SetEMAdvanced 247 SetEMCCDGain 247 SetEMClockCompensation 248 SetEMGainMode 248 SetExposureTime 248 SetExternalTriggerTermination 249 SetFanMode 249 SetFastKinetics 250 SetFastKineticsEx 251 SetFastExtTrigger 252 SetFilterMode 252 SetFilterParameters 252 SetFKVShiftSpeed 253 SetFPDP 253 SetFrameTransferMode 253 SetFrontEndEvent 254 SetFulllmage 254 SetFVBHBin 255 SetGain 256 SetGate 256 TABLE OF CONTENTS Page 8 ANDOR TABLE OF CONTENTS SetGateMode 257 SetHighCapacity 258 SetHorizontalSpeed 258 SetHSSpeed 259 Setlmage 2
32. Pre Amp Gains The first step in this process is to determine the following e Number of A D channels using the GetNumberADChannels function e Number of output amplifiers using the GetNumberAmp function e Maximum number of pre amp gains using the GetNumberPreAmpGains function NOTE Not all PRE AMP gains are available for each horizontal shift speed The IsPreAmpGainAvailable function is used to determine which are valid for a particular horizontal shift speed and this will be explained later The bit depth of each A D channel can be found using the GetBitDepth function Once this information has been obtained the next step is to find the number of available horizontal shift speeds for each output amplifier on each A D channel using the GetNumberHSSpeeds function Following this the value of each horizontal shift speed can be found using the GetHSSpeed function Each horizontal shift speed has an associated number of valid pre amp gains The next step is to obtain the value of each pre amp gain using the GetPreAmpGain function Not all pre amp gains are available for each horizontal shift speed so using the IsPreAmpGainAvailable function it is possible to check which pre amp gains are valid Once the information has been retrieved the relevant selections can be made using the functions that follow e SetADChannel e SetOutputAmplifier e SetHSSpeed e SetPreAmpGain SECTION 9 Page 77 ANDOR es SPECIAL GUIDES An example of the ps
33. a pulsed source you will need to use a shutter to avoid streaking the spectra during the binning process To set up a Random Track acquisition you need to call the following functions SetReadMode 2 int position 6 position 0 20 position 1 30 end of track 1 11 rows height position 2 40 start of track 2 position 3 40 end of track 2 1 row height position 4 100 start of track 3 position 5 150 end of track 3 51 rows height SetRandomTracks 3 position The SetRandomtTracks function validates all the entries and then makes a local copy of the tracks positions For the array of tracks to be valid the track positions MUST be in ascending order NOTES 1 A track of 1 row in height will have the same start and end positions 2 Before using Random Track mode with fiber bundles it is often useful to acquire a Full Resolution Image of the output 3 Having observed the vertical positions of the individual spectra set the Random Track mode accordingly 4 Imaging spectrographs vertically invert input light i e light from the top fiber will fall on the bottom track on the CCD chip SECTION 3 Page 37 ANDOR Cea READOUT MODES Image In Image mode the CCD is operated much like a camera In this mode you get a measured value for each pixel on the CCD in effect allowing you to take a picture of the light pattern falling on the pixel matrix of the CCD To prevent smearing the image l
34. algorithm to use 0 for a 2x2 matrix demosaic algorithm or 1 for a 3x3 one The CYMG CCD pattern can be broken into cells of 2x4 pixels e g e iXPhase and iYPhase store what colour is the bottom left pixel iBackground sets the numerical value to be removed from every pixel in the input image before demosaicing is done WORD grey pointer to image to demosaic WORD red pointer to the red plane storage allocated by the user WORD green pointer to the green plane storage allocated by the user WORD blue pointer to the blue plane storage allocated by the user ColorDemosaiclInfo info pointer to demosaic information structure unsigned int DRV SUCCESS Image demosaiced DRV_P1INVALID Invalid pointer i e NULL DRV_P2INVALID Invalid pointer i e NULL DRV P3INVALID Invalid pointer i e NULL DRV_P4INVALID Invalid pointer i e NULL DRV_P5INVALID One or more parameters in info is out of range GetMostRecentColorlmage16 WhiteBalance SECTION 11 Page 100 ANDOR FUNCTIONS EnableKeepCleans unsigned int WINAPI EnableKeepCleans int mode Description This function is only available on certain cameras operating in FVB external trigger mode It determines if the camera keep clean cycle will run between acquisitions When keep cleans are disabled in this way the exposure time is effectively the exposure time between triggers The Keep Clean cycle is enabled by default The feature capability AC FEA
35. all times e g if you are taking a series of acquisitions with a pulsed source with little or no background illumination Hold Closed If the shutter mode is set to Hold Close the shutter remains closed before during and after any data acquisition Choose this option if you wish to take an acquisition in darkness e g if you are acquiring a background scan SECTION 7 Page 65 ANDOR 97 SHUTTER CONTROL SHUTTER TYPE The shutter control line is a TTL compatible pulse which can be either active high or active low to allow the control of an external shutter NOTE If the camera has an internal shutter the function IsInternalMechanicalShutter can be used to test this but cannot control the internal and external shutter independently check the capability AC FEATURES SHUTTEREX then the TTL pulse will always be active high e f you set the shutter type to TTL High with SetShutter or SetShutterEx the Andor SDK will cause the output voltage to go high to open the shutter e f you set the shutter type to TTL Low with SetShutter or SetShutterEx the Andor SDK will cause the output voltage to go low to open the shutter For Classic systems this pulse will be sent through the Andor PCI card For other systems this pulse will be sent through the shutter SMB connector on the camera The documentation supplied by the shutter manufacturer will advise the user whether your shutter opens at a high or a low TTL level NO
36. be used to determine if this option is currently active Parameters at_u32 Index index of external output at u32 Enabled current state of external output track step 0 Off 1 On Return unsigned int DRV SUCCESS State returned DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED External outputs not supported DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with system DRV_P1INVALID Invalid external output index DRV_P2INVALID Enabled has invalid memory address See also GetCapabilities GetDDGExternalOutputEnabled SetDDGExternalOutputStepEnabled NOTE Available on USB iStar GetDDGExternalOutputTime unsigned int WINAPI GetDDGExternalOutputTime at u32 Index at u64 Delay at u64 Width Description This function can be used to find the actual timings for a particular external output Parameters at u32 Index index of external output at u64 Delay actual external output delay time in picoseconds at u64 Width actual external output width time in picoseconds Return unsigned int DRV SUCCESS Timings returned DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED External outputs not supported DRV ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with system P1INVALID Invalid external output index DRV_P2INVALID Delay has invalid memory address DRV PSINVALID Width has invalid memory address See also GetCapabilities GetDDGExternalOutputEn
37. camera DRV P1INVALID Invalid threshold Filter GetThreshold GetAcquiredData unsigned int WINAPI GetAcquiredData at 32 arr unsigned long size Description Parameters Return See also This function will return the data from the last acquisition The data are returned as long integers 32 bit signed integers The array must be large enough to hold the complete data set at 32 arr pointer to data storage allocated by the user unsigned long size total number of pixels unsigned int DRV SUCCESS Data copied DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with card DRV_P1INVALID Invalid pointer i e NULL DRV_P2INVALID Array size is incorrect DRV NO NEW DATA No acquisition has taken place GetStatus StartAcquisition GetAcquiredData16 GetAcquiredData16 unsigned int WINAPI GetAcquiredData16 WORD arr unsigned long size Description Parameters Return 16 bit version of the GetAcquiredData function The must be large enough to hold the complete data set WORD arr pointer to data storage allocated by the user long size total number of pixels unsigned int DRV SUCCESS Data copied DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with card P1INVALID Invalid pointer i e NULL DRV P2INVALID Array size isincorrec
38. compatible please download the iCam compatibility checker from andor com It will operate in Software and External trigger mode with both Frame Transfer and Non Frame Transfer mode The idea behind this is that the SDK puts the camera into a heightened state of readiness and when a trigger comes either software or hardware the acquisition can be taken immediately If you hardware is compatible and needs to be upgraded please contact productsupport andor com for a further application which will upgrade your system SECTION 9 Page 84 ANDOR SPECIAL GUIDES iCam technology is a combined firmware and software innovation that has been incorporated into Andor s EMCCD imaging cameras iCam offers enhanced performance for acquisitions whether software triggered or hardware externally triggered with absolute minimal overheads It allows for faster frame rates in software by dedicated timing patterns that eliminate unnecessary overhead times This alongside the bi directional communication between camera and PC facilitates unparalleled synchronization with other peripheral equipment A ring mode offers the capacity to use up to 16 different timing patterns uploaded into the camera head thus trigger events can yield virtually instantaneous switching between exposure channels This new functionality has been added to the Run Till Abort acquisition mode and currently will only operate with Image readout mode Cameras must contai
39. example retrieves the number of horizontal speeds allowed and their actual values in microseconds Finally it selects the fastest speed as follows GetNumberHSSpeeds 0 0 amp a first A D request data speeds for I 0 a l GetHSSpeed 0 0 1 amp speed l SetHSSpeed 0 0 Fastest speed SECTION 6 Page 64 ANDOR e SHUTTER CONTROL SECTION 7 SHUTTER CONTROL SHUTTER MODES In the sections on Acquisition modes and Readout modes the use of a shutter was highlighted to prevent the smearing of data Smearing occurs if light is allowed to fall on to the CCD while the pixel charges are being binned into the shift register prior to readout The Andor system has a dedicated shutter control line that ensures that the shutter is correctly operated at all times The SetShutter and SetShutterEx functions provide you with a selection of options that determine when and how a shutter should be used Fully Auto Fully Auto is the simplest shutter mode because it leaves all shuttering decisions to the Andor system The shutter opens and closes automatically in accordance with any acquisition parameters you have set This option will automatically provide suitable shuttering for the majority of data acquisitions Hold Open If the shutter mode is set to Hold Open the shutter will be open before during and after any data acquisition Choose this option if you wish to take a series of acquisitions with the shutter opened at
40. in card Parameters int port Number of AUX in port on Andor card Valid Values 1 to 4 int state current state of port 0 OFF LOW all otherON HIGH Return unsigned int DRV SUCCESS AUX read DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress VXDNOTINSTALLED VxD not loaded DRV ERROR ACK Unable to communicate with card DRV_P1INVALID Invalid port id See also OutAuxPort SECTION 11 Page 192 ANDOR ee FUNCTIONS Initialize unsigned int WINAPI Initialize char dir Description This function will initialize the Andor SDK System As part of the initialization procedure on some cameras i e Classic iStar and earlier iXion the DLL will need access to a DETECTOR INI which contains information relating to the detector head number pixels readout speeds etc If your system has multiple cameras then see the section Controlling multiple cameras Parameters char dir Path to the directory containing the files Return unsigned int DRV SUCCESS Initialisation successful DRV VXDNOTINSTALLED VxD not loaded INIERROR Unable to load DETECTOR INI DRV COFERROR Unable to load COF DRV FLEXERROR Unable to load RBF DRV ERROR ACK Unable to communicate with card DRV ERROR FILELOAD Unable to load COF or RBF files DRV ERROR PAGELOCK Unable to acquire lock on requested memory DRV USBERROR Unable to detect USB device or not USB2 0 DRV ERROR NOCAMERA No camera found
41. initialized DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with card NOTE Available in iStar GetDDGTTLGateWidth unsigned int WINAPI GetDDGTTLGateWidth at u64 opticalWidth at_u64 ttlWidth Description This function can be used to get the TTL gate width which corresponds to a particular optical gate width Parameters at u64 opticalWidth optical gate width in picoseconds at u64 ttlWidth TTL gate width in picoseconds Return unsigned int DRV SUCCESS Timings returned DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Optical gate width not supported DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with system DRV_P2_INVALID tthWidth has invalid memory address See also GetCapabilities SetDDGOpticalWidthEnabled SECTION 11 Page 143 ANDOR FUNCTIONS GetDDGWidthStepCoefficients unsigned int WINAPI GetDDGWidthStepCoefficients at u32 mode double p1 double p2 Description This function will return the coefficients for a particular gate width step mode Parameters at u32 mode the gate step mode Valid values 0 constant 1 exponential 2 logarithmic 3 linear Return unsigned int DRV SUCCESS Gate step coefficients returned DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Gate step not supported DRV ACQUIRING DRV ERROR ACK DRV_P1INVALID DRV_P2_INVALID DRV_P3_INVALID Acquisition in progress Unable to commu
42. minutes to stabilize and with the appropriate programming techniques the user should be able to set up other tasks as illustrated in the C examples Once the CCD sensor temperature has stabilized you can start acquiring data SECTION 10 Page 92 ANDOR ena EXAMPLES from 4 SetAcquisitionMode SetReadoutMode SetShutter SetExposureTimer SetTriggerMode SetAccumulationCycyletime SetNumberAccumulations SetNumberkinetics SetKineticCycletime GetAcquisitiontimings SetHSSpeed SetvSSpeed Ghange StartAcquisition Tess GetStatus d NO Is Data 8 es Fequisition H complete 4 9 GetAcquiredData i i VNLT 40 Acquisition 5 The acquisition parameters are programmed to match the specifications of the user e g acquisition mode single scan etc readout mode full vertical binning etc and the trigger mode Internal etc 6 You are now ready to start an acquisition 7 8 The current acquisition status is periodically monitored to check if the data acquisition is complete 9 After a successful data acquisition the data is transferred from the Andor driver into the application 10 At this point the user may choose to capture a new acquisition or not 11 Yes capture a new scan The user may decide to alter the acquisition set up e g change the exposure time or simply use the current parameters SDK SECTION 10
43. on Luca R cameras always cooled to 20 SECTION 11 Page 225 ANDOR ee FUNCTIONS SetCountConvertMode unsigned int WINAPI SetCountConvertMode int mode Description This function configures the Count Convert mode Parameters int mode 0 Data in Counts 1 Data in Electrons 2 Data in Photons Return unsigned int DRV SUCCESS Count Convert mode set DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV NOT SUPPORTED Count Convert not available for this camera DRV NOT AVAILABLE Count Convert mode not available with current settings P1INVALID Mode parameter was out of range See also GetCapabilities SetCountConvertWavelength NOTE Only available on Clara iXon 3 and iXon Ultra Modes 1 and 2 are only available when e Baseline Clamp active e Isolated crop mode off e EM gain must be greater than or equal to 10 and the lowest pre amp not be selected e For Clara systems the extended infra red mode can not be used SetCountConvertWavelength unsigned int WINAPI SetCountConvertWavelength float wavelength Description This function configures the wavelength used in Count Convert mode Parameters float wavelength wavelength used to determine QE Return unsigned int DRV SUCCESS Count Convert wavelength set DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_NOT_AVAILABLE Count Convert not available for this camera P1INVALID Wavelen
44. palette The filename of a palette file PAL for applying color to the bitmap long ymin long ymax Range of data values that palette will be scaled across If set to 0 0 the palette will scale across the full range of values Return unsigned int DRV SUCCESS Data successfully saved as bitmap BRUNO INITIALIZED System not initialized DRV ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with card DRV P1INVALID Path invalid File too large to be generated in memory DRV ERROR PAGELOCK See also SaveAsSif SaveAsEDF SaveAsFITS SaveAsRaw SaveAsSPC SaveAsTiff NOTE If the last acquisition was in Kinetic Series mode each image will be saved in a separate Bitmap file The filename specified will have an index number appended to it indicating the position in the series SECTION 11 Page 211 ANDOR FUNCTIONS SaveAsCommentedSif unsigned int WINAPI SaveAsCommentedSif char path char comment Description Parameters Return See also This function will save the data from the last acquisition into a file The comment text will be added to the user text portion of the Sif file char path pointer to a filename specified by the user char comment comment text to add to the sif file unsigned int DRV_SUCCESS Data saved DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with card DRV_P1INVALID Invalid filename S
45. pixel shift Return unsigned int DRV SUCCESS Speed returned DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV_P1INVALID Invalid index See also GetNumberVerticalSpeeds SetVerticalSpeed NOTE Deprecated by GetVSSpeed SECTION 11 Page 186 ANDOR FUNCTIONS GetVirtualDMAAddress unsigned int WINAPI GetVirtualDMAAddress void Address1 void Address2 Description THIS FUNCTION IS RESERVED GetVSAmplitudeFromString unsigned int WINAPI GetVSAmplitudeFromString char text int index Description Parameters Return See also This Function is used to get the index of the Vertical Clock Amplitude that corresponds to the string passed in char text String to test Valid values Normal 1 2 3 4 int index Returns the Index of the VSAmplitude that matches string passed in unsigned int DRV_SUCCESS Vertical Clock Amplitude string Index returned DRV NOT INITIALIZED System not initialized DRV_P1INVALID Invalid text DRV P2INVALID Invalid index pointer GetVSAmplitudeString GetVSAmplitudeValue GetVSAmplitudeString unsigned int WINAPI GetVSAmplitudeString int index char text Description Parameters Return See also This Function is used to get the Vertical Clock Amplitude string that corresponds to the index passed in int index Index of VS amplitude required Valid values to GetNumberVSAmplitudes 1 ch
46. the next acquisition such as moving an external stage or even to change the exposure time Note that not all systems support Software Trigger mode To check if these enhanced features are available with your system use the function GetCapabilities and check the ulTriggerModes variable for bit 3 AC TRIGGERMODE CONTINUOUS being set If this bit is set and the system is configured with the following modes e Head mode set to image e Acquisition mode set to Run till abort e Trigger mode set to 10 Then the SendSoftwareTrigger command will cause the acquisition to be taken It is recommended that you call IsTriggerModeAvailable 10 to check if your system is set up to use the SendSoftwareTrigger function If a SendSoftwareTrigger command is issued when the camera is not ready for it it will be ignored and an appropriate return code returned The extra functionality of pre loading exposures up to a maximum of 16 to the camera is configured with the SetRingExposureTimes command When the first acquisition is requested SendSoftwareTrigger the camera will take an acquisition with the first exposure in its list When the second acquisition is requested the next exposure in the list will be used and so on When the camera uses the final exposure in its list it will loop to the beginning again Notes on Frame Transfer e On Frame Transfer systems the Frame Transfer mode can be activated or deactivated Currently not all cameras can take adv
47. the user software an opportunity to perform other actions that will not affect the readout of the current acquisition HANDLE Event Win32 event handle unsigned int DRV_SUCCESS Event set DRV_NOT_INITIALIZED System not initialized DRV_NOT_AVAILABLE Function not supported for operating system GetFrontEndStatus SetFulllmage unsigned int WINAPI SetFulllmage int hbin int vbin Description Parameters Return See also Deprecated see Note This function will set the horizontal and vertical binning to be used when taking a full resolution image int hbin number of pixels to bin horizontally int vbin number of pixels to bin vertically unsigned int DRV SUCCESS Binning parameters accepted NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_P1INVALID Horizontal binning parameter invalid DRV_P2INVALID Vertical binning parameter invalid SetReadMode NOTE Deprecated by Setlmage SECTION 11 Page 254 ANDOR FUNCTIONS SetFVBHBin unsigned int WINAPI SetFVBHBin int bin Description This function sets the horizontal binning used when acquiring in Full Vertical Binned read mode Parameters Int bin Binning size Return unsigned int DRV_SUCCESS Binning set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress P1INVALID Invalid binning size See also SetReadMode NOTE 1 If the detector width is not a multiple of the binning DRV
48. unsigned int WINAPI Filter GetThreshold float threshold Description Parameters Return See also Returns the current Noise Filter threshold value float threshold The current threshold value unsigned int DRV SUCCESS Threshold returned DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Noise Filter processing not available for this camera P1INVALID Invalid threshold i e NULL pointer Filter SetThreshold Filtrer SetAveragingFactor unsigned int WINAPI Filter SetAveragingFactor int averagingFactor Description Parameters Return See also Sets the averaging factor int averagingFactor The averaging factor to use unsigned int DRV SUCCESS Averaging factor set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV_P1INVALID Invalid averagingFactor Filter GetAveragingFactor Filter_SetAveragingFrameCount unsigned int WINAPI Filter_SetAveragingFrameCount int frames Description Parameters Return See also Sets the averaging frame count int frames The averaging frame count to use unsigned int DRV_SUCCESS Averaging frame count set DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_P1INVALID Invalid frame count Filter GetAveragingFrameCount SECTION 11 Page 103 ANDOR ee FUNCTIONS Filter_SetDataAveragingMode unsigned int WINAPI Filter_SetDataAveragingMode int
49. unsigned int WINAPI GetAdjustedRingExposureTimes int inumTimes float fptimes Description Parameters Return See also This function will return the actual exposure times that the camera will use There may be differences between requested exposures and the actual exposures int inumTimes Numbers of times requested float fptimes Pointer to an array large enough to hold _inumTimes floats unsigned int DRV SUCCESS Success NOT INITIALIZED System not initialized DRV P1INVALID Invalid number of exposures requested GetNumberRingExposureTimes SetRingExposureTimes SECTION 11 Page 107 ANDOR e FUNCTIONS GetAIIDMAData unsigned int WINAPI GetAIIDMAData at 32 arr unsigned long size Description THIS FUNCTION IS RESERVED GetAmpDesc unsigned int WINAPI GetAmpDesc int index char name int len Description This function will return a string with an amplifier description The amplifier is selected using the index The SDK has a string associated with each of its amplifiers The maximum number of characters needed to store the amplifier descriptions is 21 The user has to specify the number of characters they wish to have returned to them from this function Parameters Int index The amplifier index char name A user allocated array of characters for storage of the description int len The length of the user allocated character array Return unsigned int DRV SUCCESS Description retu
50. valid image long validlast index of the last valid image Return unsigned int DRV SUCCESS Images have been copied into array DRV NOT INITIALIZED System not initialized DRV ERROR ACK Unable to communicate with card DRV GENERAL ERRORS The series is out of range PSINVALID Invalid pointer i e NULL PAINVALID Array size is incorrect DRV NO NEW DATA There is no new data yet See also Getlmages16 GetNumberNewlmages SECTION 11 Page 155 ANDOR e FUNCTIONS Getlmages16 unsigned int WINAPI Getlmages16 long first long last arr unsigned long size long validfirst long validlast Description 16 bit version of the Getlmages function Parameters long first index of first image in buffer to retrieve long last index of last image in buffer to retrieve WORD arr pointer to data storage allocated by the user unsigned long size total number of pixels long validfirst index of the first valid image long validlast index of the last valid image Return unsigned int DRV SUCCESS Images have been copied into array DRV NOT INITIALIZED System not initialized DRV ERROR ACK Unable to communicate with card DRV GENERAL ERRORS The series is out of range DRV P3INVALID Invalid pointer i e NULL DRV PAINVALID Array size is incorrect DRV NO NEW DATA There is no new data yet See also Getlmages GetNumberNewlmages GetlmagesPerDMA unsigned int WINAPI GetlmagesPerDMA unsigned long im
51. will return the fastest recommended speed available The very high readout speeds may require an increase in the amplitude of the Vertical Clock Voltage using SetVSAmplitude This function returns the fastest soeed which does not require the Vertical Clock Voltage to be adjusted The values returned are the vertical shift speed index and the actual speed in microseconds per pixel shift Parameters Int index index of the fastest recommended vertical shift speed float speed speed in microseconds per pixel shift Return unsigned int DRV_SUCCESS Speed returned DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress See also GetVSSpeed GetNumberVSSpeeds SetVSSpeed GetFIFOUsage unsigned int WINAPI GetFIFOUsage int FlFOusage Description THIS FUNCTION IS RESERVED GetFilterMode unsigned int WINAPI GetFilterMode int mode Description This function returns the current state of the cosmic ray filtering mode Parameters int mode current state of filter 0 OFF 2 ON Return unsigned int DRV_SUCCESS Filter mode returned DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress See also SetFilterMode SECTION 11 Page 147 FUNCTIONS SDK SECTION 11 Page 148 ANDOR FUNCTIONS GetFKExposureTime unsigned int WINAPI GetFKExposureTime float time Description Parameters Return This function will return the current valid exposur
52. 1 Page 131 ANDOR ee FUNCTIONS GetCapabilities PCI Card Capabilities PCI Card Capabilities AndorCapabilities Member ulPCICard Description Maximum speed in Hz PCI controller card is capable of GetCapabilities Gain Features Available Gain Features Available AndorCapabilities Member ulEMGainCapabilit Capability AC EMGAIN 8BIT Description 8 bit DAC settable Bit 0 State 1 Capability AC EMGAIN 12BIT Description 12 bit DAC settable Bit 1 State 1 Capability AC EMGAIN LINEAR12 Description Gain setting represent a linear gain scale 12 bit DAC used internally Bit 2 State 1 Capability AC EMGAIN REAL12 Description Gain setting represents the real EM Gain value 12 bit DAC used internally Bit 3 State 1 SECTION 11 Page 132 ANDOR ee FUNCTIONS GetControllerCardModel unsigned int WINAPI GetControllerCardModel char controllerCardModel Description This function will retrieve the type of PCI controller card included in your system This function is not applicable for USB systems The maximum number of characters that can be returned from this function is 10 Parameters char controllerCardModel A user allocated array of characters for storage of the controller card model Return unsigned int DRV SUCCESS Name returned INITIALIZED System not initialized See also GetHeadModel GetCameraSerialNumber GetCameralnformation GetCapabilities GetCount
53. 16 0 0 0 CodeFile Pci_29k cof FlexFile pci_fpga rbf SECTION 13 Page 309 ANDOR DETECTOR INI Pixel 25 0 25 0 Cooling Vacuum FKVerticalShiftSpeed 16 0e 6 DV437 Format 512 512 DummyPixels 24 24 16 528 DataHShiftSpeed 16 1 2 16 32 DataVShiftSpeed 16 16 0 0 0 DummyHShiftSpeed 16 1 2 16 32 DummyVShiftSpeed 16 16 0 0 0 VerticalHorizontalTime 16 16 0 0 0 Pixel 13 0 13 0 Cooling Vacuum CodeFile pci 29k cof FlexFile2pci fpga rbf Type 1 Page 310 DV437 SECTION 13 ANDOR Cs DETECTOR INI CONTROLLER This section details the controller card ReadOutSpeeds ReadOutSpeeds a b c d Lists the readout speeds available on the specified plug in card These values are used in conjunction with the values specified in the head section to generate the final list of available speeds PipeLine PipeLine a b c d e f g h This lists the pipeline depth that must be used the microprocessor to synchronize the reading of the AD with the digitization process The actual value used is based on a number of factors and is beyond this discussion Type Type a This specifies whether the plug in card is ISA or PCI compatible Example CC 010 ReadOutSpeeds 1 2 16 32 PipeLine 2 1 1 1 0 0 0 0 Type PCI SECTION 13 Page 311
54. 2 ANDOR e DETECTOR INI SYSTEM This section has 3 entries that describe the controller head models and the mode for operation Each entry is described in more detail below e Controller gives the section name where the controller plug in card details can be found Further details on this section are given below e Head gives the section name where the detector head details can be found Further details on this section are given below e Operation this item related to the overall system type i e whether the system is a PDA CCD ICCD or InGaAs This item has the effect of changing the Acquisition dialog within the software so that only those options relating to the system type are displayed Possible values are as follows e 2 f or PDA e 3 for InGaAs e 4for CCD e 5 for ICCD EXAMPLE System Coniroller CC 010 Head DV437 Operation 4 SECTION 13 Page 303 ANDOR DETECTOR INI COOLING This section does not contain a fixed number of entries However each entry has the same basic structure and purpose The purpose being to tell the software the range of temperatures to offer the user and the range of temperature over which the system can measure The structure of each item is Itemname a b c d itemname a b c d Example Cooling Single 28 30 28 100 Three 20 60 28 100 Vacuum 20 100 28 100 Page 304 SECTION 13 ANDOR PAS DETECTOR INI DETECTOR
55. 2 which correspond to 8 bit 16 bit and color respectively char path The filename of the tiff Parameters char palette The filename of a palette file PAL for applying color to the tiff int position The number in the series should be 1 for a single scan int typ The type of tiff file to create Return unsigned int DRV SUCCESS Data successfully saved as tiff DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with card DRV P1INVALID Path invalid DRV P2INVALID Invalid palette file DRV PSINVALID position out of range DRV PAINVALID type not valid DRV ERROR PAGELOCK File too large to be generated in memory See also SaveAsSif SaveAsEDF SaveAsFITS SaveAsRaw SaveAsSPC SaveAsBmp SaveAsTiffEx SECTION 11 Page 215 ANDOR FUNCTIONS SaveAsTiffEx unsigned int WINAPI SaveAsTiffEx char path char palette int position int typ int mode Description Parameters Return See also This function saves the last acquisition as a tiff file which can be loaded into an imaging package This is an extended version of the SaveAsTiff function The palette parameter specifies the location of a PAL file which describes the colors to use in the tiff This file consists of 256 lines of ASCII text each line containing three numbers separated by spaces indicating the red green and blue component of the respective color value The parameter position can b
56. 5 ANDOR e FUNCTIONS GetVersionInfo unsigned int WINAPI GetVersionInfo AT_VersionInfold arr char szVersionInfo at_u32 ui32BufferLen Description This function retrieves version information about different aspects of the Andor system The information is copied into a passed string buffer Currently the version of the SDK and the Device Driver USB or PCI is supported Parameters AT Versionlnfold arr AT SDKVersion requests the SDK version information AT DeviceDriverVersion requests the device driver version char szVersionInfo A user allocated array of characters for storage of the information at u32 ui32BufferLen The size of the passed character array versionlnfo Return unsigned int DRV SUCCESS Information returned DRV NOT INITIALIZED System not initialized P1INVALID Invalid information type requested DRV P2INVALID Storage array pointer is NULL DRV PSINVALID Size of the storage array is zero See also GetHeadModel GetCameraSerialNumber GetCameralnformation GetCapabilities GetVerticalSpeed unsigned int WINAPI GetVerticalSpeed int index int speed Description Deprecated see Note As your Andor system may be capable of operating at more than one vertical shift speed this function will return the actual speeds available The value returned is in microseconds per pixel shift Parameters int index speed required Valid values to GetNumberVerticalSpeeds 1 int speed speed in microseconds per
57. 503 503 503 int hbin The selected horizontal binning int cropleft The selected crop left start position int cropbottom The selected crop bottom start position Page 264 Crop Bottom Start Position 240 224 208 192 160 128 254 252 249 254 252 249 SetlsolatedCropModeEx This function effectively reduces the dimensions of the CCD by excluding some rows or Crop Top Position 271 287 303 319 351 383 257 259 262 257 259 262 SECTION 11 ANDOR FUNCTIONS Return See also unsigned int DRV_SUCCESS DRV NOT INITIALIZED DRV_ACQUIRING DRV_P1INVALID DRV_P2INVALID DRV P3INVALID DRV PAINVALID DRV PSINVALID DRV_P6INVALID DRV_P7INVALID DRV_NOT_SUPPORTED GetDetector SetReadMode Parameters set System not initialized Acquisition in progress active parameter was not zero or one Invalid crop height Invalid crop width Invalid vertical binning Invalid horizontal binning Invalid crop left start position Invalid crop bottom start position Either the camera does not support isolated Crop mode or the read mode is invalid SECTION 11 Page 265 ANDOR FUNCTIONS SetKineticCycleTime unsigned int WINAPI SetKineticCycleTime float time Description Parameters Return See also This function will set the kinetic cycle time to the nearest valid value not less than the given value The actual time used is obtained by GetAcquisitionTimings Please refer to SECTIO
58. 60 SetlmageFlip 261 SetlmageRotate 262 SetlsolatedCropMode 263 SetlsolatedCropModeEx 264 SetKineticCycleTime 266 SetMCPGain 266 SetMCPGating 267 SetMessageWindow 267 SetMetaData 267 SetMultiTrack 268 SetMultiTrackHBin 269 SetMultiTrackHRange 269 SetMultiTrackScan 269 SetNextAddress 270 SetNextAddress16 270 SetNumberAccumulations 270 SetNumberkKinetics 270 SetNumberPrescans 271 SetOutputAmplifier 271 SetOverlapMode 272 SetPCIMode 273 SetPhosphorEvent 273 SetPhotonCounting 274 SetPhotonCountingDivisions 274 SetPhotonCountingThreshold 275 SetPixelMode 275 SetPreAmpGain 275 SetRandomTracks 276 SetReadMode 277 SetReadoutRegisterPacking 277 SetRegisterDump 277 SetRingExposureTimes 278 SetSaturationEvent 279 SetShutter 280 SetShutterEx 281 SetShutters 282 SetSifComment 282 SetSingleTrack 282 SetSingleTrackHBin 283 SetSpool 284 SetSpoolThreadCount 285 SetStorageMode 285 SetTECEvent 286 SetTemperature 286 SetTemperatureEvent 286 SetTriggerlnvert 287 SetTriggerLevel 287 SetTriggerMode 288 SetlODirection 289 SetlOLevel 289 SetUserEvent 290 SetUSGenomics 290 TABLE OF CONTENTS Page 9 ANDOR TABLE OF CONTENTS SetVerticalRowBuffer 290 SetVerticalSpeed 291 SetVirtualChip 291 SetVSAmplitude 292 SetVSSpeed 293 ShutDown 293 StartAcquisition 294 UnMapPhysicalAddress 295 WaitForAcquisition 296 WaitForAcquisitionByHandle 296 WaitForAcquisitionByHandleTimeOut 298 WaitForAcquisitionTimeOut 299 WhiteBalance 300 SECTI
59. 72 ANDOR FUNCTIONS SetPCIMode unsigned int WINAPI SetPCIMode int mode int value Description Parameters Return See also NOTE With the CCI23 card events can be sent when the camera is starting to expose and when it has finished exposing This function will control whether those events happen or not int mode currently must be set to 1 int value 0 to disable the events 1 to enable unsigned int DRV SUCCESS Acquisition mode set DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_P1INVALID Acquisition Mode invalid SetAcgStatusEvent SetCameraStatusEnable This is only supported by the CCI23 card The software must register its event via the SetAcqStatusEvent To specify which event the software is interested in use the SetCameraStatusEnable SetPhosphorEvent unsigned int WINAPI SetPhosphorEvent HANDLE Event Description Parameters Return See also This function passes a Win32 Event handle to the driver via which the driver can inform the user software that the phosphor has saturated or returned to a normal state To determine what event has actually occurred call the GetPhosphorStatus function This may give the user software an opportunity to perform other actions that will not affect the readout of the current acquisition HANDLE Event Win32 event handle unsigned int DRV SUCCESS Event set DRV NOT INITIALIZED System not initialized DRV NOT
60. 77 DRV INVALID MODE 20078 DRV INVALID FILTER 20079 DRV I2CERRORS 20080 DRV DRV I2CDEVNOTFOUND 20081 DRV I2CTIMEOUT 20082 DRV_P7INVALID 20083 DRV_USBERROR 20089 DRV_IOCERROR 20090 DRV_VRMVERSIONERROR 20091 DRV_USB_INTERRUPT_ENDPOINT_ERROR 20093 DRV_RANDOM_TRACK_ERROR 20094 DRV_INVALID_TRIGGER_MODE 20095 DRV_LOAD_FIRMWARE_ERROR 20096 DRV_DIVIDE_BY_ZERO_ERROR 20097 DRV_INVALID_RINGEXPOSURES 20098 DRV_BINNING_ERROR 20099 DRV_ERROR_NOCAMERA 20990 DRV_NOT_SUPPORTED 20991 DRV_NOT_AVAILABLE 20992 DRV_ERROR_MAP 20115 DRV_ERROR_UNMAP 20116 DRV_ERROR_MDL 20117 DRV_ERROR_UNMDL 20118 DRV_ERROR_BUFFSIZE 20119 DRV_ERROR_NOHANDLE 20121 DRV_GATING_NOT_AVAILABLE 20130 DRV_FPGA_VOLTAGE_ERROR 20131 DRV_BINNING_ERROR 20099 DRV_INVALID_AMPLIFIER 20100 DRV INVALID COUNTCONVERT MODE 20101 SECTION 12 Page 301 ANDOR e DETECTOR INI SECTION 13 DETECTOR INI DETECTOR INI EXPLAINED All systems shipped from Andor contain a configuration file called Detector ini This file is used to configure both the Andor software and hardware for the system It contains information regarding the CCD chip A Ds and cooling capabilities The file contains four sections The start of each section is denoted by name where name is the name of the section The following two sections are common to all detector ini files e System e Cooling The names of the remaining sections are given by entries in the System section SECTION 13 Page 30
61. A NOTE Deprecated by the following functions e Getlmages e GetMostRecentlmage e GetOldestlimage Data copied System not initialized Unable to communicate with card Invalid pointer i e NULL Array size is incorrect There is no new data yet SECTION 11 Page 165 ANDOR ee FUNCTIONS GetNewFloatData unsigned int WINAPI GetNewFloatData float arr unsigned long size Description THIS FUNCTION IS RESERVED GetNumberADChannels unsigned int WINAPI GetNumberADChannels int channels Description As your Andor SDK system may be capable of operating with more than one A D converter this function will tell you the number available Parameters int channels number of allowed channels Return unsigned int DRV SUCCESS Number of channels returned See also SetADChannel GetNumberAmp unsigned int WINAPI GetNumberAmp int amp Description As your Andor SDK system may be capable of operating with more than one output amplifier this function will tell you the number available Parameters int amp number of allowed channels Return unsigned int DRV SUCCESS Number of output amplifiers returned See also SetOutputAmplifier GetNumberAvailablelmages unsigned int WINAPI GetNumberAvailablelmages at 32 first at 32 last Description This function will return information on the number of available images in the circular buffer This information can be used with Getlmages to retrieve a series of images If any i
62. AC FEATURES TEMPERATUREDURINGACQUISITION Description It is possible to read the camera temperature during an acquisition with the GetTemperature function Bit 9 State 1 Capability AC FEATURES KEEPCLEANCONTROL Description It is possible to turn off keep cleans between scans Bit 10 State 1 Capability AC FEATURES DDGLITE Description Reserved for internal use Bit 11 State 1 Capability AC FEATURES FTEXTERNALEXPOSURE Description The combination of Frame Transfer and External Exposure modes is available Bit 12 State 1 Capability AC FEATURES KINETICEXTERNALEXPOSURE Description External Exposure trigger mode is available in Kinetic acquisition mode Bit 13 State 1 Capability AC FEATURES DACCONTROL Description Reserved for internal use Bit 14 State 1 SECTION 11 Page 130 ANDOR Je FUNCTIONS Capability AC FEATURES METADATA Description System supports metadata SetMetaData Bit 15 State 1 Capability AC FEATURES IOCONTROL Description Configurable IO s available See SetlOLevel Bit 16 State 1 Capability AC FEATURES PHOTONCOUNTING Description System supports photon counting See SetPhotonCounting Bit 17 State 1 Capability AC FEATURES COUNTCONVERT Description System supports Count Convert See SetCountConvertMode Bit 18 State 1 Capability AC FEATURES DUALMODE Description Dual exposure mode See SetDualExposureMode Bit 19 State 1 SECTION 1
63. AC SETFUNCTION VSAMPLITUDE Description The vertical clock voltage can be set with the SetVSAmplitude function Bit 6 State 1 Capability AC SETFUNCTION HIGHCAPACITY Description High capacity mode can be turned on or off with the SetHighCapacity function Bit 7 State 1 SECTION 11 Page 123 ANDOR e FUNCTIONS GetCapabilities Available Set Functions Continued Capability AC SETFUNCTION BASELINEOFFSET Description The baseline offset can be set with the SetBaselineOffset function Bit 8 State 1 Capability AC SETFUNCTION PREAMPGAIN Description The pre amp gain can be set with the SetPreAmpGain function Bit 9 State 1 Capability AC SETFUNCTION CROPMODE Description Crop mode can be selected using the SetCropMode or SetlsolatedCropMode functions Bit 10 State 1 Capability AC SETFUNCTION DMAPARAMETERS Description The DMA parameters can be set with the SetDMAParameters function Bit 11 State 1 Capability AC SETFUNCTION HORIZONTALBIN Description The horizontal binning can be set for the relative read mode Bit 12 State 1 See Note Capability AC SETFUNCTION MULTITRACKHRANGE Description The multitrack horizontal range can be set using the SetMultiTrackHRange function Bit 13 State 1 Capability AC SETFUNCTION RANDOMTRACKNOGAPS Description Random tracks can be set with no gaps inbetween with the SetRandomTracks or SetComplexlmage functions Bit 14 State 1 NOTE For
64. Andor SDK system is capable of operating at more than one fast kinetics vertical shift speed this function will return the actual number of speeds available Parameters int number number of allowed speeds Return unsigned int DRV SUCCESS Number of speeds returned DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress See also GetFKVShiftSpeedF SetFKVShiftSpeed NOTE Only available if camera is Classic or iStar GetNumberHorizontalSpeeds unsigned int WINAPI GetNumberHorizontalSpeeds int number Description Deprecated see Note As your Andor SDK system is capable of operating at more than one horizontal shift speed this function will return the actual number of speeds available Parameters int number number of allowed horizontal speeds Return unsigned int SECTION 11 Page 167 ANDOR DRV SUCCESS Number of speeds returned DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress See also GetHorizontalSpeed SetHorizontalSpeed NOTE Deprecated by GetNumberHSSpeeds SECTION 11 Page 168 ANDOR FUNCTIONS GetNumberHSSpeeds unsigned int WINAPI GetNumberHSSpeeds int channel int typ int speeds Description Parameters Return See also As your Andor SDK system is capable of operating at more than one horizontal shift speed this function will return the actual number of speeds available int channel the AD channel int typ o
65. BINNING ERROR will be returned from PrepareAcquisition and or StartAcquisition 2 For iDus it is recommended that you set horizontal binning to 1 SECTION 11 Page 255 ANDOR FUNCTIONS SetGain unsigned int WINAPI SetGain int gain Description Deprecated for SetMCPGain SetGate unsigned int WINAPI SetGate float delay float width float step Description This function sets the Gater parameters for an ICCD system The image intensifier of the Andor ICCD acts as a shutter on nanosecond time scales using a process known as gating Parameters float delay Sets the delay gt 0 between the TO and C outputs on the SRS box to delay nanoseconds float width Sets the width gt 0 of the gate in nanoseconds float step Sets the amount lt gt 0 in nanoseconds by which the gate position is moved in time after each scan in a kinetic series Return unsigned int DRV SUCCESS Gater parameters set DRV NOT INITIALIZED System not initialized DRV ERROR ACK Unable to communicate with card ACQUIRING Acquisition in progress DRV GPIBERROR Error communicating with GPIB card DRV P1INVALID Invalid delay DRV P2INVALID Invalid width DRV PSINVALID Invalid step See also SetDelayGenerator NOTE Available on ICCD SECTION 11 Page 256 ANDOR FUNCTIONS SetGateMode unsigned int WINAPI SetGateMode int gatemode Description Allows the user to control the photocathode gating mode Parameters int gatemode the gate mode
66. CAN DRV_ERROR_CHECK_SUM DRV_ERROR_FILELOAD DRV_UNKNOWN_FUNCTION DRV ERROR VXD INIT DRV ERROR ADDRESS DRV ERROR PAGELOCK ERROR PAGE UNLOCK ERROR BOARDTEST DRV ERROR ACK DRV ERROR UP FIFO DRV ERROR PATTERN ACQUISITION ERRORS BUFFER DOWNFIFO FULL PROC UNKNOWN INSTRUCTION ILLEGAL OP CODE KINETIC TIME NOT MET KINETIC TIME NOT MET ACCUM TIME NOT MET DRV NO NEW DATA DRV_SPOOLERROR DRV_SPOOLSETUPERROR DRV_TEMPERATURE_CODES DRV_TEMPERATURE_OFF DRV_TEMP_NOT_STABILIZED DRV_TEMPERATURE_ STABILIZED DRV_TEMPERATURE_NOT_REACHED DRV_TEMPERATURE_OUT_RANGE TEMPERATURE NOT SUPPORTED DRV TEMPERATURE DRIFT GENERAL ERRORS INVALID AUX NOTLOADED FPGAPROG FLEXERROR GPIBERROR DATATYPE DRIVER ERRORS ERROR 20001 20002 20003 20004 20005 20006 20007 20008 20009 20010 20011 20012 20013 20014 20015 20017 20018 20019 20020 20021 20022 20022 20023 20024 20026 20027 20033 20034 20035 20036 20037 20038 20039 20040 20049 20050 20051 20052 20053 20054 20064 20065 ERROR CODES SECTION 12 ERROR CODES CODE ERROR DRV P1INVALID 20066 DRV P2INVALID 20067 DRV PSINVALID 20068 DRV_P4INVALID 20069 DRV_INIERROR 20070 DRV_COFERROR 20071 DRV_ACQUIRING 20072 DRV_IDLE 20073 DRV_TEMPCYCLE 20074 DRV_NOT_INITIALIZED 20075 DRV PSINVALID 20076 DRV_P6INVALID 200
67. Clock Voltage There are five levels of amplitude available for you to choose from Normal 1 2 3 4 Exercise caution when increasing the amplitude of the vertical clock voltage since higher clocking voltages may result in increased clock induced charge noise in your signal In general only the very highest vertical clocking speeds are likely to benefit from an increased vertical clock voltage amplitude Parameters int state desired Vertical Clock Voltage Amplitude Valid values 0 Normal 1 gt 4 Increasing Clock voltage Amplitude Return unsigned int DRV SUCCESS Amplitude set DRV NOT INITIALIZED System not initialized DRV NOT AVAILABLE Your system does not support this feature DRV_ACQUIRING Acquisition in progress P1INVALID Invalid amplitude parameter NOTE Available in iXon iKon and Newton full range of amplitude levels is not available on all compatible cameras SECTION 11 Page 292 ANDOR FUNCTIONS SetVSSpeed unsigned int WINAPI SetVSSpeed int index Description This function will set the vertical speed to be used for subsequent acquisitions Parameters int index index into the vertical speed table Valid values 0 to GetNumberVSSpeeds 1 Return unsigned int DRV SUCCESS Vertical speed set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress P1INVALID Index out of range See also GetNumberVSSpeeds GetVSSpeed GetFastestRecommen
68. ConvertWavelengthRange unsigned int WINAPI GetCountConvertWavelengthRange float min wave float max wave Description This function returns the valid wavelength range available in Count Convert mode Parameters float min wave minimum wavelength permited float max wave maximum wavelength permited Return unsigned int DRV SUCCESS Count Convert wavelength set DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Count Convert not supported on this camera See also GetCapabilities SetCountConvertMode SetCountConvertWavelength GetCurrentCamera unsigned int WINAPI GetCurrentCamera long cameraHandle Description When multiple Andor cameras are installed this function returns the handle of the currently selected one Parameters long cameraHandle handle of the currently selected camera Return unsigned int DRV SUCCESS Camera handle returned See also SetCurrentCamera GetAvailableCameras GetCameraHandle GetCYMGShift unsigned int WINAPI GetCYMGShift int iXshift int iYShift Description THIS FUNCTION IS RESERVED SECTION 11 Page 133 ANDOR ee FUNCTIONS GetDDGExternalOutputEnabled unsigned int WINAPI GetDDGExternalOutputEnabled at_u32 Index at_u32 Enabled Description This function gets the current state of a selected external output Parameters at_u32 Index index of external output at u32 Enabled current state of external output 0 Off 1 On Return unsigned int DRV SUCCE
69. Cycle Time can be set independently e The minimum exposure time is not related to the time taken to read out the image e External trigger operates as if the CCD was a Non FT CCD e As the captured image is quickly shifted into the storage area even in non frame transfer mode the system may still be used without a mechanical shutter e For short exposure times the image may appear streaked as the time taken to shift the image area into the storage area may be of similar magnitude e Light falling on the Image area while the Storage area is being read out may contaminate the image in the Storage area due to charge spilling vertically along a column from the Image area The slower the readout rate or the shorter the exposure time the greater the possibility of corruption To see why this is the case consider the following situation During a 100us exposure enough light has fallen on a pixel to register 10000 counts or 100 000 electrons assuming 10e count The image is then shifted into the Storage area To read out the image assuming 1000x1000 pixels it would take approximately 100ms at 10MHx readout rate This means that during the reading out of the image 10 million counts 10000 1000 will have been acquired into the pixel described above As a pixel saturates at approximately 160 000 electrons this means that the pixel will over saturated by 60 times All the excess charge has to go somewhere and spreads vertically along the CCD column
70. CycleTime SetNumberKinetics SetOutputAmplifier unsigned int WINAPI SetOutputAmplifier int typ Description Parameters Return NOTE Some EMCCD systems have the capability to use a second output amplifier This function will set the type of output amplifier to be used when reading data from the head for these systems int typ the type of output amplifier 0 Standard EMCCD gain register default Conventional clara 1 Conventional CCD register Extended NIR mode clara unsigned int DRV SUCCESS Series length set DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress P1INVALID Output amplifier type invalid 1 Available in Clara iXon amp Newton 2 If the current camera HSSpeed is not available when the amplifier is set then it will default to the maximum HSSpeed that is SECTION 11 Page 271 ANDOR e FUNCTIONS SetOverlapMode unsigned int WINAPI SetOverlapMode int mode Description This function will set whether an acquisition will readout in Overlap Mode If the acquisition mode is Single Scan or Fast Kinetics this call will have no affect Parameters int mode mode 0 OFF 1 ON Return unsigned int DRV SUCCESS Overlap mode set DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_P1INVALID Invalid parameter See also SetAcquisitionMode NOTE Only available if CCD is an Overlap sensor SECTION 11 Page 2
71. D Invalid internal mode DRV P3INVALID Invalid time to open P4INVALID Invalid time to close PSINVALID Invalid external mode 1 The opening and closing time can be different 2 For cameras capable of controlling the internal and external shutter independently capability AC FEATURES SHUTTEREX you MUST use SetShutterEx SECTION 11 Page 281 ANDOR FUNCTIONS 3 For cameras with an internal shutter use function IsInternalMechanicalShutter to test but no independent shutter control capability AC FEATURES SHUTTEREX the external shutter will always behave like the internal shutter and the externalMode parameter is meaningless SetShutters unsigned int WINAPI SetShutters int typ int mode int closingtime int openingtime int exttype int extmode int dummy1 int dummy2 Description THIS FUNCTION IS RESERVED SetSifComment unsigned int WINAPI SetSifComment char comment Description This function will set the user text that will be added to any sif files created with the SaveAsSif function The stored comment can be cleared by passing NULL or an empty text string Parameters char comment The comment to add to new sif files Return unsigned int DRV SUCCESS Sif comment set See also SaveAsSif SaveAsCommentedSif NOTE To add a comment to a SIF file that will not be used in any future SIF files that are saved use the function SaveAsCommentedSif SetSingleTrack unsigned int WINA
72. DRV SUCCESS Acquisition prepared DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_P1INVALID Invalid pointer i e NULL DRV_P2INVALID Invalid pointer i e NULL DRV_P4INVALID Number of images less than zero DRV_P5INVALID Invalid Number of Frames requested DRV_P6INVALID Invalid number of thresholds DRV_P7INVALID Invalid pointer i e NULL DRV_P8INVALID Height less than zero DRV P9INVALID Width less than zero DRV ERROR BUFFSIZE Output buffer size too small See also SECTION 11 Page 210 ANDOR ee FUNCTIONS SaveAsBmp unsigned int WINAPI SaveAsBmp char path char palette long ymin long ymax Description This function saves the last acquisition as a bitmap file which can be loaded into an imaging package The palette parameter specifies the location of a PAL file which describes the colors to use in the bitmap This file consists of 256 lines of ASCII text each line containing three numbers separated by spaces indicating the red green and blue component of the respective color value The ymin and ymax parameters indicate which data values will map to the first and last colors in the palette e All data values below or equal to ymin will be colored with the first color e All values above or equal to ymax will be colored with the last color e All other palette colors will be scaled across values between these limits Parameters char path The filename of the bitmap char
73. Description This function gets the current state of Intelligate Parameters int state current state of the Intelligate option 0 Off 1 On Return unsigned int DRV SUCCESS Intelligate state returned DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_NOT_SUPPORTED Intelligate not supported DRV_ERROR_ACK Unable to communicate with system See also GetCapabilities SetDDGIntelligate SetDDGInsertionDelay GetDDGIOC unsigned int WINAPI GetDDGIOC int state Description This function gets the current state of the integrate on chip IOC option Parameters int state current state of the IOC option 0 Off 1 On Return unsigned int DRV_SUCCESS IOC state returned DRV_NOT_INITIALIZED System not initialized DRV_NOT_SUPPORTED IOC not supported DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with system P1INVALID state has invalid memory address See also GetCapabilities SetDDGIOC SECTION 11 Page 138 ANDOR FUNCTIONS GetDDGIOCFrequency unsigned int WINAPI GetDDGIOCFrequency double frequency Description Parameters Return See also This function can be used to return the actual IOC frequency that will be triggered It should only be called once all the conditions of the experiment have been defined double frequency the frequency of integrate on chip pulses triggered within the fire pulse unsigned int DRV_SUCCESS
74. E Data cannot be written to the Preset Andor file DRV ERROR FILESAVE Failed to save data to file DRV OA FILE HAS BEEN MODIFIED File to be written to has been modified since last write local copy of file may not be the same DRV OA INVALID CHARS IN NAME File name contains invalid characters OA AddMode OA DeleteMode SECTION 11 Page 204 ANDOR FUNCTIONS OutAuxPort unsigned int WINAPI OutAuxPort int port int state Description This function sets the TTL Auxiliary Output port P on the Andor plug in card to either ON HIGH or OFF LOW Parameters int port Number of AUX out port on Andor card Valid Values 1 to 4 int state state to put port in 0 OFF LOW all others ON HIGH Return unsigned int DRV SUCCESS AUX port set DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_VXDNOTINSTALLED VxD not loaded DRV_ERROR_ACK Unable to communicate with card DRV_P1INVALID Invalid port id See also InAuxPort SECTION 11 Page 205 ANDOR e FUNCTIONS PrepareAcquisition unsigned int WINAPI PrepareAcquisition void Description This function reads the current acquisition setup and allocates and configures any memory that will be used during the acquisition The function call is not required as it will be called automatically by the StartAcquisition function if it has not already been called externally However for long kinetic series acquisitions the time to allocate and configure an
75. ECTION 3 Page 38 ANDOR C READOUT MODES Cropped In Cropped mode we can fool the sensor into thinking it is smaller than it actually is and readout continuously at a much faster frame rate The spectral time resolution is dictated by the time taken to readout the smaller defined section of the sensor If your experiment dictates that you need fast time resolution but cannot be constrained by the storage size of the sensor then it is possible to readout the EMCCD in a cropped sensor mode as illustrated below Figure 7 Cropped mode To set up the CCD with a cropped image as in figure 7 see SetlsolatedCropMode NOTE It is important to ensure that no light falls on the excluded region otherwise the acquired data will be corrupted By SUK SECTION 3 Page 39 ACQUISITION MODES SECTION 4 ACQUISITION MODES ACQUISITION MODE TYPES In the previous section the different ReadOut Modes binning patterns supported by the Andor SDK were discussed In addition the Andor SDK allows you to control the number and the timing details of acquisitions made using the various binning patterns To simplify the process of controlling these acquisitions the Andor SDK has divided the acquisition process into several different Acquisition Modes e Single Scan e Accumulate e Kinetic Series e Run Till Abort e Fast Kinetics Single Scan is the simplest form of acquisition where a single scan is captured Accumulate mode takes a s
76. ETFUNCTION SPOOLTHREADCOUNT Description The number of parallel threads can be set using the SetSpoolThreadCount function Bit 24 State 1 SECTION 11 Page 125 ANDOR e FUNCTIONS Capability AC SETFUNCTION REGISTERPACK Description Sub image packing can be set using the SetReadoutRegisterPacking function Bit 25 State 1 Capability AC SETFUNCTION PRESCANS Description The number of prescans can be set using the SetNumberPrescans function Bit 26 State 1 Capability AC SETFUNCTION GATEWIDTHSTEP Description The gate width step can be set using the SetDDGWidthStepCoefficients function Bit 27 State 1 Capability AC SETFUNCTION EXTENDED CROP MODE Description Extended crop mode can be set using the SetlsolatedCropModeEx function Bit 28 State 1 SECTION 11 Page 126 ANDOR e FUNCTIONS GetCapabilities Available Get Functions Available Get Functions AndorCapabilities Member ulGetFunctions Capability AC GETFUNCTION TEMPERATURE Description The current temperature can be determined using the GetTemperature function Bit 0 State 1 Capability AC GETFUNCTION TEMPERATURERANGE Description The range of possible temperatures can be determined using the GetTemperatureRange function Bit 2 State 1 Capability AC GETFUNCTION DETECTORSIZE Description The dimensions of the detector can be determined using the GetDetector function Bit 3 State 1 Capability AC GETFUNCTI
77. FUNCTIONS GetNumberPhotonCountingDivisions unsigned int WINAPI GetNumberPhotonCountingDivisions unsigned long noOfDivisions Description Parameters Return See also Available in some systems is photon counting mode This function gets the number of photon counting divisions available The functions SetPhotonCounting and SetPhotonCountingThreshold can be used to specify which of these divisions is to be used unsigned long noOfDivisions number of allowed photon counting divisions unsigned int DRV_SUCCESS Number of photon counting divisions returned DRV_NOT_INITIALIZED System not initialized DRV_P1INVALID Invalid parameter DRV_NOT_AVAILABLE Photon Counting not available SetPhotonCounting SetPhotonCountingThreshold GetCapabilities GetNumberPreAmpGains unsigned int WINAPI GetNumberPreAmpGains int noGains Description Parameters Return See also Available in some systems are a number of pre amp gains that can be applied to the data as it is read out This function gets the number of these pre amp gains available The functions GetPreAmpGain and SetPreAmpGain can be used to specify which of these gains is to be used int noGains number of allowed pre amp gains unsigned int DRV SUCCESS Number of pre amp gains returned DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress IsPreAmpGainAvailable GetPreAmpGain SetPreAmpGain GetCapabilities GetNumberRingExposureTim
78. Fix to resolve oscillations in data for certain Newton systems Fix for potential fail of auto cooling on Luca systems Fixed maximum number in series in fast kinetics for frame transfer systems Fixed exposure time reported in fast kinetics Version 2 82 30000 0 New features Added option for horizontal binning in random track mode Added capabilities for Horizontal Binning MultiTrackHRange and No Gaps in Random Tracks New capability added to test for overlapped external exposure mode Deprecated SetGain for SetMCPGain which is a more accurate naming convention Added Dud column support to SDK allows SDK to be configured to interpolate bad columns Bug fixes Fixed minimum exposure for Luca R Updated documentation error code correction for get data functions Fixed missing cases of GetTemperature in LabVIEW wrapper Updated documentation Corrected contact information StartAcquisition now returns an error if horizontal binning does not divide evenly into range for multi tracks Fixed crash when StartAcquisition is called in random track mode before random tracks are setup Fixed default EM gain Set to off when system initialized SetRandomtTracks no longer returns an error if not in random track mode Image mode Linux example will now work with an InGaAs SECTION 1 Page 20 ANDOR eS INTRODUCTION e SetRandomTracks was not returning an error for certain incorrect track combinations e Fixed SetBaselineClamp an
79. GIOCFrequency SetDDGlOCNumber GetDDGIOCNumber GetDDGIOCPulses SetDDGIOC SECTION 11 Page 235 ANDOR FUNCTIONS SetDDGlOCNumber unsigned int WINAPI SetDDGlOCNumber unsigned long numberPulses Description Parameters Return See also This function allows the user to limit the number of pulses used in the integrate on chip option at a given frequency It should be called once the conditions of the experiment have been setup in order for correct operation unsigned long numberPulses the number of integrate on chip pulses triggered within the fire pulse unsigned int DRV SUCCESS Value for IOC number accepted DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV NOT SUPPORTED IOC not supported DRV ERROR ACK Unable to communicate with card SetDDGlOCFrequency GetDDGlOCFrequency GetDDGlOCNumber GetDDGIOCPulses SetDDGIOC SetDDGIOCPeriod unsigned int WINAPI SetDDGlOCPeriod at u64 period Description Parameters Return See also This function can be used to set the IOC period that will be triggered It should only be called once all the conditions of the experiment have been defined at u64 period the period of integrate on chip pulses triggered within the fire pulse unsigned int DRV SUCCESS IOC period set DRV_NOT_INITIALIZED System not initialized DRV_NOT_SUPPORTED IOC not supported DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate
80. Gain NOTE Available on iDus iXon amp Newton SECTION 11 Page 275 ANDOR FUNCTIONS SetRandomTracks unsigned int WINAPI SetRandomTracks int numTracks int areas Description Parameters Return See also This function will set the Random Track parameters The positions of the tracks are validated to ensure that the tracks are in increasing order and do not overlap The horizontal binning is set via the SetCustomTrackHBin function The vertical binning is set to the height of each track Some cameras need to have at least 1 row in between specified tracks Ixon and the USB cameras allow tracks with no gaps in between Example Tracks specified as 20 30 31 40 tells the SDK that the first track starts at row 20 in the CCD and finishes at row 30 The next track starts at row 31 no gap between tracks and ends at row 40 int numTracks number tracks Valid values 1 to number of vertical pixels 2 int areas pointer to an array of track positions The array has the form bottom1 top1 bottom2 top2 bottomN topN unsigned int DRV SUCCESS Parameters set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV_P1INVALID Number of tracks invalid DRV_P2INVALID Track positions invalid DRV_RANDOM_TRACK_ERROR Invalid combination of tracks out of memory or mode not available SetCustomTrackHBin SetReadMode StartAcquisition SetCompleximage SECTION 11 Page 276
81. GetCapabilities SetDDGIOCFrequency GetDDGlOCFrequency SetDDGlOCNumber GetDDGlOCNumber SetDDGIOC GetDDGIOCTrigger unsigned int WINAPI GetDDGIOCTrigger at_u32 trigger This function can be used to retrieve the active IOC trigger at 32 trigger active IOC trigger 0 Fire pulse 1 External trigger unsigned int DRV SUCCESS IOC trigger returned DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED IOC not supported DRV_ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with system DRV P1INVALID Invalid trigger GetCapabilities SetDDGIOC SetDDGlOCTrigger SetTriggerMode GetDDGLiteControlByte unsigned int WINAPI GetDDGLiteControlByte AT DDGLiteChannelld channel unsigned char control Description THIS FUNCTION IS RESERVED GetDDGLiteGlobalControlByte unsigned int WINAPI GetDDGLiteGlobalControlByte unsigned char control Description THIS FUNCTION IS RESERVED GetDDGLitelnitialDelay unsigned int WINAPI GetDDGLitelnitialDelay AT DDGLiteChannelld channel float fDelay Description THIS FUNCTION IS RESERVED GetDDGLitelnterPulseDelay SECTION 11 Page 141 ANDOR 9 5 FUNCTIONS unsigned int WINAPI GetDDGLitelnterPulseDelay AT DDGLiteChannelld channel float fDelay Description THIS FUNCTION IS RESERVED GetDDGLitePulsesPerExposure unsigned int WINAPI GetDDGLitePulsesPerExposure AT DDGLiteChannelld channel at u32 ui32Pulses Description THIS FUNCT
82. GetRingExposureRange IsTriggerModeAvailable SetRingExposureTimes GetMCPGain unsigned int WINAPI GetMCPGain int gain Description This function will retrieve the set value for the MCP Gain Parameters int gain Returned gain value Return unsigned int DRV_SUCCESS Table returned DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_P1INVALID Invalid pointer i e NULL DRV_NOT_AVAILABLE Not a USB iStar See also SetMCPGain NOTE Available only on USB iStar SECTION 11 Page 159 ANDOR FUNCTIONS This function previously returned a table of MCP gain values against photoelectrons per count This is now retrieved using GetMCPGainTable GetMCPGainRange unsigned int WINAPI GetMCPGainRange int iLow int iHigh Description Returns the minimum and maximum values of the SetMCPGain function Parameters int iLow lowest gain setting int iHigh highest gain setting Return DRV SUCCESS Gain range returned DRV NOT INITIALIZED System not initialized See also SetMCPGain NOTE Available only iStar GetMCPGainTable unsigned int WINAPI GetMCPGainTable int iNum int piGain float pfPhotoepc Description THIS FUNCTION IS RESERVED GetMCPVoltage unsigned int WINAPI GetMCPVoltage int iVoltage Description This function will retrieve the current Micro Channel Plate voltage Parameters int iVoltage Will contain voltage on return The unit is in Volts and should be between the ra
83. IAL GUIDES Retrieving Image Data Depending on the image settings there may be more than one image available after each notification It is important to ensure that all of the new images are retrieved if they are required The recommended functions for retrieving image data are as follows e GetOldestlmage e GetMostRecentlmage e Getlmages e GetAcquiredData GetOldestImage GetMostRecentImage and Getlmages are used to retrieve data from an internal 48MB circular buffer that is written to by all acquisition modes They are particularly useful for retrieving data while an acquisition is taking place especially during run till abort mode but can also be used when the acquisition is complete For all acquisition modes except Run Till Abort the GetAcquiredData function can be used to retrieve all the acquired data once the acquisition is complete NOTE All functions mentioned here refer to retrieving 32 bit data but there are also 16 bit versions of these functions available GetOldestlmage will retrieve the oldest available image from the circular buffer Once the oldest image has been retrieved it is no longer available and calling GetOldestlmage again will retrieve the next image This is a useful function for retrieving a number of images For example if there are 5 new images available calling GetOldestlmage 5 times will retrieve them all GetMostRecentlmage will retrieve the most recent image from the circular buffer This provides a me
84. ID Invalid pointer e g NULL The GPIB device may return other errors Consult the help documentation supplied with these devices GPIBReceive SECTION 11 Page 189 ANDOR e FUNCTIONS I2CBurstRead unsigned int WINAPI I2CBurstRead BYTE i2cAddress long nBytes BYTE data Description This function will read a specified number of bytes from a chosen device attached to the 2 data bus Parameters BYTE i2cAddress The address of the device to read from long nBytes The number of bytes to read from the device BYTE data The data read from the device Return unsigned int DRV_SUCCESS Read successful DRV_VXDNOTINSTALLED VxD not loaded DRV_INIERROR Unable to load DETECTOR INI DRV COFERROR Unable to load COF DRV_FLEXERROR Unable to load RBF DRV ERROR ACK Unable to communicate with card I2CDEVNOTFOUND Could not find the specified device DRV I2CTIMEOUT Timed out reading from device DRV UNKNOWN FUNC Unknown function incorrect cof file See also l2CBurstWrite l2CRead l2CWrite 2 I2CBurstWrite unsigned int WINAPI I2CBurstWrite BYTE i2cAddress long nBytes BYTE data Description This function will write a specified number of bytes to a chosen device attached to the 1 C data bus Parameters BYTE i2cAddress The address of the device to write to long nBytes The number of bytes to write to the device BYTE data The data to write to the device Return unsigned int DRV_SUCCESS Wr
85. INVALID Invalid index See also IsPreAmpGainAvailable GetNumberPreAmpGains SetPreAmpGain GetCapabilities SECTION 11 Page 175 ANDOR FUNCTIONS GetPreAmpGainText unsigned int WINAPI GetPreAmpGainText int index char name int len Description Parameters Return See also This function will return a string with a pre amp gain description The pre amp gain is selected using the index The SDK has a string associated with each of its pre amp gains The maximum number of characters needed to store the pre amp gain descriptions is 30 The user has to specify the number of characters they wish to have returned to them from this function int index gain index Valid values 1 GetNumberPreAmpGains 1 char name A user allocated array of characters for storage of the description int len The length of the user allocated character array unsigned int DRV SUCCESS Description returned DRV NOT INITIALIZED System not initialized DRV_P1INVALID Invalid index DRV_P2INVALID Array size is incorrect DRV_NOT_SUPPORTED Function not supported with this camera IsPreAmpGainAvailable GetNumberPreAmpGains SetPreAmpGain GetCapabilities GetQE unsigned int WINAPI GetQE char sensor float wavelength unsigned int mode float QE Description Parameters Return See also Returns the percentage QE for a particular head model at a user specified wavelength char sensor head model float wavelength
86. ION IS RESERVED GetDDGLitePulseWidth unsigned int WINAPI GetDDGLitePulseWidth AT DDGLiteChannelld channel float fWidth Description THIS FUNCTION IS RESERVED GetDDGOpticalWidthEnabled unsigned int WINAPI GetDDGOpticalWidthEnabled at u32 Enabled Description This function can be used to check whether optical gate widths are being used Parameters at u32 Enabled optical gate width option 0 Off 1 On Return unsigned int DRV SUCCESS State returned DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Optical gate width not supported DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with system DRV_P1INVALID Enabled has invalid memory address See also GetCapabilities GetDDGTTLGateWidth SECTION 11 Page 142 ANDOR ee FUNCTIONS GetDDGPulse unsigned int WINAPI GetDDGPulse double width double resolution double Delay double Width Description This function attempts to find a laser pulse in a user defined region with a given resolution The values returned will provide an estimation of the location of the pulse Parameters double width the time in picoseconds of the region to be searched double resolution the minimum gate pulse used to locate the laser double Delay the approximate start of the laser pulse double Width the pulse width which encapsulated the laser pulse Return unsigned int DRV_SUCCESS Location returned DRV_NOT_INITIALIZED System not
87. ITIALIZED System not initialized ACQUIRING Acquisition in progress DRV_P1INVALID Number of accumulates See also GetAcquisitionTimings SetAccumulationCycleTime SetAcquisitionMode SetExposureTime SetKineticCycleTime SetNumberKinetics SetNumberKinetics unsigned int WINAPI SetNumberKinetics int number Description This function will set the number of scans possibly accumulated scans to be taken during a single acquisition sequence This will only take effect if the acquisition mode is Kinetic Series Parameters int number number of scans to store Return unsigned int DRV SUCCESS Series length set DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_P1INVALID Number in series invalid See also GetAcquisitionTimings SetAccumulationCycleTime SetAcquisitionMode SetExposureTime SetKineticCycleTime SECTION 11 Page 270 ANDOR FUNCTIONS SetNumberPrescans unsigned int WINAPI SetNumberPrescans int iNumber Description Parameters Return See also This function will set the number of scans acquired before data is to be retrieved This will only take effect if the acquisition mode is Kinetic Series int iNumber number of scans to ignore unsigned int DRV_SUCCESS Prescans set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV P1INVALID Number of prescans invalid GetAcquisitionTimings SetAcquisitionMode SetKinetic
88. L pointer Filter GetAveragingFrameCount unsigned int WINAPI Filter GetAveragingFrameCount int frames Description Parameters Return See also Returns the current frame count value int frames The current frame count value unsigned int DRV SUCCESS NOT INITIALIZED DRV_ACQUIRING DRV_P1INVALID Frame count returned System not initialized Acquisition in progress Invalid frame count i e NULL pointer Filter SetAveragingFrameCount Filter GetDataAveragingMode unsigned int WINAPI Filter GetDataAveragingMode int mode Description Parameters Return See also Returns the current averaging mode int mode The current averaging mode unsigned int DRV SUCCESS DRV NOT INITIALIZED DRV_ACQUIRING DRV_P1INVALID Filter SetDataAveragingMode Averaging mode returned System not initialized Acquisition in progress Invalid threshold i e NULL pointer Filter_GetMode unsigned int WINAPI Filter_GetMode unsigned int mode Description Parameters Return See also Returns the current Noise Filter mode unsigned int mode Noise Filter mode unsigned int DRV_SUCCESS DRV_NOT_INITIALIZED DRV_NOT_SUPPORTED DRV_P1INVALID Filter SetMode Filter mode returned System not initialized Noise Filter processing not available for this camera Invalid mode i e NULL pointer SECTION 11 Page 102 ANDOR FUNCTIONS Filter_GetThreshold
89. LID Invalid horizontal binning DRV_NOT_SUPPORTED Either the camera does not support isolated Crop mode or the read mode is invalid GetDetector SetReadMode NOTE For iDus it is recommended that you set horizontal binning to 1 SECTION 11 Page 263 ANDOR FUNCTIONS unsigned int WINAPI SetlsolatedCropModeEx int active int cropheight int cropwidth int vbin int hbin int cropleft int cropbottom Description columns to achieve higher throughput This feature is currently only available for iXon Ultra Note It is important to ensure that no light falls on the excluded region otherwise the acquired data will be corrupted The following centralized regions of interest are recommended to be used with this mode to achieve the fastest possible frame rates The table below shows the optimally positioned ROI coordinates recommended to be used with this mode Crop Left Start Position ROI 32 x 32 64 x 64 96 x 96 128 x 128 192 x 192 256 x 256 512x4 512x8 512x 14 496 x 4 496 x 8 496 x 16 Parameters 0 Crop mode is OFF int cropheight The selected crop height This value must be between 1 and the CCD height int cropwidth The selected crop width This value must be between 1 and the CCD width int vbin The selected vertical binning 241 219 209 189 157 123 ce CO 2 n 8 int active 1 Crop mode is ON Crop Right Position 272 282 304 316 348 378 512 512 512
90. MODE FVB Description Full Vertical Binning Read Mode available using SetReadMode Bit 3 State 1 Capability AC READMODE MULTITRACK Description Multi Track Read Mode available using SetReadMode Bit 4 State 1 Capability AC READMODE RANDOMTRACK Description Random Track Read Mode available using SetReadMode Bit 5 State 1 SECTION 11 Page 116 ANDOR e FUNCTIONS GetCapabilities Trigger Modes Trigger Modes AndorCapabilities Member ulTriggerModes Capability AC TRIGGERMODE INTERNAL Description Internal Trigger Mode available using SetTriggerMode Bit 0 State 1 Capability AC TRIGGERMODE EXTERNAL Description External Trigger Mode available using SetTriggerMode Bit 1 State 1 Capability AC TRIGGERMODE EXTERNAL FVB EM Description External FVB EM Trigger Mode available using SetTriggerMode Bit 2 State 1 Capability AC TRIGGERMODE CONTINUOUS Description Continuous Trigger Mode available using SetTriggerMode Bit 3 State 1 Capability AC TRIGGERMODE EXTERNALSTART Description External Start Trigger Mode available using SetTriggerMode Bit 4 State 1 Capability AC TRIGGERMODE BULB Description Bulb Trigger Mode available using SetTriggerMode Bit 5 State 1 Note This capability is deprecated by AC TRIGGERMODE EXTERNALEXPOSURE Capability AC TRIGGERMODE EXTERNALEXPOSURE Description External Exposure Trigger Mode available using SetTriggerMode Bit 5 St
91. N 5 ACQUISITION MODES for further information float time the kinetic cycle time in seconds unsigned int DRV_SUCCESS Cycle time accepted DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV_P1INVALID Time invalid SetNumberKinetics SetMCPGain unsigned int WINAPI SetMCPGain int gain Description Parameters Return See also Allows the user to control the voltage across the microchannel plate Increasing the gain increases the voltage and so amplifies the signal The gain range can be returned using GetMCPGainRange int gain amount of gain applied unsigned int DRV_SUCCESS Value for gain accepted DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV I2CTIMEOUT 12C command timed out DRV I2CDEVNOTFOUND 12C device not present DRV ERROR ACK Unable to communicate with device DRV_P1INVALID Gain value invalid GetMCPGainRange SetGateMode SetMCPGating NOTE Available on iStar SECTION 11 Page 266 ANDOR FUNCTIONS unsigned int WINAPI SetMCPGating int gating SetMCPGating Description This function controls the MCP gating Parameters int gating ON OFF switch for the MCP gating Valid values 0 to switch MCP gating OFF 1 to switch MCP gating ON Return unsigned int DRV SUCCESS Value for gating accepted DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV_I2CTIMEOUT
92. NE Return unsigned int DRV SUCCESS Temperature controller switched OFF DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with card DRV NOT SUPPORTED Camera does not support switching cooler off See also CoolerON SetTemperature GetTemperature GetTemperatureF GetTemperatureRange GetStatus NOTE Not available on Luca R cameras always cooled to 20 NOTE Classic amp ICCD only 1 When the temperature control is switched off the temperature of the sensor is gradually raised to 0 C to ensure no thermal stresses are set up in the sensor 2 When closing down the program via ShutDown you must ensure that the temperature of the detector is above 20 C otherwise calling ShutDown while the detector is still cooled will cause the temperature to rise faster than certified SECTION 11 Page 98 ANDOR e FUNCTIONS CoolerON unsigned int WINAPI CoolerON void Description Switches ON the cooling On some systems the rate of temperature change is controlled until the temperature is within 3 of the set value Control is returned immediately to the calling application Parameters NONE Return unsigned int DRV SUCCESS Temperature controller switched ON DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with card See also CoolerOFF SetTemperature GetTemperature GetTemperatureF
93. NOT_STABILIZED Temperature reached but not stabilized See also GetTemperatureF SetTemperature CoolerON CoolerOFF GetTemperatureRange GetTemperatureF unsigned int WINAPI GetTemperatureF float temperature Description This function returns the temperature in degrees of the detector It also gives the status of cooling process Parameters float temperature temperature of the detector Return unsigned int DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with card DRV TEMP OFF Temperature is OFF DRV TEMP STABILIZED Temperature has stabilized at set point DRV TEMP NOT REACHED Temperature has not reached set point DRV TEMP DRIFT Temperature had stabilised but has since drifted DRV TEMP NOT STABILIZED Temperature reached but not stabilized See also GetTemperature SetTemperature CoolerON CoolerOFF GetTemperatureRange SECTION 11 Page 183 ANDOR ee FUNCTIONS GetTemperatureRange unsigned int WINAPI GetTemperatureRange int mintemp int maxtemp Description This function returns the valid range of temperatures in centigrads to which the detector can be cooled Parameters int mintemp minimum temperature int maxtemp maximum temperature Return unsigned int DRV SUCCESS Temperature range returned DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress See also GetTemperature GetTemperatureF SetTemperature CoolerON C
94. Number returned DRV NOT INITIALIZED System not initialized DRV ERROR ACK Unable to communicate with card GetCapabilities SetDDGlOCFrequency SetDDGlOCNumber GetDDGlOCNumber GetDDGIOCPulses SetDDGIOC GetDDGlOCNumber unsigned int WINAPI GetDDGlOCNumber unsigned long numberPulses Description Parameters Return See also This function can be used to return the actual number of pulses that will be triggered It should only be called once all the conditions of the experiment have been defined unsigned long numberPulses the number of integrate on chip pulses triggered within the fire pulse unsigned int DRV SUCCESS Number returned DRV NOT INITIALIZED System not initialized DRV ERROR ACK Unable to communicate with card GetCapabilities SetDDGlOCFrequency GetDDGIOCFrequency SetDDGlOCNumber GetDDGIOCPulses SetDDGIOC SECTION 11 Page 139 ANDOR FUNCTIONS GetDDGIOCNumberRequested unsigned int WINAPI GetDDGlOCNumberRequested at u32 pulses Description Parameters Return See also This function can be used to return the number of pulses that were requested by the user at_u32 pulses the number of integrate on chip pulses requested unsigned int DRV_SUCCESS NOT INITIALIZED DRV NOT SUPPORTED DRV ACQUIRING DRV ERROR ACK DRV_P1INVALID Number returned System not initialized IOC not supported Acquisition in progress Unable to communicate with system pulses has invali
95. OCNumber 139 GetDDGlOCNumberRequested 140 GetDDGIOCPeriod 140 GetDDGIOCPulses 141 GetDDGlOCTrigger 141 GetDDGLiteControlByte 141 GetDDGLiteGlobalControlByte 141 GetDDGLitelnitialDelay 141 GetDDGLitelnterPulseDelay 141 GetDDGLitePulsesPerExposure 142 GetDDGLitePulseWidth 142 GetDDGOpticalWidthEnabled 142 GetDDGPulse 143 GetDDGTTLGateWidth 143 GetDDGWidthStepCoefficients 144 GetDDGWidthStepMode 144 GetDetector 145 GetDICameralnfo 145 TABLE OF CONTENTS Page 4 ANDOR TABLE OF CONTENTS GetDualExposureTimes 145 GetEMAdvanced 146 GetEMCCDGain 146 GetEMGainRange 146 GetExternalTriggerTermination 146 GetFastestRecommendedVSSpeed 147 GetFIFOUsage 147 GetFilterMode 147 GetFKExposureTime 149 GetFKVShiftSpeed 149 GetFKVShiftSpeedF 150 GetFrontEndStatus 150 GetGateMode 151 GetHardwareVersion 151 GetHeadModel 151 GetHorizontalSpeed 152 GetHSSpeed 153 GetHVflag 153 154 GetlmageFlip 154 GetlmageRotate 154 Getlmages 155 Getlmages16 156 GetlmagesPerDMA 156 GetlODirection 157 GetlOLevel 157 GetIRQ 158 GetKeepCleanTime 158 GetMaximumBinning 158 GetMaximumExposure 159 GetMaximumNumberRingExposureTimes 159 GetMCPGain 159 GetMCPGainRange 160 GetMCPGainTable 160 GetMCPVoltage 160 GetMetaDatalnfo 161 GetMinimumlmageLength 161 GetMinimumNumberlnSeries 161 GetMostRecentColorlmage16 162 GetMostRecentlmage 163 GetMostRecentlmage16 163 GetMSTimingsData 164 GetMSTimingsEnabled 164 GetNewData 164 GetNewData16 165 GetNewD
96. ON 12 ERROR CODES 301 SECTION 13 DETECTOR INI 302 DETECTOR INI EXPLAINED 302 SYSTEM 303 COOLING 304 DETECTOR 305 Format 305 DummyPixels 305 DataHShiftSpeed 305 DataVShiftSpeed 305 DummyHShiftSpeed 306 DummyVShiftSpeed 306 VerticalHorizontalTime 306 CodeFile 306 FlexFile 307 Cooling 307 Type 307 FKVerticalShiftSpeed 307 Gain 307 PhotonCountingCCD 307 EMCCDRegisterSize 308 iStar 308 SlowVerticalSpeedFactor 308 HELLFunction 308 HELLLoop1 308 ADChannels 308 AD2DataHSSpeed 308 AD2DumpHSSpeed 309 AD2BinHSSpeed 309 AD2Pipeline 309 iXon 309 EXAMPLE DETECTOR INI FILES 309 DH220 309 DV420 309 DV437 310 TABLE OF CONTENTS Page 10 ANDOR TABLE OF CONTENTS CONTROLLER 311 ReadOutSpeeds Pipeline 311 Pos 311 TABLE OF CONTENTS Page 11 ANDOR INTRODUCTION SECTION 1 INTRODUCTION The Andor Software Development Kit SDK gives the programmer access to the Andor range of CCD and Intensified CCD cameras The key part of the SDK is the Dynamic Link Library DLL which can be used with a wide variety of programming environments including C C C Visual Basic and LabVIEW The library is compatible with Windows 2000 XP Vista and Windows 7 A Linux version of the SDK is also available Currently Andor provides both 32 bit and 64 bit versions of the SDK for Windows and Linux The SDK provides a suite of functions that allow you to configure the data acquisition process in a number of diffe
97. ON MCPGAIN AC GETFUNCTION GAIN deprecated Description Reserved capability Bit 4 State 1 Capability AC GETFUNCTION EMCCDGAIN Description The gain can be determined using the GetEMCCDGain function Bit 5 State 1 Capability AC GETFUNCTION GATEMODE Description The gate mode can be determined using the GetGateMode function Bit 7 State 1 Capability AC GETFUNCTION DDGTIMES Description The gate times can be determined using the GetDDGGateTime function Bit 8 State 1 Capability AC GETFUNCTION IOC Description Integrate on chip state can be determined using the GetDDGIOC function Bit 9 State 1 SECTION 11 Page 127 ANDOR PAN FUNCTIONS GetCapabilities Available Get Functions Continued Capability AC GETFUNCTION INTELLIGATE Description Intelligate state can be determined using the GetDDGIntelligate function Bit 10 State 1 Capability AC GETFUNCTION INSERTION DELAY Description The insertion delay can be determined using the GetDDGInsertionDelay function Bit 11 State 1 Capability AC GETFUNCTION PHOSPHORSTATUS Description The phosphor status can be determined using the GetPhosphorStatus function Bit 13 State 1 Capability AC GETFUNCTION BASELINECLAMP Description The gain can be determined using the GetBaselineClamp function Bit 15 State 1 SECTION 11 Page 128 ANDOR e FUNCTIONS GetCapabilities SDK Features Available SDK Features Available
98. PI SetSingleTrack int centre int height Description This function will set the single track parameters The parameters are validated in the following order centre row and then track height Parameters int centre centre row of track Valid range 0 to number of vertical pixels int height height of track Valid range 1 maximum value depends on centre row and number of vertical pixels Return unsigned int DRV SUCCESS Parameters set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV_P1INVALID Center row invalid DRV_P2INVALID Track height invalid See also SetReadMode SECTION 11 Page 282 ANDOR ee FUNCTIONS SetSingleTrackHBin unsigned int WINAPI SetSingleTrackHBin int bin Description This function sets the horizontal binning used when acquiring in Single Track read mode Parameters Int bin Binning size Return unsigned int DRV_SUCCESS Binning set DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress P1INVALID Invalid binning size See also SetReadMode NOTE 1 If the detector width is not a multiple of the binning DRV BINNING ERROR will be returned from PrepareAcquisition and or StartAcquisition 2 For iDus it is recommended that you set horizontal binning to 1 SECTION 11 Page 283 ANDOR FUNCTIONS SetSpool unsigned int WINAPI SetSpool int active int method char path int framebuffersize Description
99. Page 93 ANDOR EXAMPLES from 11 12 CoolerOFF GetTemperature i i NO A i D Has temperature risen sufficiently m 15 ShutDown 12 When the user has completely finished acquiring data the shutdown procedure is started The cooler is switched off It is important to control both the heating and cooling rates of the CCD sensor otherwise the temperature gradients may damage the sensor Thus it is highly recommended that the user uses the correct exiting procedure rather than for example simply switching off the computer 13 14 The current temperature is periodically monitored to check if the temperature has risen to a sufficiently high value 15 For Classic amp ICCD systems wait until the temperature has risen above 20 C The user may now shut down the Andor SDK system 16 The program releases any memory still being used and exits the application SECTION 10 Page 94 ANDOR ee EXAMPLES Cooler This example is different from all the previous examples in that its main goal is not to acquire data but to demonstrate the proper use of the cooling capabilities of the Andor SDK System It includes the taking of a single FVB scan for completeness This example is an expanded version of Example 1 DDG The digital delay generator for iStar systems is demonstrated by this example The user can control the gate times gain level and integrate on chip param
100. Parameters This function will enable and disable the spooling of acquired data to the hard disk or to the RAM With spooling method 0 each scan in the series will be saved to a separate file composed of a sequence of 32 bit integers With spooling method 1 the type of data in the output files depends on what type of acquisition is taking place see below Spooling method 2 writes out the data to file as 16 bit integers Spooling method 3 creates a directory structure for storing images where multiple images may appear in each file within the directory structure and the files may be spread across multiple directories Like method 1 the data type of the image pixels depends on whether accumulate mode is being used Method 4 Creates a RAM disk for storing images so you should ensure that there is enough free RAM to store the full acquisition Methods 5 6 and 7 can be used to directly spool out to a particular file type either FITS SIF or TIFF respectively In the case of FITS and TIFF the data will be written out as 16 bit values Method 8 is similar to method 3 however the data is first compressed before writing to disk In some circumstances this may improve the maximum rate of writing images to disk however as the compression can be very CPU intensive this option may not be suitable on slower processors The data is stored in row order starting with the row nearest the readout register With the exception of methods 5 6 and 7
101. PreAmpGains GetPreAmpGain SetPreAmpGain NOTE Available only on iXon SECTION 11 Page 195 ANDOR FUNCTIONS IsTriggerModeAvailable unsigned int WINAPI IsTriggerModeAvailable int iTriggerMode Description Parameters Return See also This function checks if the hardware and current settings permit the use of the specified trigger mode int iTriggerMode Trigger mode to check unsigned int DRV SUCCESS Trigger mode available DRV NOT INITIALIZED System not initialize DRV INVALID MODE Not a valid mode SetTriggerMode Merge unsigned int WINAPI Merge const at 32 arr long nOrder long nPoint long nPixel float coeff long fit long hbin at 32 output float start float step Description THIS FUNCTION IS RESERVED SECTION 11 Page 196 ANDOR FUNCTIONS OA_AddMode unsigned int WINAPI OA_AddMode char ModeName unsigned int ModeNameLen char ModeDescription unsigned int ModeDescriptionLen Description Parameters Return See also This function will add a mode name and description to memory Note that this will not add the mode to file a subsequent call to OA WriteToFile must be made char ModeName A name for the mode to be defined unsigned int ModeNameLen Mode name string length char modeDescription A description of the user defined mode unsigned int ModeDescriptionLen Mode Description string length unsigned int DRV SUCCESS All parameters accep
102. S GetBaselineClamp unsigned int WINAPI GetBaselineClamp int state Description Parameters Return See also This function returns the status of the baseline clamp functionality With this feature enabled the baseline level of each scan in a kinetic series will be more consistent across the sequence int state Baseline clamp functionality Enabled Disabled 1 Baseline Clamp Enabled 0 Baseline Clamp Disabled unsigned int DRV SUCCESS Parameters set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV NOT SUPPORTED Baseline Clamp not supported on this camera DRV P1INVALID State parameter was not zero or one SetBaselineClamp SetBaselineOffset GetBitDepth unsigned int WINAPI GetBitDepth int channel int depth Description Parameters Return See also This function will retrieve the size in bits of the dynamic range for any available AD channel int channel the AD channel int depth dynamic range in bits unsigned int DRV SUCCESS Depth returned DRV NOT INITIALIZED System not initialized P1INVALID Invalid channel GetNumberADChannels SetADChannel SECTION 11 Page 110 ANDOR FUNCTIONS GetCameraEventStatus unsigned int WINAPI GetCameraEventStatus DWORD camStatus Description Parameters Return See also NOTE This function will return if the system is exposing or not DWORD camStatus The statu
103. S Other Capabilities Other information about the camera can be obtained using the following functions e GetCapabilities e sinternalMechanicalShutter The GetCapabilities function populates an AndorCapabilities structure with information associated with the camera Afterwards this structure can be used to determine details about the camera e g supported acquisition modes supported trigger types The IslnternalMechanicalShutter function is used to determine if the camera has an internal mechanical shutter SECTION 9 Page 80 ANDOR Cea SPECIAL GUIDES Output Amplifiers Depending on the camera type and model there will be variations Output Amplifiers that can be applied to your acquisition e EMCCD Gain e Extended NIR e High Capacity By using the GetCapabilities function you can determine which amplifiers are available to your camera the ulSetFunctions field will return the revevent information EMCCD Gain EMCCD is a quantitative digital camera technology that is capable of detecting single photon events whilst maintaining high Quantum Efficiency achievable by way of a unique electron multiplying structure built into the sensor If ulSetFunctions bit 5 returns 1 then EM Gain can be set by either the SetOutputAmplifier or the SetHSSpeed functions figure 16 P d EMCCD Gain Pseudo Code Example Note This code does not compile Pra Start of program Initialize camera Initalize Using
104. SS Image has been copied into array DRV NOT INITIALIZED System not initialized DRV ERROR ACK Unable to communicate with card DRV_P1INVALID Invalid pointer i e NULL DRV_P2INVALID Array size is incorrect DRV_NO_NEW_DATA There is no new data yet GetMostRecentlmage GetOldestlmage16 GetOldestlmage Getlmages SECTION 11 Page 163 ANDOR FUNCTIONS GetMSTimingsData unsigned int WINAPI GetMSTimingsData SYSTEMTIME TimeOfStart float pfDifferences int inoOfimages Description THIS FUNCTION IS RESERVED GetMSTimingsEnabled unsigned int WINAPI GetMSTimingsEnabled void Description THIS FUNCTION IS RESERVED GetNewData unsigned int WINAPI GetNewData at_32 arr unsigned long size Description Deprecated see Note This function will update the data array to hold data acquired so far The data are returned as long integers 32 bit signed integers The array must be large enough to hold the complete data set When used in conjunction with the SetDriverEvent and GetAcquisitonProgress functions the data from each scan in a kinetic series can be processed while the acquisition is taking place Parameters At_ array pointer to data storage allocated by the user unsigned long size total number of pixels Return unsigned int DRV_SUCCESS Data copied DRV_NOT_INITIALIZED System not initialized DRV_ERROR_ACK Unable to communicate with card DRV_P1INVALID Invalid pointer i e NULL DRV_P2INVALID A
105. SS State returned DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED External outputs not supported DRV ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with card P1INVALID Invalid external output index DRV P2INVALID Enabled has invalid memory address See also GetCapabilities SetDDGExternalOutputEnabled NOTE Available on USB iStar GetDDGExternalOutputPolarity unsigned int WINAPI GetDDGExternalOutputPolarity at u32 Index at u32 Polarity Description This function gets the current polarity of a selected external output Parameters at u32 Index index of external output at u32 Polarity current polarity of external output 0 Positive 1 Negative Return unsigned int DRV SUCCESS Polarity returned DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED External outputs not supported ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with system P1INVALID Invalid external output index DRV_P2INVALID Polarity has invalid memory address See also GetCapabilities GetDDGExternalOutputEnabled SetDDGExternalOutputPolarity NOTE Available on USB iStar SECTION 11 Page 134 ANDOR ee FUNCTIONS GetDDGExternalOutputStepEnabled unsigned int WINAPI GetDDGExternalOutputStepEnabled at_u32 Index at_u32 Enabled Description Each external output has the option to track the gate step applied to the gater This function can
106. See also GetAvailableCameras SetCurrentCamera GetCurrentCamera InitializeDevice unsigned int WINAPI InitializeDevice char dir Description THIS FUNCTION IS RESERVED SECTION 11 Page 193 ANDOR e FUNCTIONS IsCoolerOn unsigned int WINAPI IsCoolerOn int iCoolerStatus Description This function checks the status of the cooler Parameters int iCoolerStatus 0 Cooler is OFF 1 Cooler is ON Return unsigned int DRV SUCCESS Status returned DRV NOT INITIALIZED System not initialized DRV_P1INVALID Parameter is NULL See also CoolerON CoolerOFF IsCountConvertModeAvailable unsigned int WINAPI IsCountConvertModeAvailable int mode Description This function checks if the hardware and current settings permit the use of the specified Count Convert mode Parameters int mode Count Convert mode to be checked Return unsigned int DRV_SUCCESS Count Convert mode available DRV_NOT_INITIALIZED System not initialized DRV_NOT_SUPPORTED Count Convert not supported on this camera INVALID COUNTCONVERT _ Count Convert mode not available with MODE current acquisition settings See also GetCapabilities SetCountConvertMode SetCountConvertWavelength IsInternalMechanicalShutter unsigned int WINAPI IsInternalMechanicalShutter int InternalShutter Description This function checks if an iXon camera has a mechanical shutter installed Parameters int InternalShutter 0 Mechanical shutter not installed 1 Mechan
107. SetAcquisitionMode SetNumberAccumulations SetNumberKinetics SetDriverEvent SECTION 11 Page 106 ANDOR FUNCTIONS GetAcquisitionTimings unsigned int WINAPI GetAcquisitionTimings float exposure float accumulate float kinetic Description Parameters Return See also This function will return the current valid acquisition timing information This function should be used after all the acquisitions settings have been set e g SetExposureTime SetKineticCycleTime and SetReadMode etc The values returned are the actual times used in subsequent acquisitions This function is required as it is possible to set the exposure time to 20ms accumulate cycle time to 30ms and then set the readout mode to full image As it can take 250ms to read out an image it is not possible to have a cycle time of 30ms float exposure valid exposure time in seconds float accumulate valid accumulate cycle time in seconds float kinetic valid kinetic cycle time in seconds unsigned int DRV_SUCCESS Timing information returned DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV INVALID MODE Acquisition or readout mode is not available SetAccumulationCycleTime SetAcquisitionMode SetExposureTime SetHSSpeed SetKineticCycleTime SetMultiTrack SetNumberAccumulations SetNumberKinetics SetReadMode SetSingleTrack SetTriggerMode SetVSSpeed GetAdjustedRingExposureTimes
108. SetHSSpeed SetHSSpeed 0 0 Using SetOutputAmplifier SetoOutputa mplifier 0 Shut down camera Shutdown i End of Program Figure 16 Example of EMCCD Gain Pseudo Code oDK SECTION 9 Page 81 ANDOR Coa SPECIAL GUIDES Extended NIR When using Extended is increased This in turn increases the response of the sensor to these wavelengths with a QE increase from 40 Near Infra Red Mode the increased thickness of the silicon on which the CCD is formed and by manipulating the voltages applied to the silicon substrate the depth of the region where red and NIR light can convert to photoelectrons to 60 at 650 nm If ulSetFunctions bit 7 returns 1 then Extended NIR mode can be activated by using either the SetOutputAmplifier or the SetHSSpeed functions figure 17 ff Extended NIR Pseudo Code Example Note This code does not compile af Start of program Initialize camera Initalize Using SetHSSpeed SetHSSpeed 1 0 Using SetOutputAmplifier SetOutputAmplifier 1 Shut down camera Shutdown i End of Program Figure 17 Example of Extended NIR Pseudo Code SECTION 9 Page 82 ANDOR en SPECIAL GUIDES High Capacity With High capacity enabled the responsivity of the sensor is reduced thus allowing the reading of larger charge packets during binning operations If ulSetFunctions bit 7 returns 1 then High Capacity mode can be activated bu usi
109. TE With Full Vertical Binning there is no shutter pulse The shutter will always be in the Open position See Shutter Mode on the previous page and Shutter Transfer Time on the next page The I O Box also contains a 30V shutter jack socket which produces the same signal as the TTL output but is always high to open see User Guide for further details NOTE Only applicable to classic systems For iXon cameras that have independent shutter control capability AC FEATURES SHUTTEREX we can control the TTL type and mode of the internal if available and external shutter independently using function SetShutterEx The external shutter signal will be output through the Shutter SMB port on the rear of the camera The internal and external shutters will have the same opening and closing times SECTION 7 Page 66 ANDOR ee SHUTTER CONTROL SHUTTER TRANSFER TIME Mechanical shutters take a finite time to open or close This is sometimes called the Shutter Transfer Time and can be of the order of tens to hundreds of milliseconds The Transfer Time is important for many reasons Firstly if your shutter takes 40ms to open and you specify an exposure time of 20ms then the shutter will simply not get the time to open fully Similarly if you are triggering a pulse light source via the Fire pulse then you will want to ensure that the Fire pulse goes high only when the shutter is opened Also if you are acquiring data in an imaging mode Multi Tra
110. TION 10 EXAMPLES 90 INTRODUCTION 90 RUNNING THE EXAMPLES 91 C 91 LabVIEW 91 Visual Basic 91 FLOW CHART OF THE FUNCTION CALLS NEEDED TO CONTROL ANDOR CAMERA 92 SECTION 11 FUNCTIONS 97 AbortAcquisition 97 CancelWait 97 CoolerOFF 98 CoolerON 99 Demosaiclmage 100 EnableKeepCleans 101 FreelnternalMemory 101 Filter_GetAveragingFactor 101 Filter_GetAveragingFrameCount 102 Filter_GetDataAveragingMode 102 Filter_GetMode 102 TABLE OF CONTENTS Page 3 ANDOR TABLE OF CONTENTS Filter_GetThreshold 103 Filter_SetAveragingFactor 103 Filter SetAveragingFrameCount 103 Filter SetDataAveragingMode 104 Filter SetMode 104 Filter SetThreshold 104 GetAcquiredData 105 GetAcquiredData16 105 GetAcquiredFloatData 106 GetAcquisitionProgress 106 GetAcquisitionTimings 107 GetAdjustedRingExposureTimes 107 GetAIIDMAData 108 GetAmpDesc 108 GetAmpMaxSpeed 109 GetAvailableCameras 109 GetBackground 109 GetBaselineClamp 110 GetBitDepth 110 GetCameraEventStatus 111 GetCameraHandle 111 GetCameralnformation 112 GetCameraSerialNumber 112 GetCapabilities 113 GetControllerCardModel 133 GetCountConvertWavelengthRange 133 GetCurrentCamera 133 GetCYMGShift 133 GetDDGExternalOutputEnabled 134 GetDDGExternalOutputPolarity 134 GetDDGExternalOutputStepEnabled 135 GetDDGExternalOutputTime 135 GetDDGStepCoefficients 136 GetDDGStepMode 137 GetDDGGateTime 137 GetDDGlInsertionDelay 138 GetDDGIntelligate 138 GetDDGIOC 138 GetDDGlOCFrequency 139 GetDDGl
111. TION 9 Page 71 N DOR WA euo SPECIAL GUIDES This example pseudo code demonstrates how to use the functions relating to the operation of multiple cameras ff Multiple Camera Pseudo Code Example Note This code does not compile ff This example demonstrates how to 1l Determine the number of cameras available 2 Obtain a handle for each camera 3 Initialize each camera 4 Perform a single scan acquisition with each camera 5 Check which camera is currently selected 6 Shut down each camera fi Start of program Determine the number of cameras available GetAvailabl eCameras Number fCameras ff Allocate memory for NumberOfCameras handles long CameraHandles Number0 fCameras Obtain a handle for each camera and initialize for index 0 to NumberOfCameras 1l GetCameraHsndletindex CameraHandles index SetCurrentCameraiCameraHandles index Initialize Set an exposure time for each camera and start the acquisition for index 0 to Number fCameras 1 SetCurrentCamera CameraHandles index SetAcquisitionMode 1 SetExposureTime Ary other camera settings Start Acquisition f f Wait until acquisition has finished T Check which camera is currently selected long UrinownCameraHandle GetCurrentCamera UnknownCamerasHandle ff Shat down each camera for index 0 to Number fCameras 1l SetCurrentCameraiCameraHandles in
112. TURES KEEPCLEANCONTROL determines if this function can be called for the camera Parameters int mode mode 0 OFF 1 ON Return unsigned int DRV SUCCESS Keep clean cycle mode set DRV NOT INITIALIZED System not initialized DRV NOT AVAILABLE Feature not available See also GetCapabilities NOTE Currently only available on Newton and iKon cameras operating in FVB external trigger mode FreelnternalMemory unsigned int WINAPI FreelnternalMemory void Description Parameters Return See also The FreelnternalMemory function will deallocate any memory used internally to store the previously acquired data Note that once this function has been called data from last acquisition cannot be retrived NONE unsigned int DRV SUCCESS Memory freed DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with card Getlmages PrepareAcquisition Filter GetAveragingFactor unsigned int WINAPI Filter GetAveragingFactor int averagingFactor Description Parameters Return Returns the current averaging factor value int averagingFactor The current averaging factor value unsigned int DRV SUCCESS Averaging factor returned SECTION 11 Page 101 ANDOR FUNCTIONS See also DRV NOT INITIALIZED DRV ACQUIRING DRV_P1INVALID Filter SetAveragingFactor System not initialized Acquisition in progress Invalid averagingFactor i e NUL
113. Time SetAcquisitionMode 1 SetExposureTime 0 3 Here the exposure time is the time during which the CCD sensor is sensitive to light The exposure time is set via the SetExposureTime function NOTE Due to the time needed to shift charge into the shift register digitize it and operate shutters where necessary the exposure time cannot be set to just any value For example the minimum exposure time depends on many factors including the readout mode trigger mode and the digitizing rate To help the user determine what the actual exposure time will be the driver automatically calculates the nearest allowed value not less than the user s choice The actual calculated exposure time used by Andor SDK may be obtained via the GetAcquisitionTimings function this function should be called after the acquisition details have been fully defined i e readout mode trigger mode etc have been set SECTION 4 Page 41 ANDOR ek ACQUISITION MODES Accumulate Accumulate mode adds together in computer memory the data from a number of scans to form a single accumulated scan This mode is equivalent to taking a series of Single Scans and manually adding them together However by using the built in Accumulate mode you gain the ability to specify the time delay or period between two consecutive scans and also the total number of scans to be added ACCUMULATED Example Exposure Time 0 35 Exposure Tire Accumulated Cycle time
114. UCCESS Data successfully saved DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with card DRV P1INVALID Path invalid DRV P2INVALID Invalid mode DRV ERROR PAGELOCK File too large to be generated in memory SaveAsRaw unsigned int WINAPI SaveAsRaw char szFileTitle int typ Description This function saves the last acquisition as a raw data file Parameters char szFileTitle the filename to save too int typ Valid values 1 Signed 16 2 Signed 32 3 Float Return unsigned int DRV SUCCESS Data successfully saved DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with card DRV_P1INVALID Path invalid DRV_P2INVALID Invalid mode DRV_ERROR_PAGELOCK File too large to be generated in memory See also SaveAsSif SaveAsEDF SaveAsFITS SaveAsSPC SaveAsTiff SaveAsBmp SECTION 11 Page 213 ANDOR FUNCTIONS SaveAsSif unsigned int WINAPI SaveAsSif char path Description Parameters Return See also This function will save the data from the last acquisition into a file which can be read in by the main application User text can be added to sif files using the SaveAsCommentedSif and SetSifComment functions char path pointer to a filename specified by the user unsigned int DRV SUCCESS Data saved DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in pro
115. VAILABLE Feature not available See also GetNumberlO GetlOLevel GetlODirection SetlODirection SECTION 11 Page 289 ANDOR ee FUNCTIONS SetUserEvent unsigned int WINAPI SetUserEvent HANDLE userEvent Description THIS FUNCTION IS RESERVED SetUSGenomics unsigned int WINAPI SetUSGenomics long width long height Description THIS FUNCTION IS RESERVED SetVerticalRowBuffer unsigned int WINAPI SetVerticalRowBuffer int rows Description THIS FUNCTION IS RESERVED SECTION 11 Page 290 ANDOR FUNCTIONS SetVerticalSpeed unsigned int WINAPI SetVerticalSpeed int index Description Deprecated see Note This function will set the vertical speed to be used for subsequent acquisitions Parameters int index index into the vertical speed table Valid values 0 to GetNumberVerticalSpeeds 1 Return unsigned int DRV_SUCCESS Vertical speed set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress P1INVALID Index out of range See also GetNumberVerticalSpeeds GetVerticalSpeed NOTE Deprecated by SetVSSpeed SetVirtualChip unsigned int WINAPI SetVirtualChip int state Description THIS FUNCTION IS RESERVED SECTION 11 Page 291 ANDOR FUNCTIONS SetVSAmplitude unsigned int WINAPI SetVSAmplitude int state Description If you choose a high readout speed a low readout time then you should also consider increasing the amplitude of the Vertical
116. VALID Invalid external output index DRV_P2INVALID Invalid delay DRV PS3INVALID Invalid width See also GetCapabilities GetDDGExternalOutputEnabled GetDDGExternalOutputTime NOTE Available in USB iStar SetDDGGain unsigned int WINAPI SetDDGGain int gain Description Deprecated for SetMCPGain SetDDGGateStep unsigned int WINAPI SetDDGGateStep double step Description This function will set a constant value for the gate step in a kinetic series The lowest available resolution is 25 picoseconds and the maximum permitted value is 25 seconds Parameters double step gate step in picoseconds Return unsigned int DRV_SUCCESS Gate step set DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with card DRV_P1INVALID Gate step invalid See also SetDDGTimes SetDDGVariableGateStep NOTE Available on iStar SECTION 11 Page 232 ANDOR e FUNCTIONS SetDDGGateTime unsigned int WINAPI SetDDGGateTime at u64 Delay at u64 Width Description This function can be used to set the gate timings for a USB iStar Parameters at u64 Delay gate delay time in picoseconds at u64 Width gate width time in picoseconds Return unsigned int DRV SUCCESS Timings set DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED USB iStar not supported ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with system DRV_P1INVALID Invalid delay
117. Valid values 0 Fire ANDed with the Gate input 1 Gating controlled from Fire pulse only 2 Gating controlled from SMB Gate input only 3 Gating ON continuously 4 Gating OFF continuously 5 Gate using DDG Return unsigned int DRV SUCCESS Gating mode accepted DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_I2CTIMEOUT command timed out DRV I2CDEVNOTFOUND C device not present DRV ERROR ACK Unable to communicate with card P1INVALID Gating mode invalid See also GetCapabilities SetMCPGain SetMCPGating SECTION 11 Page 257 ANDOR FUNCTIONS SetHighCapacity unsigned int WINAPI SetHighCapacity int state Description Parameters Return See also This function switches between high sensitivity and high capacity functionality With high capacity enabled the output amplifier is switched to a mode of operation which reduces the responsivity thus allowing the reading of larger charge packets during binning operations int state Enables Disables High Capacity functionality 1 Enable High Capacity Disable High Sensitivity 0 Disable High Capacity Enable High Sensitivity unsigned int DRV SUCCESS Parameters set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV P1INVALID State parameter was not zero or one GetCapabilities SetHorizontalSpeed unsigned int WINAPI SetHorizontalSpeed int index Description Para
118. WINAPI GetDualExposureTimes float exposure1 float exposure2 Description This function will return the current valid acquisition timing information for dual exposure mode This mode is only available for certain sensors in run till abort mode external trigger full image Parameters float exposure1 valid exposure time in seconds for each odd numbered frame float exposure2 valid exposure time in seconds for each even numbered frame Return unsigned int DRV SUCCESS Parameters set DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Dual exposure mode not supported on this camera DRV NOT AVAILABLE Dual exposure mode not configured correctly ACQUIRING Acquisition in progress DRV_P1INVALID exposure1 has invalid memory address DRV P2INVALID exposure2 has invalid memory address See also GetCapabilities SetDualExposureMode SetDualExposureTimes SECTION 11 Page 145 ANDOR ee FUNCTIONS GetEMAdvanced unsigned int WINAPI GetEMAdvanced int state Description Returns the current Advanced gain setting Parameters Int state current EM advanced gain setting Return DRV_SUCCESS Advanced state returned DRV_NOT_INITIALIZED System not initialized DRV_ERROR_ACK Unable to communicate with card DRV_P1INVALID state has invalid memory address GetEMCCDGain unsigned int WINAPI GetEMCCDGain int gain Description Returns the current gain setting The meaning of the value returned depends on the EM
119. XDNOTINSTALLED VxD not loaded DRV INIERROR Unable to load DETECTOR INI DRV COFERROR Unable to load COF DRV FLEXERROR Unable to load RBF DRV ERROR ACK Unable to communicate with card DRV I2CTIMEOUT Timed out reading from device DRV UNKNOWN FUNC Unknown function incorrect cof file See also I2CBurstWrite l2CBurstRead I2CRead l2CWrite SECTION 11 Page 191 ANDOR FUNCTIONS I2CWrite unsigned int WINAPI I2CWrite BYTE devicelD BYTE intAddress BYTE data Description This function will write a single byte to the chosen device Parameters BYTE devicelD The device to write to BYTE intAddress The internal address of the device to write to BYTE data The byte to be written to the device Return unsigned int DRV_SUCCESS Write successful DRV_VXDNOTINSTALLED VxD not loaded DRV_INIERROR Unable to load DETECTOR INI DRV_COFERROR Unable to load COF DRV_FLEXERROR Unable to load RBF DRV_ERROR_ACK Unable to communicate with card DRV I2CDEVNOTFOUND Could not find the specified device DRV I2CTIMEOUT Timed out reading from device DRV UNKNOWN FUNC Unknown function incorrect cof file See also I2CBurstWrite l2CBurstRead 2 l2cReset IdAndorDIl unsigned int WINAPI IdAndorDIl void Description THIS FUNCTION IS RESERVED InAuxPort unsigned int WINAPI InAuxPort int port int state Description This function returns the state of the TTL Auxiliary Input Port on the Andor plug
120. _SUCCESS State returned DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Phosphor status not supported DRV_ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with system DRV P1INVALID status has invalid memory address See also GetPhysicalDMAAddress unsigned int WINAPI GetPhysicalDMAAddress unsigned long Address1 unsigned long Address2 Description THIS FUNCTION IS RESERVED GetPixelSize unsigned int WINAPI GetPixelSize float xSize float ySize Description This function returns the dimension of the pixels in the detector in microns Parameters float xSize width of pixel float ySize height of pixel Return unsigned int DRV SUCCESS Pixel size returned SECTION 11 Page 174 ANDOR e FUNCTIONS GetPreAmpGain unsigned int WINAPI GetPreAmpGain int index float gain Description For those systems that provide a number of pre amp gains to apply to the data as it is read out this function retrieves the amount of gain that is stored for a particular index The number of gains available can be obtained by calling the GetNumberPreAmpGains function and a specific Gain can be selected using the function SetPreAmpGain Parameters int index gain index Valid values GetNumberPreAmpGains 1 float gain gain factor for this index Return unsigned int DRV SUCCESS Gain returned DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV_P1
121. abled Description This function sets the state of a selected external output Parameters at u32 Index index of external output at u32 Enabled state of external output 0 Off 1 On Return unsigned int DRV SUCCESS State set DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED External outputs not supported ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with system P1INVALID Invalid external output index DRV P2INVALID Invalid state See also GetCapabilities GetDDGExternalOutputEnabled NOTE Available on USB iStar SECTION 11 Page 230 ANDOR FUNCTIONS SetDDGExternalOutputPolarity unsigned int WINAPI SetDDGExternalOutputPolarity at_u32 Index at_u32 Polarity Description Parameters Return See also This function sets the polarity of a selected external output at_u32 Index index of external output at u32 Polarity polarity of external output 0 Positive 1 Negative unsigned int DRV SUCCESS DRV NOT INITIALIZED DRV NOT SUPPORTED DRV ACQUIRING DRV ERROR ACK DRV_P1INVALID DRV_P2INVALID NOTE Available on USB iStar Polarity set System not initialized External outputs not supported Acquisition in progress Unable to communicate with system Invalid external output index Invalid state GetCapabilities GetDDGExternalOutputEnabled GetDDGExternalOutputPolarity SetDDGExternalOutputStepEnabled unsigned i
122. abled SetDDGExternalOutputTime NOTE Available in USB iStar SECTION 11 Page 135 ANDOR FUNCTIONS GetDDGStepCoefficients unsigned int WINAPI GetDDGStepCoefficients at_u32 mode double p1 double p2 Description This function will return the coefficients for a particular gate step mode Parameters at_u32 mode the gate step mode Valid values 0 constant 1 exponential 2 logarithmic 3 linear Return unsigned int DRV SUCCESS DRV NOT INITIALIZED DRV NOT SUPPORTED DRV ACQUIRING DRV ERROR ACK DRV_P1INVALID DRV_P2_INVALID DRV_P3_INVALID Gate step coefficients returned System not initialized Gate step not supported Acquisition in progress Unable to communicate with system Gate step mode invalid p1 has invalid memory address p2 has invalid memory address See also StartAcquisition SetDDGStepMode SetDDGStepCoefficients SetDDGStepCoefficients SECTION 11 Page 136 ANDOR FUNCTIONS GetDDGStepMode unsigned int WINAPI GetDDGStepMode at_u32 mode Description This function will return the current gate step mode Parameters at_u32 mode the gate step mode Valid values 0 constant 1 exponential 2 logarithmic 3 linear 100 off Return unsigned int DRV_SUCCESS Gate step mode returned DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Gate step not supported DRV_ACQUIRING DRV_ERROR_ACK DRV_P1INVALID Acquisition in progress Unable to communicate with system
123. ages Description This function will return the maximum number of images that can be transferred during a single DMA transaction Parameters unsigned long images Return unsigned int DRV SUCCESS SECTION 11 Page 156 ANDOR FUNCTIONS GetlODirection unsigned int WINAPI GetlODirection int index int iDirection Description Available in some systems are a number of IO s that can be configured to be inputs or outputs This function gets the current state of a particular IO Parameters int index IO index Valid values 0 toGetNumberlO 1 int iDirection current direction for this index 0 Output 1 Input Return unsigned int DRV SUCCESS DRV NOT INITIALIZED DRV ACQUIRING DRV_P1INVALID DRV_P2INVALID DRV_NOT_AVAILABLE See also IO direction returned System not initialized Acquisition in progress Invalid index Invalid parameter Feature not available GetNumberlO GetlOLevel SetlODirection SetlOLevel GetlOLevel unsigned int WINAPI GetlOLevel int index int iLevel Description Available in some systems are a number of IO s that can be configured to be inputs or outputs This function gets the current state of a particular IO Parameters int index IO index Valid values 0 toGetNumberlO 1 int iLevel current level for this index 0 Low 1 High Return unsigned int DRV SUCCESS DRV NOT INITIALIZED DRV ACQUIRING DRV P1INVALID DRV P2INVALID DRV NOT AVAILABLE See also
124. and blue arrays are iX x iY iAlgorithm sets the algorithm to use The function sums all the colour values per each colour field within the Region Of Interest ROI and calculates the relative to green values as 0 fRelR GreenSum RedSum and fRelB GreenSum BlueSum 1 _fRelR 2 3 GreenSum RedSum and _fRelB 2 3 GreenSum BlueSum giving more importance to the green field iROI left iROI right iROI top and iROI bottom define the ROI with the constraints 0 iROI left lt iROI right iX and 0 iROI bottom lt iROI top iX WORD wRed pointer to red field WORD wGreen pointer to green field WORD wBlue pointer to blue field float fRelR pointer to the relative to green red factor float fRelB pointer to the relative to green blue factor WhiteBalancelnfo info pointer to white balance information structure unsigned int SUCCESS White balance calculated DRV_P1INVALID Invalid pointer i e NULL DRV_P2INVALID Invalid pointer i e NULL PSINVALID Invalid pointer i e NULL DRV PAINVALID Invalid pointer i e NULL PSINVALID Invalid pointer i e NULL P6INVALID One or more parameters in info is out of range DRV DIVIDE BY ZERO ERROR The sum of the green field within the ROI is zero fRelR and fRelB are set to 1 Demosaiclmage GetMostRecentColorlmage 1 6 SECTION 11 Page 300 ANDOR CODE DRV_ERROR_CODES DRV_SUCCESS DRV_VXDNOTINSTALLED DRV_ERROR_S
125. and SetShutterEx functions Figures 10 amp 11 on the next page show the timing sequence for both Internal and External triggering modes SECTION 7 Page 67 ANDOR en SHUTTER CONTROL SIGNALS amp DELATS i Shutter Output i Fire Output NERIS E Read Time Triggeri i Fire Pulse Duration i t t Time to Open Time to Close Shutter Transfer Time Shutter Transfer Time Figure 9 Timing diagram for shutter and fire pulses in internal trigger mode Fire Pulse Duration gt Shutter Output Exposure Time FirelGate Output Keep Clean Dos Read Time External Trigger vo Time to Close Figure 10 Timing diagram for shutter and fire pulses in external trigger mode NOTES 1 In the case of external triggering the external trigger pulse the shutter pulse and the fire pulse are all coincident If you are using a shutter and externally triggering the Andor system then the external trigger must be pulsed early enough to ensure that the shutter is fully opened before the light pulse arrives Please consult the documentation supplied by the shutter manufacturer to get an indication of the transfer time you can expect from your particular shutter 2 If you do not have a shutter connected set the Closing Time and Opening Time parameters to 0 Setting these parameters to any other value will insert extra delays into cycle time calculations SECTION 7 Page 68 p ANDOR
126. antage of the frame transfer operation in Software Trigger mode By the nature of frame transfer an exposure can be occurring when the previous acquisition is being read out Currently no PCI connected cameras can be sent a software trigger when the camera is reading out e USB cameras that support Software trigger can be sent a software trigger command during readout e Frame transfer is fully supported in external trigger mode SECTION 5 Page 63 ANDOR Je SHIFT SPEEDS SECTION 6 SHIFT SPEEDS The Andor system allows you to set the speed at which charge is shifted horizontally and vertically on the CCD The horizontal and vertical shift speeds are set via the SetHSSpeed and SetVSSpeed functions respectively The vertical shift speed is the speed at which each row on the CCD is shifted vertically into the Shift Register The number of vertical shift speeds and their actual values are determined via the GetNumberVSSpeeds and GetVSSpeed functions The horizontal shift speed is the speed at which the charge in the shift register is shifted horizontally It is also the speed at which the signal is digitized via the on board A D converters The number of horizontal shift speeds and their actual values are determined via the GetNumberHSSpeeds and GetHSSpeed functions The horizontal shift speed is dependant on the CCD type and the model of plug in card in the system The shift speeds are always returned fastest first The following
127. ar text Returns string value of the VS Amplitude found at the index supplied unsigned int DRV SUCCESS Vertical Clock Amplitude string returned DRV NOT INITIALIZED System not initialized DRV_P1INVALID Invalid index DRV_P2INVALID Invalid text pointer GetVSAmplitudeFromString GetVSAmplitudeValue GetVSAmplitudeValue SECTION 11 Page 187 ANDOR FUNCTIONS unsigned int WINAPI GetVSAmplitudeValue int index int value Description Parameters Return See also This Function is used to get the value of the Vertical Clock Amplitude found at the index passed in int index Index of VS amplitude required Valid values 0 to GetNumberVSAmplitudes 1 int value Returns Value of Vertical Clock Amplitude that matches index passed in unsigned int DRV_SUCCESS Vertical Clock Amplitude value returned DRV NOT INITIALIZED System not initialized DRV_P1INVALID Invalid index DRV P2INVALID Invalid value pointer GetVSAmplitudeFromString GetVSAmplitudeString GetVSSpeed unsigned int WINAPI GetVSSpeed int index float speed Description Parameters Return See also As your Andor SDK system may be capable of operating at more than one vertical shift speed this function will return the actual speeds available The value returned is in microseconds int index speed required Valid values to GetNumberVSSpeeds 1 float speed speed in microseconds per pixel shift unsigned int DRV SUCCESS S
128. aseline level by the amount selected For example 100 will add approximately 100 counts to the default baseline value The value entered should be a multiple of 100 between 1000 and 1000 inclusively Int offset Amount to offset baseline by unsigned int DRV SUCCESS Parameters set NOT INITIALIZED System not initialized DRV NOT AVAILABLE Baseline Clamp not available for this camera ACQUIRING Acquisition in progress DRV P1INVALID Offset out of range Only available on iXon range SECTION 11 Page 221 ANDOR e FUNCTIONS SetCameraLinkMode unsigned int WINAPI SetCameraLinkMode int mode Description This function allows the user to enable or disable the Camera Link functionality for the camera Enabling this functionality will start to stream all acquired data through the camera link interface Parameters int mode Enables Disables Camera Link mode 1 Enable Camera Link 0 Disable Camera Link Return unsigned int DRV SUCCESS Parameters set NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV NOT SUPPORTED Camera Link not supported by this Camera DRV P1INVALID Mode was not zero or one NOTE Only available with iXon Ultra SECTION 11 Page 222 ANDOR FUNCTIONS SetCameraStatusEnable unsigned int WINAPI SetCameraStatusEnable DWORD Enable Description Parameters Return See also NOTE Use this function to Mask out certain
129. ata8 165 GetNewFloatData 166 GetNumberADChannels 166 GetNumberAmp 166 GetNumberAvailablelmages 166 GetNumberDevices 167 GetNumberDDGExternalOutputs 167 GetNumberFKVShiftSpeeds 167 GetNumberHorizontalSpeeds 167 GetNumberHSSpeeds 169 GetNumberNewlmages 169 GetNumberPhotonCountingDivisions 170 TABLE OF CONTENTS Page 5 ANDOR TABLE OF CONTENTS GetNumberPreAmpGains 170 GetNumberRingExposureTimes 170 GetNumberlO 171 GetNumberVerticalSpeeds 172 GetNumberVSAmplitudes 172 GetNumberVSSpeeds 172 GetOldestlmage 173 GetOldestlmage16 173 GetPhosphorStatus 174 GetPhysicalDMAAddress 174 GetPixelSize 174 GetPreAmpGain 175 GetPreAmpGainText 176 GetQE 176 GetReadOutTime 177 GetRegisterDump 177 GetRelativelmageTimes 177 GetRingExposureRange 178 GetSDK3Handle 178 GetSensitivity 178 GetShutterMinTimes 179 GetSizeOfCircularBuffer 179 GetSlotBusDeviceFunction 179 GetSoftwareVersion 180 GetSpoolProgress 180 GetStartUpTime 180 GetStatus 181 GetTECStatus 182 GetTemperature 183 GetTemperatureF 183 GetTemperatureRange 184 GetTemperatureStatus 184 GetTotalNumberlmagesAcquired 184 GetTriggerLevelRange 185 GetVersionlInfo 186 GetVerticalSpeed 186 GetVirtualDMAAddress 187 GetVSAmplitudeFromString 187 GetVSAmplitudeString 187 GetVSAmplitudeValue 187 GetVSSpeed 188 GPIBReceive 189 GPIBSend 189 I2CBurstRead 190 I2CBurstWrite 190 I2CRead 191 I2CReset 191 12CWrite 192 IdAndorDIl 192 InAuxPort 192 Initialize 193 InitializeDevice 193
130. ate 1 Capability AC TRIGGERMODE INVERTED Description Inverted Trigger Mode available using SetTriggerlnvert Bit 6 State 1 SECTION 11 Page 117 TECHNOLOGY ANDOR hd FUNCTIONS Capability AC TRIGGERMODE EXTERNAL CHARGESHIFTING Description External Charge Shifting Trigger Mode available using SetChargeShifting Bit 7 State 1 SECTION 11 Page 118 ANDOR ee FUNCTIONS GetCapabilities Camera Type Camera Type AndorCapabilities Member ulCameraType Capability AC_CAMERATYPE_PDA Description Camera is an Andor PDA Bits 0 31 Value 0 Capability AC_CAMERATYPE_IXON Description Camera is an Andor iXon Bits 0 31 Value 1 Capability AC_CAMERATYPE_ICCD Description Camera is an Andor ICCD Bits 0 31 Value 2 Capability AC_CAMERATYPE_EMCCD Description Camera is an Andor EMCCD Bits 0 31 Value 3 Capability AC_CAMERATYPE_CCD Description Camera is an Andor CCD Bits 0 31 Value 4 Capability AC_CAMERATYPE_ISTAR Description Camera is an Andor iStar Bits 0 31 Value 5 Capability AC_CAMERATYPE_VIDEO Description Camera is a third party camera Bits 0 31 Value 6 SECTION 11 Page 119 ANDOR FUNCTIONS Capability AC_CAMERATYPE_IDUS Description Camera is an Andor iDus Bits 0 31 Value 7 Capability AC_CAMERATYPE_NEWTON Description Camera is an Andor Newton Bits 0 31 Value 8 Capability AC_CAMERATYPE_SURCAM Description Ca
131. ation LABVIEW INSTALLATION When you install the SDK onto a machine with LabVIEW installed the SDK DLL and LabVIEW files are automatically copied into the LabVIEW install directory All Andor SDK function wrappers are present in a LabVIEW library file atmcd32d llb installed in your user lib directory in you LabVIEW install folder The library can be added to any of your palette views Instructions for adding the SDK to your palette view are described below Note Depending on the version of LabVIEW you are using the menu structure may be different Please consult your LabVIEW manual for general help on adding LLBs if you have any issues Select the menu item Tools gt Advanced gt Edit Palette Views 2 Right Click on the Functions tool bar amp select Insert Submenu 3 In the dialog select Link to LLB library 4 Navigate to the user lib directory and select atmcd32d llb The submenu with all SDK functions has been added 5 Right click on the new palette view and select Rename Submenu 6 Change the name to Andor SDK 7 Repeat steps 2 6 for the Controls tool bar SECTION 2 Page 32 ANDOR oer INSTALLATION Linux Troubleshooting If you are having trouble running your camera under the Linux operating system please check the following before contacting Technical Support For PCI Check that the device driver is loaded Type sbin lsmod andordrvlx should be listed For USB
132. be used Finally to retrieve the oldest image the GetOldestlmage function can be used Due to the time needed to shift charge into the shift register digitize it and operate shutters where necessary the exposure time cannot be set to just any value For example the minimum exposure time depends on many factors including the readout mode trigger mode and the digitizing rate To help the user determine what the actual exposure time will be the driver automatically calculates the nearest allowed value that is not less than the user s choice Thus the actual calculated exposure time used by Andor SDK may be obtained via GetAcquisitionTimings this function should be called after the acquisition details have been fully defined i e readout mode trigger mode etc have been set SECTION 4 Page 45 ANDOR gt ACQUISITION MODES iCam Run Till Abort When in this mode of operation Run Till Abort some systems have an enhanced trigger mode and enhanced exposure time capability To check if these enhanced features are available with your system use the function GetCapabiliies and check the ulTriggerModes variable for bt AC_TRIGGERMODE_CONTINUOUS being set The enhanced features include 1 Ring of exposures 2 Software Trigger or External trigger 3 Ability to change exposure times during acquisition without aborting the run 4 External Level Exposure Bulb Trigger These enhanced features are particular useful in situation
133. bility AC_PIXELMODE_32BIT Description Camera can acquire in 32 bit mode Bit 3 State 1 Capability AC_PIXELMODE_MONO Description Camera acquires data in grey scale Bits 16 31 Value 0 Capability AC_PIXELMODE_RGB Description Camera acquires data in RGB mode Bits 16 31 Value 1 Capability AC_PIXELMODE_CMY Description Camera acquires data in CMY mode Bits 16 31 Value 2 Page 122 GetCapabilities Pixel Mode SECTION 11 ANDOR e FUNCTIONS GetCapabilities Available Set Functions Available Set Functions AndorCapabilities Member ulSetFunctions Capability AC SETFUNCTION VREADOUT Description The vertical readout speed can be set with the SetVSSpeed function Bit 0 State 1 Capability AC SETFUNCTION HREADOUT Description The horizontal readout speed can be set with the SetHSSpeed function Bit 1 State 1 Capability AC SETFUNCTION TEMPERATURE Description The target temperature can be set using the SetTemperature function Bit 2 State 1 Capability AC SETFUNCTION MCPGAIN AC SETFUNCTION GAIN Deprecated Description Gain through the SetMCPGain function is available Bit 3 State 1 Capability AC SETFUNCTION EMCCDGAIN Description Gain through the SetEMCCDGain function is available Bit 4 State 1 Capability AC SETFUNCTION BASELINECLAMP Description Baseline clamp can be turned on or off with the SetBaselineClamp function Bit 5 State 1 Capability
134. bled and the stem of the created spool files can be entered The acquisition mode is set to Kinetic Series Continuous mode This is a simple example to demonstrate the iCam functionality that some cameras may have SECTION 10 Page 96 ANDOR e FUNCTIONS SECTION 11 FUNCTIONS This section provides details of the various Functions available AbortAcquisition unsigned int WINAPI AbortAcquisition void Description This function aborts the current acquisition if one is active Parameters NONE Return unsigned int DRV SUCCESS Acquisition aborted DRV NOT INITIALIZED System not initialized DRV IDLE The system is not currently acquiring DRV VXDNOTINSTALLED VxD not loaded DRV ERROR ACK Unable to communicate with card See also GetStatus StartAcquisition CancelWait unsigned int WINAPI CancelWait void Description This function restarts a thread which is sleeping within the WaitForAcquisition function The sleeping thread will return from WaitForAcquisition with a value not equal to DRV SUCCESS Parameters NONE Return unsigned int DRV SUCCESS Thread restarted successfully See also WaitForAcquisition SECTION 11 Page 97 ANDOR e FUNCTIONS CoolerOFF unsigned int WINAPI CoolerOFF void Description Switches OFF the cooling The rate of temperature change is controlled in some models until the temperature reaches 0 Control is returned immediately to the calling application Parameters NO
135. can during an acquisition is completed 3 Temperature as stabilized drifted from stabilization or could not be reached When an event is triggered the user software can then use other SDK functions to determine what actually happened Condition 1 and 2 can be tested via GetStatus function while condition 3 checked via GetTemperature function You must reset the event after it has been handled in order to receive additional triggers Before deleting the event you must call SetDriverEvent with NULL as the parameter HANDLE driverEvent Win32 event handle unsigned int DRV_SUCCESS Event set DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Function not supported for operating system GetStatus GetTemperature GetAcquisitionProgress NOTE Not all programming environments allow the use of multiple threads and WIN32 events SECTION 11 Page 245 ANDOR FUNCTIONS SetDualExposureMode unsigned int WINAPI SetDualExposureMode int mode Description Parameters Return See also This function turns on and off the option to acquire 2 frames for each external trigger pulse This mode is only available for certain sensors in run till abort mode external trigger full image int state Enables Disables dual exposure mode 1 Enable mode 0 Disable mode unsigned int DRV_SUCCESS Parameters set DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Dual exposure mode not supporte
136. ccepted System not initialized Acquisition in progress command timed out device not present Unable to communicate with card Mode value invalid SECTION 11 Page 249 ANDOR e FUNCTIONS SetFastKinetics unsigned int WINAPI SetFastKinetics int exposedRows int seriesLength float time int mode int hbin int vbin Description This function will set the parameters to be used when taking a fast kinetics acquisition Parameters int exposedRows sub area height in rows int seriesLength number in series float time exposure time in seconds int mode binning mode 0 FVB 4 Image int hbin horizontal binning int vbin vertical binning only used when in image mode Return unsigned int DRV SUCCESS All parameters accepted DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_P1INVALID Invalid height DRV P2INVALID Invalid number in series PSINVALID Exposure time must be greater than 0 DRV PAINVALID Mode must be equal to 0 or 4 DRV_P5INVALID Horizontal binning DRV_P6INVALID Vertical binning See also SetFKVShiftSpeed SetFastKineticsEx NOTE For classic cameras the vertical and horizontal binning must be 1 For non classic cameras it is recommended that you use SetFastKineticsEx SECTION 11 Page 250 ANDOR ee FUNCTIONS SetFastKineticsEx unsigned int WINAPI SetFastKineticsEx int exposedRows int seriesLength float time int mod
137. ck Random Track Single Track or Image with either a continuous light source or a large high background illumination with a pulsed source the shutter must be fully closed before readout begins Otherwise a smeared image will result The SetShutter and SetShutterEx functions allow you to specify a Transfer Time for both opening and closing the shutter The time you specify for the shutter opening time will affect the minimum exposure time you can set via the SetExposureTime function For example if you set the opening time to Oms then the minimum exposure time will be set to the amount of time needed to clean the shift register on the CCD However if the opening time is set to a larger value than is needed to clean the shift register say 50ms then the minimum exposure time will be 51ms i e 1ms more than the time needed to open the shutter The SetExposureTime is in effect setting the length of time the shutter output will be in the open state The rising edge of the Fire output signal follows the start of the shutter open state after a delay equal to the value you set for the opening time via the SetShutter functions Andor SDK also automatically adds the Transfer Time for the closing of the shutter to the end of the acquisition sequence introducing an appropriate delay between the start of the shutter closed state and the commencement of the data being read out This value is set via the closing time parameter in the SetShutter
138. control method is that cameras cannot be simultaneously triggered using the software if simultaneous triggering is required then external triggers should be used SECTION 9 Page 70 ANDOR eo SPECIAL GUIDES USING MULTIPLE CAMERA FUNCTIONS The GetAvailableCameras function is used to return the number of Andor cameras available A handle for each camera is obtained using the GetCameraHandle function this handle should be stored for the lifetime of the application Any of the available cameras can then be selected by calling the SetCurrentCamera function and passing in the camera handle Once a camera has been selected any other SDK function can be called as normal but it will only apply to the selected camera Initialize must be called once for each camera that you wish to use At any stage the GetCurrentCamera function can be called and it will return the handle of the currently selected camera NOTE 1 It is not possible to unplug any cameras or plug in new ones during the lifetime of the application 2 It is not possible to trigger cameras simultaneously using software To simultaneously trigger more than one camera external triggers can be used or alternatively one camera can be triggered by software and the fire pulse from this camera used to trigger the others 3 Currently if only one camera is installed there is no need to obtain the camera handle or select it since this camera will be used by default SEC
139. creases speed and improves Signal to Noise ratio S D K SECTION 3 Page 34 ANDOR lt READOUT MODES Full Vertical Binning Full Vertical Binning FVB is the simplest mode of operation It allows you to use the CCD chip as a Linear Image Sensor similar to a photo diode array The charge from each column of pixels is vertically binned into the shift register This results in a net single charge per column Therefore for a 30 11 CCD an acquisition using FVB will result in 1024 data points To set up a Full Vertical Binning acquisition call SetReadMode 0 FULL VERTICAL BINNING Chip Height Figure 2 Full Vertical Binning Single Track Single Track mode is similar to the Full Vertical Binning mode discussed previously in that upon completion of an acquisition you will have a single spectrum However that is where the similarities end With Single Track you can specify not only the height in pixels of the area to be acquired but also its vertical position on the CCD To ensure the best possible Signal to Noise ratio all the rows within the specified area are binned together into the shift register of the CCD and then digitized SINGLE TRACK Centre Track Height Row Figure 3 Single track Single Track mode is useful because you are able to precisely define only the area of the CCD sensor that is illuminated by light This is particularly important in low light level applications as it al
140. ction This may give the user software an opportunity to perform other actions that will not affect the readout of the current acquisition Parameters HANDLE Event Win32 event handle Return unsigned int DRV_SUCCESS Event set DRV_NOT_INITIALIZED System not initialized DRV_NOT_AVAILABLE Function not supported for operating system See also GetTECStatus SetTemperature unsigned int WINAPI SetTemperature int temperature Description This function will set the desired temperature of the detector To turn the cooling ON and OFF use the CoolerON and CoolerOFF function respectively Parameters int temperature the temperature in Centigrade Valid range is given by GetTemperatureRange Return unsigned int DRV SUCCESS Temperature set DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with card DRV_P1INVALID Temperature invalid DRV_NOT_SUPPORTED The camera does not support setting the temperature See also CoolerOFF CoolerON GetTemperature GetTemperatureF GetTemperatureRange NOTE Not available on Luca R cameras automatically cooled to 20 SetTemperatureEvent unsigned int WINAPI SetTemperatureEvent HANDLE temperatureEvent Description THIS FUNCTION IS RESERVED SECTION 11 Page 286 ANDOR FUNCTIONS unsigned int WINAPI SetTriggerlnvert int mode Description external trigger Parameters int mode trigger mode Valid values 0 Rising Edge 1 Falli
141. cumulations SetNumberKinetics SetRegisterDump unsigned int WINAPI SetRegisterDump int mode Description THIS FUNCTION IS RESERVED SECTION 11 Page 277 ANDOR e FUNCTIONS SetRingExposureTimes unsigned int WINAPI SetRingExposureTimes int numTimes float times Description This function will send up an array of exposure times to the camera if the hardware supports the feature See GetCapabilities Each acquisition will then use the next exposure in the ring looping round to the start again when the end is reached There can be a maximum of 16 exposures Parameters int numTimes The number of exposures float times A predeclared pointer to an array of numTimes floats Return Unsigned int DRV SUCCESS Success DRV NOT INITIALIZED System not initialized DRV INVALID MODE This mode is not available DRV P1INVALID Must be between 1 and 16 exposures inclusive DRV P2INVALID The exposures times are invalid DRV_NOTAVAILABLE System does not support this option See also GetCapabilities GetNumberRingExposureTimes GetAdjustedRingExposureTimes GetRingExposureRange IsTriggerModeAvailable SECTION 11 Page 278 ANDOR FUNCTIONS SetSaturationEvent unsigned int WINAPI SetSaturationEvent HANDLE saturationEvent Description Parameters Return See also NOTE This is only supported with the 1 23 PCI card USB cameras do not have this feature This function passes a Win32 Event handle to t
142. d Version 2 90 30003 0 New features USB iStar now supported Added function GetNumberPhotonCountingDivisions Added function GetPreAmpGainText Added 64 bit C wrapper Added Shamrock C wrapper SECTION 1 Page 16 ANDOR INTRODUCTION Added 64 bit VB NET header Added 64 bit LabVIEW support Added support for 50kHz and 1MHz on iKonM PV inspector system Bug fixes GetKeepCleanTime not implemented for DV885 The maximum binning should be limited by the size of the AD pipeline Recursive filter was not being reset between acquisitions Frame Averaging filter was not working in frame transfer mode Fixed crash on shudown with iKon L Fixed crash if GetAcquisitionTimings is called for random tracks before tracks are set up Removed some memory leaks Incorrect timings from GetAcquisitionTimings on Clara Fixed saving random tracks to Fits Luca S did not support temperature control Minimum image length for a DU860 increased to 6 to avoid problems with isolated crop mode Fixed SetPreAmpGain and IsPreAmpGainAvailable functions to check that the preamp gain index parameter is within range Fixed data glitch on DV885 in frame transfer external exposure mode requires firmware upgrade Version 2 88 30002 0 New features Added SDK function IsCountConvertModeAvailable to limit acquisition settings available for count convert Added support for new iKon L systems Added support for new iKon M systems Added OptAc
143. d SetBaselineOffset The test for availability was not complete e Fixed GetRingExposureRange Now uses same limit as SetRingExposureTimes e Fixed SetRandomTracks Was failing for some valid tracks e Fixed SetGain error code Now returns DRV NOT SUPPORTED if not an ICCD e Fixed bug in SetRandomTracks to prevent negative numbers for number of tracks with correct return code e GetAmpMaxSpeed now tests for NULL array parameter e SetCustomTrackHBin returns DRV NOT SUPPORTED if not available for a system e Fixed GetAmpDesc Tests negative value for 3rd parameter could cause crash e Fixed GetAmpDesc could return unterminated string e Luca R cooler control was never supported but SDK returned SUCCESS SDK functions now return proper error codes e Fixed bug in Initialisation Shutdown cycling could cause crash e Extra fire pulse when using kinetic series external exposure on 00885 e Fixed incorrect data when using kinetic series external exposure on Luca R e Fixed external exposure trigger mode for Luca S Version 2 81 30004 0 New features e Improved noise performance on DZ936 cameras at 3 and 5MHz horizontal readout speeds Bug fixes e None Version 2 81 30003 1 New features e None Bug fixes e Fixed some documentation errors in LabVIEW context help e Fixed Shamrock close and re initialisation C interface of Shamrock SDK e Fixed Shamrock close operation in LabVIEW Version 2 81 30002 0 New
144. d memory address GetCapabilities SetDDGlOCNumber SetDDGIOC GetDDGIOCPeriod unsigned int WINAPI GetDDGlOCPeriod at u64 period Description Parameters Return See also This function can be used to return the actual IOC period that will be triggered It should only be called once all the conditions of the experiment have been defined at u64 period the period of integrate on chip pulses triggered within the fire pulse unsigned int DRV SUCCESS NOT INITIALIZED DRV NOT SUPPORTED DRV_ACQUIRING DRV_ERROR_ACK DRV_P1INVALID IOC period returned System not initialized IOC not supported Acquisition in progress Unable to communicate with system period has invalid memory address GetCapabilities SetDDGIOC SetDDGIOCPeriod SECTION 11 Page 140 ANDOR FUNCTIONS GetDDGIOCPulses unsigned int WINAPI GetDDGIOCPulses int pulses Description This function can be used to calculate the number of pulses that will be triggered with the given exposure time readout mode acquisition mode and integrate on chip frequency It should only be called once all the conditions of the experiment have been defined Parameters int pulses the number of integrate on chip pulses triggered within the fire pulse Return unsigned int DRV_SUCCESS Number returned DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with card See also
145. d on this camera ACQUIRING Acquisition in progress DRV P1INVALID Mode parameter was not zero or one GetCapabilities SetDualExposureTimes GetDualExposureTimes SetDualExposureTimes unsigned int WINAPI SetDualExposureTimes float exposure1 float exposure2 Description Parameters Return See also This function configures the two exposure times used in dual exposure mode This mode is only available for certain sensors in run till abort mode external trigger full image float exposure1 the exposure time in seconds for each odd numbered frame float exposure2 the exposure time in seconds for each even numbered frame unsigned int DRV SUCCESS Parameters set DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Dual exposure mode not supported on this camera ACQUIRING Acquisition in progress DRV P1INVALID First exposure out of range DRV P2INVALID Second exposure out of range GetCapabilities SetDualExposureMode GetDualExposureTimes SECTION 11 Page 246 ANDOR e FUNCTIONS SetEMAdvanced unsigned int WINAPI SetEMAdvanced int state Description This function turns on and off access to higher EM gain levels within the SDK Typically optimal signal to noise ratio and dynamic range is achieved between x1 to x300 EM Gain Higher gains of x300 are recommended for single photon counting only Before using higher levels you should ensure that light levels do not exceed the
146. ded e SetShutterEx added to control both an internal and external shutter through a DV8285 e SaveAsSif now handles spooled files Bug Fixes e GetNumberHSSpeeds now includes error checking for classics e GetCapabilities returns correct bit depth for an iDus e sPreAmpGainAvailable now indicates yes for classic cameras as long as the gain index is zero and other parameters are valid e EMGain Capability now returned correctly for iDus Newton USB iStar e SaveAsBmp was not working in latest version Version 2 74 New features e Support for new Luca range of Cameras e Control of linear EM gain GetEMCCDGain GetEMGainRange SetEMGainMode e Option to save to FITS file format SaveAsFITS e Crop mode available with Newton SetCropMode SECTION 1 Page 26 ANDOR as INTRODUCTION Version 2 73 New features e Support for Newton and SurCam range of Cameras Bug fixes e GetMostRecentlmage does not now prevent access to images previous to the one obtained e Controller type can be tested SECTION 1 Page 27 ANDOR PAS INSTALLATION SECTION 2 SOFTWARE INSTALLATIONS PC requirements Please consult the Specification Sheet for your camera for the minimum and the recommended PC requirements SDK WINDOWS INSTALLATION The installation of the Andor SDK software is a straightforward process the steps for which are outlined below Before proceeding with the installation it is recommended that you read the remainde
147. dedVSSpeed ShutDown unsigned int WINAPI ShutDown void Description This function will close the AndorMCD system down Parameters NONE Return unsigned int DRV SUCCESS System shut down See also CoolerOFF CoolerON SetTemperature GetTemperature NOTE 1 For Classic amp ICCD systems the temperature of the detector should be above 20 C before shutting down the system 2 When dynamically loading a DLL which is statically linked to the SDK library ShutDown MUST be called before unloading SECTION 11 Page 293 ANDOR FUNCTIONS unsigned int WINAPI StartAcquisition void Description GetStatus NONE unsigned int DRV SUCCESS NOT INITIALIZED ACQUIRING DRV VXDNOTINSTALLED DRV ERROR ACK DRV INIERROR DRV ACQERROR DRV ERROR PAGELOCK DRV INVALID FILTER BINNING ERROR DRV SPOOLSETUPERROR Parameters Return See also StartAcquisition This function starts an acquisition The status of the acquisition can be monitored via Acquisition started System not initialized Acquisition in progress VxD not loaded Unable to communicate with card Error reading DETECTOR INI Acquisition settings invalid Unable to allocate memory Filter not available for current acquisition Range not multiple of horizontal binning Error with spool settings GetStatus GetAcquisitionTimings SetAccumulationCycleTime SetAcquisitionMode SetExposureTime SetHSSpeed SetKineticCycleTi
148. dex ShutDbownt End of program Figure 11 Example of Multiple Camera Pseudo Code S D K SECTION 9 Page 72 ANDOR Cea SPECIAL GUIDES DATA RETRIEVAL METHODS How to determine when new data is available There are a wide of range of functions available for retrieving data from the camera Deciding which functions should be used depends on whether the data will be retrieved during an acquisition or once the acquisition is complete See Retrieving Image Data For certain cases it may be useful to know what stage an acquisition is at The GetStatus function can be used to get the current status of the acquisition It will return information such as the acquisition is in progress or it is finished See GetStatus for full list of return information Another way to know if an acquisition is finished is with the WaitForAcquisition function When an acquisition is started the WaitForAcquisition function can be called it does not return from this function until the acquisition is finished The function can be cancelled by calling the CancelWait function although this will require the user application to be multi threaded dip WaitForAcquisition Pseudo Code Example Note This code does not compile of Start of program Initialize camera Initialize Start the acquisition Start cquisition Wait for the acquisition to complete WaitFor cquisition Retrieve data Shut down ca
149. dex the speed to be used Valid values to GetNumberFKVShiftSpeeds 1 Return unsigned int DRV SUCCESS Fast kinetics vertical shift speed set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV P1INVALID Index is out off range See also GetNumberFKVShiftSpeeds GetFKVShiftSpeedF NOTE Only available if camera is Classic or iStar SetFPDP unsigned int WINAPI SetFPDP int state Description THIS FUNCTION IS RESERVED SetFrameTransferMode unsigned int WINAPI SetFrameTransferMode int mode Description This function will set whether an acquisition will readout in Frame Transfer Mode If the acquisition mode is Single Scan or Fast Kinetics this call will have no affect Parameters int mode mode 0 OFF 1 ON Return unsigned int DRV SUCCESS Frame transfer mode set DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_P1INVALID Invalid parameter See also SetAcquisitionMode NOTE Only available if CCD is a Frame Transfer chip SECTION 11 Page 253 ANDOR FUNCTIONS SetFrontEndEvent unsigned int WINAPI SetFrontEndEvent HANDLE Event Description Parameters Return See also This function passes a Win32 Event handle to the driver via which the driver can inform the user software that the Front End cooler has overheated or returned to a normal state To determine what event has actually occurred call the GetFrontEndStatus function This may give
150. e int hbin int vbin int offset Description This function is the same as SetFastKinetics with the addition of an Offset parameter which will inform the SDK of the first row to be used Parameters int exposedRows sub area height in rows int seriesLength number in series float time exposure time in seconds int mode binning mode 0 FVB 4 Image int hbin horizontal binning int vbin vertical binning only used when in image mode Int offset offset of first row to be used in Fast Kinetics from the bottom of the CCD Return unsigned int DRV SUCCESS All parameters accepted DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV_P1INVALID Invalid height DRV_P2INVALID Invalid number in series DRV PSINVALID Exposure time must be greater than 0 DRV PAINVALID Mode must be equal to 0 or 4 DRV PSINVALID Horizontal binning DRV P6INVALID Vertical binning DRV P7INVALID Offset not within CCD limits See also SetFKVShiftSpeed SetFastKinetics NOTE For classic cameras the offset must be 0 and the vertical and horizontal binning must be 1 For iDus it is recommended that you set horizontal binning to 1 SECTION 11 Page 251 ANDOR FUNCTIONS SetFastExtTrigger unsigned int WINAPI SetFastExtTrigger int mode Description Parameters Return See also This function will enable fast external triggering When fast external triggering is enabled the system wil NOT wa
151. e and the default selection a is the default type and is followed by a list of all possible types AD2DataHSSpeed AD2DataHSSpeed default min max This line specifies the possible horizontal readout speeds min and max specify the range of readout times available in microseconds SECTION 13 Page 308 ANDOR PAS DETECTOR INI AD2DumpHSSpeed AD2DumpHSSpeed default min max This is similar to AD2DataHSSpeed but specifies the readout speeds available when performing a dump i e discarding of data from the CCD AD2BinHSSpeed AD2BinHSSpeed default min max This is similar to AD2DataHSSpeed but specifies the readout speeds available when binning i e summing values from blocks of neighbouring pixels data from the CCD AD2Pipeline AD2Pipeline a b c See PipeLine in the controller section iXon Ixon a Specifies whether the CCD is an iXon camera if so the line will read Ixonz1 If this line is missing the CCD is not an iXon EXAMPLE DETECTOR INI FILES DH220 DH220 Format 1 024 1 DummyPixelsz0 0 0 0 DataHShiftSpeed 16 1 2 16 32 DataVShiftSpeed 16 16 0 0 0 DummyHShiftSpeed 16 1 2 16 32 DummyVShiftSpeed 16 16 0 0 0 VerticalHorizontalTime 16 16 0 0 0 CodeFile Instapda cof Pixel 25 0 2500 0 Cooling Single DV420 DV420 Format 1024 256 DummyPixels 8 8 0 0 DataHShiftSpeed 16 1 2 16 32 DataVShiftSpeed 16 16 0 0 0 DummyHShiftSpeed 16 1 2 16 32 DummyVShiftSpeed 16 16 0 0 0 VerticalHorizontalTime 16
152. e appropriate Andor SDK commands located just to the right of the flowchart The flowchart is divided into three sections the first deals with the initialization of the system and controlling the sensor temperature The second section deals with the data acquisition process while the third illustrates the proper shutdown procedure NOTE Do not have more than one example or other SDK software e g Andor Solis iQ running at the same time SECTION 10 Page 90 ANDOR eo EXAMPLES RUNNING THE EXAMPLES C The C examples are supplied as ready to run executable files both 32 bit and 64 bit and with complete source code The code has been tested with Microsoft VC 5 0 and Borland Developer Studio 2006 You are free to modify the example source code in the C directory to be compatible with your own compiler In order to compile your own C or C programs you will need the following files e ATMCD32D H C Header File e ATMCD32D LIB ATMCD64D LIB Import Library Borland compatible e ATMCD32M LIB ATMCD64M LIB Import Library Microsoft compatible LabVIEW The LabVIEW examples are contained in the sub directory LabVIEW of the installation directory The LabVIEW examples are in the form of VI s and must be run through LabVIEW 7 0 or higher 32 bit Visual Basic The Visual Basic examples are contained in the sub directory VBasic of the installation directory Each example contains all the source code forms and pro
153. e changed to export different scans in a kinetic series If the acquisition is any other mode position should be set to 1 The parameter typ can be set to 0 1 or 2 which correspond to 8 bit 16 bit and color respectively The mode parameter specifies the mode of output Data can be output scaled from the min and max count values across the entire range of values mode 0 or can remain unchanged mode 1 Of course if the count value is higher or lower than the output data range then even in mode 1 data will be scaled char path The filename of the tiff char palette The filename of a palette file PAL for applying color to the tiff int position The number in the series should be 1 for a single scan int typ The type of tiff file to create int mode The output mode unsigned int DRV_SUCCESS Data successfully saved as tiff DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with card DRV P1INVALID Path invalid DRV P2INVALID Invalid palette file DRV PSINVALID position out of range PAINVALID type not valid DRV_P5INVALID mode not valid DRV_ERROR_PAGELOCK File too large to be generated in memory SECTION 11 Page 216 ANDOR FUNCTIONS SaveEEPROMToFile unsigned int WINAPI SaveEEPROMTOoFile char cFileName Description THIS FUNCTION IS RESERVED SaveToClipBoard unsigned int WINAPI SaveToClipBoard char palette Descri
154. e fast kinetics vertical shift speed this function will return the actual speeds available The value returned is in microseconds per pixel shift Parameters int index speed required Valid values 0 to GetNumberFKVShiftSpeeds 1 float speed speed in micro seconds per pixel shift Return unsigned int DRV SUCCESS Speed returned DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV_P1INVALID Invalid index See also GetNumberFKVShiftSpeeds SetFKVShiftSpeed NOTE Only available if camera is Classic or iStar GetFrontEndStatus unsigned int WINAPI GetFrontEndStatus int status Description This function will return if the Front End cooler has overheated Parameters int status The status of the front end cooler 0 Normal 1 Tripped Return unsigned int DRV_SUCCESS State returned DRV_NOT_INITIALIZED System not initialized DRV_NOT_SUPPORTED Front End cooler not supported DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with card DRV_P1INVALID status has invalid memory address See also SetFrontEndEvent SECTION 11 Page 150 ANDOR eo FUNCTIONS GetGateMode unsigned int WINAPI GetGateMode int gatemode Description Allows the user to get the current photocathode gating mode Parameters int gatemode the gate mode Valid values 0 Fire ANDed with the Gate input 1 Gating controlled from Fire pulse only 2 Gating controlled from SMB Gate inpu
155. e limit in the vertical int MaxBinning Will contain the Maximum binning value on return Return unsigned int DRV SUCCESS Maximum Binning returned DRV NOT INITIALIZED System not initialized DRV_P1INVALID Invalid Readmode DRV_P2INVALID HorzVert not equal to 0 or 1 DRV_P3INVALID Invalid MaxBinning address i e NULL See also GetMinimumlmageLength SetReadMode SECTION 11 Page 158 ANDOR FUNCTIONS GetMaximumExposure unsigned int WINAPI GetMaximumExposure float MaxExp Description Parameters Return See also This function will return the maximum Exposure Time in seconds that is settable by the SetExposureTime function Float int MaxExp Will contain the Maximum exposure value on return unsigned int DRV_SUCCESS Maximum Exposure returned DRV_P1INVALID Invalid MaxExp value i e NULL SetExposureTime GetMaximumNumberRingExposureTimes unsigned int WINAPI GetMaximumNumberRingExposureTimes int number Description Parameters Return See also This function will return the maximum number of exposures that can be configured in the SetRingExposureTimes SDK function int number Will contain the maximum number of exposures on return unsigned int DRV_SUCCESS Success DRV_NOT_INITIALIZED System not initialized DRV_P1INVALID Invalid number value ie NULL DRV_NOTAVAILABLE System does not support this option GetCapabilities GetNumberRingExposureTimes GetAdjustedRingExposureTimes
156. e time for a fast kinetics acquisition This function should be used after all the acquisitions settings have been set i e SetFastKinetics and SetFKVShiftSpeed The value returned is the actual time used in subsequent acquisitions float time valid exposure time in seconds unsigned int DRV_SUCCESS Timing information returned DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV INVALID MODE Fast kinetics is not available See also SetFastKinetics SetFKVShiftSpeed GetFKVShiftSpeed unsigned int WINAPI GetFKVShiftSpeed int index int speed Description Parameters Return See also Deprecated see Note As your Andor SDK system is capable of operating at more than one fast kinetics vertical shift speed this function will return the actual speeds available The value returned is in microseconds per pixel shift int index speed required Valid values to GetNumberFKVShiftSpeeds 1 int speed speed in micro seconds per pixel shift unsigned int DRV SUCCESS Speed returned DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_P1INVALID Invalid index GetNumberFKVShiftSpeeds SetFKVShiftSpeed NOTE Deprecated by GetFKVShiftSpeedF SECTION 11 Page 149 ANDOR e FUNCTIONS GetFKVShiftSpeedF unsigned int WINAPI GetFKVShiftSpeedF int index float speed Description As your Andor system is capable of operating at more than on
157. eAsRaw Bug fixes SaveAsSif in SDK not storing readout speed correctly Shutter now works correctly for Classic cameras when the software is run for the first time after rebooting PC Data was wrapping at 65K if taking a kinetic series of accumulations Version 2 77 New features Supports 32 and 64 bit Windows XP and Vista Moved to new USB device driver libUSB iCam New Run Till Abort functionality for latest iXon with CCI 23 controller card and Luca Cameras SendSoftwareTrigger SetRingExposureTimes GetAdjustedRingExposureTimes GetNumberRingExposureTimes GetRingExposureRange IsTriggerModeAvailable New image manipulation functions SetlmageFlip SetlmageRotate Save as GRAMS SPC file format SaveAsSPC Calculate the red and blue relative to green factors to white balance a colour image WhiteBalance SECTION 1 Page 25 ANDOR INTRODUCTION Version 2 76 New features e Additional capabilities added to GetCapabilities function e GetAmpDesc function added e Timeout added for WaitForAcquisition function Bug fixes e Error returned if an invalid EM gain mode is selected e Fixed issues with Fast Kinetics on an iXon e Sometimes a camera was not ready to acquire when an acquisition event was sent e Fixed initialization problem when a was in the path send to Initialize function Version 2 75 New features e Spooling to FITS SIF and TIFF now available e SetBaselineOffset function ad
158. ea is the Image area this area is at the top and farthest from the readout register It is in this area that the CCD is sensitive to light 2 The second area is the Storage area and sits between the Image area and the readout register This area is covered by an opaque mask usually a metal film and hence is not sensitive to light e The second way in which a FT CCD differs from a standard CCD is that the Image and the Storage areas can be shifted independently of each other These differences allow a FT CCD to be operated in a unique mode where one image can be read out while the next image is being acquired It also allows a FT CCD to be used in imaging mode without a shutter Only light falling inthis region M is captured Opaque film covers this region Readout Register Figure 7 Frame Transfer CCD SECTION 4 Page 49 ANDOR es ACQUISITION MODES Figure 8 takes you through the capture sequence for an FT CCD Continuously Clean CCD Keep Clean Cycle lt n lt lt Step 2 Step 3 Step 1 E Hi A Step 4 Step 5 Step 6 Figure 8 Capture sequence for a Frame Transfer CCD Step 1 Both Image and Storage areas of the CCD are fully cleaned out This is known as a Keep Clean Cycle Keep Clean Cycles occur continuously to ensure that the camera is always ready to start an acquisition when required Step 2 On receipt of a start acquisition command t
159. ed NOT INITIALIZED System not initialized DRV NO NEW DATA Non Acquisition Event occurred e g CancelWait called StartAcquisition CancelWait WaitForAcquisitionByHandle unsigned int WINAPI WaitForAcquisitionByHandle long cameraHandle Description Parameters Return Whilst using multiple cameras WaitForAcquisitionByHandle can be called after an acquisition is started using StartAcquisition to put the calling thread to sleep until an Acquisition Event occurs This can be used as a simple alternative to the functionality provided by the SetDriverEvent function as all Event creation and handling is performed internally by the SDK library Like the SetDriverEvent functionality it will use less processor resources than continuously polling with the GetStatus function If you wish to restart the calling thread without waiting for an Acquisition event call the function CancelWait An Acquisition Event occurs each time a new image is acquired during an Accumulation Kinetic Series or Run Till Abort acquisition or at the end of a Single Scan Acquisition Long cameraHandle handle of camera to put into wait state unsigned int DRV SUCCESS Acquisition Event occurred DRV P1INVALID Handle not valid SECTION 11 Page 296 ANDOR DRV_NO_NEW_DATA Non Acquisition Event occurred eg CancelWait called See also CancelWait GetCameraHandle StartAcquisition WaitForAcquisition WaitForAcquisition TimeOut WaitForAc
160. eg CancelWait called time out CancelWait GetCameraHandle StartAcquisition WaitForAcquisition WaitForAcquisitionByHandle WaitForAcquisitionTimeOut SECTION 11 Page 298 ANDOR FUNCTIONS WaitForAcquisitionTimeOut unsigned int WINAPI WaitForAcquisitionTimeOut int iTimeOutMs Description Parameters Return See also WaitForAcquisitionTimeOut can be called after an acquisition is started using StartAcquisition to put the calling thread to sleep until an Acquisition Event occurs This can be used as a simple alternative to the functionality provided by the SetDriverEvent function as all Event creation and handling is performed internally by the SDK library Like the SetDriverEvent functionality it will use less processor resources than continuously polling with the GetStatus function If you wish to restart the calling thread without waiting for an Acquisition event call the function CancelWait An Acquisition Event occurs each time a new image is acquired during an Accumulation Kinetic Series or Run Till Abort acquisition or at the end of a Single Scan Acquisition If an Acquisition Event does not occur within TimeOutMs milliseconds WaitForAcquisition TimeOut returns DRV NO NEW DATA int iTimeOutMs Time before returning DRV NO NEW DATA if no Acquisition Event occurs DRV_SUCCESS Acquisition Event occurred DRV_NO_NEW_DATA Non Acquisition Event occurred eg CancelWait called time out CancelWa
161. elld channel at u32 ui32Pulses Description THIS FUNCTION IS RESERVED SetDDGLitePulseWidth SECTION 11 Page 237 ANDOR FUNCTIONS unsigned int WINAPI SetDDGLitePulseWidth AT_DDGLiteChannelld channel float fWidth Description THIS FUNCTION IS RESERVED SECTION 11 Page 238 ANDOR e FUNCTIONS SetDDGOpticalWidthEnabled unsigned int WINAPI SetDDGOpticalWidthEnabled at u32 Enabled Description This function can be used to configure a system to use optical gate width Parameters at u32 Enabled optical gate width option 0 Off 1 On Return unsigned int DRV SUCCESS State set DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Optical gate width not supported ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with system DRV_P1INVALID Invalid state See also GetCapabilities GetDDGTTLGateWidth GetDDGOpticalWidthEnabled SetDDGStepCoefficients unsigned int WINAPI SetDDGStepCoefficients at_u32 mode double p1 double p2 Description This function will configure the coefficients used in a kinetic series with gate step active The lowest available resolution is 25 picoseconds and the maximum permitted value is 25 seconds for a PCI iStar The lowest available resolution is 10 picoseconds and the maximum permitted value is 10 seconds for a USB iStar Parameters at_u32mode the gate step mode Valid values 0 constant p1 n 1 1 exponential p1 exp p2 n
162. ensitivity Suited to the majority of EMCCD applications 2 Dynamic Range and Speed EM Amplifier Configured to deliver optimal dynamic range at fast frame rates Moderate EM gain applied 3 Fastest Frame Rate EM Amplifier For when it s all about speed Optimized for absolute fastest frame rates of the camera Especially effective when combined with sub array binning selections 4 Time Lapse EM Amplifier Configured to capture low light images with time intervals between exposures Overlap frame transfer readout is deactivated 5 Time Lapse and Short Exposures EM Amplifier Configured to minimize vertical smear when using exposure times less than 3ms 6 EMCCD Highest Dynamic Range EM Amplifier Combines EMCCD low light detection with the absolute highest dynamic range that the camera can deliver Since this requires slower readout frame rate is sacrificed 7 CCD Highest Dynamic Range Conventional Amplifier Optimized for slow scan CCD detection with highest available dynamic range Recommended for brighter signals OR when it is possible to apply long exposures to overcome noise floor 8 Photon Counting EM Configuration recommended for photon counting with individual exposures 10sec 9 Photon Counting with Long Exposures 1sec Configuration recommended for photon counting with individual exposures 1sec The following list details the valid acquisition parameters and input values for use with OptAcquire functi
163. ep 4 Step 6 Step 5 e Step 1 Both Image and Storage areas of the CCD are fully cleared out the Keep Clean Cycle e Step 2 When an acquisition begins the CCD stops the Keep Clean Cycle The image builds up in the Image area of the CCD The CCD remains in this state until the exposure time has elapsed at which point the readout process starts e Step 3 The charge built up in the Image area is quickly shifted into the Storage area The time required to move the charge into the Storage area is the same as in the Frame Transfer mode e Step 4 With the image now in the Storage area the captured image is read out The time taken to read out the image is again the same as in the Frame Transfer mode e Step 5 On completion of the readout the CCD is again completely cleared ready to acquire the next image The CCD remains in the Keep Clean Cycle until the end of the accumulation or kinetic cycle time depending on the acquisition mode i e back to Step 1 As at least one Keep Clean Cycle is performed between each exposure the minimum exposure time is no longer set by the time to read out the image As the captured image is quickly shifted into the Storage area even in non Frame Transfer mode the system may still be used without a mechanical shutter SECTION 4 Page 52 ANDOR ACQUISITION MODES NOTES e When using an FT CCD as a standard CCD the Exposure Time Accumulation Cycle Time and Kinetic
164. equence of single scans and adds them together Kinetic Series mode captures a sequence of single scans or possibly depending on the camera a sequence of accumulated scans Run Till Abort continually performs scans of the CCD until aborted If your system is a Frame Transfer CCD the acquisition modes can be enhanced by setting the chip operational mode to Frame Transfer In the remainder of this section we will discuss in detail what each of these modes actually are and what needs to be specified to fully define an acquisition The table below summarizes the information that is needed for each acquisition mode NO ACCUMULATE NO KINETIC MODE EXPOSURE CYCLE OF CYCLE ae KINETIC TIME ACCUMULATIONS TIME SERIES SINGLE SCAN X ACCUMULATE X X X KINETIC SERIES X X X X X RUN TILL ABORT X X FAST KINETICS X X X NOTE For the purpose of this document an acquisition is taken to mean the complete data capture process By contrast a scan is a single readout of data from the CCD Chip i e a complete data acquisition comprises the capture of one or more scans SECTION 4 Page 40 ANDOR i ACQUISITION MODES Single Scan Single Scan is the simplest acquisition mode available with the Andor system In this mode Andor SDK performs one scan or readout of the CCD and stores the acquired data in the memory of the PC SINGLE SCAN Example Exposure Time 0 35 To set the acquisition mode to Single Scan call Exposure
165. ers associated with the specified mode to be used for all subsequent acquisitions The mode specified by the user must be in either the Preset file or the User defined file Parameters const char const ModeName The mode to be used for all subsequent acquisitions Return unsigned int DRV_SUCCESS All parameters accepted DRV_P1INVALID Null mode name DRV OA MODE DOES NOT EXIST Mode name does not exist DRV OA CAMERA NOT SUPPORTED Camera not supported See also OA AddMode OA GetFloat unsigned int WINAPI OA GetFloat const char const ModeName const char const ModeParam float FloatValue Description This function is used to get the values for floating point type acquisition parameters Values are retrieved from memory for the specified mode name Parameters const char const ModeName The name of the mode for which an acquisition parameter will be retrieved const char const ModeParam The name of the acquisition parameter for which a value will be retrieved float FloatValue The value of the acquisition parameter Return unsigned int DRV SUCCESS All parameters accepted P1INVALID Null mode parameter DRV P2INVALID Null mode parameter DRV PSINVALID Null float value See also OA SetFloat SECTION 11 Page 198 ANDOR e FUNCTIONS OA Getint unsigned int WINAPI OA Getlnt const char const ModeName const char const ModeParam int IntValue Description This function is used to get the values for
166. es unsigned int WINAPI GetNumberRingExposureTimes int ipnumTimes Description Parameters Return See also Gets the number of exposures in the ring at this moment int ipnumTimes Numberof exposure times unsigned int DRV SUCCESS Success NOT INITIALIZED System not initialized SetRingExposureTimes SECTION 11 Page 170 ANDOR e FUNCTIONS GetNumberlO unsigned int WINAPI GetNumberlO int iNumber Description Available in some systems a number of IO s that can be configured to be inputs or outputs This function gets the number of these lO s available The functions GetlODirection GetlOLevel SetlODirection and SetlOLevel can be used to specify the configuration Parameters int iNumber number of allowed lO s Return unsigned int DRV SUCCESS Number of IO s returned DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_P1INVALID Invalid parameter DRV_NOT_AVAILABLE Feature not available See also GetlOLevel GetlODirection SetlODirection SetlOLevel SECTION 11 Page 171 ANDOR FUNCTIONS GetNumberVerticalSpeeds unsigned int WINAPI GetNumberVerticalSpeeds int number Description Parameters Return See also Deprecated see Note As your Andor system may be capable of operating at more than one vertical shift speed this function will return the actual number of speeds available int number number of allowed vertical speeds
167. es calculated using the previous settings If the number of images per dma is calculated to be greater than MaxImagesPerDMA then it will be reduced to MaxlmagesPerDMA This can be used to for example ensure that there is never more than 1 image per DMA by setting MaxImagesPerDMA to 1 Setting MaxImagesPerDMA to zero removes this limit Care should be taken when modifying these parameters as missed interrupts may prevent the acquisition from completing int MaxImagesPerDMA Override to the number of images per DMA if the calculated value is higher than this Default 0 ie no override float SecondsPerDMA Minimum amount of time to elapse between interrrupts Default 0 03s unsigned int DRV_SUCCESS DMA Parameters setup successfully DRV_NOT_INITIALIZED System not initialized DRV_P1INVALID MaxlmagesPerDMA invalid DRV P2INVALID SecondsPerDMA invalid SECTION 11 Page 244 ANDOR FUNCTIONS SetDriverEvent unsigned int WINAPI SetDriverEvent HANDLE driverEvent Description Parameters Return See also This function passes a Win32 Event handle to the SDK via which the the user software can be informed that something has occurred For example the SDK can set the event when an acquisition has completed thus relieving the user code of having to continually pole to check on the status of the acquisition The event will be set under the follow conditions 1 Acquisition completed or aborted 2 As each s
168. es mode captures a sequence of single scans or a sequence of accumulated scans into memory This mode is equivalent to manually taking a series of single scans or accumulated scans However by using the built in Kinetic Series mode you gain the ability to specify the time delay or period between two consecutive scans and also the total number of scans to be acquired KINETIC SERIES Exposure Time 0 35 Exposure Time Kinetic Cycle Time 35 e No in Kinetic Series 3 Accumulated Cycle time 1 518 s Kinetic Cycle Time No of Accurnulations 3 Kinetic Cycle Time 3s No in Kinetic series 4 co lt Kinetic Cycle Time ACCUMULATED KINETIC SERIES Exposure Time ES Accumulations i i oe gt E lt i Mese Code TH Exposure Time 03 s NOTE In External Trigger mode the delay between each scan making up the acquisition is not under the control of the Andor SDK but is synchronized to an externally generated trigger pulse SUK SECTION 4 Page 43 ANDOR ACQUISITION MODES To set the acquisition mode to Kinetic Series call SetAcquisitionMode 3 To fully define a Kinetic Series acquisition you will need to supply the following information Exposure Time This is the time in seconds during which the CCD collects light prior to readout Set via the SetExposureTime function Number of Accumulations This is the number of scans you want to add
169. etSifComment SaveAsSif SaveASEDF SaveAsFITS SaveAsRaw SaveAsSPC SaveAs Tiff SaveAsBmp NOTE The comment used in SIF files created with this function is discarded once the call completes i e future calls to SaveAsSif will not use this comment To set a persistent comment use the SetSifComment function SaveAsEDF unsigned int WINAPI SaveAsEDF char szPath int iMode Description Parameters Return See also This function saves the last acquisition in the European Synchotron Radiation Facility Data Format edf char szPath the filename to save too int iMode option to save to multiple files Valid values 0 Save to 1 file 1 Save kinetic series to multiple files unsigned int DRV_SUCCESS Data successfully saved DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with card DRV_P1INVALID Path invalid DRV_P2INVALID Invalid mode DRV_ERROR_PAGELOCK File too large to be generated in memory SECTION 11 Page 212 ANDOR FUNCTIONS SaveAsFITS unsigned int WINAPI SaveAsFITS char szFileTitle int typ Description Parameters Return See also This function saves the last acquisition in the FITS Flexible Image Transport System Data Format fits endorsed by NASA char szFileTitle the filename to save too int typ Valid values 0 Unsigned 16 1 Unsigned 32 2 Signed 16 3 Signed 32 4 Float unsigned int DRV_S
170. etTemperature StartAcquisition NOTE If the status is one of the following e DRV ACCUM TIME NOT MET e DRV KINETIC TIME NOT MET e DRV ERROR ACK e DRV ACQ BUFFER then the current acquisition will be aborted automatically SECTION 11 Page 181 ANDOR FUNCTIONS GetTECStatus unsigned int WINAPI GetTECStatus int status Description This function will return if the TEC has overheated Parameters int status The status of the TEC 0 Normal 1 Tripped Return unsigned int DRV SUCCESS State returned DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED TEC status not supported ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with card DRV P1INVALID status has invalid memory address See also SetTECEvent SECTION 11 Page 182 ANDOR ee FUNCTIONS GetTemperature unsigned int WINAPI GetTemperature int temperature Description This function returns the temperature of the detector to the nearest degree It also gives the status of cooling process Parameters int temperature temperature of the detector Return unsigned int DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with card DRV_TEMP_OFF Temperature is OFF DRV_TEMP_STABILIZED Temperature has stabilized at set point DRV_TEMP_NOT_REACHED Temperature has not reached set point DRV_TEMP_DRIFT Temperature had stabilized but has since drifted DRV_TEMP_
171. eters The acquisition is set to a kinetic series of full vertically binned scans EMCCD This example demonstrates acquisitions with an EMCCD detector and in particular the Gain setting that can be applied to these devices Events The events example shows the alternative method of handling acquisitions using Windows events to signal when the acquisition is complete instead of timer polling used in other examples A kinetic series of full vertically binned scans is taken and the events signalled by the Andor SDK are indicated in the status window as they arrive Frame Transfer The frame transfer example is similar to the kinetics example except that the accumulate cycle and kinetic Series times can not be set independently as they rely solely on the exposure time setting FVB This example illustrates the simplest mode of operation of the Andor system It initializes the system and then acquires a single spectrum using the Full Vertical Binning readout mode The user is given the ability to specify the trigger mode and exposure time as the examples progress the user is given more and more options to set Image This example is slightly more complicated than the first example with the addition of a shutter In general a shutter must be used whenever the readout mode is anything other than Full Vertical Binning For this example we will use the readout mode Image with the horizontal and vertical binning set to 1 The user is given the ability to
172. etic cycle time could not be set reliably Shutter timings not correct at 35MHz on a DU885 SetShutter function not functioning correctly for iXon Grams files created not compatible with certain software packages EM gain could not be turned off completely Glitches were found in fire pulse for FVB mode on iXon Image flipping and rotation properties incorrect in sif file CCI 20 controller card not initialising ERROR ACK Version 2 78 5 New features SetlsolatedCropMode added to LabVIEW library SaveAsTiffEx function added to provide choice of whether data is scaled Bug fixes SaveAsTiff function for a kinetic series saved the same image for every frame SaveAsTiff now checks for available memory to avoid crash GetHeadModel function was returning model in lowercase iXon FPGA version not being read properly in Initialize function SetlsolatedCropMode function repaired GetAvailableCameras did not update with USB devices plugged in amp out Using GetCameraEventStatus on fast acquisitions caused acquisition to fail Long kinetic series of FITS was not working SECTION 1 Page 24 ANDOR INTRODUCTION Version 2 78 New features Support for Luca 285 added Data transfer from USB cameras improved SetlsolatedCropMode function added to provide crop mode option added for iXon Improved support for integrate on chip Added GetDDGIOCFrequency GetDDGlOCNumber SetDDGlOCNumber Option to export to raw data Sav
173. eudo code for this capability is shown here gal Horizontal Pixel Shift Pseudo Code Example Note This code does not compile ff ff Start of program ff Initialize camera Initialize long MunmCharnels MNumPre impiairsz long Bitbepth WiumHipeeds IsPreAmp vailable float 52 ecHumber ADCharnnels MumCharnnels etc Number ecHunberPreimpioainsiMNumPre impiainsz for ii 0 to HumChannels 1 GetBitbeptht i Bitbepth for j Oto Numimp 1l GetHumberHiSpeeds i 7 NHunHSpeeds for ik 0 to NumHSpeedz 5 j E HSSpeed for im 0 to NumnPre mpiainzs l Get Pre mpGain m Pre Amp Gain Shut down camera Shut Dow f End of program TePretmpGainkvailableti j m IsPreA mp vailabls Figure 14 Example of Horizontal Pixel Shift Pseudo Code Page 78 SECTION 9 ANDOR Cea SPECIAL GUIDES Vertical Pixel Shift Capabilities Depending on the camera type and model there will be variations in the number of Vertical Shift Speeds available The first step in this process is to determine the number of vertical shift speeds using the GetNumberVSSpeeds function Following this the value of each vertical shift soeed can be found using the GetVSSpeed function Since the camera may be capable of operating at more than one vertical shift speed the GetFastestRecommendedVSSpeed function will return the i
174. features e None Bug fixes e Fixed cooling issue on Fibre Optic systems SECTION 1 Page 21 ANDOR INTRODUCTION Fixed hot column issue on iXon DU888 cameras Fixed crash in External Trigger on Newton Fixed DLL error on Windows Install program Version 2 81 New features Improved shutdown in Linux during abnormal termination Ctrl C etc signal handlers added CCI 24 support added to Linux SDK Bug fixes Removed Linux Device Driver compilation warnings for Kernel 2 6 23 and above Crash could occur if GetAcquiredData was called before PrepareAcquisition or StartAcquisition SetDriverEvent causes crash when called when system not initialized GetlmagesPerDMA did not return correct value unless PrepareAcquisition has been called Timings incorrect for Frame Transfer in iCam mode GetMostRecentlmage 16 now returns correct data when used in Accumulate acquisition mode Fixed crash that would occur if GetNumberAvailablelmages called before acquisition started Acquisitions now complete correctly if camera is reinitialised after being previously shutdown 64 bit SDK will now initialise USB cameras without the necessity of having libusbO x64 dll in same directory as executable Calibration values returned from Shamrock SDK were offset by 2 pixels from correct locations Fixed memory leak in SaveAsSif Fixed Luca re initialisation issue temperature reporting incorrect Documentation updates and corrections Versio
175. float sensitivity Description Parameters Return See also This function returns the sensitivity for a particular speed int channel AD channel index int amplifier of output amplifier int index Channel speed index int pa PreAmp gain index float sensitivity requested sensitivity unsigned int DRV SUCCESS Sensitivity returned DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV P1INVALID Invalid channel DRV P2INVALID Invalid amplifier DRV PSINVALID Invalid speed index DRV_P4INVALID Invalid gain GetCapabilities NOTE Available only on iXon and Clara SECTION 11 Page 178 ANDOR FUNCTIONS GetShutterMinTimes unsigned int WINAPI GetShutterMinTimes int minclosingtime int minopeningtime Description Parameters Return This function will return the minimum opening and closing times in milliseconds for the shutter on the current camera int minclosingtime returns the minimum closing time in milliseconds that the shutter of the camera supports int minopeningtime returns the minimum opening time in milliseconds that the shutter of the camera supports unsigned int DRV_SUCCESS Minimum times successfully returned DRV NOT INITIALIZED System not initialized DRV P1INVALID Parameter is NULL DRV P2INVALID Parameter is NULL GetSizeOfCircularBuffer unsigned int WINAPI GetSizeOfCircularBuffer long index Descrip
176. g for Cycle Time Start command B Exposure period Image area clocks Storage area clocks Horizontal clocks External Trigger Fire output Start command External Keep clean hifted running with global mage area shifte Horizontal clocks into storage area clear on 885 Storage area read running out phase External Exposure Trigger in Non Frame Transfer mode Note that not all systems support External Exposure mode To check if this feature is available with your system use the function GetCapabilities and check the ulTriggerModes variable for bit 5 AC_TRIGGERMODE_EXTERNALEXPOSURE being set If this bit is set please use the function GetCapabilities again and check the ulFeatures variable for bit 12 AC_FEATURES_FTEXTERNALEXPOSURE being set when Frame Transfer mode is used and bit 13 AC_FEATURES_KINETICEXTERNALEXPOSURE being set when Kinetc and Frame Transfer modes are used together S D K SECTION 5 Page 61 ANDOR Ces TRIGGERING External FVB EM IExternal FVB EM Trigger Mode is much like operating an acquisition in FVB read mode with EM gain applied using external trigger with Keep cleans turned off The difference surrounds the readout of the collected data and therefore the associated readout time When using EM gain a second EM register is used to apply the gain to the acquired data The diagram below gives a quick overview of the readout process used in both processes Imagine a pixe
177. go to the Control Panel and click on the System control From here select the Hardware tab and then click on the Device Manager button e Shut down the PC and ensure that the PCI card is seated correctly e For 32 bit OS ensure that the file atmcdwdm sys file appears in the C WINDOWS system32 drivers directory The latest version is 4 29 0 0 e For 64 bit OS ensure that the file atmcdwdm64 sys file appears in the C WINDOWS system32 drivers directory The latest version is 4 29 0 0 e If the Windows NT driver atmcd sys is in the Drivers directory delete it and restart the PC If you are experiencing communication problems with the Andor USB cameras carry out the following actions e Confirm that the PC being used is USB 2 0 compatible and that a USB 2 0 port is being used for the camera e Check the power to the iDus camera e Check the USB cable from the PC to the iDus camera e Ensure that a LibUSB Win32 Devices section exists in the Device Manager and tab and that your camera is listed To access the Device Manager go to the Control Panel and click on the System control From here select the Hardware tab and then click on the Device Manager button If the entry does not exist or there is an exclamation mark beside it carry out the following actions 1 Power the camera off and on and after the new hardware is detected follow the instructions to install a driver for the new device When asked for a location point to the direc
178. gress DRV ERROR ACK Unable to communicate with card DRV_P1INVALID Invalid filename DRV_ERROR_PAGELOCK File too large to be generated in memory SetSifComment SaveAsCommentedSif SECTION 11 Page 214 ANDOR e FUNCTIONS SaveAsSPC unsigned int WINAPI SaveAsSPC char path Description This function saves the last acquisition in the GRAMS spc file format Parameters char path the filename to save too Return unsigned int DRV SUCCESS Data successfully saved DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with card DRV_P1INVALID Path invalid DRV_ERROR_PAGELOCK File too large to be generated in memory See also SaveAsSif SaveAsEDF SaveAsFITS SaveAsRaw SaveAsTiff SaveAsBmp SaveAsTiff unsigned int WINAPI SaveAsTiff char path char palette int position int typ Description This function saves the last acquisition as a tiff file which can be loaded into an imaging package The palette parameter specifies the location of a PAL file which describes the colors to use in the tiff This file consists of 256 lines of ASCII text each line containing three numbers separated by spaces indicating the red green and blue component of the respective color value The parameter position can be changed to export different scans in a kinetic series If the acquisition is any other mode position should be set to 1 The parameter typ can be set to 0 1 or
179. gth value was out of range See also GetCapabilities SetCountConvertMode SECTION 11 Page 226 ANDOR ee FUNCTIONS SetCropMode unsigned int WINAPI SetCropMode int active int cropHeight int reserved Description This function effectively reduces the height of the CCD by excluding some rows to achieve higher frame rates This is currently only available on Newton cameras when the selected read mode is Full Vertical Binning The cropHeight is the number of active rows measured from the bottom of the CCD Note it is important to ensure that no light falls on the excluded region otherwise the acquired data will be corrupted Parameters int active 1 Crop mode is ON 0 Crop mode is OFF int cropHeight The selected crop height This value must be between 1 and the CCD height int reserved This value should be set to 0 Return unsigned int DRV SUCCESS Parameters set DRV NOT INITIAILIZED System not initialized ACQUIRING Acquisition in progress P1INVALID Active parameter is not zero or one DRV_P2INVALID Cropheight parameter is less than one or greater than the CCD height DRV PSINVALID Reserved parameter is not equal to zero DRV NOT SUPPORTED Either the camera is not a Newton or the read mode is not Full Vertical Binning See also GetDetector SetlsolatedCropMode NOTE Available on Newton SECTION 11 Page 227 ANDOR e FUNCTIONS SetCurrentCamera unsigned int WINAPI SetCurrentCame
180. he CCD stops the Keep Clean Cycle This allows the image photoelectric charge to build up in the Image area of the CCD The CCD remains in this state until the exposure time has elapsed at which point the readout process starts Step 3 In this step the charge built up in the Image area is quickly shifted into the Storage area The time required to move the charge into the storage area is calculated as follows No of Rows in the Image Area x Vertical Shift Rate Once the Image area has been shifted into the storage area the Image area stops vertically shifting and begins to accumulate charge again i e the next exposure starts Step 4 While the Image area is accumulating charge the Storage area is being read out This readout phase can take tens of milliseconds to seconds depending on the image size readout pattern and readout speed Step 5 amp 6 On completion of the readout the system will wait until the exposure time has elapsed before starting the next readout Step 6 As the captured image is quickly shifted into the Storage area a Frame Transfer CCD system can be used without a mechanical shutter NOTES e When using Frame Transfer mode the minimum exposure time for a FT CCD operated in frame transfer mode is the time taken to readout the image from the storage area SECTION 4 Page 50 ANDOR ACQUISITION MODES The Accumulation Cycle Time and the Kinetic Cycle Time are fully dependent on the exposu
181. he driver via which the driver can inform the main software that an acquisition has saturated the sensor to a potentially damaging level You must reset the event after it has been handled in order to receive additional triggers Before deleting the event you must call SetEvent with NULL as the parameter HANDLE saturationEvent Win32 event handle unsigned int DRV SUCCESS Acquisition mode set DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Function not supported for operating system SetDriverEvent The programmer must reset the event after it has been handled in order to receive additional triggers unless the event has been created with auto reset e g event CreateEvent NULL FALSE FALSE NULL Also NOT all programming environments allow the use of multiple threads and Win32 events Only supported with the 23 card USB cameras do not have this feature SECTION 11 Page 279 ANDOR ee FUNCTIONS SetShutter unsigned int WINAPI SetShutter int typ int mode int closingtime int openingtime Description This function controls the behaviour of the shutter The typ parameter allows the user to control the TTL signal output to an external shutter The mode parameter configures whether the shutter opens amp closes automatically controlled by the camera or is permanently open or permanently closed The opening and closing time specify the time required to open and close the shutter this
182. he first call before using any other pt cquire function Initialize MyFile xml FileNameLength Add a new mode maximum length for mode name is 255 characters and also for mode description is 255 characters AddMode ModeName ModeNameLength ModeDescription ModeDescriptionLength Define the Acquisition Parameters which make up the new mode Acquistion parameters must be valid parameters supported by OptAcquire OA SetInt ModeName electron multiplying gain IntValue OA SetFloat ModeName readout rate FloatValue OA SetString ModeName output amplifier StringValue StringLen Write the new mode to file Note Modes CANNOT be written to the Preset file OA WriteToFile MyFile xml FileNameLen Figure 17 Example of OptAcquire Adding a New Mode S D K SECTION 9 Page 89 ANDOR EXAMPLES SECTION 10 EXAMPLES INTRODUCTION We present here a number of examples of controlling Andor SDK to acquire data Source code for each example can be found on the disk Each example is presented in three different languages Visual Basic LabVIEW and C The examples were devised to demonstrate the wide versatility and range of the data acquisition mechanisms available with Andor SDK The examples are all based on variations of the flowchart described on the following pages The flowchart is a basic demonstration of how to set up and control the Andor system to acquire data with th
183. hen data will be read from the file If the file does not exist the file name may be used when the user calls WriteToFile unsigned int FileNameLen The length of the filename unsigned int DRV SUCCESS DRV_P1INVALID DRV_OA_CAMERA_NOT_SUPPORTED DRV_OA_GET_CAMERA_ERROR DRV_OA_INVALID_STRING_LENGTH DRV_OA_ANDOR_FILE_NOT_LOADED DRV_OA_USER_FILE_NOT_LOADED DRV_OA_FILE_ACCESS_ERROR DRV_OA_PRESET_AND_USER_FILE_N OT_LOADED OA WruiteToFile All parameters accepted Null filename Camera not supported Unable to retrieve information about the model of the Camera The parameter has an invalid length i e 255 Preset Andor file failed to load Supplied User file failed to load Failed to determine status of file Failed to load Andor and User file Page 202 SECTION 11 ANDOR FUNCTIONS OA SetFloat unsigned int WINAPI OA SetFloat const char const ModeName const char ModeParam const float FloatValue Description Parameters Return See also This function is used to set values for floating point type acquisition parameters where the new values are stored in memory To commit changes to file call WriteToFile const char const ModeName The name of the mode for which an acquisition parameter will be edited const char const ModeParam The name of the acquisition parameter to be edited const float FloatValue The value to assign to the acquisition parameter unsigned in
184. hm DRV PSINVALID Invalid red pointer i e NULL DRV_P4INVALID Invalid green pointer i e NULL DRV_P5INVALID Invalid bluepointer i e NULL DRV NO NEW DATA There is no new data yet GetMostRecentlmage16 Demosaiclmage WhiteBalance SECTION 11 Page 162 ANDOR FUNCTIONS GetMostRecentlmage unsigned int WINAPI GetMostRecentlmage at 32 arr unsigned long size Description Parameters Return See also This function will update the data array with the most recently acquired image in any acquisition mode The data are returned as long integers 32 bit signed integers The array must be exactly the same size as the complete image long arr pointer to data storage allocated by the user unsigned long size total number of pixels unsigned int DRV SUCCESS Image has been copied into array DRV NOT INITIALIZED System not initialized DRV ERROR ACK Unable to communicate with card DRV_P1INVALID Invalid pointer i e NULL DRV_P2INVALID Array size is incorrect DRV NO NEW DATA There is no new data yet GetMostRecentlmage16 GetOldestImage GetOldestlmage16 Getlmages GetMostRecentlmage16 unsigned int WINAPI GetMostRecentlmage16 WORD arr unsigned long size Description Parameters Return See also 16 bit version of the GetMostRecentlmage function WORD arr pointer to data storage allocated by the user unsigned long size total number of pixels unsigned int DRV SUCCE
185. hould be called after the acquisition has been fully defined i e readout mode trigger mode etc have been set If you are using a shutter please refer to SECTION 8 SHUTTER CONTROL for further information SECTION 4 Page 44 ANDOR ACQUISITION MODES Run Till Abort Run Till Abort mode continually performs scans of the CCD at the rate set by the user until the acquisition is stopped by calling the AbortAcquisition function The minimum possible delay between each scan will be the minimum Kinetic Cycle Time Exposure Time Run Till Abort Ee lt m e g Minimum Kinetic Cycle Time Exposure Time 0 3s To set the acquisition mode to Run Till Abort call SetAcquistionMode 5 SetExposureTime 0 3 SetKineticCycleTime 0 Here the exposure time is the time during which the CCD sensor is sensitive to light NOTES 1 The total number of images acquired during the acquisition can be obtained at any time by calling the GetTotalNumberlmagesAcquired function The data acquired during the acquisition will be stored in the circular buffer until it is overwritten by new scans The capacity of the circular buffer can be obtained by calling the GetSizeOfCircularBuffer function To retrieve all valid data from the circular buffer before it is overwritten by new data the GetNumberNewlmages and Getlmages functions should be used Alternatively to retrieve only the most recent image the GetMostRecentlmage function can
186. hutter and internal shutter to be controlled independently only available on some cameras please consult your Camera User Guide The typ parameter allows the user to control the TTL signal output to an external shutter The opening and closing times specify the length of time required to open and close the shutter this information is required for calculating acquisition timings see SHUTTER TRANSFER TIME The mode and extmode parameters control the behaviour of the internal and external shutters To have an external shutter open and close automatically in an experiment set the mode parameter to Open and set the extmode parameter to Auto To have an internal shutter open and close automatically in an experiment set the extmode parameter to Open and set the mode parameter to Auto To not use any shutter in the experiment set both shutter modes to permanently open Int typ 0 Output TTL low signal to open shutter 1 Output TTL high signal to open shutter int mode 0 Auto 1 Open 2 Close int closingtime time shutter takes to close milliseconds int openingtime Time shutter takes to open milliseconds int mode 0 Auto 1 Open 2 Close Unsigned int DRV SUCCESS Shutter set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with card DRV NOT SUPPORTED Camera does support shutter control DRV P1INVALID Invalid TTL type P2INVALI
187. iDus the horizontalbin capability will be 0 as it is not recommended but it is possible Capability AC SETFUNCTION EMADVANCED Description Extended EM gain range can be accessed using SetEMAdvanced Bit 15 State 1 SECTION 11 Page 124 ANDOR PAS FUNCTIONS GetCapabilities Available Set Functions Continued Capability AC_SETFUNCTION_GATEMODE Description The gate mode can be set with the SetGateMode function Bit 16 State 1 Capability AC_SETFUNCTION_DDGTIMES Description The USB iStar DDG gate times can be set with the SetDDGGateTime function Bit 17 State 1 Capability AC_SETFUNCTION_IOC Description Integrate on chip can be set with the SetDDGIOC function Bit 18 State 1 Capability AC_SETFUNCTION_INTELLIGATE Description Intelligate can be selected using the SetDDGintelligate function Bit 19 State 1 Capability AC SETFUNCTION INSERTION DELAY Description Insertion delay can be set with the SetDDGInsertionDelay function Bit 20 State 1 Capability AC SETFUNCTION GATESTEP Description Gate step can be configured using the SetDDGGateStep function Bit 21 State 1 Capability AC SETFUNCTION TRIGGERTERMINATION Description The trigger termination can be set using the SetExternalTriggerTermination function Bit 22 State 1 Capability AC SETFUNCTION EXTENDEDNIR Description Extended NIR mode can be set using the SetHSSpeed function Bit 23 State 1 Capability AC S
188. ical shutter installed Return unsigned int DRV SUCCESS Internal Shutter state returned DRV NOT AVAILABLE Not an iXon camera DRV P1INVALID Parameter is NULL NOTE Available only on iXon SECTION 11 Page 194 ANDOR FUNCTIONS IsAmplifierAvailable unsigned int WINAPI IsAmplifierAvailable int iamp Description Parameters Return See also This function checks if the hardware and current settings permit the use of the specified amplifier int iamp amplifier to check unsigned int DRV SUCCESS Amplifier available NOT INITIALIZED System not initialized DRV INVALID AMPLIFIER Not a valid amplifier SetHSSpeed IsPreAmpGain Available unsigned int WINAPI IsPreAmpGainAvailable int channel int amplifier int index int pa int status Description Parameters Return See also This function checks that the AD channel exists and that the amplifier speed and gain are available for the AD channel int channel channel index int amplifier of output amplifier int index Channel speed index int pa PreAmp gain index int status 0 PreAmpGain not available 1 PreAmpGain Available unsigned int DRV SUCCESS PreAmpGain status returned DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV P1INVALID Invalid channel DRV P2INVALID Invalid amplifier DRV PSINVALID Invalid speed index DRV_P4INVALID Invalid gain GetNumber
189. ight must be prevented from falling onto the CCD during the readout process Please refer to SECTION 8 SHUTTER CONTROL for further information p SUPERPIXELS Figure 6 Image mode To reduce the file size and increase the speed of readout it is possible to specify a sub area of the CCD to be read out It is also possible to bin pixels together horizontally and vertically to create super pixels To set up a Full Resolution Image acquisition you need to call the following functions SetReadMode 4 Setimage 1 1 1 1024 1 256 To acquire a sub area with lower left co ordinates of 19 10 with binning of 4 in both the horizontal and vertical directions and 100x16 pixels in the acquired image you would call the Setlmage function with the following parameters Setlmage 4 4 19 118 10 25 By a process of binning charge vertically into the shift register from several rows at a time e g 4 and then binning charge horizontally from several columns of the shift register at a time e g 4 the ANDOR SDK System is effectively reading out charge from a matrix of super pixels which each measure 4 x 4 real pixels The result is a more coarsely defined image but faster processing speed lower storage requirements and a better signal to noise ratio since for each element or super pixel in the resultant image the combined charge from several pixels is being binned and read out rather than the possibly weak charge from an individual pixel S
190. in Multi Track read mode Parameters int iStart First horizontal pixel in multi track mode int iEnd Last horizontal pixel in multi track mode Return unsigned int DRV SUCCESS Range set DRV NOT INITIALIZED System not initialized DRV NOT AVAILABLE Feature not available for this camera ACQUIRING Acquisition in progress DRV_P1INVALID Invalid start position DRV_P2INVALID Invalid end position See also SetReadMode SetMultiTrack SetMultiTrackScan unsigned int WINAPI SetMultiTrackScan int trackHeight int numberTracks int iSIHStart int iSIHEnd int trackHBinning int trackVBinning int trackGap int trackOffset int trackSkip int numberSubFrames Description THIS FUNCTION IS RESERVED SECTION 11 Page 269 ANDOR e FUNCTIONS SetNextAddress unsigned int WINAPI SetNextAddress at 32 data long lowAdd long highAdd long len long physical Description THIS FUNCTION IS RESERVED SetNextAddress16 unsigned int WINAPI SetNextAddress16 at_32 data long lowAdd long highAdd long len long physical Description THIS FUNCTION IS RESERVED SetNumberAccumulations unsigned int WINAPI SetNumberAccumulations int number Description This function will set the number of scans accumulated in memory This will only take effect if the acquisition mode is either Accumulate or Kinetic Series Parameters int number number of scans to accumulate Return unsigned int DRV SUCCESS Accumulations set DRV NOT IN
191. in array unsigned int last Index of last frame in array at_u64 arr array of times in nanoseconds for each frame from time of start int index number of frames for which start time is required Return unsigned int DRV_SUCCESS Timings returned DRV_NOT_INITIALIZED System not initialized DRV_MSTIMINGS_ERROR Invalid timing request See also GetCapabilities SetMetaData SECTION 11 Page 177 ANDOR FUNCTIONS GetRingExposureRange unsigned int WINAPI GetRingExposureRange float fpMin float fpMax Description Parameters Return See also With the Ring Of Exposure feature there may be a case when not all exposures can be met The ring of exposure feature will guarantee that the highest exposure will be met but this may mean that the lower exposures may not be If the lower exposures are too low they will be increased to the lowest value possible This function will return these upper and lower values float fpMin Minimum exposure float foMax Maximum exposure unsigned int DRV SUCCESS Min and max returned DRV NOT INITIALIZED System not initialize DRV INVALID MODE Trigger mode is not available GetCapabilities GetNumberRingExposureTimes IsTriggerModeAvailable SetRingExposureTimes GetSDK3Handle unsigned int WINAPI GetSDK3Handle int Handle Description THIS FUNCTION IS RESERVED GetSensitivity unsigned int WINAPI GetSensitivity int channel int index int amplifier int pa
192. information is required for calculating acquisition timings see SHUTTER TRANSFER TIME Parameters int typ 0 Output TTL low signal to open shutter 1 Output TTL high signal to open shutter int mode 0 Auto 1 Open 2 Close int closingtime Time shutter takes to close milliseconds int openingtime Time shutter takes to open milliseconds Return unsigned int DRV_SUCCESS Shutter set DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with card DRV_NOT_SUPPORTED Camera does not support shutter control DRV_P1INVALID Invalid TTL type DRV_P2INVALID Invalid mode DRV PS3INVALID Invalid time to open DRV_P4INVALID Invalid time to close NOTE 1 The opening and closing time can be different 2 For cameras capable of controlling the internal and external shutter independently capability AC FEATURES SHUTTEREX you MUST use SetShutterEx 3 Cameras with an internal shutter use function IsInternalMechanicalShutter to test but no independent shutter control capability AC FEATURES SHUTTEREX will always output a HIGH to open TTL signal through the external shutter port SECTION 11 Page 280 ANDOR FUNCTIONS SetShutterEx unsigned int WINAPI SetShutterEx int typ int mode int closingtime int openingtime int extmode Description Parameters Return NOTE This function expands the control offered by SetShutter to allow an external s
193. integer type acquisition parameters Values are retrieved from memory for the specified mode name Parameters const char const ModeName The name of the mode for which an acquisition parameter will be retrieved const char const ModeParam The name of the acquisition parameter for which a value will be retrieved int IntValue The buffer to return the value of the acquisition parameter Return unsigned int DRV SUCCESS All parameters accepted DRV_P1INVALID Null mode name DRV P2INVALID Null mode parameter DRV PSINVALID Null integer value See also OA Setlnt OA GetModeAcqParams unsigned int WINAPI OA GetModeAcqParams const char const ModeName char const ListOfParams Description This function will return all acquisition parameters associated with the specified mode The mode specified by the user must be in either the Preset file or the User defined file The user must allocate enough memory for all of the acquisition parameters Parameters const char const ModeName The mode for which all acquisition parameters must be returned char const ListOfParams A user allocated array of characters for storage of the acquisition parameters Parameters will be delimited by a 63 m Return unsigned int DRV SUCCESS All parameters accepted DRV_P1INVALID Null mode name DRV_P2INVALID Null mode parameter DRV_OA_NO_USER_DATA No data for selected mode See also OA GetNumberOfAcgParams SECTION 11 Page 199 ANDOR
194. ister These speeds are used when the charge been shifted in the amplifier does not need to be digitized This allows faster keep clean cycles and faster readout when pixel skipping is implemented Where a default speed b c d e allowed speeds fastest first DummyVShiftSpeed DummyVShiftSpeed a b c d e This lists the speeds in microseconds at which the CCD rows can be vertically shifted These speeds are used during CCD keep cleans Where a default speed b c d e allowed speeds fastest first VerticalHorizontalTime VerticalHorizontalTime a b c d e This lists the time in microseconds which must be taken into account when timing calculations are been done Where a default speed b c allowed speeds fastest first CodeFile CodeFile filename ext This gives the file name of the micro code uploaded to the microprocessor on the plug in card This field is typically PCI 29k COF for standard systems and PCII29K COF for I C compatible cards SECTION 13 Page 306 ANDOR e DETECTOR INI FlexFile FlexFile filename ext This gives the file name of the logic uploaded to the Field Programmable Gate Array on the plug in card This field is only used by the PCI version of the system This field is typically PCI FPGA RBF for standard systems and PCIIFPGA RBF for I C compatible cards Cooling Cooling type This gives the type of cooling The type relates back to the cooling section Type Type type Thi
195. it StartAcquisition WaitForAcquisition WaitForAcquisitionByHandle WaitForAcquisitionByHandleTimeOut SECTION 11 Page 299 ANDOR FUNCTIONS WhiteBalance unsigned int WINAPI WhiteBalance WORD wRed WORD wGreen WORD wBlue float fRelR float fRelB WhiteBalancelnfo info Description Parameters Return See also For colour sensors only Calculates the red and blue relative to green factors to white balance a colour image using the parameters stored in info Before passing the address of an WhiteBalancelnfo structure to the function the iSize member of the structure should be set to the size of the structure In C this can be done with the line info gt iSize sizeof WhiteBalancelnfo Below is the WhiteBalancelnfo structure definition and a description of its members typedef struct WHITEBALANCEINFO int iSize Structure size int iX Number of X pixels Must be gt 2 int iY Number of Y pixels Must be gt 2 int iAlgorithm Algorithm to used to calculate white balance int iROI left Region Of Interest from which white balance is calculated int iROI right Region Of Interest from which white balance is calculated int iROI top Region Of Interest from which white balance is calculated int iROI bottom Region Of Interest from which white balance is calculated WhiteBalancelnfo iX and iY are the image dimensions The number of elements of the input red green
196. it until a Keep Clean cycle has been completed before accepting the next trigger This setting will only have an effect if the trigger mode has been set to External via SetTriggerMode int mode 0 Disabled 1 Enabled unsigned int DRV SUCCESS Parameters accepted SetTriggerMode SetFilterMode unsigned int WINAPI SetFilterMode int mode Description Parameters Return See also This function will set the state of the cosmic ray filter mode for future acquisitions If the filter mode is on consecutive scans in an accumulation will be compared and any cosmic ray like features that are only present in one scan will be replaced with a scaled version of the corresponding pixel value in the correct scan int mode current state of filter 0 OFF 2 ON unsigned int DRV_SUCCESS Filter mode set DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress P1INVALID Mode is out off range GetFilterMode SetFilterParameters unsigned int WINAPI SetFilterParameters int width float sensitivity int range float accept int smooth int noise Description THIS FUNCTION IS RESERVED SECTION 11 Page 252 ANDOR FUNCTIONS SetFKVShiftSpeed unsigned int WINAPI SetFKVShiftSpeed int index Description This function will set the fast kinetics vertical shift speed to one of the possible speeds of the system It will be used for subsequent acquisitions Parameters int in
197. it version of SIFIO e Added 64 bit support for LabVIEW e Removed limitation on the size of a kinetic series e Added SDK version to FITS file format e Added support for for USB iStar DH320T e Added support for external charge shifting mode on latest iKon M systems Bug fixes e Improved accuracy of FVB timings e Improved performance of detection of end of exposure on Clara e Fixed issue with CoolerON and USB iStar e Fixed behaviour of ARM signal in fast kinetics external trigger e Fixed crash when using a large number of random tracks e Fixed photon counting thresholds on USB iStar e Fixed crash in PostProcessCountConvert e Fixed number of preamp options reported for Clara e Fixed readout time reported for Clara in overlap external exposure e Fixed test for valid gate step settings e Fixed problem with potentially invalid shift speed when A D is changed e Fixed intermittent fail in Fast Kinetics e Fixed the number of kinetics used when operating in gate step and kinetics e Fixed crash when selecting Integrate On Chip in external trigger e Fixed problem with reported EM gain range e Modified FITS keys to be 8 characters to meet standard e Gate step should only be available for kinetics and fast kinetics mode e Fixed crash in when spooling to FITS e The data type calculation is applied on the generated spectrum if appropriate when using a Mechelle e Fixed crash when spooling to sif if acquisition aborted before any frames acquire
198. ite successful DRV_VXDNOTINSTALLED VxD not loaded DRV_INIERROR Unable to load DETECTOR INI DRV COFERROR Unable to load COF DRV_FLEXERROR Unable to load RBF DRV_ERROR_ACK Unable to communicate with card DRV I2CDEVNOTFOUND Could not find the specified device DRV I2CTIMEOUT Timed out reading from device DRV UNKNOWN FUNC Unknown function incorrect cof file See also l2CBurstRead I2CRead I2CWrite l2cReset SECTION 11 Page 190 ANDOR FUNCTIONS Il2CRead unsigned int WINAPI I2CRead BYTE devicelD BYTE intAddress BYTE pdata Description This function will read a single byte from the chosen device Parameters BYTE devicelD The device to read from BYTE intAddress The internal address of the device to be read from BYTE pdata The byte read from the device Return unsigned int DRV SUCCESS Read successful DRV VXDNOTINSTALLED VxD not loaded DRV INIERROR Unable to load DETECTOR INI DRV COFERROR Unable to load COF DRV FLEXERROR Unable to load RBF DRV ERROR ACK Unable to communicate with card I2CDEVNOTFOUND Could not find the specified device DRV I2CTIMEOUT Timed out reading from device DRV UNKNOWN FUNC Unknown function incorrect cof file See also I2CBurstWrite l2CBurstRead I2CWrite 2 I2CReset unsigned int WINAPI I2CReset void Description This function will reset the IC data bus Parameters Return unsigned int DRV SUCCESS Reset successful DRV V
199. ject files to re build executable files Each of the Visual Basic examples comes with a ready to run executable file When building you own projects you must include the file ATMCD32D BAS This file contains the Andor SDK function prototypes for interfacing with the dynamic link library ATMCD32D DLL NOTE To run any of the examples you will need the following files e ATMCD32D DLL ATMCD64D DLL depending on system e DETECTOR INI Contains initialization information not required on iDus iXon or Newton systems SECTION 10 Page 91 ANDOR Ce EXAMPLES FLOW CHART OF THE FUNCTION CALLS NEEDED TO CONTROL ANDOR CAMERA Initialize GetDetector GetHardwareVersion 1 GetNumbervSSpeeds GetvSSpeed GetSoftwareVersion GetHSSpeed GetNumberHSSpeed GetTemperatureRange SetTemperature CoolerON Get Temperature NO Has Ello Temperature Stabilized YES to 5 v 1 The application initializes the camera then obtains information relating to the capabilities of the system NOTE The Andor SDK takes several seconds to Auto Calibrate the on board A D converter whenever the Initialize function is called 2 The CCD sensor s operating temperature is set to some value within the allowed temperature range e g 2 C and the cooler is switched on 3 4 The current temperature is periodically monitored to check if the temperature has stabilized to the set value The temperature can take several
200. l at position A Normally for the readout cycle to complete this pixel will have to shift along the shift register and then along the entire length of the EM Register to C before the next acquisition can begin When using FVB EM Trigger Mode however the EM Register Is used as a temporary storage area and so the pixel at A no longer needs to travel all the way to C but can stop at position B as this leaves sufficient space in the shift register for the next acquisition the data is in effect pipelined Shift Register A gt B EM Register C Note that not all systems support External FVB EM Trigger mode To check if this enhanced feature is available with your system use the function GetCapabilities and check the ulFeature variable for bit 10 AC_FEATURES_KEEPCLEANCONTROL being set S D K SECTION 5 Page 62 ANDOR e TRIGGERING Software In Software Trigger Mode once an acquisition has been started via the StartAcquisition function the user software determines when data is actually acquired via the SendSoftwareTrigger command This will give full control to the user software to ensure that it only requests an acquisition when it is ready It permits the highly efficient upload of new exposure times between acquisitions and even allows a pre load of up to 16 exposures to the camera which will be cycled through with each acquisition It also permits the user Software to perform certain actions before requesting
201. l and vertical flipping unsigned int DRV SUCCESS All parameters accepted DRV NOT INITIALIZED System not initialized P1INVALID Rotate parameter invalid SetlmageFlip SECTION 11 Page 262 ANDOR FUNCTIONS SetlsolatedCropMode unsigned int WINAPI SetlsolatedCropMode int active int cropheight int cropwidth int vbin int hbin Description Parameters Return See also This function effectively reduces the dimensions of the CCD by excluding some rows or columns to achieve higher throughput In isolated crop mode iXon Newton and iKon cameras can operate in either Full Vertical Binning or Imaging read modes iDus can operate in Full Vertical Binning read mode only Note It is important to ensure that no light falls on the excluded region otherwise the acquired data will be corrupted int active 1 Crop mode is ON 0 Crop mode is OFF int cropheight The selected crop height This value must be between 1 and the CCD height int cropwidth The selected crop width This value must be between 1 and the CCD width int vbin The selected vertical binning int hbin The selected horizontal binning unsigned int DRV SUCCESS Parameters set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV P1INVALID active parameter was not zero or one DRV P2INVALID Invalid crop height DRV PSINVALID Invalid crop width PAINVALID Invalid vertical binning DRV_P5INVA
202. le using SetAcquisitionMode Bit 6 State 1 SECTION 11 Page 114 ANDOR e FUNCTIONS GetCapabilities Read Modes Read Modes AndorCapabilities Member ulReadModes Capability AC READMODE FULLIMAGE Description Full Image Read Mode available using SetReadMode Bit 0 State 1 Capability AC READMODE SUBIMAGE Description Sub Image Read Mode available using SetReadMode Bit 1 State 1 Capability AC READMODE SINGLETRACK Description Single track Read Mode available using SetReadMode Bit 2 State 1 Capability AC READMODE FVB Description Full Vertical Binning Read Mode available using SetReadMode Bit 3 State 1 Capability AC READMODE MULTITRACK Description Multi Track Read Mode available using SetReadMode Bit 4 State 1 Capability AC READMODE RANDOMTRACK Description Random Track Read Mode available using SetReadMode Bit 5 State 1 SECTION 11 Page 115 ANDOR e FUNCTIONS GetCapabilities Read Modes compatible with Frame Transfer mode Read Modes AndorCapabilities Member ulFTReadModes Capability AC READMODE FULLIMAGE Description Full Image Read Mode available using SetReadMode Bit 0 State 1 Capability AC READMODE SUBIMAGE Description Sub Image Read Mode available using SetReadMode Bit 1 State 1 Capability AC READMODE SINGLETRACK Description Single track Read Mode available using SetReadMode Bit 2 State 1 Capability AC READ
203. lows you to minimize the contribution of dark current in the measured signal Also if you are using an imaging spectrograph such as the Shamrock with a multiple core fiber this mode allows you to select a single fiber for examination To set up a Single Track acquisition you need to call the following functions SetReadMode 3 SetSingleTrack 128 20 NOTE If a non frame transfer camera is used a shutter may be required to prevent light which would otherwise fall on the CCD chip outside the specified track from corrupting the data during binning Please refer to SECTION 8 SHUTTER CONTROL for further information SECTION 3 Page 35 ANDOR Cea READOUT MODES Multi Track Multi Track mode allows you to create one or more tracks each of which behaves like the Single Track above With Multi Track you specify the number of tracks and the track height The driver internally sets the actual position of each track so that the tracks are evenly spaced across the CCD The tracks can be vertically shifted en masse by specifying a positive or negative offset about a central position For greater control over the positioning of the tracks use Random Track mode MULTI TRACK Track eg DENS Track Number Figure 4 Multi Track Multi Tracks will allow you to simultaneously acquire a number of spectra delivered typically via a fiber bundle If you are using a non frame
204. mages int iAveragingFilterMode int iHeight int iWidth int iFrameCount int iAveragingFactor SECTION 11 Page 207 ANDOR FUNCTIONS Description THIS FUNCTION IS RESERVED SDK SECTION 11 Page 208 ANDOR FUNCTIONS PostProcessNoiseFilter unsigned int WINAPI PostProcessNoiseFilter at 32 Inputlmage at 32 Outputlmage int OutputBufferSize int Baseline int Mode float Threshold int Height int Width Description Parameters Return See also This function will apply a filter to the input image and return the processed image in the output buffer The filter applied is chosen by the user by setting Mode to a permitted value at32 Inputlmage at32 Outputlmage int OutputBufferSize int Baseline int Mode float Threshold int Height int Width unsigned int DRV SUCCESS The input image data to be processed The output buffer to return the processed image The size of the output buffer The baseline associated with the image The mode to use to process the data Valid options are 1 Use Median Filter 2 Use Level Above Filter 3 Use Interquartile Range Filter 4 Use Noise Threshold Filter This is the Threshold multiplier for the Median Interquartile and Noise Threshold filters For the Level Above filter this is Threshold count above the baseline The height of the image The width of the image Acquisition prepared DRV NOT SUPPORTED Ca
205. mages are overwritten in the circular buffer they no longer can be retrieved and the information returned will treat overwritten images as not available Parameters at 32 first returns the index of the first available image in the circular buffer at 32 last returns the index of the last available image in the circular buffer Return unsigned int DRV SUCCESS Number of acquired images returned DRV NOT INITIALIZED System not initialized DRV ERROR ACK Unable to communicate with card DRV NO NEW DATA There is no new data yet See also Getlmages Getlmages16 GetNumberNewlmages SECTION 11 Page 166 ANDOR e FUNCTIONS GetNumberDevices unsigned int WINAPI GetNumberDevices int numDevs Description THIS FUNCTION IS RESERVED GetNumberDDGExternalOutputs unsigned int WINAPI GetNumberDDGExternalOutputs at_u32 Count Description This function gets the number of available external outputs Parameters at u32 Count number of available external outputs Return unsigned int DRV SUCCESS Number returned DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED External outputs not supported DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with system DRV_P1INVALID Count has invalid memory address See also GetCapabilities SetDDGExternalOutputEnabled NOTE Available on USB iStar GetNumberFKVShiftSpeeds unsigned int WINAPI GetNumberFKVShiftSpeeds int number Description As your
206. mat Vertical and horizontal flip tags added to the FITS header Newton now supports multiple images per USB interrupt to reduce CPU load Support added for new revision of Newton DU920P Control of gate mode added to iStar floating toolbar Bug fixes Fixed bug where SetPhotonCountingThreshold was always returning DRV NOT SUPPORTED Fixed reported acquisition timings for external trigger non frame transfer mode Fixed the SDK flipper mirror issue problem with the port numbers being used and updated shipped examples GetFIFOUsage is now thread safe USB driver for SR500 and SR750 updated to avoid conflicts with servo controllers Fixed External trigger frame transfer video mode operation SECTION 1 Page 18 ANDOR INTRODUCTION Version 2 85 30000 0 New features Andor Clara image quality improved Option to run external exposure in a kinetic series for all cameras which support iCam Photon Counting check added to GetCapabilities Added kinetic cycle time tag to spooled tiff files PrepareAcquisition now returns an error if insufficient memory available Bug fixes e SetSpool now returns DRV NOT AVAILABLE under Linux when trying to spool to FITS e Fixed crash on initialize when no Andor cameras were connected e Fixed problem with reinitializing Shamrock models SR500 and SR750 e Fixed problem where calling IsCoolerOn during an acquisition could stop the acquisition e Fixed issue where events from a previous acquisition were
207. me SetMultiTrack SetNumberAccumulations SetNumberKinetics SetReadMode SetSingleTrack SetTriggerMode SetVSSpeed SECTION 11 Page 294 ANDOR FUNCTIONS UnMapPhysicalAddress unsigned int WINAPI UnMapPhysicalAddress void Description THIS FUNCTION IS RESERVED SECTION 11 Page 295 ANDOR FUNCTIONS WaitForAcquisition unsigned int WINAPI WaitForAcquisition void Description Parameters Return See also WaitForAcquisition can be called after an acquisition is started using StartAcquisition to put the calling thread to sleep until an Acquisition Event occurs This can be used as a simple alternative to the functionality provided by the SetDriverEvent function as all Event creation and handling is performed internally by the SDK library Like the SetDriverEvent functionality it will use less processor resources than continuously polling with the GetStatus function If you wish to restart the calling thread without waiting for an Acquisition event call the function CancelWait An Acquisition Event occurs each time a new image is acquired during an Accumulation Kinetic Series or Run Till Abort acquisition or at the end of a Single Scan Acquisition If a second event occurs before the first one has been acknowledged the first one will be ignored Care should be taken in this case as you may have to use CancelWait to exit the function NONE unsigned int DRV SUCCESS Acquisition Event occurr
208. me has elapsed at which point the complete sensor is clocked vertically by the number of rows specified by the user Steps 4 amp 5 the process is continued until the number of images stored equals the series length set by the user Step 6 at this point the sequence moves into the readout phase by first vertically shifting the first image to the bottom row of the sensor The sensor is then read out in the standard method Points to consider for Fast Kinetics Mode Light MUST only be allowed to fall on the specified sub area Light falling anywhere else will contaminate the data The maximum number of images in the sequence is set by the position of the sub area the height of the sub area and the number of rows in the CCD Image and Storage area There are no Keep Clean cycles during the acquisition sequence The industry fastest vertical shift speeds of the iXon enables fastest time resolution with minimal vertical smearing Arange of internal trigger and external trigger options are available for Fast Kinetics Readout SECTION 4 Page 48 ANDOR 3 ACQUISITION MODES Frame Transfer Frame transfer is a mode of operation of the chip that is only available if your system contains a Frame Transfer CCD FT CCD It can be switched on for any acquisition mode A FT CCD differs from a standard CCD in 2 ways e Firstly a FT CCD contains 2 areas of approximately equal size see figure 7 below 1 The first ar
209. mera ShutDown i End of program Figure 12 Example of WaitForAcquisition Pseudo Code SECTION 9 Page 73 ANDOR SPECIAL GUIDES The SetDriverEvent function can be used in conjunction with event handles If an event is created using the WIN32 CreateEvent function and passed to the SDK using the SetDriverEvent function an event handle now exists which the SDK can use to inform the application that something has occurred To ensure that the event has been set by a new image arriving and not something else e g temperature change the GetTotalNumberlmagesAcquired function can be used This function will return the total number of images acquired and transferred to the Andor SDK and which are now available to be retrieved by the user see section Retrieving Image Data Comparing the new value to a previously stored one is an effective way of checking that there are new images available 2 SetDriverEvent Pseudo Code Example Note This code does not compile pies Start of program Initialize camera babi ea Wht Gad Create an event handle HANDLE hEvent CreateEventi Set the driver event SetDriverEvent hEvent Start the acquisition Start cquisition Wait for the acquisition to complete WaitForSingleObjecti Retrieve data Shut down camera ShutDown i End of program Figure 13 Example of SetDriverEvent Pseudo Code SDK SECTION 9 Page 74 ANDOR e SPEC
210. mera does not support Noise filter processing DRV NOT INITIALIZED System not initialized DRV ACQUIRING DRV_P1INVALID DRV_P2INVALID DRV_P4INVALID DRV PSINVALID DRV_P6INVALID DRV_P7INVALID DRV P8INVALID Acquisition in progress Invalid pointer i e NULL Invalid pointer i e NULL Baseline less than zero Invalid Filter mode Threshold value not valid for selected mode Height less than zero Width less than zero DRV ERROR BUFFSIZE Output buffer size too small SECTION 11 Page 209 ANDOR FUNCTIONS PostProcessPhotonCounting unsigned int WINAPI PostProcessPhotonCounting at 32 Inputlmage at 32 Outputlmage int OutputBufferSize int NumlImages int NumFrames int NumberOfThresholds float Threshold int Height int Width Description This function will convert the input image data to photons and return the processed image in the output buffer Parameters at32 Inputlmage The input image data to be processed at32 Outputlmage output buffer to return the processed image int OutputBufferSize The size of the output buffer int NumlImages The number of images if a kinetic series is supplied as the input data int NumFrames The number of frames per output image int NumberOfThresholds The number of thresholds provided by the user float Threshold The Thresholds used to define a photon int Height The height of the image int Width The width of the image Return unsigned int
211. mera is an Andor Surcam Bits 0 31 Value 9 Capability AC_CAMERATYPE_USBICCD Description Camera is an Andor USB ICCD Bits 0 31 Value 10 Capability AC_CAMERATYPE_LUCA Description Camera is an Andor Luca Bits 0 31 Value 11 Capability AC_CAMERATYPE_RESERVED Description Reserved Bits 0 31 Value 12 Capability AC_CAMERATYPE_IKON Description Camera is an Andor iKon Bits 0 31 Value 13 Capability AC_CAMERATYPE_INGAAS Description Camera is an Andor InGaAs Bits 0 31 Value 14 Capability AC_CAMERATYPE_IVAC Description Camera is an Andor iVac Bits 0 31 Page 120 GetCapabilities Camera Type continued SECTION 11 ANDOR FUNCTIONS Value 15 Capability AC_CAMERATYPE_CLARA Description Camera is an Andor Clara Bits 0 31 Value 17 Capability AC_CAMERATYPE_USBISTAR Description Camera is an Andor USB iStar Bits 0 31 Value 18 Capability AC_CAMERATYPE_IXONULTRA Description Camera is an Andor iXon Ultra Bits 0 31 Value 21 All other values reserved Page 121 SECTION 11 ANDOR FUNCTIONS Pixel Mode AndorCapabilities Member ulPixelModes Capability AC_PIXELMODE_8BIT Description Camera can acquire in 8 bit mode Bit 0 State 1 Capability AC_PIXELMODE_14BIT Description Camera can acquire in 14 bit mode Bit 1 State 1 Capability AC_PIXELMODE_16BIT Description Camera can acquire in 16 bit mode Bit 2 State 1 Capa
212. meters Return See also Deprecated see Note This function will set the horizontal speed to one of the possible speeds of the system It will be used for subsequent acquisitions int index the horizontal speed to be used Valid values 0 to GetNumberHorizontalSpeeds 1 unsigned int DRV SUCCESS Horizontal speed set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress P1INVALID Index is out off range GetNumberHorizontalSpeeds GetHorizontalSpeed NOTE Deprecated by SetHSSpeed SECTION 11 Page 258 ANDOR Je FUNCTIONS SetHSSpeed unsigned int WINAPI SetHSSpeed int typ int index Description This function will set the speed at which the pixels are shifted into the output node during the readout phase of an acquisition Typically your camera will be capable of operating at several horizontal shift speeds To get the actual speed that an index corresponds to use the GetHSSpeed function Parameters int typ output amplification Valid values 0 electron multiplication Conventional clara 1 conventional Extended NIR mode clara int index the horizontal speed to be used Valid values to GetNumberHSSpeeds 1 Return unsigned int DRV SUCCESS Horizontal speed set DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_P1INVALID Mode is invalid DRV_P2INVALID Index is out off range See also GetNumberHSSpeeds GetHSSpeed GetNumberAmp
213. mode Description Sets the current data averaging mode Parameters int mode The averaging factor mode to use Valid options are 0 No Averaging Filter 5 Recursive Averaging Filter 6 Frame Averaging Filter Return unsigned int DRV_SUCCESS Averaging mode set DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_P1INVALID Invalid mode See also Filter GetDataAveragingMode Filter SetMode unsigned int WINAPI Filter SetMode unsigned int mode Description Set the Noise Filter to use Parameters unsigned int mode Filter mode to use Valid options are 0 No Filter 1 Median Filter 2 Level Above Filter 3 Interquartile Range Filter 4 Noise Threshold Filter Return unsigned int DRV SUCCESS Filter set DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Noise Filter processing not available for this camera DRV_P1INVALID Invalid mode See also Filter GetMode Filter SetThreshold unsigned int WINAPI Filter SetThreshold float threshold Description Sets the threshold value for the Noise Filter Parameters float threshold Threshold value used to process image Valid values are 0 65535 for Level Above filter SECTION 11 Page 104 ANDOR See also FUNCTIONS 0 10 for all other filters unsigned int DRV SUCCESS Threshold set DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Noise Filter processing not available for this
214. mode e Change to keep cooler always on for iXon Ultra e Fix for USB systems not acquiring under Linux Version 2 92 30005 0 New features e Added support for iXon Ultra GetVSAmplitudeString GetVSAmplitudeFromString GetVSAmplitudeValue GetEMAdvanced e Added support for USB iStar model DH312T e Cameras now default to fastest readout speed on initialize e GetMCPGainRange added to C wrapper e Added a Visual Basic 6 helper for iStar functions with 64 bit parameters Bug fixes e Updated IsPreAmpGainAvailable to make sure that a valid speed index for the channel is being used e Updated 64 bit LabVIEW library e Kinetic series of subimages not completing for Clara SECTION 1 Page 15 ANDOR INTRODUCTION Fixed return codes for IO functions Fixed Count Convert using Conventional mode Automatically turn on EMAdvanced for OptAcquire modes with high EMGain values Fixed USB iStar functions in VB NET and Delphi wrappers Fixed issue were the DDG appeared not to be working after the gating mode had been set to CW OFF Fixed bug were external trigger IOC was not triggering for each trigger Fixed minimum exposure time for InGaAs Version 2 91 30001 0 New features Added option for user to choose between IOC series per exposure or trigger Added support for optical gate width GetDDGTTLGateWidth GetDDGOpticalWidthEnabled SetDDGOpticalWidthEnabled e USB iStar acquisition settings now stored in sif file e Added 64 b
215. mode has invalid memory address See also StartAcquisition SetDDGStepMode SetDDGStepCoefficients GetDDGStepCoefficients GetDDGGateTime unsigned int WINAPI GetDDGGateTime at_u64 Delay at_u64 Width Description This function can be used to get the actual gate timings for a USB iStar Parameters at u64 Delay gate delay time in picoseconds at_u64 Width gate width time in picoseconds Return unsigned int DRV_SUCCESS Timings returned DRV_NOT_INITIALIZED System not initialized DRV_NOT_SUPPORTED USB iStar not supported DRV_ACQUIRING DRV_ERROR_ACK DRV_P1INVALID DRV_P2INVALID Acquisition in progress Unable to communicate with system Delay has invalid memory address Width has invalid memory address See also GetCapabilities SetDDGGateTime SECTION 11 Page 137 ANDOR e FUNCTIONS GetDDGInsertionDelay unsigned int WINAPI GetDDGInsertionDelay int state Description This function gets the current state of the insertion delay Parameters int state current state of the insertion delay option 0 Normal 1 Ultra Fast Return unsigned int DRV SUCCESS Insertion delay state returned DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV NOT SUPPORTED Insertion delay not supported DRV ERROR ACK Unable to communicate with system See also GetCapabilities SetDDGlntelligate SetDDGInsertionDelay GetDDGintelligate unsigned int WINAPI GetDDGlIntelligate int state
216. n See also This function will set the current gate width step mode at u32 mode the gate step mode Valid values 0 constant 1 exponential 2 logarithmic 3 linear 100 off unsigned int DRV SUCCESS Gate step mode set DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Gate step not supported DRV_ACQUIRING Acquisition in progress P1INVALID Invalid gate step mode SetDDGWidthStepCoefficients GetDDGWidthStepMode GetDDGWidthStepCoefficients SECTION 11 Page 242 ANDOR e FUNCTIONS SetDelayGenerator unsigned int WINAPI SetDelayGenerator int board short address int typ Description This function sets parameters to control the delay generator through the GPIB card in your computer Parameters int board The GPIB board number of the card used to interface with the Delay Generator short address The number that allows the GPIB board to identify and send commands to the delay generator Int typ The type of your Delay Generator Return unsigned int DRV SUCCESS Delay Generator set up DRV NOT INITIALIZED System not initialized DRV ERROR ACK Unable to communicate with card ACQUIRING Acquisition in progress DRV P1INVALID GPIB board invalid DRV P2INVALID GPIB address invalid DRV PSINVALID Delay generator type invalid See also SetGate NOTE Available on ICCD SECTION 11 Page 243 ANDOR FUNCTIONS SetDMAParameters unsigned int WINAPI SetDMAParameters int
217. n 2 80 New features iKon L support added Added SetAccumulationCycleTime to LabVIEW library Random and multi tracks now available in frame transfer mode for iXon SetNumberPrescans function added New timing functions added GetKeepCleanTime GetReadOutTime Bug fixes SetEMAdvanced was not working on Luca R Random tracks external start was broken on a DU888 InGaAs was not working in last release Multiple USB cameras could not be controlled Fast Kinetics external trigger was not working on early DV885 cameras Kinetic cycle time calculated wrongly when accumulating SECTION 1 Page 22 INTRODUCTION S D K SECTION 1 Page 23 ANDOR INTRODUCTION Version 2 79 New features Memory allocation improved to allow larger kinetic series to be acquired without spooling Luca R range supported iKon L supported GetlmageFlip and GetlmageRotation added Multi tracks available in frame transfer mode for iXon Random tracks available in frame transfer mode for iXon Capability added to test for multi and random tracks in frame transfer SetMultiTrackHRange added Random tracks can now be configured with no gaps in between for iXon Bug fixes Temperature drifting is now handled for all cameras GetTemperatureStatus did not return result for iXon Pixel values for last column on DU885 incorrect Fast kinetics external trigger not operating correctly on a DU885 Crash when initiailising multiple usb cameras Kin
218. n a suitable firmware and if a PCI card is being used it must be a CCI 23 card and have a suitable firmware loaded If you are unsure if your current Hardware is iCam compatible please download the iCam compatibility checker from andor com It will operate in Software and External trigger mode with both Frame Transfer and Non Frame Transfer mode The idea behind this is that the SDK puts the camera into a heightened state of readiness and when a trigger comes either software or hardware the acquisition can be taken immediately If you hardware is compatible and needs to be upgraded please contact productsupport andor com for a further application which will upgrade your system SECTION 9 Page 85 ANDOR SPECIAL GUIDES OptAcquire This is a unique interface whereby a user can choose from a pre determined list of camera set up configurations The user need only choose how they would like their camera to be optimized e g for Sensitivity and Speed Dynamic Range and Speed Time Lapse Parameters such as EM gain value vertical shift speed vertical clock amplitude pre amp sensitivity and horizontal readout speed will then be optimized accordingly behind the scenes Furthermore the option exists to create additional user defined configurations Pre defined OptAcquire modes include 1 Sensitivity and Speed EM Amplifier Optimized for capturing weak signal at fast frame rates with single photon s
219. nded E g writing to file or displaying on screen Parameters int iHFlip Sets horizontal flipping int iVFlip Sets vertical flipping 1 Enables Flipping 0 Disables Flipping If this function is used in conjunction with the SetlmageRotate function the rotation will occur before the flip regardless of which order the functions are called Return unsigned int DRV SUCCESS All parameters accepted DRV NOT INITIALIZED System not initialized P1INVALID HFlip parameter invalid DRV P2INVALID VFlip parameter invalid See also SetlmageRotate SECTION 11 Page 261 ANDOR FUNCTIONS SetlmageRotate unsigned int WINAPI SetlmageRotate int iRotate Description Parameters Return See also This function will cause data output from the SDK to be rotated on one or both axes This rotate is not done in the camera it occurs after the data is retrieved and will increase processing overhead If the rotation could be implemented by the user more efficiently then use of this function is not recomended E g writing to file or displaying on screen int iRotate Rotation setting 0 No rotation 1 Rotate 90 degrees clockwise 2 Rotate 90 degrees anti clockwise If this function is used in conjunction with the SetlmageFlip function the rotation will occur before the flip regardless of which order the functions are called 180 degree rotation can be achieved using the SetlmageFlip function by selecting both horizonta
220. ndex and the value of the fastest recommended speed available The very high vertical shift speeds may require an increase in the amplitude of the vertical clock voltage using the SetVSAmplitude function The GetFastestRecommendedVSSpeed function returns the fastest speed which does not require the vertical clock voltage to be adjusted If the fastest recommended speed is selected the vertical clock voltage should be set as normal NOTE Exercise caution when increasing the amplitude of the Vertical Clock voltage since higher clocking voltages may result in increased Clock Induced Charge in your signal In general only the very highest speeds are likely to benefit from increased vertical clock voltage amplitude Once the information has been retrieved the relevant selections can be made using these functions e SetVSSpeed e SetVSAmplitude An example of the pseudo code for this capability is shown in figure 15 Vertical Pixel Shift Pseudo Code Example Note This code does not compile Start of program Initialize camera Initialize t long NunVSSpeeds RecommendedVSSpeedIndex float VSSpeed GetNunberVSSpeeds NunVSSpeedsz GetFastestRecommendedVSSpeed RecommendedVSSpeedIndex VSSpeed for 0 to NumChannels 1 GetVSSpeed i VSSpeed Shat down camera ShutDowni End of program Figure 15 Example of vertical pixel shift pseudo code SECTION 9 Page 79 ANDOR 9 SPECIAL GUIDE
221. ng Edge Return unsigned int DRV SUCCESS DRV NOT INITIALIZED DRV ACQUIRING DRV_P1INVALID DRV_NOT_AVAILABLE See also SetTriggerlnvert This function will set whether an acquisition will be triggered on a rising or falling edge Trigger mode set System not initialized Acquisition in progress Trigger mode invalid Feature not available Trigger Modes SetTriggerMode SetFastExtTrigger SetTriggerLevel unsigned int WINAPI SetTriggerLevel float level Description This function sets the trigger voltage which the system will use Parameters float level trigger voltage Return unsigned int DRV SUCCESS Level set DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Trigger levels not supported ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with system P1INVALID Trigger level invalid See also GetCapabilities GetTriggerLevelRange SECTION 11 Page 287 ANDOR FUNCTIONS SetTriggerMode unsigned int WINAPI SetTriggerMode int mode Description Parameters Return See also This function will set the trigger mode that the camera will operate in int mode trigger mode Valid values 0 Internal 1 External 6 External Start 7 External Exposure Bulb 9 External FVB EM only valid for EM Newton models in FVB mode 10 Software Trigger 12 External Charge Shifting unsigned int DRV_SUCCESS Trigger mode set DRV_NOT_INITIALIZED System n
222. ng the SetHighCapacity function figure 19 High Capacity Pseudo Code Example Note This code does not compile ff Start of program Initialize camera Initalize Enable High Capacity SetHighCapacity l Shut down camera Shutdown i End of Program Figure 18 Example of High Capacity mode Pseudo Code S D K SECTION 9 Page 83 ANDOR SPECIAL GUIDES iCam iCam technology is a combined firmware and software innovation that has been incorporated into Andor s EMCCD imaging cameras iCam offers enhanced performance for acquisitions whether software triggered or hardware externally triggered with absolute minimal overheads It allows for faster frame rates in software by dedicated timing patterns that eliminate unnecessary overhead times This alongside the bi directional communication between camera and PC facilitates unparalleled synchronization with other peripheral equipment A ring mode offers the capacity to use up to 16 different timing patterns uploaded into the camera head thus trigger events can yield virtually instantaneous switching between exposure channels This new functionality has been added to the Run Till Abort acquisition mode and currently will only operate with Image readout mode Cameras must contain a suitable firmware and if a PCI card is being used it must be a CCI 23 card and have a suitable firmware loaded If you are unsure if your current Hardware is iCam
223. nge 600 1100 Volts Return unsigned int DRV SUCCESS Voltage returned DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_NOT_AVAILABLE Not a USB iStar DRV_GENERAL_ERRORS EEPROM not valid See also GetMCPGain NOTE Available only on USB iStar SECTION 11 Page 160 ANDOR FUNCTIONS GetMetaDatalnfo unsigned int WINAPI GetMetaDatalnfo SYSTEMTIME TimeOfStart float TimeFromStart int index Description Parameters Return See also This function will return the time of the initial frame and the time in milliseconds of further frames from this point SYSTEMTIME TimeOfStart Structure with start time details float TimeFromStart time in milliseconds for a particular frame from time of start int index frame for which time is required unsigned int DRV SUCCESS Timings returned DRV NOT INITIALIZED System not initialized MSTIMINGS ERROR Invalid timing request SetMetaData GetMinimumlmageLength unsigned int WINAPI GetMinimumlmageLength int MinlmageLength Description Parameters Return See also This function will return the minimum number of pixels that can be read out from the chip at each exposure This minimum value arises due the way in which the chip is read out and will limit the possible sub image dimensions and binning sizes that can be applied int MinlmageLength Will contain the minimum number of super pixels on return unsigned i
224. nicate with system Gate step mode invalid p1 has invalid memory address p2 has invalid memory address See also SetDDGWidthStepCoefficients SetDDGWidthStepMode GetDDGWidthStepMode GetDDGWidthStepMode unsigned int WINAPI GetDDGWidthStepMode at u32 mode Description This function will return the current gate width step mode Parameters at u32 mode the gate step mode Valid values 0 constant 1 exponential 2 logarithmic 3 linear 100 off Return unsigned int DRV SUCCESS Gate step mode returned DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Gate step not supported DRV ACQUIRING DRV ERROR ACK DRV_P1INVALID Acquisition in progress Unable to communicate with system mode has invalid memory address See also SetDDGWidthStepCoefficients SetDDGWidthStepMode GetDDGWidthStepCoefficients SECTION 11 Page 144 ANDOR ee FUNCTIONS GetDetector unsigned int WINAPI GetDetector int xpixels int ypixels Description This function returns the size of the detector in pixels The horizontal axis is taken to be the axis parallel to the readout register Parameters int xpixels number of horizontal pixels int ypixels number of vertical pixels Return unsigned int DRV_SUCCESS Detector size returned DRV_NOT_INITIALIZED System not initialized GetDICameralnfo unsigned int WINAPI GetDICameralnfo void info Description THIS FUNCTION IS RESERVED GetDualExposureTimes unsigned int
225. not getting cleared e Additional pixel shift removed from overlap mode on Clara Version 2 84 30000 0 New features e Andor Clara now supported SetDACOutput SetDACOutputScale GetNumberlO SetlODirection SetlOLevel GetlOLevel GetlODirection SetTriggerlnvert IsAmplifierAvailable SetOverlapMode SetMetaData GetMetaDatalnfo Bug fixes e Spooled files beyond 4GB could not be opened e Data was being lost when spooled files of small images went beyond 4GB e Spooled FITS file had cycle time saved as 0 e sPreAmpAvailable should use channel passed rather than current one e Random tracks data corrupted for consecutive tracks for cameras other than iXon e Getlmages16 LabVIEW wrapper was calling wrong SDK function Version 2 83 30001 0 New features SECTION 1 Page 19 ANDOR INTRODUCTION Added SetlmageFlip and SetlmageRotate functions to LabView wrapper Bug fixes Added ShamrockGetCalibration function to the Shamrock SDK help Version 2 83 30000 0 New features iVac systems now fully supported Shamrock spectrographs SR500 and SR750 now fully supported Fast kinetics now available for Luca R Added High Capacity Mode support for DW936 cameras Bug fixes Fixes to Delphi header Fixed discrepancies between cycle times for multi track and random track Fixed problem in fast kinetics when there was an odd number of super pixels Removed corrupted fire pulse in fast kinetics external trigger
226. nsigned int WINAPI SetPhotonCountingThreshold long min long max Description Parameters Return See also This function sets the minimum and maximum threshold for the photon counting option long min minimum threshold in counts for photon counting long max maximum threshold in counts for photon counting unsigned int DRV_SUCCESS Thresholds accepted DRV_P1INVALID Minimum threshold outside valid range 1 65535 DRV_P2INVALID Maximum threshold outside valid range DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with card SetPhotonCounting SetPixelMode unsigned int WINAPI SetPixelMode int bitdepth int colormode Description THIS FUNCTION IS RESERVED SetPreAmpGain unsigned int WINAPI SetPreAmpGain int index Description Parameters Return See also This function will set the pre amp gain to be used for subsequent acquisitions The actual gain factor that will be applied can be found through a call to the GetPreAmpGain function The number of Pre Amp Gains available is found by calling the GetNumberPreAmpGains function int index index pre amp gain table Valid values 0 to GetNumberPreAmpGains 1 unsigned int DRV SUCCESS Pre amp gain set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress P1INVALID Index out of range IsPreAmpGainAvailable GetNumberPreAmpGains GetPreAmp
227. nt DRV SUCCESS Minimum Number of Pixels returned DRV NOT INITIALIZED System not initialized DRV P1INVALID Invalid MinlmageLength value i e NULL Setlmage GetMinimumNumberlnSeries unsigned int WINAPI GetMinimumNumberlnSeries int number Description THIS FUNCTION IS RESERVED SECTION 11 Page 161 ANDOR FUNCTIONS GetMostRecentColorlmage16 unsigned int WINAPI GetMostRecentColorlmage16 unsigned long size int algorithm red WORD green WORD blue Description Parameters Return See also For colour sensors only Color version of the GetMostRecentlmage16 function The CCD is sensitive to Cyan Yellow Magenta and Green CYMG The Red Green and Blue RGB are calculated and Data is stored in 3 planes images one for each basic color unsigned long size total number of pixels int algorithm algorithm used to extract the RGB from the original CYMG CCD 0 basic algorithm combining Cyan Yellow and Magenta 1 algorithm combining Cyan Yellow Magenta and Green WORD red pointer to red data storage allocated by the user WORD green pointer to red data storage allocated by the user WORD blue pointer to red data storage allocated by the user unsigned int DRV SUCCESS Image RGB has been copied into arrays DRV NOT INITIALIZED System not initialized DRV ERROR ACK Unable to communicate with card P1INVALID Arrays size is incorrect DRV P2INVALID Invalid algorit
228. nt EMClockCompensationFlag Description THIS FUNCTION IS RESERVED SetEMGainMode unsigned int WINAPI SetEMGainMode int mode Description Set the EM Gain mode to one of the following possible settings Mode 0 The EM Gain is controlled by DAC settings in the range 0 255 Default mode 1 The EM Gain is controlled by DAC settings in the range 0 4095 2 Linear mode 3 Real EM gain To access higher gain values if available it is necessary to enable advanced EM gain see SetEMAdvanced Parameters int mode EM Gain mode Return DRV SUCCESS Mode set DRV NOT INITIALIZED System not initialized DRV ACQUIRING Acquisition in progress DRV_P1INVALID EM Gain mode invalid SetExposureTime unsigned int WINAPI SetExposureTime float time Description This function will set the exposure time to the nearest valid value not less than the given value The actual exposure time used is obtained by GetAcquisitionTimings Please refer to SECTION 5 ACQUISITION MODES for further information Parameters float time the exposure time in seconds Return unsigned int DRV_SUCCESS Exposure time accepted DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_P1INVALID Exposure Time invalid See also GetAcquisitionTimings NOTE For Classics if the current acquisition mode is Single Track Multi Track or Image then this function will actually set the Shutter Time The actual exposure time used is obtained from the
229. nt WINAPI SetDDGExternalOutputStepEnabled at_u32 Index at_u32 Enabled Description Parameters Return See also Each external output has the option to track the gate step applied to the gater This function can be used to set the state of this option at_u32 Index index of external output at u32 Enabled state of external output track step 0 Off 1 On unsigned int DRV_SUCCESS DRV_NOT_INITIALIZED DRV_NOT_SUPPORTED DRV_ACQUIRING DRV_ERROR_ACK DRV_P1INVALID DRV_P2INVALID NOTE Available on USB iStar State set System not initialized External outputs not supported Acquisition in progress Unable to communicate with system Invalid external output index Invalid state GetCapabilities GetDDGExternalOutputEnabled GetDDGExternalOutputStepEnabled SECTION 11 Page 231 ANDOR ee FUNCTIONS SetDDGExternalOutputTime unsigned int WINAPI SetDDGExternalOutputTime at_u32 Index at_u64 Delay at_u64 Width Description This function can be used to set the timings for a particular external output Parameters at_u32 Index index of external output at_u64 Delay external output delay time in picoseconds at_u64 Width external output width time in picoseconds Return unsigned int DRV_SUCCESS Timings set DRV_NOT_INITIALIZED System not initialized DRV_NOT_SUPPORTED External outputs not supported DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with card DRV_P1IN
230. o number of vertical pixels int height height of each track Valid values gt 0 maximum depends on number of tracks int offset vertical displacement of tracks Valid values depend on number of tracks and track height int bottom first pixels row of the first track int gap number of rows between each track could be 0 unsigned int DRV_SUCCESS Parameters set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV_P1INVALID Number of tracks invalid DRV_P2INVALID Track height invalid DRV PS3INVALID Offset invalid SetReadMode StartAcquisition SetRandomTracks SECTION 11 Page 268 ANDOR FUNCTIONS SetMultiTrackHBin unsigned int WINAPI SetMultiTrackHBin int bin Description This function sets the horizontal binning used when acquiring in Multi Track read mode Parameters int bin Binning size Return unsigned int DRV SUCCESS Binning set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress P1INVALID Invalid binning size See also SetReadMode SetMultiTrack NOTE 1 If the multitrack range is not a multiple of the binning BINNING ERROR will be returned from PrepareAcquisition and or StartAcquisition 2 For iDus it is recommended that you set horizontal binning to 1 SetMultiTrackHRange unsigned int WINAPI SetMultiTrackHRange int iStart int iEnd Description This function sets the horizontal range used when acquiring
231. on also returns the status of any cooling process including whether the cooler is ON or OFF 3 If the GetTemperature function returns the DRV TEMP STABILIZED status flag then the temperature is within 3 C of the set temperature and the microprocessor is no LONGER regulating the cooling rate At this point the temperature regulation is controlled via analog electronics SECTION 8 Page 69 ANDOR eo SPECIAL GUIDES SECTION 9 SPECIAL GUIDES CONTROLLING MULTIPLE CAMERAS Using the SDK It is possible to control multiple Andor cameras The following SDK functions permit the selection and use of one Andor camera at a time e GetAvailableCameras e GetCameraHandle e SetCurrentCamera e GetCurrentCamera e Initialize NOTE If only one camera is available it is not necessary to use any of these functions since that camera will be selected by default A maximum of eight cameras can be controlled by the SDK This can be a combination of USB and PCI cameras The maximum number of PCI cameras will be limited by the number of available slots and the ability of the PC to transfer the data While using more than one camera the other SDK functions are used in the normal way When a function is called it only affects the currently selected camera and is not sent to all cameras This allows each camera to be programmed individually but it also means that each camera has to be individually initialized and shut down Another aspect of this
232. ons Parameter output amplifier Type String Valid Values Conventional or Electron Multiplying Parameter frame transfer Type String Valid Values ON or OFF Parameter readout_rate Type Float Valid Values A valid and supported value which can be retrieved by subsequent calls to GetNumberHSSpeeds and GetHSSpeed SECTION 9 Page 86 ANDOR en SPECIAL GUIDES Parameter shift_speed Type Float Valid Values A valid and supported value which can be retrieved by subsequent calls to GetNumberVSSpeeds and GetVSSpeed Parameter electron_multiplying_gain Type Integer Valid Values A valid and supported value which can be retrieved from a call to GetEMGainRange Parameter vertical_clock_amplitude Type Integer Valid Values A valid and supported integer value in the range 0 4 Parameter preamplifier_gain Type Integer Valid Values A valid and supported value which can be retrieved from subsequent calls to GetNumberPreAmpGains and GetPreAmpGain SECTION 9 Page 87 ANDOR SPECIAL GUIDES An example of the pseudo code for using OptAcquire is shown in figure 16 and figure 17 fi Example use of OptAcquire Functions Start pt cquire using the Preset Modes fi Initialise specifying a user xml file to use The file does not need to exist at this stage however a file name must be provided This must be the first call before using any other pt
233. oolerOFF GetTemperatureStatus unsigned int WINAPI GetTemperatureStatus float SensorTemp float TargetTemp float AmbientTemp float CoolerVolts Description THIS FUNCTION IS RESERVED GetTotalNumberlmagesAcquired unsigned int WINAPI GetTotalNumberlmagesAcquired long index Description This function will return the total number of images acquired since the current acquisition started If the camera is idle the value returned is the number of images acquired during the last acquisition Parameters long index returns the total number of images acquired since the acquisition started Return unsigned int DRV SUCCESS Number of acquired images returned DRV NOT INITIALIZED System not initialized SECTION 11 Page 184 ANDOR e FUNCTIONS GetTriggerLevelRange unsigned int WINAPI GetTriggerLevelRange float minimum float maximum Description This function returns the valid range of triggers in volts which the system can use Parameters float minimum minimum trigger voltage float maximum maximum trigger voltage Return unsigned int DRV SUCCESS Levels returned DRV NOT INITIALIZED System not initialized DRV NOT SUPPORTED Trigger levels not supported DRV ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with system P1INVALID minimum has invalid memory address DRV P2INVALID maximum has invalid memory address See also GetCapabilities SetTriggerLevel SECTION 11 Page 18
234. or storage of the Head Model This should be declared as size MAX_PATH Return unsigned int DRV_SUCCESS Name returned DRV_NOT_INITIALIZED System not initialized GetHorizontalSpeed unsigned int WINAPI GetHorizontalSpeed int index int speed Description Deprecated see Note As your Andor system is capable of operating at more than one horizontal shift speed this function will return the actual speeds available The value returned is in microseconds per pixel shift Parameters int index speed required Valid values 0 to NumberSpeeds 1 where NumberSpeeds is the parameter returned by GetNumberHorizontalSpeeds int speed speed in micro seconds per pixel shift Return unsigned int DRV_SUCCESS Speed returned DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_P1INVALID Invalid index See also GetNumberHorizontalSpeeds SetHorizontalSpeed NOTE Deprecated by GetHSSpeed SECTION 11 Page 152 ANDOR FUNCTIONS GetHSSpeed unsigned int WINAPI GetHSSpeed int channel int typ int index float speed Description Parameters Return See also As your Andor system is capable of operating at more than one horizontal shift speed this function will return the actual speeds available The value returned is in MHZ int channel the AD channel int typ output amplification Valid values 0 electron multiplication Conventional clara 1 conventional Extended NIR Mode clara
235. orizontal binning is not implementated for iDus and must be set to 1 Vertical binning is used in the following way A track of 1101102412 is actually implemented as 5 tracks of height 2 Note that a vertical binning of 1 will have the effect of vertically binning the entire track otherwise vertical binning will operate as normal 12 1 1024 1 1 3 4 1 1024 1 1 561 1024 1 1 781 10241 1 9 10 1 1024 1 1 Parameters int numAreas int areas Return Unsigned int DRV SUCCESS Success NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV P1INVALID Number of tracks invalid DRV P2INVALID Track positions invalid DRV ERROR FILELOAD Serious internal error DRV RANDOM TRACK ERROR Invalid combination of tracks out of memory or mode not available See also SetRandomTracks NOTE Only available with iXon and USB cameras SECTION 11 Page 224 ANDOR FUNCTIONS SetCoolerMode unsigned int WINAPI SetCoolerMode int mode Description This function determines whether the cooler is switched off when the camera is shut down Parameters int mode 1 Temperature is maintained on ShutDown 0 Returns to ambient temperature on ShutDown Return unsigned int DRV SUCCESS DRV NOT INITIALIZED DRV ACQUIRING DRV_P1INVALID DRV_NOT_SUPPORTED Parameters set System not initialized Acquisition in progress State parameter was not zero or one Camera does not support NOTE Mode 0 not available
236. ot initialized DRV_ACQUIRING Acquisition in progress P1INVALID Trigger mode invalid Trigger Modes SetFastExtTrigger SECTION 11 Page 288 ANDOR FUNCTIONS SetlODirection unsigned int WINAPI SetlODirection int index int iDirection Description Available in some systems are a number of lO s that can be configured to be inputs or outputs This function sets the current state of a particular IO Parameters int index IO index Valid values 0 to GetNumberlO 1 int iDirection requested direction for this index 0 Output 1 Input Return unsigned int DRV SUCCESS DRV NOT INITIALIZED ACQUIRING DRV_P1INVALID DRV_P2INVALID DRV_NOT_AVAILABLE See also IO direction set System not initialized Acquisition in progress Invalid index Invalid direction Feature not available GetNumberlO GetlOLevel GetlODirection SetlOLevel SetlOLevel unsigned int WINAPI SetlOLevel int index int iLevel Description Available in some systems are a number of IO s that can be configured to be inputs or outputs This function sets the current state of a particular IO Parameters int index IO index Valid values 0 to GetNumberlO 1 int iLevel current level for this index 0 Low 1 High Return unsigned int DRV_SUCCESS level set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV_P1INVALID Invalid index DRV_P2INVALID Invalid level DRV_NOT_A
237. peed returned DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV_P1INVALID Invalid index GetNumberVSSpeeds SetVSSpeed GetFastestRecommendedVSSpeed SECTION 11 Page 188 ANDOR FUNCTIONS GPIBReceive unsigned int WINAPI GPIBReceive int id short address char text int size Description Parameters Return See also This function reads data from a device until a byte is received with the EOI line asserted or until size bytes have been read int id The interface board number short address Address of device to send data char text The data to be sent int size Number of characters to read unsigned int DRV SUCCESS Data received PSINVALID Invalid pointer e g NULL Other errors may be returned by the GPIB device Consult the help documentation supplied with these devices GPIBSend GPIBSend unsigned int WINAPI GPIBSend int id short address char text Description Parameters Return See also This function initializes the GPIB by sending interface clear Then the device described by address is put in a listen active state Finally the string of characters text is sent to the device with a newline character and with the EOI line asserted after the final character int id The interface board number short address Address of device to send data char text The data to be sent unsigned int DRV SUCCESS Data sent DRV PSINVAL
238. pping 1 Flipping Enabled 0 Flipping Disabled unsigned int DRV SUCCESS All parameters accepted DRV NOT INITIALIZED System not initialized P1INVALID HFlip parameter invalid DRV P2INVALID VFlip parameter invalid SetlmageRotate SetlmageFlip GetlmageRotate unsigned int WINAPI GetlmageRotate int iRotate Description Parameters Return See also This function will obtain whether the acquired data output is rotated in any direction int iRotate Rotation setting 0 No rotation 1 Rotate 90 degrees clockwise 2 Rotate 90 degrees anti clockwise unsigned int DRV SUCCESS All parameters accepted DRV NOT INITIALIZED System not initialized P1INVALID Rotate parameter invalid SetlmageFlip SetlmageRotate SECTION 11 Page 154 ANDOR e FUNCTIONS Getlmages unsigned int WINAPI Getlmages long first long last at 32 arr unsigned long size long validfirst long validlast Description This function will update the data array with the specified series of images from the circular buffer If the specified series is out of range i e the images have been overwritten or have not yet been acquired then an error will be returned Parameters long first index of first image in buffer to retrieve long last index of last image in buffer to retrieve at 32 arr pointer to data storage allocated by the user unsigned long size total number of pixels long validfirst index of the first
239. pt that instead of a Software command instigating the acquisition an external source does so All the benefits described in the Software Trigger section can also be applied to the external trigger mode It is set up in the same way with the same modes except that the trigger mode is set to External Frame transfer is also fully functional in iCam External Trigger mode When Frame Transfer is on it means that the Arm signal from the camera will be enabled during the current readout at a point to ensure the next exposure will end after the current readout is finished This will give the fastest frame rate and also ensure that the next exposure cannot end until the previous one has been readout SECTION 5 Page 58 ANDOR Ca TRIGGERING External Start In External Start Trigger Mode once an acquisition has been started via the StartAcquisition function the camera system is placed into an external keep clean mode which ensures that the CCD is not saturated before the external trigger occurs Once the External Trigger is received the Keep Clean sequence is stopped and the acquisition is initiated After the initial acquisition the system will then continue to operate as in internal trigger mode The figure below illustrates the timing sequence for this mode of operation External trigger keep clean running with Number of vertical clocks depends on sub area height global clear on 885 ii z Image amp Storage area clocks Ho
240. ption THIS FUNCTION IS RESERVED SelectDevice unsigned int WINAPI SelectDevice int devNum Description THIS FUNCTION IS RESERVED SendSoftwareTrigger unsigned int WINAPI SendSoftwareTrigger Description Parameters Return See also NOTES This function sends an event to the camera to take an acquisition when in Software Trigger mode Not all cameras have this mode available to them To check if your camera can operate in this mode check the GetCapabilities function for the Trigger Mode AC TRIGGERMODE CONTINUOUS If this mode is physically possible and other settings are suitable IsTriggerModeAvailable and the camera is acquiring then this command will take an acquisition NONE unsigned int DRV SUCCESS Trigger sent DRV NOT INITIALIZED System not initialized DRV INVALID MODE Not in SoftwareTrigger mode DRV IDLE Not Acquiring DRV ERROR CODES Error communicating with camera DRV ERROR ACK Previous acquisition not complete GetCapabilities ISTriggerModeAvailable SetAcquisitionMode SetReadMode SetTriggerMode The settings of the camera must be as follows ReadOut mode is full image RunMode is Run Till Abort TriggerMode is 10 SECTION 11 Page 217 ANDOR FUNCTIONS SetAccumulationCycleTime unsigned int WINAPI SetAccumulationCycleTime float time Description Parameters Return See also This function will set the accumulation cycle time to the nearest valid value not les
241. quire support for DV885 systems Bug fixes Fixed race condition in WaitForAcquisitionTimeout Image in crop mode on 00860 was shifting by 4 pixels for heights of less than 4 Fixed SR303 hardware issue where the step position of the wavelength drive will move when powered on SetPCIMode should return NOT SUPPORTED when not using the 23 24 card All Shamrock LabVIEW function names prepended with shamrock to avoid conflicts Version 2 88 30000 0 New features Added OptAcquire feature to simplify configuration of iXon systems Added Count Convert feature to return data as photons or electrons Added Data Averaging feature for real time and post processing Added Spurious noise Filters for both real time and post processing Added Photon Counting post processing option Andor LabVIEW library updated to use version 8 0 Added Dual Exposure Mode for iKon L Updated SIFIO to enable the retrieval of calibration data Updated Shamrock SDK to include a calibration for Zolix spectrographs Added SDK function and capability for GetBaselineClamp Changed keep clean in FVB mode for iXon to prevent temperature drift Bug fixes Updated capability options for C SECTION 1 Page 17 ANDOR INTRODUCTION Updated Andor LabVIEW library Shutter open close times fixed for Auto mode Fixed EM gain control when using multiple systems from the same executable Fixed isolated crop mode when data is being accumulated Fixed i
242. quisitionByHandleTimeOut SDK SECTION 11 Page 297 ANDOR FUNCTIONS WaitForAcquisitionByHandleTimeOut unsigned int WINAPI WaitForAcquisitionByHandleTimeOut long cameraHandle int iTimeOutMs Description Parameters Return See also Whilst using multiple cameras WaitForAcquisitionByHandle can be called after an acquisition is started using StartAcquisition to put the calling thread to sleep until an Acquisition Event occurs This can be used as a simple alternative to the functionality provided by the SetDriverEvent function as all Event creation and handling is performed internally by the SDK library Like the SetDriverEvent functionality it will use less processor resources than continuously polling with the GetStatus function If you wish to restart the calling thread without waiting for an Acquisition event call the function CancelWait An Acquisition Event occurs each time a new image is acquired during an Accumulation Kinetic Series or Run Till Abort acquisition or at the end of a Single Scan Acquisition If an Acquisition Event does not occur within TimeOutMs milliseconds WaitForAcquisitionTimeOut returns DRV NO NEW DATA Long cameraHandle handle of camera to put into wait state int iTimeOutMs Time before returning DRV NO NEW DATA if no Acquisition Event occurs unsigned int DRV_SUCCESS Acquisition Event occurred DRV_P1INVALID Handle not valid DRV_NO_NEW_DATA Non Acquisition Event occurred
243. r of this section first 1 Insert the CD supplied with the SDK and execute the SETUP EXE program This will take you through the complete installation process You will be prompted to select the type of camera you have purchased as the installation needs to configure were required the Detector ini file appropriately You will also be requested to select a destination directory this should be a directory that all users planning to use the SDK have full read write privileges to The directory will be created if it does not already exist It is recommended that if you are performing an upgrade or reinstall that you do it to a clean directory Example programs will be copied into sub directories of the installation directory specified above 2 f not already installed proceed with installing camera hardware Consult your User guide for details You may have to restart the PC to complete the installation 3 Navigate to the directory destination directory NExamples C directory Go into sub directory and run the exe file that you see there If this runs successfully then your installation has completed If it does not run with a successful message please consult the troubleshooting guide later in this section The installation process will copy the following files into the specified base directory ATMCD32D DLL 32 bit Dynamic Link Library ATMCD64D DLL 64 bit Dynamic Link Library DETECTOR INI Classic CCD ICCD and iS
244. ra long cameraHandle Description When multiple Andor cameras are installed this function allows the user to select which camera is currently active Once a camera has been selected the other functions can be called as normal but they will only apply to the selected camera If only 1 camera is installed calling this function is not required since that camera will be selected by default Parameters long cameraHandle Selects the active camera Return unsigned int DRV SUCCESS Camera successfully selected DRV P1INVALID Invalid camera handle SEE ALSO GetCurrentCamera GetAvailableCameras GetCameraHandle SetCustomTrackHBin unsigned int WINAPI SetCustomTrackHBin int bin Description This function sets the horizontal binning value to be used when the readout mode is set to Random Track Parameters Int bin Binning size Return unsigned int DRV SUCCESS Binning set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress P1INVALID Invalid binning size See also SetReadMode NOTE For iDus it is recommended that you set horizontal binning to 1 SECTION 11 Page 228 ANDOR FUNCTIONS SetDACOutputScale unsigned int WINAPI SetDACOutputScale int scale Description select the active one Parameters Return unsigned int DRV_SUCCESS DRV NOT INITIALIZED DRV ACQUIRING DRV NOT AVAILABLE DRV P1INVALID See also SetDACOutput Clara offers 2 configurable precision 16 bit DAC output
245. ram The name of the acquisition parameter for which a value will be retrieved char StringValue The buffer to return the value of the acquisition parameter const unsigned int StringLen length of the buffer unsigned int DRV SUCCESS All parameters accepted DRV_P1INVALID Null mode name DRV_P2INVALID Null mode parameter DRV PSINVALID Null string value DRV PAINVALID Invalid string length OA SetString SECTION 11 Page 201 ANDOR FUNCTIONS OA_GetUserModeNames unsigned int WINAPI OA GetUserModeNames char ListOfModes Description Parameters Return See also This function will return the available mode names from a User defined file The mode and the User defined file must exist The user must allocate enough memory for all of the acquisition parameters char ListOfModes A user allocated array of characters for storage of the mode names Mode names will be delimited by a unsigned int DRV SUCCESS DRV P1INVALID OA NULL ERROR OA GetNumberOfUserModes All parameters accepted Null list of modes Invalid pointer OA Initialize unsigned int WINAPI Initialize const char const Filename unsigned int FileNameLen Description Parameters Return See also This function will initialise the OptAcquire settings from a Preset file and a User defined file if it exists char const Filename The name of a user xml file If the file exists t
246. re time and hence cannot be set via the software For our Classic CCD range of cameras with frame transfer type sensors the camera can be operated in External Trigger mode In this mode there are no keep cleans and the external trigger starts the Readout phase The exposure time is the time between external triggers and hence the user cannot set the exposure or cycle times For our iXon range of cameras the external trigger mode is more flexible With these cameras the user can define the amount of time between the external trigger event occurring and the readout starting This can be useful in those situations where the TTL trigger occurs before the light event you are trying to capture As in the Classic Camera case no keep cleans are running and the true exposure time is the time between triggers However the exposure window has moved in time by the exposure time There is no need for a mechanical shutter As the exposure time is long compared to the time required to shift the image into the storage area and therefore image streaking will be insignificant SECTION 4 Page 51 ANDOR ACQUISITION MODES It is also possible to operate a FT CCD in a non frame transfer mode In this standard mode of operation an FT CCD acts much like a standard CCD The capture sequence for this standard mode is illustrated here Continuously Clean CCD Keep Clean Cycle T w 2 Step 3 ww m St
247. regime of tens of photons per pixel otherwise accelerated ageing of the sensor can occur Parameters int state Enables Disables access to higher EM gain levels 1 Enable access 0 Disable access Return unsigned int DRV SUCCESS Parameters set DRV NOT INITIALIZED System not initialized DRV NOT AVAILABLE Advanced EM gain not available for this camera DRV_ACQUIRING Acquisition in progress DRV_P1INVALID State parameter was not zero or one See also GetCapabilities GetEMCCDGain SetEMCCDGain SetEMGainMode SetEMCCDGain unsigned int WINAPI SetEMCCDGain int gain Description Allows the user to change the gain value The valid range for the gain depends on what gain mode the camera is operating in See SetEMGainMode to set the mode and GetEMGainRange to get the valid range to work with To access higher gain values gt x300 see SetEMAdvanced Parameters int gain amount of gain applied Return unsigned int DRV_SUCCESS Value for gain accepted DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV I2CTIMEOUT 12 command timed out DRV I2CDEVNOTFOUND I2C device not present DRV ERROR ACK Unable to communicate with card DRV_P1INVALID Gain value invalid See also GetEMCCDGain SetEMGainMode GetEMGainRange SetEMAdvanced NOTE Only available on EMCCD sensor systems SECTION 11 Page 247 ANDOR e FUNCTIONS SetEMClockCompensation unsigned int WINAPI SetEMClockCompensation i
248. rent ways There are also functions to control the CCD temperature and shutter operations The driver will automatically handle its own internal memory requirements To use the SDK effectively the user must develop a software package to configure the acquisition provide memory management process the data captured and create the user interface The manual is broken into several sections and it is recommended that the user read Sections 1 10 before starting to use the SDK These sections describe the installation process camera initialization configuration and data capture Section 11 is a complete function reference detailing the function syntax parameters passed and error codes returned To further aid the user there is a comprehensive list of examples included with the SDK The examples illustrate the use of C Visual Basic and LabVIEW SECTION 1 Page 12 ANDOR INTRODUCTION TECHNICAL SUPPORT Contact details for your nearest representative can be found on our website SOFTWARE IMPROVEMENTS AND ADDITIONAL FEATURES Version SDK 2 95 30000 0 New Features Bug Fixes Windows 8 Support USB iStar now supports the option to change the gate width for each frame in a kinetic series Added support for cameras that can store sensor specific acquisition configuration settings on the camera to provide backward compatibility with older software versions Updated Windows USB camera driver to version 1 2 6 giving better authen
249. ring which it is safe to allow a pulsed source to fire The figure below illustrates the timing sequence for this mode of operation Exposure time Shutter Output Fire Output lt 3 Read time Triqqer lt Fire Pulse A Time to Open Time to Close Shutter Transfer Time Shutter Transfer Time Internal Trigger Mode is ideal for situations where you are using continuous wave CW light sources an ordinary room light for instance and incoming data for the purposes of your observation are steady and unbroken thus you can begin acquisitions at will You may use Internal Trigger Mode when you are able to send a trigger signal or Fire Pulse to a short duration pulsed source a laser for example in this case initiating the data acquisition process can also signal the pulsed source to fire SECTION 5 Page 56 ANDOR gt TRIGGERING External In External Trigger Mode once an acquisition has been started via the StartAcquisition function the camera is placed into a special dumping version of the Keep Clean mode which ensures that the CCD is not saturated before the external trigger occurs Once the External Trigger is received the Keep Clean sequence is stopped and the acquisition is initiated The figure below illustrates the timing sequence for this mode of operation I Exposure Time gt FIRE PULSE DURATION 1
250. rizontal clocks External Trigger Fire output _ _ ___ Number of repeats set Read phase Exposure time by series length External Start trigger in Fast Kinetics mode SECTION 5 Page 59 ANDOR TRIGGERING External Exposure The External Exposure trigger is a mode of operation where the exposure time is fully controlled by the external trigger input While the trigger input is high the CCD is accumulating charge in the Image area When the external trigger goes low the accumulated charge is quickly shifted into the Storage area and then read out in the normal manner The figures below illustrate the timing sequences for this mode of operation Exposure period 1 Exposure period 2 H pi Image area clocks Storage area clocks Horizontal clocks External trigger Fire output Image area shifted into storage area Exposure period defined by extemal pulse Global clear used to Horizontal clocks keep image area continue running clean Exposure period 1 Exposure period 2 i i An DD spe aa cta Storage area clocks Horizontal clocks Fire output Note exposure period starts Note Falling edge before the readout MUST occur after Exposure period has completed read out completed defined by external pulse External Exposure Trigger in Frame Transfer mode 885 model only S D K SECTION 5 Page 60 ANDOR as hte TRIGGERING Idle keep clean cycle Waitin
251. rned DRV NOT INITIALIZED System not initialized P1INVALID The amplifier index is not valid DRV P2INVALID The desc pointer is null DRV PSINVALID The len parameter is invalid less than 1 See also GetNumberAmp SECTION 11 Page 108 ANDOR e FUNCTIONS GetAmpMaxSpeed unsigned int WINAPI GetAmpMaxSpeed int index float speed Description This function will return the maximum available horizontal shift speed for the amplifier selected by the index parameter Parameters Int index amplifier index float speed horizontal shift speed Return unsigned int DRV SUCCESS Speed returned DRV NOT INITIALIZED System not initialized P1INVALID The amplifier index is not valid See also GetNumberAmp GetAvailableCameras unsigned int WINAPI GetAvailableCameras long totalCameras Description This function returns the total number of Andor cameras currently installed It is possible to call this function before any of the cameras are initialized Parameters long totalCameras the number of cameras currently installed Return unsigned int DRV SUCCESS Number of available cameras returned DRV GENERAL ERRORS An error occurred while obtaining the number of available cameras See also SetCurrentCamera GetCurrentCamera GetCameraHandle GetBackground unsigned int WINAPI GetBackground at 32 arr unsigned long size Description THIS FUNCTION IS RESERVED SECTION 11 Page 109 ANDOR FUNCTION
252. rray size is incorrect DRV NO NEW DATA There is no new data yet See also SetDriverEvent GetAcquisitionProgress SetAcquisitionMode GetNewData8 GetNewData16 NOTE Deprecated by the following functions e Getlmages e GetMostRecentlmage e GetOldestlimage SECTION 11 Page 164 ANDOR FUNCTIONS GetNewData16 unsigned int WINAPI GetNewData16 WORD arr unsigned long size Description Deprecated see Note 16 bit version of the GetNewData function Parameters WORD arr pointer to data storage allocated by the user unsigned long size total number of pixels Return unsigned int DRV_SUCCESS DRV_NOT_INITIALIZED DRV_ERROR_ACK DRV_P1INVALID DRV_P2INVALID DRV_NO_NEW_DATA NOTE Deprecated by the following functions e Getlmages e GetMostRecentlmage e GetOldestlimage Data copied System not initialized Unable to communicate with card Invalid pointer i e NULL Array size is incorrect There is no new data yet GetNewData8 unsigned int WINAPI GetNewData8 unsigned char arr unsigned long size Description Deprecated see Note 8 bit version of the GetNewData function This function will return the data in the lower 8 bits of the acquired data Parameters unsigned char arr pointer to data storage allocated by the user unsigned long size total number of pixels Return unsigned int DRV SUCCESS NOT INITIALIZED DRV ERROR ACK DRV_P1INVALID DRV_P2INVALID DRV_NO_NEW_DAT
253. rs 32 bit signed integers The array must be exactly the same size as the full image Parameters at 32 arr pointer to data storage allocated by the user unsigned long size total number of pixels Return unsigned int DRV SUCCESS Image has been copied into array DRV NOT INITIALIZED System not initialized DRV ERROR ACK Unable to communicate with card DRV P1INVALID Invalid pointer i e NULL DRV P2INVALID Array size is incorrect DRV NO NEW DATA There is no new data yet See also GetOldestlmage16 GetMostRecentlmage GetMostRecentlmage16 GetOldestlmage16 unsigned int WINAPI GetOldestImage16 WORD arr unsigned long size Description 16 bit version of the GetOldestlmage function Parameters WORD arr pointer to data storage allocated by the user unsigned long size total number of pixels Return unsigned int DRV SUCCESS Image has been copied into array DRV NOT INITIALIZED System not initialized DRV ERROR ACK Unable to communicate with card DRV_P1INVALID Invalid pointer i e NULL DRV_P2INVALID Array size is incorrect DRV NO NEW DATA There is no new data yet See also GetOldestlmage GetMostRecentlmage16 GetMostRecentlmage SECTION 11 Page 173 ANDOR FUNCTIONS GetPhosphorStatus unsigned int WINAPI GetPhosphorStatus int status Description This function will return if the phosphor has saturated Parameters int status The status of the phosphor 0 Normal 1 Saturated Return unsigned int DRV
254. rst scan is still in progress See SetAcgStatusEvent NOTE This will also work in External trigger mode SetTriggerMode with an external trigger source determining the start of an exposure instead of the SendSoftwareTrigger command In external trigger care must be taken to ensure that the external trigger occurs when the camera is ready for it i e the frequency of the external trigger source has to be within the capabilities of the camera with the current settings With External Exposure trigger mode the width of the trigger pulse source will determine the exposure time and the Ring of Exposures will not be applicable See also Acquisition Modes GetAdjustedRingExposureTimes GetNumberRingExposureTimes GetRingExposureRange IsTriggerModeAvailable SendSoftwareTrigger SetRingExposureTimes SetTriggerMode SECTION 4 Page 47 ANDOR ACQUISITION MODES Fast Kinetics Fast Kinetics is a special readout mode that uses the actual sensor as a temporary storage medium and allows an extremely fast sequence of images to be captured The capture sequence is described with the following steps Step 1 both the Image and Storage areas of the sensor are fully cleaned out the Keep Clean Cycle Step 2 the Keep Clean Cycle stops and the acquisition begins The image builds up on the illuminated section of the sensor which is typically a small number of rows at the top of the sensor Step 3 the sensor remains in this state until the exposure ti
255. s Fixed crash seen on initialising OptAcquire with 64 bit SDK Fixed iDus target temperature being different from the one that was set Shamrock device drivers are now signed and so will not generate a security warning during installation Version 2 94 30005 0 New features e None Bug fixes e None Version 2 94 30001 0 New features SECTION 1 Page 13 ANDOR INTRODUCTION e None Bug fixes e OC not operating through SDK Fix to prevent crash when selecting multitrack on Luca R Fix for issue that was causing SDK to not write up the last Photon Counting threshold value Fix for the labview Get Pixel Calibration vi always returning ATSIF_P2INVALID error Fix for external trigger when the camera is under constant illumination the image is saturated irrespective of exposure time Fix for SDK defaulting to using an unavailable PAG for iXon 888 Validation now performed on the parameters of the SetDDGTimes function Fix so DDG Gate mode can not be changed while acquiring Crop settings now stored in sif file format iXon Ultra Shutter fixes Added function GetMaximumNumberRingExposureTimes Fixed temperature rate control to ensure the temperature remains steady Added x64 LabView Shamrock Examples Version 2 93 30007 0 New features e None Bug fixes e Fix for Neo PreAmpGainControl feature returning NOT IMPLEMENTED Version 2 93 30006 0 New features e None Bug fixes e Fix for RTA mode on certain cameras under x64
256. s This function should be used to int scale 5 or 10 volt DAC range 1 2 DAC Scale option accepted System not initialized Acquisition in progress Feature not available DAC Scale value invalid NOTE Only available on Andor Clara SetDACOutput unsigned int WINAPI SetDACOutput int option int resolution int value Description set the required voltage Parameters Clara offers 2 configurable precision 16 bit DAC outputs This function should be used to int option DAC Output DAC Pin 1 or 2 1 2 int resolution resolution of DAC can be set from 2 to 16 bit in steps of 2 int value requested DAC value for particular resolution Return unsigned int DRV_SUCCESS DRV_NOT_INITIALIZED DRV_ACQUIRING DRV_NOT_AVAILABLE DRV_P1INVALID DRV_P2INVALID DRV PSINVALID See also SetDACOutputScale DAC Scale option accepted System not initialized Acquisition in progress Feature not available DAC range value invalid Resolution unavailable Requested value not within DAC range NOTE Only available on Andor Clara SECTION 11 Page 229 ANDOR FUNCTIONS SetDataType unsigned int WINAPI SetDataType int typ Description THIS FUNCTION IS RESERVED SetDDG Address unsigned int WINAPI SetDDGAddress BYTE t0 BYTE t1 BYTE t2 BYTE t3 BYTE address Description THIS FUNCTION IS RESERVED SetDDGExternalOutputEnabled unsigned int WINAPI SetDDGExternalOutputEnabled at u32 Index at u32 En
257. s of the firepulse will be returned that the firepulse is low 0 Fire pulse low 1 Fire pulse high unsigned int DRV SUCCESS Status returned DRV NOT INITIALIZED System not initialized SetAcgStatusEvent SetPClMode This is only supported by the CCI23 card GetCameraHandle unsigned int WINAPI GetCameraHandle long cameralndex long cameraHandle Description Parameters Return See also This function returns the handle for the camera specified by cameralndex When multiple Andor cameras are installed the handle of each camera must be retrieved in order to select a camera using the SetCurrentCamera function The number of cameras can be obtained using the GetAvailableCameras function long cameralndex index of any of the installed cameras Valid values 0 to NumberCameras 1 where NumberCameras is the value returned by the GetAvailableCameras function long cameraHandle handle of the camera unsigned int DRV_SUCCESS Camera handle returned DRV_P1INVALID Invalid camera index SetCurrentCamera GetAvailableCameras GetCurrentCamera SECTION 11 Page 111 ANDOR ee FUNCTIONS GetCameralnformation unsigned int WINAPI GetCameralnformation int index long information Description This function will return information on a particular camera denoted by the index Parameters Int index reserved Long information current state of camera Bit 1 1 USB camera present Bit 2 1 All dlls loaded properly
258. s than the given value The actual cycle time used is obtained by GetAcquisitionTimings Please refer to SECTION 5 ACQUISITION MODES for further information float time the accumulation cycle time in seconds unsigned int DRV SUCCESS Cycle time accepted DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress P1INVALID Exposure time invalid SetNumberAccumulations GetAcquisition Timings SetAcqStatusEvent unsigned int WINAPI SetAcqStatusEvent HANDLE statusEvent Description Parameters Return See also NOTE This function passes a Win32 Event handle to the driver via which the driver can inform the user software that the camera has started exposing or that the camera has finished exposing determine what event has actually occurred call GetCameraEventStatus funtion This may give the user software an opportunity to perform other actions that will not affect the readout of the current acquisition The SetPCIMode function must be called to enable disable the events from the driver HANDLE statusEvent Win32 event handle unsigned int DRV_SUCCESS Mode set DRV_NOT_INITIALIZED System not initialized DRV_NOT_SUPPORTED Function not supported for operating system GetCameraEventStatus SetPCIMode This is only available with the CCI23 PCI card SECTION 11 Page 218 ANDOR ee FUNCTIONS SetAcquisitionMode unsigned int WINAPI SetAcquisitionMode int mode De
259. s value specifies whether the head contains a Standard 0 or a Frame Transfer 1 CCD The default is Standard FKVerticalShiftSpeed FKVerticalShiftSpeed speed This specifies the Fast Kinetics vertical shift speed Gain Gain a This specifies whether the system has software controllable Gain Mode settings 0 Not software selectable 1 Software selectable PhotonCountingCCD PhotonCountingCCD a This specifies whether the system contains a L3 Vision sensor from Marconi 0 Standard CCD 1 L8 Vision sensor SECTION 13 Page 307 ANDOR PAS DETECTOR INI EMCCDRegisterSize EMCCDRegisterSize a This specifies the length on the electron multiplying register in L3 Vision CCD iStar iStar a This specifies whether the system is an iStar or a standard ICCD 0 Standard ICCD 1 iStar SlowVerticalSpeedFactor SlowVerticalSpeedFactor a This specifies the factor by which the vertical shifted has been slowed This is used for those CCD s that are not capable at running at 16us The only possible value is 7 HELLFunction HELLFunction file The file specified contains the instructions required to perform readout of an iXon CCD It is specific to each type of CCD HELLLoop1 HELLLoop1 file The file specified contains generic instructions for readout of an iXon CCD and as such is not specific to a particular CCD ADChannels ADChannels a b This line indicates the types of ADChannels available for us
260. s where you need to acquire data at a fast rate but not at some predefined rate or when you need to change the exposure time between successive scans A good example would be calcium imaging where you need to take 2 images at different wavelengths with possibly different light levels With this new mode of operation you would set the experiment up as follows 1 Configure the camera to acquire an image SetReadMode Setlmage SetFrameTransferMode 2 Select Run till abort mode SetAcquisitionMode 3 Select Software trigger SetTriggerMode 10 Confirm with IsTriggerModeAvailable 10 B Set exposure time SetExposureTime or SetRingExposureTimes Move filter to first position Start acquisition StartAcquisition Send software Trigger SendSoftwareTrigger Wait for an acquisition event See SetDriverEvent o o m Move Filter to next position 10 Change exposure time See SetExposureTime 11 Retrieve data see GetAcquiredData 12 Go to step 7 In the procedure outlined above we manually changed the exposure during the sequence However we could have used the new Ring of exposures feature to set up the two exposure times in advance and let the camera automatically switch between them as necessary see SetRingExposureTimes There is also the ability to detect the end of the exposure and start reconfiguring the experiment for the next SECTION 4 Page 46 ANDOR ACQUISITION MODES acquisition while the readout of the fi
261. scription This function will set the acquisition mode to be used on the next StartAcquisition Parameters int mode the acquisition mode Valid values 1 Single Scan 2 Accumulate 3 Kinetics 4 Fast Kinetics 5 Run till abort Return unsigned int DRV_SUCCESS Acquisition mode set DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_P1INVALID Acquisition Mode invalid See also StartAcquisition NOTE In Mode 5 the system uses a Run Till Abort acquisition mode In Mode 5 only the camera continually acquires data until the AbortAcquisition function is called By using the SetDriverEvent function you will be notified as each acquisition is completed SetAcquisitionType unsigned int WINAPI SetAcquisitionType int typ Description THIS FUNCTION IS RESERVED SetADChannel unsigned int WINAPI SetADChannel int channel Description This function will set the AD channel to one of the possible A Ds of the system This AD channel will be used for all subsequent operations performed by the system Parameters int index the channel to be used Valid values 0 to GetNumberADChannels 1 Return unsigned int DRV_SUCCESS AD channel set DRV_P1INVALID Index is out off range See also GetNumberADChannels SECTION 11 Page 219 ANDOR FUNCTIONS SetAdvancedTriggerModeState unsigned int WINAPI SetAdvancedTriggerModeState int iState Description Parameters Return See also NOTE This func
262. series Set via the SetNumberKinetics function SECTION 4 Page 54 ANDOR gt TRIGGERING SECTION 5 TRIGGERING TRIGGER MODES To assist the user in synchronizing data capture with external events the Andor system supports several modes of triggering including Internal External External Start External Exposure Bulb External FVB EM only valid for EM Newton models in FVB mode needs added Software The trigger mode is set via the SetTriggerMode function In the remainder of this section we will examine the modes in detail and give some indication on the appropriate application of each trigger mode SECTION 5 Page 55 ANDOR as TRIGGERING Internal In Internal Trigger Mode once an acquisition has been started via the StartAcquisition function the Andor system determines when data is actually acquired Before the camera starts the data capture process it ensures that the CCD is in the appropriate state This ensures that all acquisitions are identical no matter how long a time has elapsed since data was last acquired in fact the camera continually reads out the CCD to help prevent it from being saturated by light falling on it whilst it is not acquiring data The camera also generates all the necessary pulses for shuttering and firing external sources These pulses are accessed directly on the camera or via the Auxiliary Connector depending on the model The Fire Output defines the position in time du
263. set values for string type acquisition parameters where the new values are stored in memory To commit changes to file call WriteToFile Parameters const char const ModeName The name of the mode for which an acquisition parameter is to be edited const char const ModeParam The name of the acquisition parameter to be edited char StringValue The value to assign to the acquisition parameter const unsigned int StringLen length of the input string Return unsigned int DRV SUCCESS All parameters accepted DRV_P1INVALID Null mode name DRV_P2INVALID Null mode parameter DRV_P3INVALID Null string value DRV_P4INVALID Invalid string length DRV OA INVALID STRING LENGTH One or more of the string parameters has an invalid length i e gt 255 DRV OA MODE DOES NOT EXIST The Mode does not exist See also OA GetString OA EnableMode OA WriteToFile OA WriteToFile unsigned int WINAPI OA WriteToFile const char const FileName unsigned int FileNameLen Description Parameters Return See also This function will write a User defined list of modes to the User file The Preset file will not be affected const char const FileName The name of the file to be written to unsigned int FileNameLen File name string length unsigned int DRV SUCCESS All parameters accepted DRV P1INVALID Null filename DRV OA INVALID STRING LENGTH One or more of the string parameters has an invalid length i e gt 255 DRV OA INVALID FIL
264. specify the exposure time trigger mode and some of the shutter details Image Binning This example shows how to acquire single images with possible binning The sub image to be read can be entered and the binning for each dimension can be set Kinetics Accumulate For this example we go back to the Full Vertical Binning readout mode as in example 1 However we introduce a new acquisition mode Kinetic Series Kinetic Series is the most complex acquisition mode with up to 5 parameters to be set The user is given the ability to specify the number of accumulations per scan accumulation cycle time number of scans in Kinetic series Kinetic cycle time and the exposure time SECTION 10 Page 95 ANDOR Cs EXAMPLES Kinetic Image This example is a combination of the imaging and kinetic examples Multi Track This example illustrates the use of the Multi Track readout mode The acquisition mode is constrained to Single Scan and uses internal triggering As this example uses imaging we again use a shutter The user has the ability to specify both the shutter and Multi Track parameters Random Track This example is similar to Multi Track readout mode as described above The user has the ability to add select their own track parameters i e Start amp Stop number of tracks Maximum of 20 tracks for iDus and they can also select the shutter parameters Spool This example demonstrates the use of spooling to disk Spooling can be enabled or disa
265. ssues with control of multiple systems with multiple threads Fixed exposure time in software trigger mode when using large cycle time Fixed memory leak in GetAvailableCameras function Fixed random tracks stopping in video mode Version 2 87 30000 0 New features Clara E now supported Newton DU970 71P cameras now supported Cycle time reduced for imaging on Newton and iVac systems Number of accumulations can now be set in a kinetic series in overlap mode FVB cycle time reduced in crop mode provided only the height of the sensor has been cropped Bug fixes Clara near infra red mode not operating correctly when using FVB read mode Minimum exposure time increased to 1 millisecond for Clara near infra red mode Change to remove odd even pixel noise after a number of accumulations in iDus Change to resolve image wrap around on Newton sensors Image was being shifted between frames when photon counting was being used on a Clara Fast kinetics now working in FVB mode First pulse missed in ring of exposures on Clara Updated bitmap header data to allow avi s to play in Windows 7 Multiple systems was not supported for 64 bit Windows TimeStamp from Clara meta data was incorrect for a kinetic series of accumulations Video mode was eventually freezing in iCam PCI systems Fix for Spooling to fits issue in Windows 7 Fix for image shift seen in DU940P newton cameras Version 2 86 30000 0 New features Clara meta data now stored in sif file for
266. t DRV NO NEW DATA No acquisition has taken place SECTION 11 Page 105 ANDOR FUNCTIONS See also GetStatus StartAcquisition GetAcquiredData GetAcquiredFloatData unsigned int WINAPI GetAcquiredFloatData float arr unsigned long size Description THIS FUNCTION IS RESERVED GetAcquisitionProgress unsigned int WINAPI GetAcquisitionProgress long acc long series Description Parameters Return See also This function will return information on the progress of the current acquisition It can be called at any time but is best used in conjunction with SetDriverEvent The values returned show the number of completed scans in the current acquisition If O is returned for both accum and series then either e No acquisition is currently running e acquisition has just completed e The very first scan of an acquisition has just started and not yet completed GetStatus can be used to confirm if the first scan has just started returning ACQUIRING otherwise it will return IDLE For example if accum 2 and series 3 then the acquisition has completed 3 in the series and 2 accumulations in the 4 scan of the series long acc returns the number of accumulations completed in the current kinetic scan long series return the number of kinetic scans completed unsigned int DRV SUCCESS Number of accumulation and series scans completed DRV NOT INITIALIZED System not initialized
267. t DRV SUCCESS All parameters accepted DRV_P1INVALID Null mode name DRV_P2INVALID Null mode parameter DRV OA INVALID STRING LENGTH One or more of the string parameters has an invalid length i e gt 255 DRV OA MODE DOES NOT EXIST The Mode does not exist OA GetFloat OA EnableMode OA WriteToFile OA Setlnt unsigned int WINAPI OA Setlnt const char const ModeName const char ModeParam const int IntValue Description Parameters Return See also This function is used to set values for integer type acquisition parameters where the new values are stored in memory To commit changes to file call WriteToFile const char const ModeName The name of the mode for which an acquisition parameter will be edited const char const ModeParam The name of the acquisition parameter to be edited const int IntValue The value to assign to the acquisition parameter unsigned int DRV SUCCESS All parameters accepted DRV_P1INVALID Null mode name DRV_P2INVALID Null mode parameter DRV OA INVALID STRING LENGTH One or more of the string parameters has an invalid length i e gt 255 DRV OA MODE DOES NOT EXIST Tha Moue doss norerist OA Getlnt OA EnableMode OA WriteToFile SECTION 11 Page 203 ANDOR FUNCTIONS OA SetString unsigned int WINAPI OA SetString const char const ModeName const char ModeParam char StringValue const unsigned int StringLen Description This function is used to
268. t only 3 Gating ON continuously 4 Gating OFF continuously 5 Gate using DDG Return unsigned int DRV SUCCESS Gating mode accepted DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV_I2CTIMEOUT command timed out DRV I2CDEVNOTFOUND C device not present DRV ERROR ACK Unable to communicate with card P1INVALID gatemode has invalid memory address See also GetCapabilities SetGateMode GetHardwareVersion unsigned int WINAPI GetHardwareVersion unsigned int PCB unsigned int Decode unsigned int dummy1 unsigned int dummy2 unsigned int CameraFirmwareVersion unsigned int CameraFirmwareBuild Description This function returns the Hardware version information Parameters Unsigned int PCB Plug in card version unsigned int Decode Flex 10K file version unsigned int dummy1 unsigned int dummy2 unsigned int CameraFirmwareVersion Version number of camera firmware unsigned int CameraFirmwareBuild Build number of camera firmware Return unsigned int DRV SUCCESS Version information returned DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with card GetHeadModel SECTION 11 Page 151 ANDOR ee FUNCTIONS unsigned int WINAPI GetHeadModel char name Description This function will retrieve the type of CCD attached to your system Parameters char name A user allocated array of characters f
269. tar cameras only ATMCD32D H C C only ATMCD32D LIB Borland compatible library C C only ATMCD32M LIB Microsoft compatible library C C only ATMCD32D BAS Visual Basic only ATMCD32D PAS Pascal only ATMCD32CS DLL CZ only ATMCD32D VB VB net SECTION 2 Page 28 ANDOR e INSTALLATION NOTE The files are also copied into each example directory This is to allow each example to be run as a stand alone program A device driver required to support the camera will also be installed The actual driver installed will depend on the camera type and operating system version i e e For PCI systems the driver file is atmcdwdm sys for 32 bit operating systems or atmcdwdm64 sys for 64 bit operating systems e For USB cameras the driver file is libusbO sys for 32 bit operating systems or libusbO x64 sys for 64 bit operating systems NOTE Do not have more than one example or other SDK software e g Andor Solis iQ running at the same time SECTION 2 Page 29 ANDOR PAS INSTALLATION Windows Troubleshooting Installing on Windows 7 e Some users have experienced difficulty installing the SDK on Windows 7 if so please see the Window 7 Driver Installation Guide If you are running a PCI camera e Check that the Andor Technology PCI driver appears in the Ensure that an Andor section in exists in the Device Manager and that an Andor Technology PCI driver appears in it To access the Device Manager
270. ted DRV_P1INVALID Null mode name DRV_P3INVALID Null mode description DRV OA INVALID STRING LENGTH One or more parameters have an invalid length i e 255 DRV OA INVALID NAMING Mode and description have the same name this is not valid DRV OA MODE BUFFER FULL Number of modes exceeds limit DRV OA INVALID CHARS IN NAME Mode name and or description contain invalid characters DRV OA MODE ALREADY EXISTS Mode name already exists in the file OA INVALID CHARS IN NAME Invalid charcters in Mode Name or Mode Description OA DeleteMode OA WriteToFile OA DeleteMode unsigned int WINAPI OA DeleteMode const char const ModeName unsigned int ModeNameLen Description Parameters Return See also This function will remove a mode from memory To permanently remove a mode from file call OA WriteToFile after OA DeleteMode The Preset file will not be affected const char const ModeName The name of the mode to be removed unsigned int ModeNameLen Mode name string length unsigned int All parameters accepted DRV SUCCESS Null mode name DRV P1INVALID The mode name parameter has an invalid OA INVALID STRING LENGTH length i e gt 256 Mode does not exist DRV OA MODE DOES NOT EXIST OA AddMode OA WruiteToFile SECTION 11 Page 197 ANDOR ee FUNCTIONS OA_EnableMode unsigned int WINAPI OA_EnableMode const char const ModeName Description This function will set all the paramet
271. tegrate on chip IOC option Parameters int integrate ON OFF switch for the IOC option Valid values 0 to switch IOC OFF 1 to switch IOC ON Return unsigned int DRV_SUCCESS IOC option accepted DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_NOT_SUPPORTED IOC not supported DRV_ERROR_ACK Unable to communicate with system See also GetCapabilities SetDDGlOCFrequency GetDDGIOCFrequency SetDDGlOCNumber GetDDGlOCNumber GetDDGIOCPulses SECTION 11 Page 234 ANDOR FUNCTIONS SetDDGIOCFrequency unsigned int WINAPI SetDDGlOCFrequency double frequency Description Parameters Return See also This function sets the frequency of the integrate on chip option It should be called once the conditions of the experiment have been setup in order for correct operation The frequency should be limited to 5000Hz when Intelligate is activated to prevent damage to the head and 50000Hz otherwise to prevent the gater from overheating The recommended order is Experiment setup exposure time readout mode gate parameters SetDDGIOCFrequency SetDDGlOC true GetDDGIOCPulses y StartAcquisition double frequency frequency of IOC option in Hz unsigned int DRV SUCCESS Value for frequency accepted DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV NOT SUPPORTED IOC not supported DRV_ERROR_ACK Unable to communicate with card GetDD
272. the AndorCapabilites structure The next few pages contain a summary of the capabilities currently returned Andor capabilities caps the capabilities structure to be filled in unsigned int DRV NOT INITIALIZED System not initialized DRV SUCCESS Capabilities returned DRV P1INVALID Invalid caps parameter i e NULL GetCameraHandle GetCameraSerialNumber GetHeadModel GetCameralnformation SECTION 11 Page 113 FUNCTIONS ANDOR ee FUNCTIONS GetCapabilities Acquisition Modes Acquisition Modes AndorCapabilities Member ulAcqModes Capability AC_ACQMODE_SINGLE Description Single Scan Acquisition Mode available using SetAcquisitionMode Bit 0 State 1 Capability AC ACQMODE VIDEO Description Video Run Till Abort Acquisition Mode available using SetAcquisitionMode Bit 1 State 1 Capability AC ACQMODE ACCUMULATE Description Accumulation Acquisition Mode available using SetAcquisitionMode Bit 2 State 1 Capability AC ACQMODE KINETIC Description Kinetic Series Acquisition Mode available using SetAcquisitionMode Bit 3 State 1 Capability AC ACQMODE FRAMETRANSFER Description Frame Transfer Acquisition Mode available using SetAcquisitionMode Bit 4 State 1 Capability AC ACQMODE FASTKINETICS Description Fast Kinetics Acquisition Mode available using SetAcquisitionMode Bit 5 State 1 Capability AC ACQMODE OVERLAP Description Overlap Acquisition Mode availab
273. the data acquired during a spooled acquisition can be retrieved through the normal functions This is a change to previous versions it is no longer necessary to load the data from disk from your own application int active Enable disable spooling Valid values 0 Disable spooling 1 Enable spooling int method Indicates the format of the files written to disk Valid values 0 Files contain sequence of 32 bit integers 1 Format of data in files depends on whether multiple accumulations are being taken for each scan Format will be 32 bit integer if data is being accumulated each scan otherwise the format will be 16 bit integer 2 Files contain sequence of 16 bit integers 3 Multiple directory structure with multiple images per file and multiple files per directory 4 Spool to RAM disk 5 Spool to 16 bit Fits File 6 Spool to Andor Sif format 7 Spool to 16 bit Tiff File 8 Similar to method 3 but with data compression char path String containing the filename stem May also contain the path to the directory into which the files are to be stored int framebuffersize This sets the size of an internal circular buffer used as temporary storage The value is the total number images the buffer can hold not the size in bytes Typical value would be 10 This value would be increased in situations where the computer is not able to spool the data to disk at the SECTION 11 Page 284 ANDOR eo FUNCTIONS required rate Ret
274. thmic p1 log p2 n 3 Linear p1 p2 n n 1 2 number in kinetic series unsigned int DRV SUCCESS Gate step mode set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with card P1INVALID Gate step mode invalid StartAcquisition NOTE Available on iStar SECTION 11 Page 241 ANDOR FUNCTIONS SetDDGWidthStepCoefficients unsigned int WINAPI SetDDGWidthStepCoefficients at u32 mode double p1 double p2 Description Parameters Return See also This function will configure the coefficients used in a kinetic series with gate width step active The lowest available resolution is 25 picoseconds and the maximum permitted value is 25 seconds for a PCI iStar The lowest available resolution is 10 picoseconds and the maximum permitted value is 10 seconds for a USB iStar at u32mode the gate step mode Valid values 0 constant p1 n 1 1 exponential p1 exp p2 n 2 logarithmic p1 log p2 n 3 linear p2 n n 1 2 number in kinetic series unsigned int DRV SUCCESS Gate step mode coefficients set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress P1INVALID Gate step mode invalid SetDDGWidthStepMode GetDDGWidthStepMode GetDDGWidthStepCoefficients SetDDGWidthStepMode unsigned int WINAPI SetDDGWidthStepMode at_u32 mode Description Parameters Retur
275. thod for displaying the most recent image on screen while the acquisition is in progress should be used in conjunction with the GetNumberNewlmages function The GetNumberNewlmages function returns the start and end index of the images that are available in the circular buffer These indexes should be used along with the Getlmages function to retrieve all of the available data This provides an effective way of retrieving a number of new images in one function call GetAcquiredData should be used once the acquisition is complete to retrieve all the data from the series This could be a single scan or an entire kinetic series SECTION 9 Page 75 ANDOR SPECIAL GUIDES DETERMINING CAMERA CAPABILITIES Retrieving capabilities from the camera It is important to be able to determine the capabilities of the camera This allows the user to take the full benefit of all the features available There are a number of functions available which can be used to obtain this information and these can be found in the following areas of this section e Horizontal Pixel Shift Capabilities e Vertical Pixel Shift Capabilities e Other Capabilities SECTION 9 Page 76 ANDOR e SPECIAL GUIDES Horizontal Pixel Shift Capabilities Depending on the camera type and model there will be variations in the number of A D channels the number of Output Amplifiers the number amp range of Horizontal Shift Speeds and the number amp range of
276. tication support on Windows 7 The accuracy of the temperature reported by DU885 systems has been improved Added version information to the atmechelle dll library GetCapabilities SDK function now includes the option to test whether a system supports the pre scan feature Support for configuring gate settings on a DG535 through GPIB GetAcquisitionProgress will now show the accumulation number incremented when in Accumulate mode and cosmic ray filter on SetFKVShiftSpeed although deprecated can now be used with non Classic systems Disabled fast kinetics for InGaAs Added GetRelativelmageTimes function to retrieve meta data information for a range of frames Support for iDus 416 camera Adding Extended Isolated Crop Mode functionality that allows a cropped image to be acquired from anywhere on the sensor for iXon Ultra Fixes to prevent gating when USB iStar is not acquiring Fixed issue on Windows 7 which meant the number of images per DMA was fixed at 1 Fixed a 1 row error in the position of a Fast kinetics acquisition Fix for reduced frame rate when horizontally binning in crop mode Fix for images saved using the SavesAs functions storing an incorrect value for the Pre Amp Gain Fix for External start trigger mode causing the acquisition to continuously wait and ignore triggers on iXon cameras at 3MHz readout Removed an arc artefact from the first frame on a DU920 BR DD Fix to resolve an accumulated Odd Even effect on iDus 401 BV camera
277. tion Parameters Return This function will return the maximum number of images the circular buffer can store based on the current acquisition settings long index returns the maximum number of images the circular buffer can store unsigned int DRV SUCCESS Maximum number of images returned DRV NOT INITIALIZED System not initialized GetSlotBusDeviceFunction unsigned int WINAPI GetSlotBusDeviceFunction DWORD dwSlot DWORD dwBus DWORD dwDevice DWORD dwFunction Description THIS FUNCTION IS RESERVED SECTION 11 Page 179 ANDOR ee FUNCTIONS GetSoftwareVersion unsigned int WINAPI GetSoftwareVersion unsigned int eprom unsigned int cofFile unsigned int vxdRev unsigned int vxdVer unsigned int dllRev unsigned int dilVer Description This function returns the Software version information for the microprocessor code and the driver Parameters unsigned int eprom EPROM version unsigned int cofFile COF file version unsigned int vxdRev Driver revision number unsigned int vxdVer Driver version number unsigned int dllIRev DLL revision number unsigned int dllVer DLL version number Return unsigned int DRV SUCCESS Version information returned DRV NOT INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with card GetSpoolProgress unsigned int WINAPI GetSpoolProgress long index Description Deprecated see Note This f
278. tion will set the state for the iCam functionality that some cameras are capable of There may be some cases where we wish to prevent the software using the new functionality and just do it the way it was previously done int iState 0 turn off iCam 1 Enable iCam unsigned int DRV SUCCESS State set DRV NOT INITIALIZED System not initialized DRV P1INVALID state invalid iCam By default the advanced trigger functionality is enabled SECTION 11 Page 220 ANDOR FUNCTIONS SetBackground unsigned int WINAPI SetBackground at_32 arr unsigned long size Description THIS FUNCTION IS RESERVED SetBaselineClamp unsigned int WINAPI SetBaselineClamp int state Description Parameters Return This function turns on and off the baseline clamp functionality With this feature enabled the baseline level of each scan in a kinetic series will be more consistent across the sequence int state Enables Disables Baseline clamp functionality 1 Enable Baseline Clamp 0 Disable Baseline Clamp unsigned int DRV SUCCESS Parameters set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV NOT SUPPORTED Baseline Clamp not supported on this camera DRV P1INVALID State parameter was not zero or one SetBaselineOffset unsigned int WINAPI SetBaselineOffset int offset Description Parameters Return NOTE This function allows the user to move the b
279. together to create each member of your kinetic series The default value of 1 means that each member of the kinetic series will consist of a single scan Set via the SetNumberAccumulations function Accumulate Cycle Time This is the period in seconds between the start of individual scans see Number of Accumulations above that are accumulated in computer memory to create each member of your kinetic series each member of the series is an accumulated scan Set via the SetAccumulationCycleTime function This parameter is only applicable if you have selected the Internal trigger and the Number of Accumulations is greater than 1 Please refer to SECTION 6 TRIGGERING for further information Number in Kinetic Series This is the number of scans or accumulated scans you specify to be in your series Set via the SetNumberKinetics function Kinetic Cycle Time This is the period in seconds between the start of each scan or set of accumulated scans if you have set the Number of Accumulations to more than 1 in the series Set via the SetKineticCycleTime function This parameter is only applicable if you have selected the Internal trigger see Trigger Modes NOTE 1 If the exposure time or the cycle time are set too low or are not permissible values the driver will automatically calculate the nearest appropriate value 2 The actual values used can be obtained via the GetAcquisitionTimings function This function s
280. tory where the software was installed 2 If there is a USB device with an exclamation mark beside it and you cannot account for this device then it is probably the Andor camera and the driver is not installed Install the driver as described previously or right click on the entry and update driver 3 Close down any Andor software remove the USB cable from either the camera or the PC and reconnect it again Run the software to see if the camera is now detected 4 If still not connected then remove the USB cable from either the PC or the camera power the camera off and on the camera and reconnect the USB cable again 5 Run the software to see if the camera is now detected SECTION 2 Page 30 ANDOR oer INSTALLATION NOTE If the camera is still not detected after step 6 please contact the appropriate technical support person SECTION 2 Page 31 ANDOR e INSTALLATION SDK LINUX INSTALLATION The first step is to unpack the archive that you have received With the following steps replace lt version gt with the version number of the archive you have E g 2 15 1 Opena terminal 2 Change the directory to where the andor lt version gt tar gz file is located 3 Type tar zxvf andor lt version gt tar gz A new directory named andor is created To install the SDK run the script install andor from the andor directory See the INSTALL file located in the same directory for further inform
281. transfer camera and a continuous source you will need to use a shutter to avoid streaking the spectra during the binning process Please refer to SECTION 8 SHUTTER CONTROL for further information To set up a Multi Track acquisition you need to call the following functions SetReadMode 1 SetMultiTrack 5 20 0 bottom gap The SetMultiTrack function also returns the position of the first pixel row of the first track bottom together with the gap between tracks This allows the user to calculate the actual position of each track NOTE 1 Before using Multi Track mode with fiber bundles it is often useful to acquire a full resolution image of the output Having observed the vertical position and spacing of the individual spectra you can vary track height and offset accordingly 2 Imaging spectrographs vertically invert input light i e light from the top fiber will fall on the bottom track on the CCD chip SECTION 3 Page 36 ANDOR Loa READOUT MODES Random Track In Random Track mode the position and height of each track is specified by the user unlike Multi Track mode were the driver sets the position of each track automatically RANDOM TRACK ET TT TT TT TT Track Number i Figure 5 Random Track Random Track will allow you to simultaneously acquire a number of spectra delivered typically via a fiber bundle Unless you are acquiring data from
282. types of acquisition status events The default is to notify on every type of event but this may cause missed events if different types of event occur very close together The bits in the mask correspond to the following event types 0 Fire pulse down event 1 Fire pulse up event Set the corresponding bit to 0 to disable the event type and 1 to enable the event type DWORD Enable bitmask with bits set for those events about which you wish to be notified unsigned int DRV SUCCESS Mask Set DRV VXDNOTINSTALLED Device Driver not installed SetAcgStatusEvent SetPCIMode Only available with PCI systems using the CCI 23 controller card Fire pulse up event not available on USB systems SetChargeShifting unsigned int WINAPI SetChargeShifting unsigned int numRows unsigned int numRepeats Description Parameters Return See also NOTE Use this function in External Charge Shifting trigger mode to configure how many rows to shift and how many times for each frame of data The number of repeats must be a multiple of 2 Unsigned int numRows number of rows to shift after each external trigger Unsigned int numRepeats number of times to shift rows unsigned int DRV_SUCCESS Success DRV_NOT_INITIALIZED System not initialized DRV_NOT_SUPPORTED Trigger mode not supported DRV_ACQUIRING Acquisition in progress DRV P1INVALID Number of rows invalid DRV P2INVALID Number of repeats invalid SetTriggerMode GetCapabilities
283. ulse width in picoseconds Return unsigned int DRV SUCCESS Values for gate pulse accepted DRV NOT INITIALIZED System not initialized DRV ACQUIRING Acquisition in progress DRV I2CTIMEOUT 126 command timed out I2CDEVNOTFOUND I2C device not present DRV ERROR ACK Unable to communicate with card P1INVALID Invalid output A delay DRV P2INVALID Invalid gate delay DRV PSINVALID Invalid pulse width See also SetDDGGateStep NOTE Available on iStar SECTION 11 Page 240 ANDOR FUNCTIONS SetDDGTriggerMode unsigned int WINAPI SetDDGTriggerMode int mode Description Parameters Return This function will set the trigger mode of the internal delay generator to either Internal or External int mode trigger mode Valid values 0 Internal 1 External unsigned int DRV SUCCESS Trigger mode set DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV ERROR ACK Unable to communicate with card P1INVALID Trigger mode invalid NOTE Available on iStar SetDDGVariableGateStep unsigned int WINAPI SetDDGVariableGateStep int mode double p1 double p2 Description Parameters Return See also This function will set a varying value for the gate step in a kinetic series The lowest available resolution is 25 picoseconds and the maximum permitted value is 25 seconds int mode the gate step mode Valid values 1 Exponential p1 exp p2 n 2 Logari
284. unction will return information on the progress of the current spool operation The value returned is the number of images that have been saved to disk during the current kinetic scan Parameters long index returns the number of files saved to disk in the current kinetic scan Return unsigned int DRV SUCCESS Spool progress returned DRV NOT INITIALIZED System not initialized See also SetSpool NOTE Deprecated by GetTotalNumberlmagesAcquired GetStartUpTime unsigned int WINAPI GetStartUpTime float time Description THIS FUNCTION IS RESERVED SECTION 11 Page 180 ANDOR FUNCTIONS GetStatus unsigned int WINAPI GetStatus int status Description This function will return the current status of the Andor SDK system This function should be called before an acquisition is started to ensure that it is IDLE and during an acquisition to monitor the process Parameters int status current status DRV IDLE IDLE waiting on instructions DRV TEMPCYCLE Executing temperature cycle DRV_ACQUIRING Acquisition in progress DRV ACCUM TIME NOT MET Unable to meet Accumulate cycle time DRV KINETIC TIME NOT MET Unable to meet Kinetic cycle time DRV ERROR ACK Unable to communicate with card DRV ACQ BUFFER Computer unable to read the data via the ISA slot at the required rate DRV SPOOLERROR Overflow of the spool buffer Return unsigned int DRV SUCCESS Status returned DRV NOT INITIALIZED System not initialized See also S
285. urn unsigned int DRV_SUCCESS Parameters set DRV_NOT_INITIALIZED System not initialized DRV_ACQUIRING Acquisition in progress See also GetSpoolProgress NOTE Spooled images will not be post processed i e flipped or rotated SetSpoolThreadCount unsigned int WINAPI SetSpoolThreadCount int count Description This function sets the number of parallel threads used for writing data to disk when spooling is enabled Increasing this to a value greater than the default of 1 can sometimes improve the data rate to the hard disk particularly with Solid State hard disks In other cases increasing this value may actually reduce the rate at which data is written to disk Parameters int count The number of threads to use Return unsigned int DRV SUCCESS Thread count is set DRV NOT INITIALIZED System not initialized DRV ACQUIRING Acquisition in progress DRV_P1INVALID Invalid thread count See also SetSpool NOTE This feature is currently only available when using the Neo camera SetStorageMode unsigned int WINAPI SetStorageMode long mode Description THIS FUNCTION IS RESERVED SECTION 11 Page 285 ANDOR ee FUNCTIONS SetTECEvent unsigned int WINAPI SetTECEvent HANDLE Event Description This function passes a Win32 Event handle to the driver via which the driver can inform the user software that the TEC has overheated or returned to a normal state To determine what event has actually occurred call the GetTECStatus fun
286. utput amplification Valid values 0 electron multiplication 1 conventional int speeds number of allowed horizontal speeds unsigned int DRV SUCCESS Number of speeds returned DRV NOT INITIALIZED System not initialized DRV P1INVALID Invalid channel DRV P2INVALID Invalid horizontal read mode GetHSSpeed SetHSSpeed GetNumberADChannels GetNumberNewlmages unsigned int WINAPI GetNumberNewlmages long first long last Description Parameters Return See also This function will return information on the number of new images i e images which have not yet been retrieved in the circular buffer This information can be used with Getlmages to retrieve a series of the latest images If any images are overwritten in the circular buffer they can no longer be retrieved and the information returned will treat overwritten images as having been retrieved long first returns the index of the first available image in the circular buffer long last returns the index of the last available image in the circular buffer unsigned int DRV SUCCESS Number of acquired images returned DRV NOT INITIALIZED System not initialized DRV ERROR ACK Unable to communicate with card DRV NO NEW DATA There is no new data yet Getlmages Getlmages16 GetNumberAvailablelmages Note This index will increment as soon as a single accumulation has been completed within the current acquisition SECTION 11 Page 169 ANDOR
287. with system DRV_P1INVALID Invalid period GetCapabilities SetDDGIOC GetDDGIOCPeriod SECTION 11 Page 236 FUNCTIONS SetDDGIOCTrigger unsigned int WINAPI SetDDGIOCTrigger at_u32 trigger This function can be used to select whether to trigger the IOC pulse train with either the rising edge of the fire pulse or an externally supplied trigger at u32 trigger IOC trigger option Valid values 0 fire pulse 1 external trigger unsigned int DRV SUCCESS IOC trigger set DRV_NOT_INITIALIZED System not initialized DRV_NOT_SUPPORTED IOC not supported DRV_ACQUIRING Acquisition in progress DRV_ERROR_ACK Unable to communicate with system DRV P1INVALID Invalid trigger GetCapabilities GetDDGlOCTrigger SetDDGIOC SetTriggerMode SetDDGLiteControlByte unsigned int WINAPI SetDDGLiteControlByte AT_DDGLiteChannelld channel unsigned char control Description THIS FUNCTION IS RESERVED SetDDGLiteGlobalControlByte unsigned int WINAPI SetDDGLiteGlobalControlByte unsigned char control Description THIS FUNCTION IS RESERVED SetDDGLitelnitialDelay unsigned int WINAPI SetDDGLitelnitialDelay AT DDGLiteChannelld channel float fDelay Description THIS FUNCTION IS RESERVED SetDDGLitelnterPulseDelay unsigned int WINAPI SetDDGLitelnterPulseDelay AT DDGLiteChannelld channel float fDelay Description THIS FUNCTION IS RESERVED SetDDGLitePulsesPerExposure unsigned int WINAPI SetDDGLitePulsesPerExposure AT DDGLiteChann
288. y memory can be quite long which can result in a long delay between calling StartAcquisition and the acquisition actually commencing For iDus there is an additional delay caused by the camera being set up with any new acquisition parameters Calling PrepareAcquisition first will reduce this delay in the StartAcquisition call Parameters NONE Return unsigned int DRV SUCCESS Acquisition prepared DRV NOT INITIALIZED System not initialized ACQUIRING Acquisition in progress DRV VXDNOTINSTALLED VxD not loaded DRV ERROR ACK Unable to communicate with card DRV INIERROR Error reading DETECTOR INI DRV ACQERROR Acquisition settings invalid DRV ERROR PAGELOCK Unable to allocate memory DRV INVALID FILTER Filter not available for current acquisition DRV IOCERROR Integrate On Chip setup error BINNING ERROR Range not multiple of horizontal binning DRV SPOOLSETUPERROR Error with spool settings See also StartAcquisition FreelnternalMemory SECTION 11 Page 206 ANDOR FUNCTIONS PostProcessCountConvert unsigned int WINAPI PostProcessCountConvert at 32 Inputlmage at 32 Outputlmage int OutputBufferSize int Numlmages int Baseline int Mode int EmGain float QE float Sensitivity int Height int Width Description This function will convert the input image data to either Photons or Electrons based on the mode selected by the user The input data should be in counts Parameters at32 Inputlmage

functions sdk

Contents

Download Pdf Manuals

Related Search

Related Contents