MKS Ophir FluxGage User Manual
  1. Manuals
  2. Brands
  3. MKS Manuals
  4. Industrial Equipment
  5. Ophir FluxGage
  6. User manual
MKS Ophir FluxGage User Manual

MKS Ophir FluxGage User Manual

Dll software development kit
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Ophir FluxGage and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for MKS Ophir FluxGage

Summary of Contents for MKS Ophir FluxGage

  • Page 2: Table Of Contents

    SUMMARY 1. INTRODUCTION ......................3 2. THE SOFTWARE INTERFACE ................... 3 2.1..........................3 NITIALIZATION 2.2............................4 LOSE 2.3............................4 ERSION 2.4....................5 PECTROMETER CONFIGURATION 2.4.1. S .......................... 5 VERAGE 2.4.2. G .......................... 5 VERAGE 2.4.3. I ........................

  • Page 3: Introduction

    INTRODUCTION This manual provides information for integrating the Software of the FluxGage™ into your system. 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.

  • Page 4: Close

    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,...

  • Page 5: Spectrometer Configuration

    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.

  • Page 6: Integration Time

    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...

  • Page 7: Fluxgage

    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,...

  • Page 8: Utoset Urrent

    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.

  • Page 9: Autoset

    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...

  • Page 10: Setgaincurrent

    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™...

  • Page 11: Setgainphotodiode

    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™...

  • Page 12: Take Background

    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...

  • Page 13: Calibration

    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.

  • Page 14: Calibrationdate

    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...

  • Page 15: Restore Factory Calibration

    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...

  • Page 16: Fluxgage™ - Calculate Configuration

    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.

  • Page 17: Get Par Limit 1

    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.

  • Page 18: Get Par Limit 3

    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.

  • Page 19: Set Par Limit 2

    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.

  • Page 20: Wavelenght Value

    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...

  • Page 21: Measurement

    2.5.13.Measurement 2.5.13.1. Acquisition Function Name ReadValue Definition This function returns all measurements and calculations executed by the FluxGage™. The measurement includes the calibration value and background value This function returns: Data: o Percent Flicker o Flicker index o DUV o Lumen o Calculate ...
  • Page 22 public struct Calculate public double fluxLumen; public int percentFlickerFiltered400Hz; public double[] wavelength; public double[] energyWattPerNanometer; public bool outOfRange; public string errorlbl; public bool overHeat; public float flickerIndexFiltered400Hz; public double illuminanceAtdiffuser_kLux; public double[] tM30_FullFidelity_99; public double[] tM30_FidelityIndexRf_16; public double[] tM30_Rcs; public double tM30_GamutIndexRg;...

  • Page 23: Lwa Correction

    2.5.14.LWA Correction 2.5.14.1. Factor Limit Function Name GetLWAMaxValue Definition This function returns the limit define by the FluxGage™ for the LWA correction Prototype void GetLWAMaxValue (String Resource_Name out DBL Max_Length, out DBL Max_Width, out DBL Max_Angle) Input String Visa resource name Output DBL Max_Length DBL Max_Width...
  • Page 24 public static void AutoSet(string resource_Name, ushort number_Of_Average, out uint integration_Time_ms, out byte gain_Photodiode, out byte gain_Current); public static void AutoSet_Current(string resource_Name, out byte gain_Current); public static void AutoSet_Photodiode(string resource_Name, out byte gain_Photodiode); public static void AutoSet_Spectrum(string resource_Name, ushort number_Of_Average, out uint integration_Time_ms);...

Table of Contents