background image

FluxGage DLL User Manual   

 

 

 

 

 

SUMMARY 

 

1.

 

INTRODUCTION ......................................................................................................... 3

 

2.

 

THE

 

SOFTWARE

 

INTERFACE ................................................................................... 3

 

2.1.

 

I

NITIALIZATION

 ............................................................................................................................... 3

 

2.2.

 

C

LOSE

 .......................................................................................................................................... 4

 

2.3.

 

V

ERSION

 ....................................................................................................................................... 4

 

2.4.

 

S

PECTROMETER CONFIGURATION

 ................................................................................................... 5

 

2.4.1.

 

S

ET 

A

VERAGE

 .......................................................................................................................... 5

 

2.4.2.

 

G

ET 

A

VERAGE

 .......................................................................................................................... 5

 

2.4.3.

 

I

NTEGRATION 

T

IME

 .................................................................................................................... 6

 

2.5.

 

F

LUX

G

AGE

™ ................................................................................................................................ 7

 

2.5.1.

 

A

UTOSET

 .................................................................................................................................. 7

 

2.5.2.

 

A

UTOSET

_C

URRENT

 ................................................................................................................. 8

 

2.5.3.

 

A

UTOSET

_P

HOTODIODE

 ............................................................................................................ 8

 

2.5.4.

 

A

UTOSET

_S

PECTRUM

 ............................................................................................................... 9

 

2.5.5.

 

S

ET 

G

AIN 

C

URRENT

 ................................................................................................................ 10

 

2.5.6.

 

G

ET 

G

AIN 

C

URRENT

 ............................................................................................................... 10

 

2.5.7.

 

S

ET 

G

AIN 

P

HOTODIODE

 .......................................................................................................... 11

 

2.5.8.

 

G

ET 

G

AIN 

P

HOTODIODE

 .......................................................................................................... 11

 

2.5.9.

 

T

AKE 

B

ACKGROUND

 ................................................................................................................ 12

 

2.5.10.

 

C

LEAR 

B

ACKGROUND

 ............................................................................................................. 12

 

2.5.11.

 

C

ALIBRATION

 .......................................................................................................................... 13

 

2.5.11.1.

 

C

ALIBRATION

 .................................................................................................................................. 13

 

2.5.11.2.

 

C

ALIBRATION 

D

ATE

 .......................................................................................................................... 14

 

2.5.11.3.

 

R

ESTORE 

F

ACTORY 

C

ALIBRATION

 ..................................................................................................... 15

 

2.5.11.4.

 

O

VERWRITE 

F

ACTORY 

C

ALIBRATION

 .................................................................................................. 15

 

2.5.12.

 

F

LUX

G

AGE

 

-

 

C

ALCULATE CONFIGURATION

 ............................................................................ 16

 

2.5.12.1.

 

S

ET 

F

LICKER

 ................................................................................................................................... 16

 

2.5.12.2.

 

G

ET 

F

LICKER

 .................................................................................................................................. 16

 

2.5.12.3.

 

G

ET 

PAR

 

L

IMIT 

1 ............................................................................................................................ 17

 

2.5.12.4.

 

G

ET 

PAR

 

L

IMIT 

2 ............................................................................................................................ 17

 

2.5.12.5.

 

G

ET 

PAR

 

L

IMIT 

3 ............................................................................................................................ 18

 

2.5.12.6.

 

S

ET 

PAR

 

L

IMIT 

1 ............................................................................................................................ 18

 

2.5.12.7.

 

S

ET 

PAR

 

L

IMIT 

2 ............................................................................................................................ 19

 

2.5.12.8.

 

S

ET 

PAR

 

L

IMIT 

3 ............................................................................................................................ 19

 

2.5.12.9.

 

W

AVELENGHT VALUE

 ....................................................................................................................... 20

 

2.5.13.

 

M

EASUREMENT

 ....................................................................................................................... 21

 

2.5.13.1.

 

A

CQUISITION

 ................................................................................................................................... 21

 

2.5.14.

 

LWA

 

C

ORRECTION

 ................................................................................................................. 23

 

2.5.14.1.

 

F

ACTOR 

L

IMIT

 ................................................................................................................................. 23

 

2.5.14.2.

 

U

SER DEFINITION

 ............................................................................................................................. 23

 

 

 

Summary of Contents for Ophir FluxGage

Page 1: ......

Page 2: ...ODIODE 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 FACT...

Page 3: ...ement 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 par...

Page 4: ...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_Driv...

Page 5: ...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 retur...

Page 6: ...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...

Page 7: ...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 Int...

Page 8: ...ent 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 d...

Page 9: ...s 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 ui...

Page 10: ...GainCurrent 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 th...

Page 11: ...ent 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 return...

Page 12: ...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 Funct...

Page 13: ...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 Ca...

Page 14: ...nge 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_...

Page 15: ...ctory 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: ...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 De...

Page 17: ...ulation 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 f...

Page 18: ...lculation 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...

Page 19: ...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 us...

Page 20: ...inition 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 Wavel...

Page 21: ...cent 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 He...

Page 22: ...public float flickerIndexFiltered200Hz public int percentFlickerFiltered90Hz public double x public double y public double cCT public double duv public double generalCRI public double specialCRI publi...

Page 23: ...t String Visa resource name 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 Wi...

Page 24: ...ut 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 eEPRO...

Reviews: