BitFlow.NET
Source code documentation of the BitFlow .NET interface.
Classes | Enumerations
Package BufferAcquisition

Buffer Interface image acquisition library. More...

Classes

class  AcqTrigger
 
class  AcquisitionError
 
class  AcqusitionEngine
 
class  Board
 
class  BufferedAcquisition
 Abstract base class of the Buffer Interface acquisition library. More...
 
class  BufferInfo
 Used to bridge the gap between managed C++ and C# for returning the buffer info for the WaitForFrameDone methods. More...
 
class  CircularAcquisition
 This class provides the ability to capture images into a circular queue using a BitFlow interface board. More...
 
class  CirManagement
 
class  FileIO
 
class  SeqManagement
 
class  SequenceAcquisition
 This class provides the ability to acquire a sequence of images using a BitFlow interface board. More...
 
class  Version
 

Enumerations

enum  InquireParams {
  InquireParams.Model = ManagedInquireParams.Model, InquireParams.IDReg = ManagedInquireParams.IDReg, InquireParams.LUT = ManagedInquireParams.LUT, InquireParams.XSize = ManagedInquireParams.XSize,
  InquireParams.YSize = ManagedInquireParams.YSize, InquireParams.Format = ManagedInquireParams.Format, InquireParams.BitsPerPix = ManagedInquireParams.BitsPerPix, InquireParams.BytesPerPix = ManagedInquireParams.BytesPerPix,
  InquireParams.AqTimeout = ManagedInquireParams.AqTimeout, InquireParams.FrameSize = ManagedInquireParams.FrameSize, InquireParams.DisplayFrameSize = ManagedInquireParams.DisplayFrameSize, InquireParams.FrameWidth = ManagedInquireParams.FrameWidth,
  InquireParams.DisplayFrameWidth = ManagedInquireParams.DisplayFrameWidth, InquireParams.BitsPerPixDisplay = ManagedInquireParams.BitsPerPixDisplay, InquireParams.BytesPerPixDisplay = ManagedInquireParams.BytesPerPixDisplay, BitsPerSequence = ManagedInquireParams.BitsPerSequence,
  BitsPerSequenceDisplay = ManagedInquireParams.BitsPerSequenceDisplay
}
 A list of the parameters for inquiry. More...
 
enum  BoardModel : uint {
  BoardModel.Unknown = ManagedBoardModel.Unknown, RR11 = ManagedBoardModel.RR11, RR12 = ManagedBoardModel.RR12, RR13 = ManagedBoardModel.RR13,
  RR14 = ManagedBoardModel.RR14, RR23 = ManagedBoardModel.RR23, RR24 = ManagedBoardModel.RR24, RR44 = ManagedBoardModel.RR44,
  RV010 = ManagedBoardModel.RV010, RV110 = ManagedBoardModel.RV110, RV220 = ManagedBoardModel.RV220, RV330 = ManagedBoardModel.RV330,
  RV440 = ManagedBoardModel.RV440, R64Dif = ManagedBoardModel.R64Dif, R64ClF = ManagedBoardModel.R64ClF, R64ClD = ManagedBoardModel.R64ClD,
  R64DifB = ManagedBoardModel.R64DifB, R64ClFB = ManagedBoardModel.R64ClFB, R64ClDB = ManagedBoardModel.R64ClDB, R64DifH = ManagedBoardModel.R64DifH,
  R64ClFH = ManagedBoardModel.R64ClFH, R64ClDH = ManagedBoardModel.R64ClDH, R64DifHB = ManagedBoardModel.R64DifHB, R64ClFHB = ManagedBoardModel.R64ClFHB,
  R64ClDHB = ManagedBoardModel.R64ClDHB, Kbn2D = ManagedBoardModel.Kbn2D, Kbn2B = ManagedBoardModel.Kbn2B, Kbn2F = ManagedBoardModel.Kbn2F,
  Kbn4D = ManagedBoardModel.Kbn4D, Kbn4B = ManagedBoardModel.Kbn4B, Kbn4F = ManagedBoardModel.Kbn4F, NeonB = ManagedBoardModel.NeonB,
  NeonD = ManagedBoardModel.NeonD, NeonQ = ManagedBoardModel.NeonQ, NeonDif = ManagedBoardModel.NeonDif, Alta1 = ManagedBoardModel.Alta1,
  Alta2 = ManagedBoardModel.Alta2, Alta4 = ManagedBoardModel.Alta4, AltaCO1 = ManagedBoardModel.AltaCO1, AltaCO2 = ManagedBoardModel.AltaCO2,
  AltaCO4 = ManagedBoardModel.AltaCO4, KbnCXP1 = ManagedBoardModel.KbnCXP1, KbnCXP2 = ManagedBoardModel.KbnCXP2, KbnCXP4 = ManagedBoardModel.KbnCXP4,
  CtnCXP4 = ManagedBoardModel.CtnCXP4, CtnCXP2 = ManagedBoardModel.CtnCXP2
}
 All the BitFlow board models. Can be one of the following. More...
 
enum  LutType { LutType.LUT8And12 = ManagedLutTypes.LUT8And12, LutType.LUT16 = ManagedLutTypes.LUT16, LutType.LUTNone = ManagedLutTypes.LUTNone }
 The Look Up Tables (LUT) avalable on boards. More...
 
enum  SetupOptions {
  Default = 0, AbortMissedFrame = ManagedSetupOptions.ManagedAbortMissedFrame, DisableAqErrorSig = ManagedSetupOptions.ManagedDisableAqErrorSig, InvertEvenFrames = ManagedSetupOptions.ManagedInvertEvenFrames,
  InvertOddFrames = ManagedSetupOptions.ManagedInvertOddFrames, OnlyOddLines = ManagedSetupOptions.ManagedOnlyOddLines, OnlyEvenLines = ManagedSetupOptions.ManagedOnlyEvenLines
}
 
enum  AcqControlOptions { Wait = ManagedAcqControlOptions.Wait, Async = ManagedAcqControlOptions.Async }
 
enum  SeqDoneReturns { SeqDoneReturns.SequenceCaptured = 0, SeqDoneReturns.AcqusitionAborted = ManagedSeqDoneReturns.AcqusitionAborted, SeqDoneReturns.AcqusitionStopped = ManagedSeqDoneReturns.AcqusitionStopped, SeqDoneReturns.CleanupCalled = ManagedSeqDoneReturns.CleanupCalled }
 
enum  OverwriteMethod { Stop = ManagedOverwriteMethod.Stop, Ignore = ManagedOverwriteMethod.Ignore }
 
enum  WaitFrameDoneReturns { WaitFrameDoneReturns.FrameAcquired = 0, WaitFrameDoneReturns.AcqusitionStopped = ManagedFrameDoneReturns.AcqusitionStopped, WaitFrameDoneReturns.AcqusitionAborted = ManagedFrameDoneReturns.AcqusitionAborted, WaitFrameDoneReturns.CleanupCalled = ManagedFrameDoneReturns.CleanupCalled }
 
enum  TriggerModes {
  FreeRun = ManagedTrigModes.FreeRun, OneShot = ManagedTrigModes.OneShot, AcquisitionCommand = ManagedTrigModes.AcquisitionCommand, ContinuousData = ManagedTrigModes.ContinuousData,
  OneShotStartStop = ManagedTrigModes.OneShotStartStop
}
 
enum  TriggerPolarity { AssertedHigh = ManagedTrigPolarity.AssertedHigh, AssertedLow = ManagedTrigPolarity.AssertedLow }
 
enum  OpenOptions {
  Initialize = ManagedOpenOptions.Initialize, Exclusive = ManagedOpenOptions.Exclusive, NoIntThread = ManagedOpenOptions.NoIntThread, NoCameraOpen = ManagedOpenOptions.NoCameraOpen,
  NoAlreadyOpenMess = ManagedOpenOptions.NoAlreadyOpenMess, NoOpenErrorMess = ManagedOpenOptions.NoOpenErrorMess, SecondProcessOpen = ManagedOpenOptions.SecondProcessOpen, AllowTwoOpens = ManagedOpenOptions.AllowTwoOpens
}
 
enum  NTGTrigModes { NTGTrigModes.FreeRun = ManagedNTGTrigModes.FreeRun, NTGTrigModes.OneShotTrigger = ManagedNTGTrigModes.OneShotTrigger, NTGTrigModes.OneShotEncoder = ManagedNTGTrigModes.OneShotEncoder }
 Trigger modes of the New Timing Generator (NTG). More...
 
enum  NTGOutputSignal : uint {
  NTGOutputSignal.OutputCC1 = ManagedNTGOutputSignal.OutputCC1, NTGOutputSignal.OutputCC2 = ManagedNTGOutputSignal.OutputCC2, NTGOutputSignal.OutputCC3 = ManagedNTGOutputSignal.OutputCC3, NTGOutputSignal.OutputCC4 = ManagedNTGOutputSignal.OutputCC4,
  NTGOutputSignal.OutputGP0 = ManagedNTGOutputSignal.OutputGP0, NTGOutputSignal.OutputGP1 = ManagedNTGOutputSignal.OutputGP1, NTGOutputSignal.OutputGP2 = ManagedNTGOutputSignal.OutputGP2, NTGOutputSignal.OutputGP3 = ManagedNTGOutputSignal.OutputGP3,
  NTGOutputSignal.OutputGP4 = ManagedNTGOutputSignal.OutputGP4, NTGOutputSignal.OutputGP5 = ManagedNTGOutputSignal.OutputGP5, NTGOutputSignal.OutputGP6 = ManagedNTGOutputSignal.OutputGP6, NTGOutputSignal.InputTrig = ManagedNTGOutputSignal.InputTrig,
  NTGOutputSignal.InputEncA = ManagedNTGOutputSignal.InputEncA, NTGOutputSignal.InputEncB = ManagedNTGOutputSignal.InputEncB
}
 Flag values of the New Timing Generator (NTG) output signal. Bitwise OR these together to output the NTG waveform to any available combination. More...
 
enum  WriteOptions {
  WriteOptions.Default = 0, WriteOptions.SwapRGB = ManagedWriteOptions.ManSwapRGB, WriteOptions.Pack32To24Bit = ManagedWriteOptions.Pack32To24Bit, WriteOptions.BottomUp = ManagedWriteOptions.BottomUp,
  WriteOptions.OverwriteFile = ManagedWriteOptions.OverwriteFile
}
 The write options when saving an image to disk. More...
 
enum  BufferStatus { Available = ManagedBufferStatus.Available, Hold = ManagedBufferStatus.Hold }
 
enum  CirBufferStatus {
  Available = ManagedCirBufferStatus.Available, Fresh = ManagedCirBufferStatus.Fresh, New = ManagedCirBufferStatus.New, Hold = ManagedCirBufferStatus.Hold,
  Queued = ManagedCirBufferStatus.Queued
}
 

Detailed Description

Buffer Interface image acquisition library.

Enumeration Type Documentation

enum BufferAcquisition.BoardModel : uint

All the BitFlow board models. Can be one of the following.

Enumerator
Unknown 

Unable to determine board model.

enum BufferAcquisition.InquireParams

A list of the parameters for inquiry.

Enumerator
Model 

Returns the board model.

IDReg 

Returns the current setting of the ID switch on the board.

LUT 

Returns the type of LUT on the board.

XSize 

Returns the width of the image in pixels.

YSize 

Returns the height of the image in lines.

Format 

Returns the image format.

BitsPerPix 

Returns the pixel depth in bits, as acquired to host.

BytesPerPix 

Returns the pixel depth in bytes, as acquired to host.

AqTimeout 

Returns the timeout value in the attached camera file.

FrameSize 

Returns the image size in bytes, as acquired to host.

DisplayFrameSize 

Returns the image size in bytes, as acquired to display.

FrameWidth 

Returns the width of the image in bytes, as acquired to host.

DisplayFrameWidth 

Returns the width of the image in bytes, as acquired to display.

BitsPerPixDisplay 

Returns the pixel depth in bits, as acquired to display.

BytesPerPixDisplay 

Returns the pixel depth in bytes, as acquired to display.

enum BufferAcquisition.LutType

The Look Up Tables (LUT) avalable on boards.

Enumerator
LUT8And12 

A 8 or 12 bit LUT.

LUT16 

A 16 bit LUT.

LUTNone 

No LUT on board.

enum BufferAcquisition.NTGOutputSignal : uint

Flag values of the New Timing Generator (NTG) output signal. Bitwise OR these together to output the NTG waveform to any available combination.

Enumerator
OutputCC1 

Output to Camera Link CC1.

OutputCC2 

Output to Camera Link CC2.

OutputCC3 

Output to Camera Link CC3.

OutputCC4 

Output to Camera Link CC4.

OutputGP0 

Output to General Purpose output 0.

OutputGP1 

Output to General Purpose output 1.

OutputGP2 

Output to General Purpose output 2.

OutputGP3 

Output to General Purpose output 3.

OutputGP4 

Output to General Purpose output 4.

OutputGP5 

Output to General Purpose output 5.

OutputGP6 

Output to General Purpose output 6.

InputTrig 

BitFlow SDK > 5.60 only. Output to the frame grabber trigger input.

InputEncA 

BitFlow SDK > 5.60 only. Output to the frame grabber Encoder A input.

InputEncB 

BitFlow SDK > 5.60 only. Output to the frame grabber Encoder B input.

enum BufferAcquisition.NTGTrigModes

Trigger modes of the New Timing Generator (NTG).

Enumerator
FreeRun 

Output the NTG waveform continuously.

OneShotTrigger 

Output the NTG waveform once, when the frame grabber receives an input trigger.

OneShotEncoder 

Output the NTG waveform once, when the frame grabber's encoder input.

enum BufferAcquisition.SeqDoneReturns
Enumerator
SequenceCaptured 

Sequence captured, all is well.

AcqusitionAborted 

Acquisition was aborted .

AcqusitionStopped 

Acquisition was stopped.

CleanupCalled 

Cleanup was called.

enum BufferAcquisition.WaitFrameDoneReturns
Enumerator
FrameAcquired 

Frame acquired, all is well.

AcqusitionStopped 

Acquisition was stopped.

AcqusitionAborted 

Acquisition was aborted.

CleanupCalled 

Cleanup was called.

enum BufferAcquisition.WriteOptions

The write options when saving an image to disk.

Enumerator
Default 

Save image to disk as is.

SwapRGB 

Swaps the RGB color format to BGR color.

Pack32To24Bit 

Saves 32 bit color (RGBX) data to 24 bit (RGB).

BottomUp 

Saves the data to disk upside down from what is being displayed.

OverwriteFile 

Will overwrite existing files without prompting the user.