carto® 3 - quote price · fluxgage dll user manual 5 2.4. spectrometer configuration 2.4.1. set...

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


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


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)


Output String Instrument_Information

String Instrument_Firmware_Revision

String Instrument_Driver_Revision

String HW_Revision

String EEPROM_Version

String SN


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)


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)


Output ushort Number_of_Average


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)


uint Integration Time in millisecond

Output none


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


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,



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)


Output byte GainPhotodiode


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,


out uint Intergration_time_ms)



Output uint Intergration_Time_ms


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)


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,



Output byte GainCurrent


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)


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)


Output byte Gain_Photodiode


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,


uint Integration_Time_ms)




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)


Output Bool Result


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)


FluxGage.CalibrationFileValue CalibrationFileValue

int LuminousFluxTargetLumen

ushort Command (ClearBackground, TakeBackground)

ushort Average



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)


Output String day_Of_Month

String Month

String year


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)


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)


Output none


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


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





out double stop)

Input none

Output Double start

Double stop






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






double stop)

Input Double start

Double stop

Output none





double stop)

Input Double start

Double stop

Output none


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)


Output float Wavelenght_Start

float Wavelenght_Stop


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

X Y CCT CRI

- Boolean Out of Range: is true if the spectrometer value is over the threshold (you

need to execute the function Autoset)

- Boolean Over Heat: is true if the temperature of the FluxGage™ is over the threshold.

- Error Label: o Acquisition ( no error) o Invalid Background. Turn Luminaire Off.

Press Background. Turn Luminaire On o Invalid Photodiode. Press [Autoset] o Invalid Current. Press [Autoset] o Invalid Spectrum o Flux value invalid.


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; public double tM30_FidelityIndexRf; public double tM30_Rf__44skin; public double i;

public int percentFlickerFiltered200Hz; public float flickerIndexFiltered200Hz; public int percentFlickerFiltered90Hz; public double x;

public double y; public double cCT; public double duv; public double generalCRI; public double[] specialCRI; public double pPF1; public double pPF2; public double pPF3; public float flickerIndex; public int percentFlicker; public double flickerFrequency; public float flickerIndexFiltered; public int percentFlickerFiltered; public float flickerIndexFiltered90Hz; public TM30_path_test tM30_path_test;

public TM30_path_test tM30_path_ref;}

Prototype

void ReadValue ( String Resource_Name,


uint Integration_Time_ms,

out FluxGage.Calculate Calculate)




Output FluxGage. Calculate Calculate


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)


Output DBL Max_Length

DBL Max_Width

DBL Max_Angle

2.5.14.2. User definition

Function Name LWAUserCorrection

Definition

The user can define the luminaire dimensions - Length, Width, and Beam Angle (LWA) according to the maximal allowed dimensions. These user-defined parameters are used to correct the luminous flux value.

Prototype void LWAUserCorrection(String Resource_Name,

DBL Length,

DBL Width,

DBL Angle)


DBL Length,

DBL Width,

DBL Angle

Output none


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); public static void Calibration(string resource_Name, int luminous_Flux_Target_Lumen, CalibrationFileValue calibrationFileValue, ushort average, uint integration_Time_ms, out bool outOfRange, out bool calibration_Pass, out string status, out double fluxLumen); public static void CalibrationDate(string resource_Name, out string day_Of_Month, out string month, out string year); public static void ClearBackground(string resource_Name, out bool result); public static void Close(string resource_Name, out bool result); public static void GetAverage(string resource_Name, out ushort number_Of_Average); public static void GetFlickerBandwidth(out uint flicker_Bandwidth); public static void GetGainCurrent(string resource_Name, out byte gain_Current); public static void GetGainPhotodiode(string resource_Name, out byte gain_Photodiode); public static void GetLWAMaxValue(string resource_Name, out double max_Length, out double max_Width, out double max_Angle); public static void GetPARLimits_1(out double start, out double stop); public static void GetPARLimits_2(out double start, out double stop); public static void GetPARLimits_3(out double start, out double stop); public static void GetVersion(string resource_Name, out string instrument_Information, out string eEPROM_Version, out string instrument_Firmware_Revision, out string hW_Revision, out string instrument_Driver_Revision, out string sN); public static void GetWavelengthStartStop(string resource_Name, out float wavelenght_Start, out float wavelenght_Stop); public static void Initialization(bool iD_Query, bool reset, out string resource_Name); public static void OverwriteFactoryValue(string resource_Name); public static void ReadValue(string resource_Name, ushort number_Of_Average, uint integration_Time_ms, out Calculate calculate); public static void RestoreFactoryValue(string resource_Name); public static void Set_LWAUserCorrection(string resource_Name, double length, double width, double angle, out bool result); public static void SetAverage(string resource_Name, ushort number_Of_Average); public static void SetFlickerBandwidth(uint flicker_Bandwidth); public static void SetGainCurrent(string resource_Name, byte gain_Current); public static void SetGainPhotodiode(string resource_Name, byte gain_Photodiode); public static void SetIntegrationTime(string resource_Name, uint integration_Time_ms); public static void SetPARLimits_1(double start, double stop); public static void SetPARLimits_2(double start, double stop); public static void SetPARLimits_3(double start, double stop); public static void TakeBackground(string resource_Name, ushort number_Of_Average, uint integration_Time_ms);

For the latest version, please visit our website: www.ophiropt.com/photonics

FluxGage DLL User Manual 30 January, 2019

Rev 2.0.17-1

http://www.ophiropt.com/laser-measurement

carto® 3 - quote price · fluxgage dll user manual 5 2.4. spectrometer configuration 2.4.1. set...

Documents