jai sdk .net wrapper.pdf

8/18/2019 JAI SDK .NET Wrapper.pdf

1/677

JAI SDK .NET Wrapper

Generated by Doxygen 1.5.9

Wed Sep 19 12:02:08 2012


2/677


3/677

Contents

1 JAI SDK .NET Wrapper 1

1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

1.2 Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

1.3 Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

2 Module Index 141

2.1 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

3 Class Index 143

3.1 Class List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

4 File Index 145

4.1 File List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

5 Module Documentation 147

5.1 JAI SDK .NET Wrapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

5.2 Factory specific functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

5.2.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

5.2.2 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . 151

5.2.2.1 EFactoryError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

5.2.2.2 EFactoryInfoType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

5.2.2.3 ECameraInfoType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

5.2.3 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

5.2.3.1 GetFactoryErrorString . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

5.2.3.2 J_Factory_Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

5.2.3.3 J_Factory_Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

5.2.3.4 J_Factory_GetInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

5.2.3.5 J_Factory_UpdateCameraList . . . . . . . . . . . . . . . . . . . . . . . 153

5.2.3.6 J_Factory_GetNumOfCameras . . . . . . . . . . . . . . . . . . . . . . 154

5.2.3.7 J_Factory_GetCameraIDByIndex . . . . . . . . . . . . . . . . . . . . . 155


4/677

ii CONTENTS

5.2.3.8 J_Factory_GetCameraInfo . . . . . . . . . . . . . . . . . . . . . . . . . 155

5.2.3.9 J_Factory_EnableForceIp . . . . . . . . . . . . . . . . . . . . . . . . . 156

5.2.3.10 J_Factory_GetGenICamErrorInfo . . . . . . . . . . . . . . . . . . . . . 1565.3 Action Command function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157



5.3.2.1 J_Factory_SendActionCommand . . . . . . . . . . . . . . . . . . . . . 158

5.4 Camera specific functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159



5.4.2.1 EDeviceAccessFlags . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

5.4.2.2 EConfInfoType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

5.4.2.3 EConfVisibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

5.4.2.4 EConfNodeType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

5.4.2.5 EConfAccessMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

5.4.2.6 EConfNameSpace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

5.4.2.7 EConfCachingMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

5.4.2.8 EConfRepresentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

5.4.2.9 EDisplayNotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

5.5 Camera connection functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165



5.5.2.1 J_Camera_Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

5.5.2.2 J_Camera_OpenMc . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

5.5.2.3 J_Camera_Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

5.6 Direct GenICam node value access functions . . . . . . . . . . . . . . . . . . . . . . . . 167



5.6.2.1 J_Camera_GetValueInt64 . . . . . . . . . . . . . . . . . . . . . . . . . 167

5.6.2.2 J_Camera_GetValueDouble . . . . . . . . . . . . . . . . . . . . . . . . 168

5.6.2.3 J_Camera_GetValueString . . . . . . . . . . . . . . . . . . . . . . . . 168

5.6.2.4 J_Camera_SetValueInt64 . . . . . . . . . . . . . . . . . . . . . . . . . 169

5.6.2.5 J_Camera_SetValueDouble . . . . . . . . . . . . . . . . . . . . . . . . 169

5.6.2.6 J_Camera_SetValueString . . . . . . . . . . . . . . . . . . . . . . . . . 170

5.6.2.7 J_Camera_ExecuteCommand . . . . . . . . . . . . . . . . . . . . . . . 170

5.7 Direct register access functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

Generated on Wed Sep 19 12:02:03 2012 for JAI SDK .NET Wrapper by Doxygen


5/677

CONTENTS iii



5.7.2.1 J_Camera_ReadData . . . . . . . . . . . . . . . . . . . . . . . . . . . 1715.7.2.2 J_Camera_WriteData . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

5.7.2.3 J_Camera_WriteData . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

5.8 Configuration information function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174



5.8.2.1 J_Camera_GetConfigInfo . . . . . . . . . . . . . . . . . . . . . . . . . 174

5.9 GenICam Feature Node access functions . . . . . . . . . . . . . . . . . . . . . . . . . . . 175



5.9.2.1 J_Camera_GetNumOfNodes . . . . . . . . . . . . . . . . . . . . . . . 175

5.9.2.2 J_Camera_GetNodeByIndex . . . . . . . . . . . . . . . . . . . . . . . 176

5.9.2.3 J_Camera_GetNodeByName . . . . . . . . . . . . . . . . . . . . . . . 177

5.9.2.4 J_Camera_GetNumOfSubFeatures . . . . . . . . . . . . . . . . . . . . 178

5.9.2.5 J_Camera_GetSubFeatureByIndex . . . . . . . . . . . . . . . . . . . . 178

5.9.2.6 J_Camera_GetFeatureByName . . . . . . . . . . . . . . . . . . . . . . 179

5.9.2.7 J_Camera_InvalidateNodes . . . . . . . . . . . . . . . . . . . . . . . . 180

5.10 Image Data Stream access functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181



5.10.2.1 J_Camera_GetNumOfDataStreams . . . . . . . . . . . . . . . . . . . . 181

5.10.2.2 J_Camera_CreateDataStream . . . . . . . . . . . . . . . . . . . . . . . 182

5.10.2.3 J_Camera_CreateDataStreamMc . . . . . . . . . . . . . . . . . . . . . 183

5.10.2.4 ImageCallBack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

5.10.2.5 ConnectionStatusCallBack . . . . . . . . . . . . . . . . . . . . . . . . 184

5.10.2.6 GEVEventCallBack . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

5.10.2.7 NodeEventCallBack . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

5.11 Save or Load Setting functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185



5.11.2.1 ESaveSettingsFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

5.11.2.2 ELoadSettingsFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186


5.11.3.1 J_Camera_SaveSettings . . . . . . . . . . . . . . . . . . . . . . . . . . 186



6/677

iv CONTENTS

5.11.3.2 J_Camera_LoadSettings . . . . . . . . . . . . . . . . . . . . . . . . . . 186

5.11.3.3 J_Camera_GetSettingsValidationErrorInfo . . . . . . . . . . . . . . . . 187

5.12 Data Stream specific functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1885.12.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190


5.12.2.1 EAcqQueueType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

5.12.2.2 EAcqStartFlags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

5.12.2.3 EAcqStopFlags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

5.12.2.4 EBufferInfoCmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

5.12.2.5 EStreamInfoCmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

5.12.2.6 EDataStreamParamCmd . . . . . . . . . . . . . . . . . . . . . . . . . . 193


5.12.3.1 J_DataStream_AnnounceBuffer . . . . . . . . . . . . . . . . . . . . . . 193

5.12.3.2 J_DataStream_FlushQueue . . . . . . . . . . . . . . . . . . . . . . . . 194

5.12.3.3 J_DataStream_StartAcquisition . . . . . . . . . . . . . . . . . . . . . . 195

5.12.3.4 J_DataStream_StopAcquisition . . . . . . . . . . . . . . . . . . . . . . 196

5.12.3.5 J_DataStream_GetStreamInfo . . . . . . . . . . . . . . . . . . . . . . . 197

5.12.3.6 J_DataStream_GetBufferID . . . . . . . . . . . . . . . . . . . . . . . . 197

5.12.3.7 J_DataStream_Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

5.12.3.8 J_DataStream_RevokeBuffer . . . . . . . . . . . . . . . . . . . . . . . 198

5.12.3.9 J_DataStream_QueueBuffer . . . . . . . . . . . . . . . . . . . . . . . . 199

5.12.3.10 J_DataStream_GetBufferInfo . . . . . . . . . . . . . . . . . . . . . . . 200

5.12.3.11 J_DataStream_GetParam . . . . . . . . . . . . . . . . . . . . . . . . . 204

5.12.3.12 J_DataStream_SetParam . . . . . . . . . . . . . . . . . . . . . . . . . 205

5.13 Event Interface functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206



5.13.2.1 EEventInfoID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

5.13.2.2 EDeviceEventType . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

5.13.2.3 EDeviceConnectionType . . . . . . . . . . . . . . . . . . . . . . . . . 208

5.13.2.4 ECondWaitResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208


5.13.3.1 J_Event_GetData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

5.13.3.2 J_Event_GetInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

5.13.3.3 J_Event_Flush . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

5.13.3.4 J_Event_Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211



7/677

CONTENTS v

5.14 Camera event specific functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212


5.14.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2125.14.2.1 J_Camera_RegisterEvent . . . . . . . . . . . . . . . . . . . . . . . . . 212

5.14.2.2 J_Camera_RegisterEvent . . . . . . . . . . . . . . . . . . . . . . . . . 214

5.14.2.3 J_Camera_UnRegisterEvent . . . . . . . . . . . . . . . . . . . . . . . . 216

5.15 Data Stream event specific functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217



5.15.2.1 J_DataStream_RegisterEvent . . . . . . . . . . . . . . . . . . . . . . . 217

5.15.2.2 J_DataStream_RegisterEvent . . . . . . . . . . . . . . . . . . . . . . . 220

5.15.2.3 J_DataStream_UnRegisterEvent . . . . . . . . . . . . . . . . . . . . . 224

5.16 Condition specific functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225



5.16.2.1 J_Event_CreateCondition . . . . . . . . . . . . . . . . . . . . . . . . . 226

5.16.2.2 J_Event_SignalCondition . . . . . . . . . . . . . . . . . . . . . . . . . 227

5.16.2.3 J_Event_ExitCondition . . . . . . . . . . . . . . . . . . . . . . . . . . 228

5.16.2.4 J_Event_ResetCondition . . . . . . . . . . . . . . . . . . . . . . . . . 228

5.16.2.5 J_Event_WaitForCondition . . . . . . . . . . . . . . . . . . . . . . . . 228

5.16.2.6 J_Event_WaitForMultipleConditions . . . . . . . . . . . . . . . . . . . 230

5.16.2.7 J_Event_CloseCondition . . . . . . . . . . . . . . . . . . . . . . . . . 232

5.17 GenICam node specific functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235



5.17.2.1 J_Node_GetAccessMode . . . . . . . . . . . . . . . . . . . . . . . . . 238

5.17.2.2 J_Node_GetName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

5.17.2.3 J_Node_GetNameSpace . . . . . . . . . . . . . . . . . . . . . . . . . . 239

5.17.2.4 J_Node_GetVisibility . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

5.17.2.5 J_Node_Invalidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

5.17.2.6 J_Node_GetIsCachable . . . . . . . . . . . . . . . . . . . . . . . . . . 240

5.17.2.7 J_Node_GetCachingMode . . . . . . . . . . . . . . . . . . . . . . . . 240

5.17.2.8 J_Node_GetPollingTime . . . . . . . . . . . . . . . . . . . . . . . . . 240

5.17.2.9 J_Node_GetToolTip . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

5.17.2.10 J_Node_GetDescription . . . . . . . . . . . . . . . . . . . . . . . . . . 241

5.17.2.11 J_Node_GetDisplayName . . . . . . . . . . . . . . . . . . . . . . . . . 241



8/677

vi CONTENTS

5.17.2.12 J_Node_GetEventID . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

5.17.2.13 J_Node_GetIsStreamable . . . . . . . . . . . . . . . . . . . . . . . . . 242

5.17.2.14 J_Node_GetNumOfProperties . . . . . . . . . . . . . . . . . . . . . . . 2425.17.2.15 J_Node_GetPropertyNameByIndex . . . . . . . . . . . . . . . . . . . . 242

5.17.2.16 J_Node_GetPropertyByName . . . . . . . . . . . . . . . . . . . . . . . 242

5.17.2.17 J_Node_ImposeAccessMode . . . . . . . . . . . . . . . . . . . . . . . 243

5.17.2.18 J_Node_ImposeVisibility . . . . . . . . . . . . . . . . . . . . . . . . . 243

5.17.2.19 J_Node_GetAlias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

5.17.2.20 NodeChangeDelegate . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

5.17.2.21 J_Node_RegisterCallback . . . . . . . . . . . . . . . . . . . . . . . . . 244

5.17.2.22 J_Node_GetType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

5.17.2.23 J_Node_GetIsSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

5.17.2.24 J_Node_GetNumOfSelectedFeatures . . . . . . . . . . . . . . . . . . . 245

5.17.2.25 J_Node_GetSelectedFeatureByIndex . . . . . . . . . . . . . . . . . . . 245

5.17.2.26 J_Node_GetNumOfSelectingFeatures . . . . . . . . . . . . . . . . . . 245

5.17.2.27 J_Node_GetSelectingFeatureByIndex . . . . . . . . . . . . . . . . . . . 246

5.17.2.28 J_Node_GetRepresentation . . . . . . . . . . . . . . . . . . . . . . . . 246

5.17.2.29 J_Node_GetUnit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

5.17.2.30 J_Node_GetDocuURL . . . . . . . . . . . . . . . . . . . . . . . . . . 247

5.17.2.31 J_Node_GetIsDeprecated . . . . . . . . . . . . . . . . . . . . . . . . . 247

5.18 IInteger GenICam node specific functions . . . . . . . . . . . . . . . . . . . . . . . . . . 248



5.18.2.1 J_Node_GetMinInt64 . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

5.18.2.2 J_Node_GetMaxInt64 . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

5.18.2.3 J_Node_GetInc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

5.18.2.4 J_Node_SetValueInt64 . . . . . . . . . . . . . . . . . . . . . . . . . . 250

5.18.2.5 J_Node_GetValueInt64 . . . . . . . . . . . . . . . . . . . . . . . . . . 250

5.18.2.6 J_Node_GetFloatAlias . . . . . . . . . . . . . . . . . . . . . . . . . . 251

5.19 IFloat GenICam node specific functions . . . . . . . . . . . . . . . . . . . . . . . . . . . 252



5.19.2.1 J_Node_GetMinDouble . . . . . . . . . . . . . . . . . . . . . . . . . . 253

5.19.2.2 J_Node_GetMaxDouble . . . . . . . . . . . . . . . . . . . . . . . . . . 253

5.19.2.3 J_Node_SetValueDouble . . . . . . . . . . . . . . . . . . . . . . . . . 253

5.19.2.4 J_Node_GetValueDouble . . . . . . . . . . . . . . . . . . . . . . . . . 254



9/677

CONTENTS vii

5.19.2.5 J_Node_GetDisplayNotation . . . . . . . . . . . . . . . . . . . . . . . 254

5.19.2.6 J_Node_GetDisplayPrecision . . . . . . . . . . . . . . . . . . . . . . . 255

5.19.2.7 J_Node_GetFloatHasInc . . . . . . . . . . . . . . . . . . . . . . . . . . 2555.19.2.8 J_Node_GetFloatInc . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

5.19.2.9 J_Node_GetIntAlias . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

5.19.2.10 J_Node_GetEnumAlias . . . . . . . . . . . . . . . . . . . . . . . . . . 256

5.20 IEnumeration GenICam node specific functions . . . . . . . . . . . . . . . . . . . . . . . 257



5.20.2.1 J_Node_GetNumOfEnumEntries . . . . . . . . . . . . . . . . . . . . . 257

5.20.2.2 J_Node_GetEnumEntryByIndex . . . . . . . . . . . . . . . . . . . . . 258

5.20.2.3 J_Node_GetEnumEntryValue . . . . . . . . . . . . . . . . . . . . . . . 258

5.21 ICommand GenICam node specific functions . . . . . . . . . . . . . . . . . . . . . . . . 259



5.21.2.1 J_Node_ExecuteCommand . . . . . . . . . . . . . . . . . . . . . . . . 259

5.21.2.2 J_Node_GetCommandIsDone . . . . . . . . . . . . . . . . . . . . . . . 259

5.22 IString GenICam node specific functions . . . . . . . . . . . . . . . . . . . . . . . . . . . 260



5.22.2.1 J_Node_SetValueString . . . . . . . . . . . . . . . . . . . . . . . . . . 260

5.22.2.2 J_Node_GetValueString . . . . . . . . . . . . . . . . . . . . . . . . . . 260

5.23 IRegister GenICam node specific functions . . . . . . . . . . . . . . . . . . . . . . . . . 262



5.23.2.1 J_Node_SetValueRegister . . . . . . . . . . . . . . . . . . . . . . . . . 262

5.23.2.2 J_Node_GetValueRegister . . . . . . . . . . . . . . . . . . . . . . . . . 263

5.23.2.3 J_Node_GetRegisterLength . . . . . . . . . . . . . . . . . . . . . . . . 263

5.23.2.4 J_Node_GetRegisterAddress . . . . . . . . . . . . . . . . . . . . . . . 263

5.24 Image acquisition and manipulation functions . . . . . . . . . . . . . . . . . . . . . . . . 265



5.24.2.1 EPixelTypeColorInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

5.24.2.2 EPixelFormatType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268


5.24.3.1 GetPixelTypeColorInfo . . . . . . . . . . . . . . . . . . . . . . . . . . 269



10/677

viii CONTENTS

5.24.3.2 GetPixelTypeMemorySize . . . . . . . . . . . . . . . . . . . . . . . . . 270

5.25 View window specific functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

5.25.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2735.25.2 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . 273

5.25.2.1 EIVWWindowType . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273

5.25.2.2 EIVWOptionType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

5.25.2.3 EIVWCallbackType . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

5.25.2.4 EColorInterpolationAlgorithm . . . . . . . . . . . . . . . . . . . . . . 275

5.25.2.5 EColorConversionPixelFormat . . . . . . . . . . . . . . . . . . . . . . 275


5.25.3.1 J_Image_OpenViewWindow . . . . . . . . . . . . . . . . . . . . . . . 276

5.25.3.2 J_Image_OpenViewWindowEx . . . . . . . . . . . . . . . . . . . . . . 277

5.25.3.3 J_Image_CloseViewWindow . . . . . . . . . . . . . . . . . . . . . . . 277

5.25.3.4 J_Image_ShowImage . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

5.25.3.5 J_Image_ShowImage . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

5.25.3.6 J_Image_SetImageOffset . . . . . . . . . . . . . . . . . . . . . . . . . 278

5.25.3.7 J_Image_SetImageOffsetEx . . . . . . . . . . . . . . . . . . . . . . . . 279

5.25.3.8 J_Image_GetImageOffsetEx . . . . . . . . . . . . . . . . . . . . . . . 279

5.25.3.9 J_Image_MoveViewWindow . . . . . . . . . . . . . . . . . . . . . . . 280

5.25.3.10 J_Image_ResizeChildWindow . . . . . . . . . . . . . . . . . . . . . . 280

5.25.3.11 J_Image_GetViewWindowRect . . . . . . . . . . . . . . . . . . . . . . 280

5.25.3.12 J_Image_GetFrameWindowRect . . . . . . . . . . . . . . . . . . . . . 281

5.25.3.13 J_Image_SetViewWindowTitle . . . . . . . . . . . . . . . . . . . . . . 281

5.25.3.14 J_Image_SetViewWindowOption . . . . . . . . . . . . . . . . . . . . . 281

5.25.3.15 J_Image_GetViewWindowOption . . . . . . . . . . . . . . . . . . . . . 282

5.25.3.16 ImageViewWindowCallBack . . . . . . . . . . . . . . . . . . . . . . . 282

5.25.3.17 J_Image_SetViewWindowCallback . . . . . . . . . . . . . . . . . . . . 283

5.26 Stream channel specific functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284



5.26.2.1 J_Image_OpenStream . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

5.26.2.2 J_Image_OpenStreamLight . . . . . . . . . . . . . . . . . . . . . . . . 285

5.26.2.3 J_Image_CloseStream . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

5.26.2.4 J_Image_GetStreamInfo . . . . . . . . . . . . . . . . . . . . . . . . . . 286

5.26.2.5 J_Image_GetStreamHandle . . . . . . . . . . . . . . . . . . . . . . . . 287

5.27 Image manipulation functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288



11/677

CONTENTS ix



5.27.2.1 ESaveFileFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2895.27.3 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

5.27.3.1 J_Image_FromRawToDIB . . . . . . . . . . . . . . . . . . . . . . . . . 289

5.27.3.2 J_Image_FromRawToDIB . . . . . . . . . . . . . . . . . . . . . . . . . 290

5.27.3.3 J_Image_FromRawToImage . . . . . . . . . . . . . . . . . . . . . . . 290

5.27.3.4 J_Image_FromRawToImage . . . . . . . . . . . . . . . . . . . . . . . 291

5.27.3.5 J_Image_ConvertImage . . . . . . . . . . . . . . . . . . . . . . . . . . 292

5.27.3.6 J_Image_Malloc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

5.27.3.7 J_Image_MallocDIB . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

5.27.3.8 J_Image_Malloc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

5.27.3.9 J_Image_Free . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

5.28 Image save and load functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296



5.28.2.1 J_Image_SaveFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

5.28.2.2 J_Image_SaveFileEx . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

5.28.2.3 J_Image_SaveFileRaw . . . . . . . . . . . . . . . . . . . . . . . . . . 298

5.28.2.4 J_Image_LoadFileRaw . . . . . . . . . . . . . . . . . . . . . . . . . . 298

5.29 Pixel access functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300



5.29.2.1 J_Image_GetPixel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

5.29.2.2 J_Image_GetPixelEx . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

5.29.2.3 J_Image_SetPixel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

5.29.2.4 J_Image_GetAverage . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

5.30 Image white balance control functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302



5.30.2.1 J_Image_SetGain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

5.30.2.2 J_Image_GetGain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

5.30.2.3 J_Image_ExecuteWhiteBalance . . . . . . . . . . . . . . . . . . . . . . 303

5.31 High Dynamic Range functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304





12/677

x CONTENTS

5.31.2.1 J_Image_MallocHDR . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

5.31.2.2 J_Image_AnalyzeHDR . . . . . . . . . . . . . . . . . . . . . . . . . . 305

5.31.2.3 J_Image_FuseHDR . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3065.32 Lookup-Table functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307



5.32.2.1 J_Image_MallocLUT . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

5.32.2.2 J_Image_FreeLUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

5.32.2.3 J_Image_ConvertLUT . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

5.32.2.4 J_Image_LUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

5.32.2.5 J_Image_CreateGammaLUT . . . . . . . . . . . . . . . . . . . . . . . 309

5.32.2.6 J_Image_ApplyGammaToLUT . . . . . . . . . . . . . . . . . . . . . . 310

5.32.2.7 J_Image_CreateLinearLUT . . . . . . . . . . . . . . . . . . . . . . . . 310

5.32.2.8 J_Image_CreateKneeLUT . . . . . . . . . . . . . . . . . . . . . . . . . 311

5.32.2.9 J_Image_GetLUTValue . . . . . . . . . . . . . . . . . . . . . . . . . . 312

5.32.2.10 J_Image_SetLUTValue . . . . . . . . . . . . . . . . . . . . . . . . . . 312

5.32.2.11 J_Image_SaveLUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

5.32.2.12 J_Image_LoadLUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

5.33 Histogram functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314



5.33.2.1 J_Image_MallocHistogram . . . . . . . . . . . . . . . . . . . . . . . . 314

5.33.2.2 J_Image_FreeHistogram . . . . . . . . . . . . . . . . . . . . . . . . . . 315

5.33.2.3 J_Image_ClearHistogram . . . . . . . . . . . . . . . . . . . . . . . . . 315

5.33.2.4 J_Image_CreateHistogram . . . . . . . . . . . . . . . . . . . . . . . . 315

5.33.2.5 J_Image_GetHistogramValue . . . . . . . . . . . . . . . . . . . . . . . 316

5.34 Transformation functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317



5.34.2.1 EFlipType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

5.34.2.2 ERotateType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317


5.34.3.1 J_Image_Flip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

5.34.3.2 J_Image_Rotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

5.35 Image Processing functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319




13/677

CONTENTS xi


5.35.2.1 EProcessFunctionType . . . . . . . . . . . . . . . . . . . . . . . . . . 320

5.35.3 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3205.35.3.1 J_Image_Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

5.35.3.2 J_Image_ProcessingEx . . . . . . . . . . . . . . . . . . . . . . . . . . 322

5.36 Color-Compensation Image Processing algorithms . . . . . . . . . . . . . . . . . . . . . 324



5.36.2.1 J_Image_Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324


5.37 Lens Distortion Correction Image Processing algorithms . . . . . . . . . . . . . . . . . . 327



5.37.2.1 EInterpolationType . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327



5.37.3.2 J_Image_ProcessingInit . . . . . . . . . . . . . . . . . . . . . . . . . . 329

5.37.3.3 J_Image_ProcessingFree . . . . . . . . . . . . . . . . . . . . . . . . . 329

5.38 The CFactory Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

5.39 The CCamera Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

5.40 Scripting and Command Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

5.41 Image Acquisition Control methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333


5.41.1.1 ImageViewWindowDelegate . . . . . . . . . . . . . . . . . . . . . . . 335

5.41.1.2 StartAcquisition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

5.41.1.3 StopAcquisition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

5.41.1.4 StartImageAcquisition . . . . . . . . . . . . . . . . . . . . . . . . . . . 336




5.41.1.8 StopImageAcquisition . . . . . . . . . . . . . . . . . . . . . . . . . . . 338

5.41.1.9 StopImageAcquisitionEx . . . . . . . . . . . . . . . . . . . . . . . . . 338

5.41.2 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338

5.41.2.1 NewImageDelegate . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338

5.41.2.2 ViewWindowEventDelegate . . . . . . . . . . . . . . . . . . . . . . . . 338

5.41.3 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339



14/677

xii CONTENTS

5.41.3.1 AcquisitionCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

5.41.3.2 EnablePacketResend . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

5.41.3.3 PassCorruptFrames . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3395.41.3.4 IsGrabbing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

5.41.3.5 NumFramesDelivered . . . . . . . . . . . . . . . . . . . . . . . . . . . 340

5.41.3.6 NumFramesLost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340

5.41.3.7 NumBuffersAnnounced . . . . . . . . . . . . . . . . . . . . . . . . . . 340

5.41.3.8 NumFramesQueued . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340

5.41.3.9 NumFramesAwaitingDelivery . . . . . . . . . . . . . . . . . . . . . . . 341

5.41.3.10 NumFramesCorruptOnDelivery . . . . . . . . . . . . . . . . . . . . . . 341

5.42 White-Balance control methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342


5.42.1.1 SetGain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

5.42.1.2 GetGain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

5.42.1.3 ExecuteWhiteBalance . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

5.43 Camera Connection Status delegate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344

5.43.1 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344

5.43.1.1 NewConnectionStatusDelegate . . . . . . . . . . . . . . . . . . . . . . 344

5.44 GigE Vision Event delegate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

5.44.1 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

5.44.1.1 GEVEventDelegate . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

5.45 Node Event delegate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

5.45.1 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

5.45.1.1 NodeEventDelegate . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

5.46 Scripting methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347


5.46.1.1 RunScriptResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347


5.46.2.1 GetScriptErrorString . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

5.46.2.2 ValidateScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

5.46.2.3 GetScriptProgress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

5.46.2.4 GetScriptLastCommand . . . . . . . . . . . . . . . . . . . . . . . . . . 348

5.46.2.5 RunScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

5.46.2.6 RunScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

5.46.2.7 CreateSettingsScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

5.47 Direct Register Access methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350



15/677

CONTENTS xiii


5.47.1.1 WriteRegister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350

5.47.1.2 ReadRegister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3505.48 GenICam Node Access methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351


5.48.1.1 GetNodeValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

5.48.1.2 GetNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

5.48.1.3 GetSubFeatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

5.49 Image Save methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353


5.49.1.1 SaveNextFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

5.49.1.2 SaveNextFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

5.49.1.3 SaveLastFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

5.49.1.4 SaveLastRawFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

5.49.1.5 SaveLastFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

5.49.1.6 SaveLastRawFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

5.49.1.7 SaveLastFrameRaw . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

5.49.1.8 SaveLastRawFrameRaw . . . . . . . . . . . . . . . . . . . . . . . . . . 355

5.50 Zoom and Navigation methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357


5.50.1.1 ZoomIn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

5.50.1.2 ZoomIn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

5.50.1.3 ZoomOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

5.50.1.4 ZoomOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

5.50.1.5 ZoomReset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

5.50.1.6 ZoomDirect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

5.50.1.7 NavigateLeftUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

5.50.1.8 NavigateLeftUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

5.50.1.9 NavigateUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

5.50.1.10 NavigateUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

5.50.1.11 NavigateRightUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

5.50.1.12 NavigateRightUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

5.50.1.13 NavigateLeft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

5.50.1.14 NavigateLeft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

5.50.1.15 NavigateCenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

5.50.1.16 NavigateRight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362



16/677

xiv CONTENTS

5.50.1.17 NavigateRight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

5.50.1.18 NavigateLeftDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

5.50.1.19 NavigateLeftDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3635.50.1.20 NavigateDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

5.50.1.21 NavigateDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

5.50.1.22 NavigateRightDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

5.50.1.23 NavigateRightDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

5.51 Inter-packet Delay calculation methods . . . . . . . . . . . . . . . . . . . . . . . . . . . 366


5.51.1.1 EstimatedInterPacketDelay . . . . . . . . . . . . . . . . . . . . . . . . 366

5.51.1.2 EstimatedInterPacketDelay . . . . . . . . . . . . . . . . . . . . . . . . 366

5.52 Asynchronous image recording . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368


5.52.1.1 StartAsyncImageRecording . . . . . . . . . . . . . . . . . . . . . . . . 369

5.52.1.2 StopAsyncImageRecording . . . . . . . . . . . . . . . . . . . . . . . . 369

5.52.1.3 AsyncImageRecordingDoneHandler . . . . . . . . . . . . . . . . . . . 369

5.52.1.4 GetAsyncRecordedImage . . . . . . . . . . . . . . . . . . . . . . . . . 369

5.52.1.5 GetAsyncRecordedImages . . . . . . . . . . . . . . . . . . . . . . . . 370

5.52.1.6 FreeAsyncRecordedImages . . . . . . . . . . . . . . . . . . . . . . . . 370

5.52.2 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370

5.52.2.1 AsyncImageRecordingDoneEvent . . . . . . . . . . . . . . . . . . . . 370

5.52.3 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370

5.52.3.1 AsyncImageRecordingSkipCount . . . . . . . . . . . . . . . . . . . . . 370

5.52.3.2 AsyncImageRecordingCount . . . . . . . . . . . . . . . . . . . . . . . 370

5.52.3.3 TotalAsyncImagesRecordedCount . . . . . . . . . . . . . . . . . . . . 370

5.52.3.4 IsAsyncImageRecordingRunning . . . . . . . . . . . . . . . . . . . . . 371

5.52.3.5 GetAsyncImageRecordingMode . . . . . . . . . . . . . . . . . . . . . 371

5.53 The CNode Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3725.54 The Managed JAI SDK Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373


6 Class Documentation 375

6.1 ActionCommandAck Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375


6.1.2 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

6.1.2.1 Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

6.1.2.2 Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376



17/677

CONTENTS xv

6.1.2.3 Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376

6.1.2.4 ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376

6.1.2.5 IPAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3766.2 BufferInfoStruct Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377



6.2.2.1 Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

6.2.2.2 Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

6.2.2.3 UserPointer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

6.2.2.4 TimeStamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

6.2.2.5 BufferNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

6.2.2.6 NewData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

6.2.2.7 IsQueued . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

6.2.2.8 PayloadType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

6.2.2.9 PixelFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

6.2.2.10 Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

6.2.2.11 Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

6.2.2.12 XOffset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

6.2.2.13 YOffset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

6.2.2.14 XPadding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

6.2.2.15 YPadding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

6.2.2.16 MissingPackets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

6.2.2.17 AwaitDelivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

6.2.2.18 BlockId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

6.3 CCamera Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381


6.3.2 Member Enumeration Documentation . . . . . . . . . . . . . . . . . . . . . . . . 392

6.3.2.1 AsyncImageRecordingMode . . . . . . . . . . . . . . . . . . . . . . . 392

6.3.2.2 EDeviceClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393

6.3.3 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . 393

6.3.3.1 CCamera . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393

6.3.4 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . 393

6.3.4.1 Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393

6.3.4.2 Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393

6.3.4.3 Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394




18/677

xvi CONTENTS

6.3.5.1 FactoryHandle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394

6.3.5.2 CameraHandle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394

6.3.5.3 StreamHandle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3946.3.5.4 WindowHandle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

6.3.6 Property Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

6.3.6.1 Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

6.3.6.2 FramesPerSecond . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

6.3.6.3 FramesDisplayedPerSecond . . . . . . . . . . . . . . . . . . . . . . . . 395

6.3.6.4 ImageSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

6.3.6.5 SizeX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

6.3.6.6 SizeY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

6.3.6.7 OffsetX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

6.3.6.8 OffsetY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

6.3.6.9 TimeStamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

6.3.6.10 TimeStampMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

6.3.6.11 BlockId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

6.3.6.12 TickFrequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

6.3.6.13 MissingPackets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

6.3.6.14 FrameCounter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

6.3.6.15 TotalMissingPackets . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

6.3.6.16 StretchLiveVideo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

6.3.6.17 EnableMouseZoom . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

6.3.6.18 EnableMouseCursorDisplay . . . . . . . . . . . . . . . . . . . . . . . . 396

6.3.6.19 RestoreLiveVideoWindow . . . . . . . . . . . . . . . . . . . . . . . . . 397

6.3.6.20 LiveVideoWindowRectangle . . . . . . . . . . . . . . . . . . . . . . . 397

6.3.6.21 SkipImageDisplayWhenBusy . . . . . . . . . . . . . . . . . . . . . . . 397

6.3.6.22 RotateImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

6.3.6.23 ImageRotateType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

6.3.6.24 FlipImageHorizontally . . . . . . . . . . . . . . . . . . . . . . . . . . 397

6.3.6.25 FlipImageVertically . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

6.3.6.26 EnableLUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

6.3.6.27 LUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

6.3.6.28 IsOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

6.3.6.29 IsReadOnly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

6.3.6.30 ConnectionStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

6.3.6.31 IsAcquisitionRunning . . . . . . . . . . . . . . . . . . . . . . . . . . . 398



19/677

CONTENTS xvii

6.3.6.32 IsLastFrameAvailable . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

6.3.6.33 LastFrameCopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

6.3.6.34 LastRawFrameCopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3986.3.6.35 IsBayerCamera . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

6.3.6.36 AcquisitionStartFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

6.3.6.37 CameraID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

6.3.6.38 Manufacturer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

6.3.6.39 ModelName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

6.3.6.40 DeviceClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

6.3.6.41 IPAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

6.3.6.42 MACAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

6.3.6.43 UserName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

6.3.6.44 SerialNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

6.3.6.45 InterfaceID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

6.3.6.46 DriverType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

6.3.6.47 NumOfDataStreams . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

6.3.6.48 ConfigModelName . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400

6.3.6.49 ConfigVendorName . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400

6.3.6.50 ConfigToolTip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400

6.3.6.51 ConfigStandardNameSpace . . . . . . . . . . . . . . . . . . . . . . . . 400

6.3.6.52 ConfigGenApiVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . 400

6.3.6.53 ConfigSchemaVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . 400

6.3.6.54 ConfigDeviceVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . 400

6.3.6.55 ConfigProductGuid . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400

6.3.6.56 ConfigVersionGuid . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400

6.3.6.57 EnableColorInterpolation . . . . . . . . . . . . . . . . . . . . . . . . . 400

6.3.6.58 ColorInterpolationAlgorithm . . . . . . . . . . . . . . . . . . . . . . . 401

6.4 CFactory Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402


6.4.2 Member Enumeration Documentation . . . . . . . . . . . . . . . . . . . . . . . . 404

6.4.2.1 EDriverType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404


6.4.3.1 CFactory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404


6.4.4.1 Dispose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405

6.4.4.2 Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405



20/677

xviii CONTENTS

6.4.4.3 Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405

6.4.4.4 Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405

6.4.4.5 UpdateCameraList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4056.4.4.6 SendActionCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

6.4.4.7 SendActionCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . 407


6.4.5.1 CameraList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408

6.4.5.2 FactoryHandle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408


6.4.6.1 PreferredDriverType . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409

6.4.6.2 EnableAutoForceIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409

6.4.6.3 Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409

6.4.6.4 BuildDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409

6.4.6.5 BuildTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409

6.4.6.6 Manufacturer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

6.4.6.7 NumOfCameras . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

6.5 CNode Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411



6.5.2.1 CNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414


6.5.3.1 FindEnumValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414

6.5.3.2 ImposeAccessMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

6.5.3.3 ImposeVisibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

6.5.3.4 ExecuteCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

6.5.3.5 Invalidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415


6.5.4.1 Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

6.5.4.2 DisplayName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

6.5.4.3 ToolTip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

6.5.4.4 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

6.5.4.5 NameSpace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

6.5.4.6 Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

6.5.4.7 DisplayNotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

6.5.4.8 DisplayPrecision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

6.5.4.9 Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416



21/677

CONTENTS xix

6.5.4.10 DocuURL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

6.5.4.11 IsCachable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

6.5.4.12 CachingMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4176.5.4.13 PollingTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

6.5.4.14 EventID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

6.5.4.15 IsStreamable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

6.5.4.16 IsDeprecated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

6.5.4.17 IsSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

6.5.4.18 SelectedNodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

6.5.4.19 SelectingNodeNames . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

6.5.4.20 AliasNodeHandle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

6.5.4.21 FloatAliasNodeHandle . . . . . . . . . . . . . . . . . . . . . . . . . . 417

6.5.4.22 IntegerAliasNodeHandle . . . . . . . . . . . . . . . . . . . . . . . . . 418

6.5.4.23 EnumAliasNodeHandle . . . . . . . . . . . . . . . . . . . . . . . . . . 418

6.5.4.24 NodeType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

6.5.4.25 EnumValues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

6.5.4.26 Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

6.5.4.27 NodeHandle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

6.5.4.28 AccessMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

6.5.4.29 Visibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

6.5.4.30 Min . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

6.5.4.31 Max . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

6.5.4.32 Inc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

6.5.4.33 Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

6.5.4.34 Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

6.5.4.35 IsReadable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

6.5.4.36 IsWritable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

6.5.4.37 IsImplemented . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

6.5.4.38 IsAvailable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

6.5.4.39 NodeValueType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

6.5.4.40 Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

6.6 ColorCompensationROIStruct Struct Reference . . . . . . . . . . . . . . . . . . . . . . . 421



6.6.2.1 RectOfROI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

6.6.2.2 BThreshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421



22/677

xx CONTENTS

6.6.2.3 GThreshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

6.6.2.4 RThreshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422

6.6.2.5 BGain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4226.6.2.6 GGain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422

6.6.2.7 RGain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422

6.7 Command Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423



6.7.2.1 Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423

6.7.2.2 Comman

jai sdk .net wrapper.pdf

Documents