PlusBkProFocusCameraLinkReceiver Class Reference

Class for receiving images through the BK ProFocus SDK (Grabbie) More...

#include <src/PlusDataCollection/BkProFocus/PlusBkProFocusCameraLinkReceiver.h>

Inheritance diagram for PlusBkProFocusCameraLinkReceiver:

Collaboration diagram for PlusBkProFocusCameraLinkReceiver:

Public Member Functions
virtual bool	Cleanup ()
virtual bool	DataAvailable (int lines, int pitch, void const *frameData)
	PlusBkProFocusCameraLinkReceiver ()
virtual bool	Prepare (int samples, int lines, int pitch)
virtual void	SetDecimation (int decimation)
virtual void	SetImagingMode (vtkPlusBkProFocusCameraLinkVideoSource::ImagingModeType imagingMode)
virtual void	SetPlusVideoSource (vtkPlusBkProFocusCameraLinkVideoSource *videoSource)
virtual	~PlusBkProFocusCameraLinkReceiver ()

Protected Attributes
vtkPlusBkProFocusCameraLinkVideoSource *	m_CallbackVideoSource
int	m_Decimation
unsigned char *	m_Frame
vtkPlusBkProFocusCameraLinkVideoSource::ImagingModeType	m_ImagingMode
unsigned int	m_MaxNumberOfLines
unsigned int	m_NumberOfRfSamplesPerLine

Detailed Description

Class for receiving images through the BK ProFocus SDK (Grabbie)

Definition at line 12 of file PlusBkProFocusCameraLinkReceiver.h.

Constructor & Destructor Documentation

PlusBkProFocusCameraLinkReceiver()

PlusBkProFocusCameraLinkReceiver::PlusBkProFocusCameraLinkReceiver

(

)

Definition at line 15 of file PlusBkProFocusCameraLinkReceiver.cxx.

~PlusBkProFocusCameraLinkReceiver()

PlusBkProFocusCameraLinkReceiver::~PlusBkProFocusCameraLinkReceiver ( )

virtual

Definition at line 28 of file PlusBkProFocusCameraLinkReceiver.cxx.

Member Function Documentation

Cleanup()

bool PlusBkProFocusCameraLinkReceiver::Cleanup ( )

virtual

Callback functions called by the BK ProFocus SDK when stopping the acquisition

Definition at line 80 of file PlusBkProFocusCameraLinkReceiver.cxx.

DataAvailable()

bool PlusBkProFocusCameraLinkReceiver::DataAvailable ( int  lines, int  pitch, void const *  frameData  )

virtual

Callback functions called by the BK ProFocus SDK when a frame is acquired

Parameters

lines	Number of RF lines
pitch	Number of bytes between the start of two consecutive lines in frame data
frameData	Pixel data

Definition at line 93 of file PlusBkProFocusCameraLinkReceiver.cxx.

Prepare()

bool PlusBkProFocusCameraLinkReceiver::Prepare ( int  samples, int  lines, int  pitch  )

virtual

Callback functions called by the BK ProFocus SDK when starting the acquisition

Parameters

samples	Number of bytes of one RF line, including the line header
lines	Number of RF lines
pitch	Number of bytes between the start of two consecutive lines in frame data

Definition at line 33 of file PlusBkProFocusCameraLinkReceiver.cxx.

SetDecimation()

void PlusBkProFocusCameraLinkReceiver::SetDecimation ( int  decimation )

virtual

Set decimation value to reduce the amount of processed data. Only every N-th RF sample is acquired. Regardelss of the decimation value all the lines are acquired.

Definition at line 219 of file PlusBkProFocusCameraLinkReceiver.cxx.

SetImagingMode()

void PlusBkProFocusCameraLinkReceiver::SetImagingMode ( vtkPlusBkProFocusCameraLinkVideoSource::ImagingModeType  imagingMode )

virtual

Set what kind of images are sent to the video source. The default is RF mode, when the raw RF data is recorded. Applications (e.g., fCal) may still be able to show a B-mode image for monitoring the acquisition by performing the brightness conversion and scan conversion internally. Other imaging modes are not yet supported.

Definition at line 213 of file PlusBkProFocusCameraLinkReceiver.cxx.

SetPlusVideoSource()

void PlusBkProFocusCameraLinkReceiver::SetPlusVideoSource ( vtkPlusBkProFocusCameraLinkVideoSource *  videoSource )

virtual

Set the video source that will be notified when a new frame is received

Definition at line 207 of file PlusBkProFocusCameraLinkReceiver.cxx.

Member Data Documentation

m_CallbackVideoSource

vtkPlusBkProFocusCameraLinkVideoSource* PlusBkProFocusCameraLinkReceiver::m_CallbackVideoSource

protected

Video source that is notified about each new frame

Definition at line 60 of file PlusBkProFocusCameraLinkReceiver.h.

m_Decimation

int PlusBkProFocusCameraLinkReceiver::m_Decimation

protected

Paramter to reduce the amount of processed and stored data. The receiver uses only 1 out of m_Decimation samples in a line.

Definition at line 69 of file PlusBkProFocusCameraLinkReceiver.h.

m_Frame

unsigned char* PlusBkProFocusCameraLinkReceiver::m_Frame

protected

Buffer storing the RF lines that can be converted to brightness lines, after decimation

Definition at line 66 of file PlusBkProFocusCameraLinkReceiver.h.

m_ImagingMode

vtkPlusBkProFocusCameraLinkVideoSource::ImagingModeType PlusBkProFocusCameraLinkReceiver::m_ImagingMode

protected

For future use. Now only RF mode is supported.

Definition at line 63 of file PlusBkProFocusCameraLinkReceiver.h.

m_MaxNumberOfLines

unsigned int PlusBkProFocusCameraLinkReceiver::m_MaxNumberOfLines

protected

Number RF lines that can be stored in m_Frame

Definition at line 80 of file PlusBkProFocusCameraLinkReceiver.h.

m_NumberOfRfSamplesPerLine

unsigned int PlusBkProFocusCameraLinkReceiver::m_NumberOfRfSamplesPerLine

protected

Number of samples (I or Q value) in one RF line in m_Frame. One sample is a 16-bit integer. The number of RF "sample pairs" = number of RF "samples" / 2. The number does not include the RF line header.

Definition at line 77 of file PlusBkProFocusCameraLinkReceiver.h.

---

The documentation for this class was generated from the following files:

• src/PlusDataCollection/BkProFocus/PlusBkProFocusCameraLinkReceiver.h
• src/PlusDataCollection/BkProFocus/PlusBkProFocusCameraLinkReceiver.cxx