MKS Ophir FluxGage User manual

FluxGage DLL User Manual 2
SUMMARY
1. INTRODUCTION.........................................................................................................3
2. THE SOFTWARE INTERFACE...................................................................................3
2.1. INITIALIZATION...............................................................................................................................3
2.2. CLOSE ..........................................................................................................................................4
2.3. VERSION .......................................................................................................................................4
2.4. SPECTROMETER CONFIGURATION...................................................................................................5
2.4.1. SET AVERAGE ..........................................................................................................................5
2.4.2. GET AVERAGE..........................................................................................................................5
2.4.3. INTEGRATION TIME....................................................................................................................6
2.5. FLUXGAGE™................................................................................................................................7
2.5.1. AUTOSET..................................................................................................................................7
2.5.2. AUTOSET_CURRENT.................................................................................................................8
2.5.3. AUTOSET_PHOTODIODE............................................................................................................8
2.5.4. AUTOSET_SPECTRUM...............................................................................................................9
2.5.5. SET GAIN CURRENT................................................................................................................10
2.5.6. GET GAIN CURRENT ...............................................................................................................10
2.5.7. SET GAIN PHOTODIODE ..........................................................................................................11
2.5.8. GET GAIN PHOTODIODE..........................................................................................................11
2.5.9. TAKE BACKGROUND................................................................................................................12
2.5.10. CLEAR BACKGROUND .............................................................................................................12
2.5.11. CALIBRATION..........................................................................................................................13
2.5.11.1.CALIBRATION .................................................................................................................................. 13
2.5.11.2.CALIBRATION DATE.......................................................................................................................... 14
2.5.11.3.RESTORE FACTORY CALIBRATION ..................................................................................................... 15
2.5.11.4.OVERWRITE FACTORY CALIBRATION.................................................................................................. 15
2.5.12. FLUXGAGE™-CALCULATE CONFIGURATION............................................................................16
2.5.12.1.SET FLICKER................................................................................................................................... 16
2.5.12.2.GET FLICKER .................................................................................................................................. 16
2.5.12.3.GET PAR LIMIT 1............................................................................................................................ 17
2.5.12.4.GET PAR LIMIT 2............................................................................................................................ 17
2.5.12.5.GET PAR LIMIT 3............................................................................................................................ 18
2.5.12.6.SET PAR LIMIT 1 ............................................................................................................................ 18
2.5.12.7.SET PAR LIMIT 2 ............................................................................................................................ 19
2.5.12.8.SET PAR LIMIT 3 ............................................................................................................................ 19
2.5.12.9.WAVELENGHT VALUE ....................................................................................................................... 20
2.5.13. MEASUREMENT.......................................................................................................................21
2.5.13.1.ACQUISITION................................................................................................................................... 21
2.5.14. LWA CORRECTION.................................................................................................................23
2.5.14.1.FACTOR LIMIT ................................................................................................................................. 23
2.5.14.2.USER DEFINITION............................................................................................................................. 23

FluxGage DLL User Manual 3
1. INTRODUCTION
This manual provides information for integrating the Software of the FluxGage™into your
system.
2. THE SOFTWARE INTERFACE
This chapter describes the FluxGage™API library –FluxGage.dll. It describes the various
data types and functions available and the measurement modes used to drive it.
2.1. Initialization
Function Name
Initialization
Definition
This function:
1. Verifies that the FluxGage™ is connected
2. Opens the VISA port
3. Resets the FluxGage™- if Reset parameter is true
4. Checks the FluxGage™ name - if ID Query parameter is true
5. Reads all FluxGage™ memory
6. Clears the background value in the FluxGage™ memory
Prototype
void Initialization( Bool ID_Query,
Bool Reset,
out String Resource_Name)
Input
Bool ID_Query
Bool Reset
Output
String Visa resource name

FluxGage DLL User Manual 4
2.2. Close
Function Name
Close
Definition
Close the VISA port.
Prototype
void Close(String Resource_Name, out bool result)
Input
String Visa resource name
Output
out bool Result
2.3. Version
Function Name
Get Version
Definition
This function returns the version of the software and the hardware
Prototype
void GetVersion( String Resource_Name,
out String Instrument_Information,
out String Instrument_Firmware_Revision,
out String Instrument_Driver_Revision,
out String HW_Revision,
out String EEPROM_Version,
out String SN)
Input
String Visa resource name
Output String Instrument_Information
String Instrument_Firmware_Revision
String Instrument_Driver_Revision
String HW_Revision
String EEPROM_Version
String SN

FluxGage DLL User Manual 5
2.4. Spectrometer configuration
2.4.1. Set Average
Function Name
SetAverage
Definition
This function configures the average used by the spectrometer.
Prototype
void SetAverage( String Resource_Name,
ushort Number_of_Average)
Input
String Visa resource name
ushort Number_of_Average
Output
None
2.4.2. Get Average
Function Name
GetAverage
Definition
This function returns the current average used by the spectrometer.
Prototype
void GetAverage( String Resource_Name,
out ushort Number_of_Average)
Input
String Visa resource name
Output
ushort Number_of_Average

FluxGage DLL User Manual 6
2.4.3. Integration Time
Function Name
Set IntegrationTime
Definition
This function configures the integration time used by the spectrometer.
Prototype
void SetIntegrationTime( String Resource_Name
uint Integration_Time_ms)
Input
String Visa resource name
uint Integration Time in millisecond
Output
none

FluxGage DLL User Manual 7
2.5. FluxGage™
2.5.1. Autoset
Function Name
AutoSet
Definition
This function searches and defines the correct gain and integration time for the
FluxGage™.
This function returns the gain value for the Current, the gain value for the photodiode
and the integration time for the spectrometer.
Prototype
void AutoSet( String Resource_Name,
ushort number_Of_Average,
out uint Intergration_time_ms,
out byte Gain_Photodiode,
out byte Gain_Current)
Input
String Visa Resource_Name
ushort number_Of_Average
Output
uint Intergration_Time_ms
byte GainPhotodiode
byte GainCurrent

FluxGage DLL User Manual 8
2.5.2. Autoset_Current
Function Name
AutoSet_Current
Definition
This function searches and defines the correct current gain for the FluxGage™.
This function returns the gain value for the Current.
Prototype
void AutoSet_Current( String Resource_Name,
out byte Gain_Current)
Input
String Visa resource name
Output
byte GainCurrent
2.5.3. Autoset_Photodiode
Function Name
AutoSet_Photodiode
Definition
This function searches and defines the correct photodiode gain for the FluxGage™.
This function returns the gain value for the photodiode.
Prototype
void AutoSet_Photodiode( String Resource_Name,
out byte Gain_Photodiode)
Input
String Visa resource name
Output byte GainPhotodiode

FluxGage DLL User Manual 9
2.5.4. Autoset_Spectrum
Function Name
AutoSet_Spectrum
Definition
This function searches and defines the integration time for the FluxGage™.
This function returns the integration time for the spectrometer
Prototype
void AutoSet_Spectrum( String Resource_Name,
ushort number_Of_Average,
out uint Intergration_time_ms)
Input
String Visa resource name
ushort number_Of_Average
Output
uint Intergration_Time_ms

FluxGage DLL User Manual 10
2.5.5. Set Gain Current
Function Name
SetGainCurrent
Definition
This function defines the gain for the Current (user definition)
Prototype
void SetGainCurrent ( String Resource_Name,
byte Gain_Current)
Input
String Visa resource name
byte Gain_Current
Output
None
2.5.6. Get Gain Current
Function Name
GetGainCurrent
Definition
This function returns the gain for the Current used by the FluxGage™
Prototype
void GetGainCurrent ( String Resource_Name,
out byte Gain_Current)
Input
String Visa resource name
Output
byte GainCurrent

FluxGage DLL User Manual 11
2.5.7. Set Gain Photodiode
Function Name
SetGainPhotodiode
Definition
This function defines the gain for the Photodiode (user definition)
Prototype
void SetGainCurrent ( String Resource_Name,
byte Gain_Photodiode)
Input
String Visa resource name
byte Gain_Photodiode
Output
none
2.5.8. Get Gain Photodiode
Function Name
GetGainPhotodiode
Definition
This function returns the gain for the Photodiode used by the FluxGage™
Prototype
void GetGainPhotodiode ( String Resource_Name,
out byte Gain_Photodiode)
Input
String Visa resource name
Output
byte Gain_Photodiode

FluxGage DLL User Manual 12
2.5.9. Take Background
Function Name
Take Background
Definition
This function defines the background value used during the measure/calibration.
Prototype
void TakeBackground ( String Resource_Name,
ushort number_Of_Average,
uint Integration_Time_ms)
Input
String Visa resource name
ushort number_Of_Average
uint Integration Time in millisecond
Output None
2.5.10.Clear Background
Function Name
Clear Background
Definition
This function clears the current background value
Prototype
void ClearBackground ( String Resource_Name,
out bool result)
Input
String Visa resource name
Output Bool Result

FluxGage DLL User Manual 13
2.5.11.Calibration
2.5.11.1.Calibration
Function Name
Calibration
Definition
This function defines:
- Vector calibration for the spectrometer
- Factor calibration for the luminous flux
If the luminous flux target equals to 0 lumens, the luminous flux calibration step
is not executed.
If the Calibration file value is empty, the spectrometer calibration step is not
executed.
Vector calibration reference format:
Array 2D
1st Column: Wavelength
2nd Column: Pixel value.
Status value:
- Calibration Lumen Passed.
- Calibration Lumen Failed.
- Calibration Spectrum Passed.
- Calibration Spectrum Failed.
- Saved to working value.
Prototype
void Calibration( String Resource_Name,
FluxGage.CalibrationFileValue
CalibrationFileValue,
int Luminous_Flux_Target_Lumen,
ushort Average,
uint Integration_Time_ms,
out DBL FluxLumen,
out Bool Calibration_Pass,
out Bool OutOfRange,
out String Status)
Input
String Visa resource name
FluxGage.CalibrationFileValue CalibrationFileValue
int LuminousFluxTargetLumen
ushort Command (ClearBackground, TakeBackground)
ushort Average
uint Integration Time in millisecond

FluxGage DLL User Manual 14
Output
DBL computeLuminousFluxLumen value (after
calibratrion)
Bool CalibrationPass
Bool OutOfRange
String Status
2.5.11.2.Calibration Date
Function Name
CalibrationDate
Definition
Returns the date for the current calibration.
Prototype
void CalibrationDate( String Resource_Name,
out string day_Of_Month,
out string month,
out string year)
Input
String Visa resource name
Output String day_Of_Month
String Month
String year

FluxGage DLL User Manual 15
2.5.11.3.Restore Factory Calibration
Function Name
Restores Factory Value
Definition
This function replaces the current local calibration use by the FluxGage™ by the
factory value.
Prototype
void RestoreFactoryValue(String Resource_Name)
Input
String Visa resource name
Output
none
2.5.11.4.Overwrite Factory Calibration
Function Name
Overwrite Factory Value
Definition
This function replaces the factory value by the current local calibration use by the
FluxGage™.
Prototype
void OverwriteFactoryValue( String Resource_Name)
Input
String Visa resource name
Output
none

FluxGage DLL User Manual 16
2.5.12. FluxGage™ - Calculate configuration
2.5.12.1.Set Flicker
Function Name
Set FlickerBandwith
Definition
Defines the frequency used for the filter the flicker signal.
Prototype
void SetFlickerBandwidth(uint Flicker_Bandwidth)
Input
uint Flicker_Bandwidt
Output
none
2.5.12.2.Get Flicker
Function Name
Get FlickerBandwith
Definition
Defines the frequency used for the filter the flicker signal.
Prototype
void GetFlickerBandwidth(out uint Flicker_Bandwidth)
Input
none
Output
uint Flicker_Bandwidth

FluxGage DLL User Manual 17
2.5.12.3.Get PAR Limit 1
Function Name
Get PARLimits 1
Definition
Get the limit used for the PAR calculation.
Prototype
void GetPARLimits_1(out double start,
out double stop)
Input none
Output
Double start
Double stop
2.5.12.4.Get PAR Limit 2
Function Name
Get PARLimits 2
Definition
Get the limit used for the PAR calculation.
Prototype
void GetPARLimits_2(out double start,
out double stop)
Input none
Output
Double start
Double stop

FluxGage DLL User Manual 18
2.5.12.5.Get PAR Limit 3
Function Name
Get PARLimits 3
Definition
Get the limit used for the PAR calculation.
Prototype
void GetPARLimits_3(out double start,
out double stop)
Input none
Output
Double start
Double stop
2.5.12.6.Set PAR Limit 1
Function Name
Set PARLimits 1
Definition
Defines the limit used for the PAR calculation.
Prototype
void SetPARLimits_1(double start,
double stop)
Input Double start
Double stop
Output
None

FluxGage DLL User Manual 19
2.5.12.7.Set PAR Limit 2
Function Name
Set PARLimits 2
Definition
Defines the limit used for the PAR calculation.
Prototype
void SetPARLimits_2(double start,
double stop)
Input Double start
Double stop
Output
none
2.5.12.8.Set PAR Limit 3
Function Name
Set PARLimits 3
Definition
Defines the limit used for the PAR calculation.
Prototype
void SetPARLimits_3(double start,
double stop)
Input Double start
Double stop
Output
none

FluxGage DLL User Manual 20
2.5.12.9.Wavelenght value
Function Name
GetWavelengthStartStop
Definition
Returns the Start and Stop values for the spectrum vector.
Note: the wavelength step is 1 nm
Prototype
void GetWavelengthStartStop( String Resource_Name,
out float Wavelenght_Start,
out float Wavelenght_Stop)
Input
String Visa resource name
Output
float Wavelenght_Start
float Wavelenght_Stop