Class for acquiring images from Andor cameras. More...

#include <src/PlusDataCollection/Andor/vtkPlusAndorVideoSource.h>

Inheritance diagram for vtkPlusAndorVideoSource:

Collaboration diagram for vtkPlusAndorVideoSource:

[legend]

Public Types
enum	AcquisitionMode : int { SingleScan = 1, Accumulate = 2, Kinetics = 3, FastKinetics = 4, RunTillAbort = 5 }

enum	ReadMode : int { FullVerticalBinning = 0, MultiTrack = 1, RandomTrack = 2, SingleTrack = 3, Image = 4 }

enum	ShutterMode : int { FullyAuto = 0, PermanentlyOpen = 1, PermanentlyClosed = 2, OpenForFVBSeries = 4, OpenForAnySeries = 5 }

typedef vtkPlusDevice	Superclass

enum	TriggerMode : int { Internal = 0, External = 1, ExternalStart = 6, ExternalExposure = 7, ExternalFVBEM = 9, SoftwareTrigger = 10, ExternalChargeShifting = 12 }

Public Types inherited from vtkPlusDevice
typedef vtkImageAlgorithm	Superclass

Public Member Functions
PlusStatus	AbortAcquisition ()

unsigned int	checkStatus (unsigned int returnStatus, std::string functionName)

AcquisitionMode	GetAcquisitionMode ()

std::string	GetBadPixelCorrectionImage ()

std::string	GetBiasDarkCorrectionImage ()

std::array< double, 9 >	GetCameraIntrinsics ()

unsigned int	GetCCDStatus ()

virtual const char *	GetClassName ()

int	GetCoolerMode ()

int	GetCoolTemperature ()

int	GetCurrentTemperature (float *temperature)

std::array< double, 4 >	GetDistortionCoefficients ()

float	GetExposureTime ()

std::string	GetFlatCorrectionImage ()

float	GetHSSpeed ()

float	GetPreAmpGain ()

int	GetPreAmpGainIndex ()

ReadMode	GetReadMode ()

bool	GetRequireCoolTemp ()

int	GetSafeTemperature ()

virtual std::string	GetSdkVersion ()

ShutterMode	GetShutter ()

std::vector< double >	GetSpacing ()

TriggerMode	GetTriggerMode ()

bool	GetUseCosmicRayCorrection ()

float	GetVSSpeed ()

int	GetVSSpeedIndex ()

virtual int	IsA (const char *type)

bool	IsAcquisitionThreadRunning ()

bool	IsCCDAcquiring ()

bool	IsCoolerOn ()

virtual bool	IsTracker () const

virtual PlusStatus	NotifyConfigured ()

void	operator= (const vtkPlusAndorVideoSource &)=delete

void	PrepareAcquisition ()

virtual void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE

virtual PlusStatus	ReadConfiguration (vtkXMLDataElement *config)

PlusStatus	SetAcquisitionMode (AcquisitionMode acquisitionMode)

PlusStatus	SetBadPixelCorrectionImage (const std::string badPixelFilePath)

PlusStatus	SetBiasDarkCorrectionImage (const std::string biasDarkFilePath)

PlusStatus	SetCameraIntrinsics (std::array< double, 9 > intrinsics)

PlusStatus	SetCoolerMode (int mode)

PlusStatus	SetCoolerState (bool coolerState)

PlusStatus	SetCoolTemperature (int coolTemp)

PlusStatus	SetDistortionCoefficients (std::array< double, 4 > coefficients)

PlusStatus	SetExposureTime (float exposureTime)

PlusStatus	SetFlatCorrectionImage (const std::string flatFilePath)

PlusStatus	SetFrameFieldImageToReferenceTransform (std::array< float, 16 > transform)

PlusStatus	SetHorizontalBins (int bins)

PlusStatus	SetHSSpeed (int type, int index)

PlusStatus	SetPreAmpGainIndex (int preAmpGainIndex)

PlusStatus	SetReadMode (ReadMode setReadMode)

PlusStatus	SetRequireCoolTemp (bool RequireCoolTemp)

PlusStatus	SetSafeTemperature (int safeTemp)

PlusStatus	SetShutter (ShutterMode shutter)

PlusStatus	SetShutterClosingTimeMilliseconds (int closingTime)

PlusStatus	SetShutterOpeningTimeMilliseconds (int openingTime)

PlusStatus	SetTriggerMode (TriggerMode triggerMode)

PlusStatus	SetUseCosmicRayCorrection (bool UseCosmicRayCorrection)

PlusStatus	SetVerticalBins (int bins)

PlusStatus	SetVSSpeedIndex (int index)

PlusStatus	StartBLIFrameAcquisition (int binning, int vsSpeed, int hsSpeed, float exposureTime, int shutterCloseTime=0, int shutterOpenTime=0)

PlusStatus	StartCorrectionFrameAcquisition (std::string correctionFilePath, ShutterMode shutter, int binning, int vsSpeed, int hsSpeed, float exposureTime, int shutterCloseTime=0, int shutterOpenTime=0)

PlusStatus	StartGrayscaleFrameAcquisition (int binning, int vsSpeed, int hsSpeed, float exposureTime, int shutterCloseTime=0, int shutterOpenTime=0)

	vtkPlusAndorVideoSource (const vtkPlusAndorVideoSource &)=delete

bool	WaitForAcquisitionWithTimeout (double maximumWaitTimeInSeconds, int sleepQuantumMilliseconds=10)

void	WaitForCooldown ()

void	WaitForWarmup ()

virtual PlusStatus	WriteConfiguration (vtkXMLDataElement *config)

Public Member Functions inherited from vtkPlusDevice
PlusStatus	AddFieldDataSource (vtkPlusDataSource *aSource)

PlusStatus	AddInputChannel (vtkPlusChannel *aChannel)

PlusStatus	AddOutputChannel (vtkPlusChannel *aChannel)

PlusStatus	AddTool (vtkPlusDataSource *tool, bool requireUniquePortName=true)

PlusStatus	AddVideoSource (vtkPlusDataSource *anImage)

void	ClearAllBuffers ()

virtual PlusStatus	Connect ()

virtual PlusStatus	CreateDefaultOutputChannel (const char *channelId=NULL, bool addSource=true)

void	DeepCopy (const vtkPlusDevice &device)

virtual PlusStatus	Disconnect ()

virtual PlusStatus	ForceUpdate ()

virtual double	GetAcquisitionRate () const

virtual PlusStatus	GetBufferSize (vtkPlusChannel &aChannel, int &outVal, const std::string &aSourceId=std::string(""))

virtual int	GetConnected () const

virtual bool	GetCorrectlyConfigured () const

PlusStatus	GetDataSource (const char aSourceId, vtkPlusDataSource &aSource)

PlusStatus	GetDataSource (const std::string &aSourceId, vtkPlusDataSource *&aSource)

virtual double	GetDesiredTimestamp ()

virtual std::string	GetDeviceId () const

PlusStatus	GetFieldDataSource (const char aSourceId, vtkPlusDataSource &aSource) const

PlusStatus	GetFieldDataSource (const std::string &aSourceId, vtkPlusDataSource *&aSource) const

DataSourceContainerConstIterator	GetFieldDataSourcessIteratorBegin () const

DataSourceContainerConstIterator	GetFieldDataSourcessIteratorEnd () const

PlusStatus	GetFirstActiveOutputVideoSource (vtkPlusDataSource *&aVideoSource)

PlusStatus	GetFirstActiveTool (vtkPlusDataSource *&aTool) const

PlusStatus	GetFirstOutputChannel (vtkPlusChannel *&aChannel)

PlusStatus	GetFirstVideoSource (vtkPlusDataSource *&anImage)

virtual unsigned long	GetFrameNumber () const

virtual double	GetFrameTimeStamp () const

virtual PlusStatus	GetImage (const std::string &requestedImageId, std::string &assignedImageId, const std::string &imageReferencFrameName, vtkImageData imageData, vtkMatrix4x4 ijkToReferenceTransform)

virtual PlusStatus	GetImageMetaData (igsioCommon::ImageMetaDataList &imageMetaDataItems)

virtual US_IMAGE_TYPE	GetImageType (vtkPlusChannel &aChannel)

PlusStatus	GetInputDevices (std::vector< vtkPlusDevice * > &outDeviceList) const

PlusStatus	GetInputDevicesRecursive (std::vector< vtkPlusDevice * > &outDeviceList) const

virtual PlusStatus	GetInputFrameSize (vtkPlusChannel &aChannel, unsigned int &x, unsigned int &y, unsigned int &z) const

virtual PlusStatus	GetInputFrameSize (vtkPlusChannel &aChannel, FrameSizeType &dim) const

double	GetInternalUpdateRate () const

virtual double	GetLocalTimeOffsetSec () const

double	GetMissingInputGracePeriodSec () const

virtual int	GetNumberOfFieldDataSources () const

virtual int	GetNumberOfTools () const

virtual int	GetNumberOfVideoSources () const

PlusStatus	GetOutputChannelByName (vtkPlusChannel &aChannel, const char aChannelId)

PlusStatus	GetOutputChannelByName (vtkPlusChannel *&aChannel, const std::string &aChannelId)

ChannelContainerConstIterator	GetOutputChannelsEnd () const

ChannelContainerIterator	GetOutputChannelsEnd ()

ChannelContainerConstIterator	GetOutputChannelsStart () const

ChannelContainerIterator	GetOutputChannelsStart ()

virtual PlusStatus	GetOutputFrameSize (vtkPlusChannel &aChannel, unsigned int &x, unsigned int &y, unsigned int &z) const

virtual PlusStatus	GetOutputFrameSize (vtkPlusChannel &aChannel, FrameSizeType &dim) const

virtual std::string	GetParameter (const std::string &key) const

virtual PlusStatus	GetParameter (const std::string &key, std::string &outValue) const

virtual igsioCommon::VTKScalarPixelType	GetPixelType (vtkPlusChannel &aChannel)

virtual double	GetStartTime ()

virtual double	GetTimestampClosestToDesired ()

PlusStatus	GetTool (const char aToolSourceId, vtkPlusDataSource &aTool) const

PlusStatus	GetTool (const std::string &aToolSourceId, vtkPlusDataSource *&aTool) const

PlusStatus	GetToolByPortName (const char aPortName, vtkPlusDataSource &aSource)

PlusStatus	GetToolByPortName (const std::string &aPortName, vtkPlusDataSource *&aSource)

DataSourceContainerConstIterator	GetToolIteratorBegin () const

DataSourceContainerConstIterator	GetToolIteratorEnd () const

std::string	GetToolReferenceFrameName () const

virtual int	GetUpdateWithDesiredTimestamp ()

PlusStatus	GetVideoSource (const char aSourceId, vtkPlusDataSource &aVideoSource)

PlusStatus	GetVideoSourceByIndex (const unsigned int index, vtkPlusDataSource *&aVideoSource)

DataSourceContainerConstIterator	GetVideoSourceIteratorBegin () const

DataSourceContainerConstIterator	GetVideoSourceIteratorEnd () const

std::vector< vtkPlusDataSource * >	GetVideoSources () const

PlusStatus	GetVideoSourcesByPortName (const char aPortName, std::vector< vtkPlusDataSource > &sources)

PlusStatus	GetVideoSourcesByPortName (const std::string &aPortName, std::vector< vtkPlusDataSource * > &sources)

virtual bool	IsConnected () const

virtual bool	IsRecording () const

virtual bool	IsResettable ()

virtual bool	IsVirtual () const

virtual int	OutputChannelCount () const

virtual PlusStatus	Probe ()

virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual PlusStatus	Reset ()

virtual PlusStatus	SendText (const std::string &textToSend, std::string *textReceived=NULL)

PlusStatus	SetAcquisitionRate (double aRate)

virtual PlusStatus	SetBufferSize (vtkPlusChannel &aChannel, int FrameBufferSize, const std::string &aSourceId=std::string(""))

virtual void	SetDataCollector (vtkPlusDataCollector *_arg)

virtual void	SetDesiredTimestamp (double)

void	SetDeviceId (const std::string &id)

void	SetFieldDataSourcesBufferSize (int aBufferSize)

virtual PlusStatus	SetImageType (vtkPlusChannel &aChannel, US_IMAGE_TYPE imageType)

virtual PlusStatus	SetInputFrameSize (vtkPlusDataSource &aSource, unsigned int x, unsigned int y, unsigned int z)

virtual void	SetLocalTimeOffsetSec (double aTimeOffsetSec)

virtual void	SetMissingInputGracePeriodSec (double)

virtual PlusStatus	SetParameter (const std::string &key, const std::string &value)

virtual PlusStatus	SetPixelType (vtkPlusChannel &aChannel, igsioCommon::VTKScalarPixelType pixelType)

virtual void	SetStartTime (double startTime)

void	SetToolReferenceFrameName (const std::string &frameName)

void	SetToolsBufferSize (int aBufferSize)

virtual void	SetUpdateWithDesiredTimestamp (int)

virtual PlusStatus	StartRecording ()

virtual PlusStatus	StopRecording ()

virtual void	UpdateWithDesiredTimestampOff ()

virtual void	UpdateWithDesiredTimestampOn ()

virtual PlusStatus	WriteToolsToSequenceFile (const std::string &filename, bool useCompression=false)

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkPlusAndorVideoSource *	New ()

static vtkPlusAndorVideoSource *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkPlusDevice
static PlusStatus	GetToolReferenceFrameFromTrackedFrame (igsioTrackedFrame &aFrame, std::string &aToolReferenceFrameName)

static int	IsTypeOf (const char *type)

static vtkPlusDevice *	New ()

static vtkPlusDevice *	SafeDownCast (vtkObject *o)

Protected Types
using	DataSourceArray = std::vector< vtkPlusDataSource * >

Protected Member Functions
PlusStatus	AcquireFrame ()

void	AddFrameToDataSource (DataSourceArray &ds)

void	AdjustBuffers (int horizontalBins, int verticalBins)

void	AdjustSpacing (int horizontalBins, int verticalBins)

void	ApplyCosmicRayCorrection (int binning, cv::Mat &floatImage)

void	ApplyFrameCorrections (int binning)

void	CorrectBadPixels (int binning, cv::Mat &cvIMG)

void	FindBadCells (int binning)

bool	GetUseFrameCorrections ()

PlusStatus	InitializeAndorCamera ()

void	InitializePort (DataSourceArray &port)

virtual PlusStatus	InternalConnect ()

virtual PlusStatus	InternalDisconnect ()

PlusStatus	InternalStartRecording () override

PlusStatus	InternalStopRecording () override

PlusStatus	InternalUpdate () override

void	ResizeFlatCorrectionImage (int binning)

void	SetCustomFrameFields ()

PlusStatus	SetInitializeCoolerState (bool InitializeCoolerState)

PlusStatus	SetUseFrameCorrections (bool UseFrameCorrections)

PlusStatus	TurnCoolerOFF ()

PlusStatus	TurnCoolerON ()

	vtkPlusAndorVideoSource ()

	~vtkPlusAndorVideoSource ()

Protected Member Functions inherited from vtkPlusDevice
virtual PlusStatus	AddVideoItemToVideoSources (const std::vector< vtkPlusDataSource * > &videoSources, const igsioVideoFrame &frame, long frameNumber, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType *customFields=NULL)

virtual PlusStatus	AddVideoItemToVideoSources (const std::vector< vtkPlusDataSource * > &videoSources, void imageDataPtr, US_IMAGE_ORIENTATION usImageOrientation, const FrameSizeType &frameSizeInPx, igsioCommon::VTKScalarPixelType pixelType, unsigned int numberOfScalarComponents, US_IMAGE_TYPE imageType, int numberOfBytesToSkip, long frameNumber, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType customFields=NULL)

PlusStatus	EnsureUniqueDataSourceId (const std::string &aSourceId)

vtkXMLDataElement *	FindInputChannelElement (vtkXMLDataElement rootXMLElement, const char aChannelId)

vtkXMLDataElement *	FindOutputChannelElement (vtkXMLDataElement rootXMLElement, const char aChannelId)

vtkXMLDataElement *	FindThisDeviceElement (vtkXMLDataElement *rootXMLElement)

virtual vtkPlusDataCollector *	GetDataCollector ()

double	GetRecordingStartTime () const

bool	GetStartThreadForInternalUpdates () const

bool	HasGracePeriodExpired ()

virtual void	InternalWriteInputChannels (vtkXMLDataElement *rootXMLElement)

virtual void	InternalWriteOutputChannels (vtkXMLDataElement *rootXMLElement)

virtual void	SetCorrectlyConfigured (bool)

virtual void	SetRecordingStartTime (double)

virtual void	SetStartThreadForInternalUpdates (bool)

virtual PlusStatus	ToolTimeStampedUpdate (const std::string &aToolSourceId, vtkMatrix4x4 matrix, ToolStatus status, unsigned long frameNumber, double unfilteredtimestamp, const igsioFieldMapType customFields=NULL)

virtual PlusStatus	ToolTimeStampedUpdateWithoutFiltering (const std::string &aToolSourceId, vtkMatrix4x4 matrix, ToolStatus status, double unfilteredtimestamp, double filteredtimestamp, const igsioFieldMapType customFields=NULL)

	vtkPlusDevice ()

virtual	~vtkPlusDevice ()

Static Protected Member Functions
static void *	AcquireBLIFrameThread (vtkMultiThreader::ThreadInfo *info)

static void *	AcquireCorrectionFrameThread (vtkMultiThreader::ThreadInfo *info)

static void *	AcquireGrayscaleFrameThread (vtkMultiThreader::ThreadInfo *info)

Static Protected Member Functions inherited from vtkPlusDevice
static void *	vtkDataCaptureThread (vtkMultiThreader::ThreadInfo *data)

Protected Attributes
std::string	badPixelCorrection

std::string	biasDarkCorrection

DataSourceArray	BLICorrected

DataSourceArray	BLIRaw

double	cameraIntrinsics [9] = { 0 }

int	CoolerMode = 0

int	CoolTemperature = -50

float	CurrentTemperature = 0.123456789

double	currentTime = UNDEFINED_TIMESTAMP

igsioFieldMapType	CustomFields

double	distortionCoefficients [4] = { 0 }

float	effectiveExpTime = 1.0

int	effectiveHBins = 1

int	effectiveHSInd = 1

vtkPlusAndorVideoSource::ShutterMode	effectiveShutter = ShutterMode::FullyAuto

int	effectiveShutterClosingTimeMilliseconds = 0

int	effectiveShutterOpeningTimeMilliseconds = 0

int	effectiveVBins = 1

int	effectiveVSInd = 1

float	ExposureTime = 1.0

std::string	flatCorrection

FrameSizeType	frameSize = {1024, 1024, 1}

DataSourceArray	GrayCorrected

DataSourceArray	GrayRaw

int	HorizontalBins = 1

int	HSSpeed [2] = { 0, 1 }

std::array< float, 16 >	imageToReferenceTransform = { 0 }

bool	InitializeCoolerState = true

AcquisitionMode	m_AcquisitionMode = AcquisitionMode::SingleScan

ReadMode	m_ReadMode = ReadMode::Image

TriggerMode	m_TriggerMode = TriggerMode::Internal

double	OutputSpacing [3] = { 0 }

int	PreAmpGainIndex = 0

std::vector< uint16_t >	rawFrame

bool	RequireCoolTemp = true

int	SafeTemperature = 5

std::string	saveCorrectionPath

vtkPlusAndorVideoSource::ShutterMode	Shutter = ShutterMode::FullyAuto

int	ShutterClosingTimeMilliseconds = 0

int	ShutterOpeningTimeMilliseconds = 0

vtkMultiThreader *	Threader = vtkMultiThreader::New()

int	threadID = -1

bool	UseCosmicRayCorrection = true

bool	UseFrameCorrections = true

int	VerticalBins = 1

int	VSSpeedIndex = 0

Protected Attributes inherited from vtkPlusDevice
double	AcquisitionRate

int	Connected

bool	CorrectlyConfigured

StreamBufferItem *	CurrentStreamBufferItem

vtkPlusDataCollector *	DataCollector

double	DesiredTimestamp

std::string	DeviceId

DataSourceContainer	Fields

unsigned long	FrameNumber

double	FrameTimeStamp

ChannelContainer	InputChannels

double	LocalTimeOffsetSec

double	MissingInputGracePeriodSec

ChannelContainer	OutputChannels

int	OutputNeedsInitialization

std::map< std::string, std::string >	Parameters

int	Recording

double	RecordingStartTime

std::set< std::string >	ReportedUnknownTools

bool	RequireImageOrientationInConfiguration

bool	RequirePortNameInDeviceSetConfiguration

bool	StartThreadForInternalUpdates

bool	ThreadAlive

vtkMultiThreader *	Threader

int	ThreadId

double	TimestampClosestToDesired

std::string	ToolReferenceFrameName

DataSourceContainer	Tools

int	UpdateWithDesiredTimestamp

DataSourceContainer	VideoSources

Additional Inherited Members
Public Attributes inherited from vtkPlusDevice
double	InternalUpdateRate

vtkIGSIORecursiveCriticalSection *	UpdateMutex

vtkTimeStamp	UpdateTime

Static Public Attributes inherited from vtkPlusDevice
static const std::string	BMODE_PORT_NAME = "B"

static const std::string	PARAMETER_XML_ELEMENT_TAG = "Parameter"

static const std::string	PARAMETERS_XML_ELEMENT_TAG = "Parameters"

static const std::string	RFMODE_PORT_NAME = "Rf"

Static Protected Attributes inherited from vtkPlusDevice
static const int	VIRTUAL_DEVICE_FRAME_RATE = 50

Detailed Description

Class for acquiring images from Andor cameras.

Requires PLUS_USE_ANDOR_CAMERA option in CMake. Requires the Andor SDK (SDK provided by Andor).

Definition at line 25 of file vtkPlusAndorVideoSource.h.

Member Typedef Documentation

◆ DataSourceArray

using vtkPlusAndorVideoSource::DataSourceArray = std::vector<vtkPlusDataSource*>

protected

Definition at line 276 of file vtkPlusAndorVideoSource.h.

◆ Superclass

typedef vtkPlusDevice vtkPlusAndorVideoSource::Superclass

Definition at line 30 of file vtkPlusAndorVideoSource.h.

Member Enumeration Documentation

◆ AcquisitionMode

enum vtkPlusAndorVideoSource::AcquisitionMode : int

Acquisition mode. Valid values: 1 Single Scan 2 Accumulate 3 Kinetics 4 Fast Kinetics 5 Run till abort

Enumerator
SingleScan
Accumulate
Kinetics
FastKinetics
RunTillAbort

Definition at line 103 of file vtkPlusAndorVideoSource.h.

◆ ReadMode

enum vtkPlusAndorVideoSource::ReadMode : int

Readout mode.

Enumerator
FullVerticalBinning
MultiTrack
RandomTrack
SingleTrack
Image

Definition at line 115 of file vtkPlusAndorVideoSource.h.

◆ ShutterMode

enum vtkPlusAndorVideoSource::ShutterMode : int

Shutter mode: For an external shutter: Output TTL high signal to open shutter.

Enumerator
FullyAuto
PermanentlyOpen
PermanentlyClosed
OpenForFVBSeries
OpenForAnySeries

Definition at line 54 of file vtkPlusAndorVideoSource.h.

◆ TriggerMode

enum vtkPlusAndorVideoSource::TriggerMode : int

Trigger mode. Valid values: 0. Internal

External
External Start
External Exposure (Bulb)
External FVB EM (only valid for EM Newton models in FVB mode)
Software Trigger
External Charge Shifting

Enumerator
Internal
External
ExternalStart
ExternalExposure
ExternalFVBEM
SoftwareTrigger
ExternalChargeShifting

Definition at line 135 of file vtkPlusAndorVideoSource.h.

Constructor & Destructor Documentation

◆ vtkPlusAndorVideoSource() [1/2]

vtkPlusAndorVideoSource::vtkPlusAndorVideoSource ( const vtkPlusAndorVideoSource & )

delete

◆ vtkPlusAndorVideoSource() [2/2]

vtkPlusAndorVideoSource::vtkPlusAndorVideoSource ( )

protected

Constructor

Definition at line 220 of file vtkPlusAndorVideoSource.cxx.

◆ ~vtkPlusAndorVideoSource()

vtkPlusAndorVideoSource::~vtkPlusAndorVideoSource ( )

protected

Destructor

Definition at line 229 of file vtkPlusAndorVideoSource.cxx.

Member Function Documentation

◆ AbortAcquisition()

PlusStatus vtkPlusAndorVideoSource::AbortAcquisition ( )

Abort the running acquisition process and thread.

Definition at line 921 of file vtkPlusAndorVideoSource.cxx.

◆ AcquireBLIFrameThread()

void * vtkPlusAndorVideoSource::AcquireBLIFrameThread ( vtkMultiThreader::ThreadInfo * info )

staticprotected

Definition at line 791 of file vtkPlusAndorVideoSource.cxx.

◆ AcquireCorrectionFrameThread()

void * vtkPlusAndorVideoSource::AcquireCorrectionFrameThread ( vtkMultiThreader::ThreadInfo * info )

staticprotected

Definition at line 893 of file vtkPlusAndorVideoSource.cxx.

◆ AcquireFrame()

PlusStatus vtkPlusAndorVideoSource::AcquireFrame ( )

protected

Acquire a single frame using current parameters. Data is put in the frameBuffer ivar.

Definition at line 540 of file vtkPlusAndorVideoSource.cxx.

◆ AcquireGrayscaleFrameThread()

void * vtkPlusAndorVideoSource::AcquireGrayscaleFrameThread ( vtkMultiThreader::ThreadInfo * info )

staticprotected

Definition at line 842 of file vtkPlusAndorVideoSource.cxx.

◆ AddFrameToDataSource()

void vtkPlusAndorVideoSource::AddFrameToDataSource ( DataSourceArray & ds )

protected

Data from the frameBuffer ivar is added to the provided data source.

Definition at line 577 of file vtkPlusAndorVideoSource.cxx.

◆ AdjustBuffers()

void vtkPlusAndorVideoSource::AdjustBuffers	(	int	horizontalBins,
		int	verticalBins
	)

protected

Definition at line 407 of file vtkPlusAndorVideoSource.cxx.

◆ AdjustSpacing()

void vtkPlusAndorVideoSource::AdjustSpacing	(	int	horizontalBins,
		int	verticalBins
	)

protected

Definition at line 434 of file vtkPlusAndorVideoSource.cxx.

◆ ApplyCosmicRayCorrection()

void vtkPlusAndorVideoSource::ApplyCosmicRayCorrection	(	int	binning,
		cv::Mat &	floatImage
	)

protected

Applies cosmic ray correction.

Definition at line 689 of file vtkPlusAndorVideoSource.cxx.

◆ ApplyFrameCorrections()

void vtkPlusAndorVideoSource::ApplyFrameCorrections ( int binning )

protected

Applies bias correction for dark current, flat correction and lens distortion.

Definition at line 717 of file vtkPlusAndorVideoSource.cxx.

◆ checkStatus()

unsigned int vtkPlusAndorVideoSource::checkStatus	(	unsigned int	returnStatus,
		std::string	functionName
	)

Check the return status of Andor SDK functions.

Definition at line 1494 of file vtkPlusAndorVideoSource.cxx.

◆ CorrectBadPixels()

void vtkPlusAndorVideoSource::CorrectBadPixels	(	int	binning,
		cv::Mat &	cvIMG
	)

protected

Applies correction for bad pixels.

Definition at line 628 of file vtkPlusAndorVideoSource.cxx.

◆ FindBadCells()

void vtkPlusAndorVideoSource::FindBadCells ( int binning )

protected

Calculates which cells need bad-pixel correction for the given binning level.

Definition at line 601 of file vtkPlusAndorVideoSource.cxx.

◆ GetAcquisitionMode()

vtkPlusAndorVideoSource::AcquisitionMode vtkPlusAndorVideoSource::GetAcquisitionMode ( )

Definition at line 1214 of file vtkPlusAndorVideoSource.cxx.

◆ GetBadPixelCorrectionImage()

std::string vtkPlusAndorVideoSource::GetBadPixelCorrectionImage ( )

inline

Definition at line 164 of file vtkPlusAndorVideoSource.h.

◆ GetBiasDarkCorrectionImage()

std::string vtkPlusAndorVideoSource::GetBiasDarkCorrectionImage ( )

inline

Definition at line 169 of file vtkPlusAndorVideoSource.h.

◆ GetCameraIntrinsics()

std::array< double, 9 > vtkPlusAndorVideoSource::GetCameraIntrinsics ( )

Definition at line 1281 of file vtkPlusAndorVideoSource.cxx.

◆ GetCCDStatus()

unsigned int vtkPlusAndorVideoSource::GetCCDStatus ( )

Check the status of the SDK.

Definition at line 1451 of file vtkPlusAndorVideoSource.cxx.

◆ GetClassName()

virtual const char* vtkPlusAndorVideoSource::GetClassName ( )

virtual

Reimplemented from vtkPlusDevice.

◆ GetCoolerMode()

int vtkPlusAndorVideoSource::GetCoolerMode ( )

Definition at line 1411 of file vtkPlusAndorVideoSource.cxx.

◆ GetCoolTemperature()

int vtkPlusAndorVideoSource::GetCoolTemperature ( )

Definition at line 1431 of file vtkPlusAndorVideoSource.cxx.

◆ GetCurrentTemperature()

int vtkPlusAndorVideoSource::GetCurrentTemperature ( float * temperature )

Get the current temperature of the camera in degrees celsius.

Definition at line 492 of file vtkPlusAndorVideoSource.cxx.

◆ GetDistortionCoefficients()

std::array< double, 4 > vtkPlusAndorVideoSource::GetDistortionCoefficients ( )

Definition at line 1296 of file vtkPlusAndorVideoSource.cxx.

◆ GetExposureTime()

float vtkPlusAndorVideoSource::GetExposureTime ( )

Definition at line 1082 of file vtkPlusAndorVideoSource.cxx.

◆ GetFlatCorrectionImage()

std::string vtkPlusAndorVideoSource::GetFlatCorrectionImage ( )

inline

Definition at line 174 of file vtkPlusAndorVideoSource.h.

◆ GetHSSpeed()

float vtkPlusAndorVideoSource::GetHSSpeed ( )

Get the actual HS Speed in MHz for the current HSSpeed index.

Definition at line 1132 of file vtkPlusAndorVideoSource.cxx.

◆ GetPreAmpGain()

float vtkPlusAndorVideoSource::GetPreAmpGain ( )

Get the actual gain factor for the current pre amp gain index.

Definition at line 1194 of file vtkPlusAndorVideoSource.cxx.

◆ GetPreAmpGainIndex()

int vtkPlusAndorVideoSource::GetPreAmpGainIndex ( )

Definition at line 1188 of file vtkPlusAndorVideoSource.cxx.

◆ GetReadMode()

vtkPlusAndorVideoSource::ReadMode vtkPlusAndorVideoSource::GetReadMode ( )

Definition at line 1228 of file vtkPlusAndorVideoSource.cxx.

◆ GetRequireCoolTemp()

bool vtkPlusAndorVideoSource::GetRequireCoolTemp ( )

Definition at line 1311 of file vtkPlusAndorVideoSource.cxx.

◆ GetSafeTemperature()

int vtkPlusAndorVideoSource::GetSafeTemperature ( )

Definition at line 1445 of file vtkPlusAndorVideoSource.cxx.

◆ GetSdkVersion()

std::string vtkPlusAndorVideoSource::GetSdkVersion ( )

virtual

Get the version of SDK

Reimplemented from vtkPlusDevice.

Definition at line 207 of file vtkPlusAndorVideoSource.cxx.

◆ GetShutter()

vtkPlusAndorVideoSource::ShutterMode vtkPlusAndorVideoSource::GetShutter ( )

Definition at line 1068 of file vtkPlusAndorVideoSource.cxx.

◆ GetSpacing()

std::vector< double > vtkPlusAndorVideoSource::GetSpacing ( )

Definition at line 483 of file vtkPlusAndorVideoSource.cxx.

◆ GetTriggerMode()

vtkPlusAndorVideoSource::TriggerMode vtkPlusAndorVideoSource::GetTriggerMode ( )

Definition at line 1242 of file vtkPlusAndorVideoSource.cxx.

◆ GetUseCosmicRayCorrection()

bool vtkPlusAndorVideoSource::GetUseCosmicRayCorrection ( )

Definition at line 1268 of file vtkPlusAndorVideoSource.cxx.

◆ GetUseFrameCorrections()

bool vtkPlusAndorVideoSource::GetUseFrameCorrections ( )

protected

Definition at line 1255 of file vtkPlusAndorVideoSource.cxx.

◆ GetVSSpeed()

float vtkPlusAndorVideoSource::GetVSSpeed ( )

Get the actual VS Speed in microseconds per pixel shift for the current VSSpeed index.

Definition at line 1163 of file vtkPlusAndorVideoSource.cxx.

◆ GetVSSpeedIndex()

int vtkPlusAndorVideoSource::GetVSSpeedIndex ( )

Definition at line 1157 of file vtkPlusAndorVideoSource.cxx.

◆ InitializeAndorCamera()

PlusStatus vtkPlusAndorVideoSource::InitializeAndorCamera ( )

protected

Initialize vtkPlusAndorVideoSource

Initialize custom fields of this data source

Definition at line 238 of file vtkPlusAndorVideoSource.cxx.

◆ InitializePort()

void vtkPlusAndorVideoSource::InitializePort ( DataSourceArray & port )

protected

Initialize all data sources of the provided port

Definition at line 307 of file vtkPlusAndorVideoSource.cxx.

◆ InternalConnect()

PlusStatus vtkPlusAndorVideoSource::InternalConnect ( )

protectedvirtual

Device-specific connect

Reimplemented from vtkPlusDevice.

Definition at line 322 of file vtkPlusAndorVideoSource.cxx.

◆ InternalDisconnect()

PlusStatus vtkPlusAndorVideoSource::InternalDisconnect ( )

protectedvirtual

Device-specific disconnect

Reimplemented from vtkPlusDevice.

Definition at line 358 of file vtkPlusAndorVideoSource.cxx.

◆ InternalStartRecording()

PlusStatus vtkPlusAndorVideoSource::InternalStartRecording ( )

overrideprotectedvirtual

Device-specific recording start

Reimplemented from vtkPlusDevice.

Definition at line 395 of file vtkPlusAndorVideoSource.cxx.

◆ InternalStopRecording()

PlusStatus vtkPlusAndorVideoSource::InternalStopRecording ( )

overrideprotectedvirtual

Device-specific recording stop

Reimplemented from vtkPlusDevice.

Definition at line 401 of file vtkPlusAndorVideoSource.cxx.

◆ InternalUpdate()

PlusStatus vtkPlusAndorVideoSource::InternalUpdate ( )

inlineoverrideprotectedvirtual

This will be triggered regularly if this->StartThreadForInternalUpdates is true. Framerate is controlled by this->AcquisitionRate. This is meant for debugging.

Reimplemented from vtkPlusDevice.

Definition at line 321 of file vtkPlusAndorVideoSource.h.

◆ IsA()

virtual int vtkPlusAndorVideoSource::IsA ( const char * type )

virtual

Reimplemented from vtkPlusDevice.

◆ IsAcquisitionThreadRunning()

bool vtkPlusAndorVideoSource::IsAcquisitionThreadRunning ( )

Check if the acquisition thread is running. Calling StartAcquisition() without calling PrepareAcquisition() beforehand can result in some delays while the device allocates memory for e.g., different binning sizes, so use this check to determine whether the acquisition thread has completed.

Definition at line 1488 of file vtkPlusAndorVideoSource.cxx.

◆ IsCCDAcquiring()

bool vtkPlusAndorVideoSource::IsCCDAcquiring ( )

Check if the Andor CCD is acquiring.

Definition at line 1460 of file vtkPlusAndorVideoSource.cxx.

◆ IsCoolerOn()

bool vtkPlusAndorVideoSource::IsCoolerOn ( )

Definition at line 1351 of file vtkPlusAndorVideoSource.cxx.

◆ IsTracker()

virtual bool vtkPlusAndorVideoSource::IsTracker ( ) const

inlinevirtual

Specify the device connected to this class

Reimplemented from vtkPlusDevice.

Definition at line 34 of file vtkPlusAndorVideoSource.h.

◆ IsTypeOf()

static int vtkPlusAndorVideoSource::IsTypeOf ( const char * type )

static

◆ New()

static vtkPlusAndorVideoSource* vtkPlusAndorVideoSource::New ( )

static

Constructor for a smart pointer of this class

◆ NotifyConfigured()

PlusStatus vtkPlusAndorVideoSource::NotifyConfigured ( )

virtual

Verify the device is correctly configured

Reimplemented from vtkPlusDevice.

Definition at line 194 of file vtkPlusAndorVideoSource.cxx.

◆ operator=()

void vtkPlusAndorVideoSource::operator= ( const vtkPlusAndorVideoSource & )

delete

◆ PrepareAcquisition()

void vtkPlusAndorVideoSource::PrepareAcquisition ( )

Prepare acquisition now, so acquisition itself takes shorter.

Definition at line 1466 of file vtkPlusAndorVideoSource.cxx.

◆ PrintSelf()

void vtkPlusAndorVideoSource::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Reimplemented from vtkPlusDevice.

Definition at line 34 of file vtkPlusAndorVideoSource.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusAndorVideoSource::ReadConfiguration ( vtkXMLDataElement * config )

virtual

Read configuration from xml data

Reimplemented from vtkPlusDevice.

Definition at line 63 of file vtkPlusAndorVideoSource.cxx.

◆ ResizeFlatCorrectionImage()

void vtkPlusAndorVideoSource::ResizeFlatCorrectionImage ( int binning )

protected

Resizes flat correction image depeding on the binning

Definition at line 1022 of file vtkPlusAndorVideoSource.cxx.

◆ SafeDownCast()

static vtkPlusAndorVideoSource* vtkPlusAndorVideoSource::SafeDownCast ( vtkObject * o )

static

◆ SetAcquisitionMode()

PlusStatus vtkPlusAndorVideoSource::SetAcquisitionMode ( AcquisitionMode acquisitionMode )

Definition at line 1206 of file vtkPlusAndorVideoSource.cxx.

◆ SetBadPixelCorrectionImage()

PlusStatus vtkPlusAndorVideoSource::SetBadPixelCorrectionImage ( const std::string badPixelFilePath )

Paths to correction images for dead pixels, additive and multiplicative bias.

Definition at line 934 of file vtkPlusAndorVideoSource.cxx.

◆ SetBiasDarkCorrectionImage()

PlusStatus vtkPlusAndorVideoSource::SetBiasDarkCorrectionImage ( const std::string biasDarkFilePath )

Definition at line 961 of file vtkPlusAndorVideoSource.cxx.

◆ SetCameraIntrinsics()

PlusStatus vtkPlusAndorVideoSource::SetCameraIntrinsics ( std::array< double, 9 > intrinsics )

Data for setting undistortion coefficients.

Definition at line 1274 of file vtkPlusAndorVideoSource.cxx.

◆ SetCoolerMode()

PlusStatus vtkPlusAndorVideoSource::SetCoolerMode ( int mode )

Cooler Mode control. When CoolerMode is set on, the cooler will be kept on when the camera is shutdown. This is helpful to reduce the number of cooling cycles the camera undergoes. Power loss to the camera will result in the camera returning to ambient temperature.

Definition at line 1390 of file vtkPlusAndorVideoSource.cxx.

◆ SetCoolerState()

PlusStatus vtkPlusAndorVideoSource::SetCoolerState ( bool coolerState )

Turn the cooler on/off.

Definition at line 1327 of file vtkPlusAndorVideoSource.cxx.

◆ SetCoolTemperature()

PlusStatus vtkPlusAndorVideoSource::SetCoolTemperature ( int coolTemp )

Normal operating temperature (degrees celsius).

Definition at line 1417 of file vtkPlusAndorVideoSource.cxx.

◆ SetCustomFrameFields()

void vtkPlusAndorVideoSource::SetCustomFrameFields ( )

protected

Set some acquisition parameters as per-frame header fields

Definition at line 447 of file vtkPlusAndorVideoSource.cxx.

◆ SetDistortionCoefficients()

PlusStatus vtkPlusAndorVideoSource::SetDistortionCoefficients ( std::array< double, 4 > coefficients )

Definition at line 1289 of file vtkPlusAndorVideoSource.cxx.

◆ SetExposureTime()

PlusStatus vtkPlusAndorVideoSource::SetExposureTime ( float exposureTime )

Frame exposure time, seconds. Sets to the nearest valid value not less than the given value.

Definition at line 1074 of file vtkPlusAndorVideoSource.cxx.

◆ SetFlatCorrectionImage()

PlusStatus vtkPlusAndorVideoSource::SetFlatCorrectionImage ( const std::string flatFilePath )

Definition at line 986 of file vtkPlusAndorVideoSource.cxx.

◆ SetFrameFieldImageToReferenceTransform()

PlusStatus vtkPlusAndorVideoSource::SetFrameFieldImageToReferenceTransform ( std::array< float, 16 > transform )

Definition at line 476 of file vtkPlusAndorVideoSource.cxx.

◆ SetHorizontalBins()

PlusStatus vtkPlusAndorVideoSource::SetHorizontalBins ( int bins )

Horizontal and vertical binning. Allowed values: 1, 2, 4, 8.

Definition at line 1088 of file vtkPlusAndorVideoSource.cxx.

◆ SetHSSpeed()

PlusStatus vtkPlusAndorVideoSource::SetHSSpeed	(	int	type,
		int	index
	)

Set horizontal shift speed.

Definition at line 1118 of file vtkPlusAndorVideoSource.cxx.

◆ SetInitializeCoolerState()

PlusStatus vtkPlusAndorVideoSource::SetInitializeCoolerState ( bool InitializeCoolerState )

protected

Setting to true means cooler turns on at startup. Setting to false means cooler state doesn't change on start. Therefore use false if your previous session was set to maintain temperature on ShutDown.

Definition at line 1317 of file vtkPlusAndorVideoSource.cxx.

◆ SetPreAmpGainIndex()

PlusStatus vtkPlusAndorVideoSource::SetPreAmpGainIndex ( int preAmpGainIndex )

Index of the pre-amp gain, not the actual value.

Definition at line 1175 of file vtkPlusAndorVideoSource.cxx.

◆ SetReadMode()

PlusStatus vtkPlusAndorVideoSource::SetReadMode ( ReadMode setReadMode )

Definition at line 1220 of file vtkPlusAndorVideoSource.cxx.

◆ SetRequireCoolTemp()

PlusStatus vtkPlusAndorVideoSource::SetRequireCoolTemp ( bool RequireCoolTemp )

Dev flag whether to require the Camera to be at the Cool Temperature to acquire frames. It can be set to false to acquire frames even though not at the cool temperature.

Definition at line 1304 of file vtkPlusAndorVideoSource.cxx.

◆ SetSafeTemperature()

PlusStatus vtkPlusAndorVideoSource::SetSafeTemperature ( int safeTemp )

Lowest temperature at which it is safe to shut down the camera.

Definition at line 1437 of file vtkPlusAndorVideoSource.cxx.

◆ SetShutter()

PlusStatus vtkPlusAndorVideoSource::SetShutter ( ShutterMode shutter )

Definition at line 1034 of file vtkPlusAndorVideoSource.cxx.

◆ SetShutterClosingTimeMilliseconds()

PlusStatus vtkPlusAndorVideoSource::SetShutterClosingTimeMilliseconds ( int closingTime )

Definition at line 1042 of file vtkPlusAndorVideoSource.cxx.

◆ SetShutterOpeningTimeMilliseconds()

PlusStatus vtkPlusAndorVideoSource::SetShutterOpeningTimeMilliseconds ( int openingTime )

Definition at line 1055 of file vtkPlusAndorVideoSource.cxx.

◆ SetTriggerMode()

PlusStatus vtkPlusAndorVideoSource::SetTriggerMode ( TriggerMode triggerMode )

Definition at line 1234 of file vtkPlusAndorVideoSource.cxx.

◆ SetUseCosmicRayCorrection()

PlusStatus vtkPlusAndorVideoSource::SetUseCosmicRayCorrection ( bool UseCosmicRayCorrection )

Flag whether to call ApplyCosmicRayCorrection of BLI acquisitions or not.

Definition at line 1261 of file vtkPlusAndorVideoSource.cxx.

◆ SetUseFrameCorrections()

PlusStatus vtkPlusAndorVideoSource::SetUseFrameCorrections ( bool UseFrameCorrections )

protected

Flag whether to call ApplyFrameCorrections on the raw acquired frame on acquisition or to skip frame corrections.

Definition at line 1248 of file vtkPlusAndorVideoSource.cxx.

◆ SetVerticalBins()

PlusStatus vtkPlusAndorVideoSource::SetVerticalBins ( int bins )

Definition at line 1103 of file vtkPlusAndorVideoSource.cxx.

◆ SetVSSpeedIndex()

PlusStatus vtkPlusAndorVideoSource::SetVSSpeedIndex ( int index )

Set index to use in the vertical shift speed table.

Definition at line 1144 of file vtkPlusAndorVideoSource.cxx.

◆ StartBLIFrameAcquisition()

PlusStatus vtkPlusAndorVideoSource::StartBLIFrameAcquisition	(	int	binning,
		int	vsSpeed,
		int	hsSpeed,
		float	exposureTime,
		int	shutterCloseTime = `0`,
		int	shutterOpenTime = `0`
	)

-1 uses currently active settings.

Definition at line 769 of file vtkPlusAndorVideoSource.cxx.

◆ StartCorrectionFrameAcquisition()

PlusStatus vtkPlusAndorVideoSource::StartCorrectionFrameAcquisition	(	std::string	correctionFilePath,
		ShutterMode	shutter,
		int	binning,
		int	vsSpeed,
		int	hsSpeed,
		float	exposureTime,
		int	shutterCloseTime = `0`,
		int	shutterOpenTime = `0`
	)

Convenience function to save a bias frame for a certain binning/speed configuration.

Definition at line 870 of file vtkPlusAndorVideoSource.cxx.

◆ StartGrayscaleFrameAcquisition()

PlusStatus vtkPlusAndorVideoSource::StartGrayscaleFrameAcquisition	(	int	binning,
		int	vsSpeed,
		int	hsSpeed,
		float	exposureTime,
		int	shutterCloseTime = `0`,
		int	shutterOpenTime = `0`
	)

-1 uses currently active settings.

Definition at line 819 of file vtkPlusAndorVideoSource.cxx.

◆ TurnCoolerOFF()

PlusStatus vtkPlusAndorVideoSource::TurnCoolerOFF ( )

protected

Definition at line 1377 of file vtkPlusAndorVideoSource.cxx.

◆ TurnCoolerON()

PlusStatus vtkPlusAndorVideoSource::TurnCoolerON ( )

protected

Definition at line 1363 of file vtkPlusAndorVideoSource.cxx.

◆ WaitForAcquisitionWithTimeout()

bool vtkPlusAndorVideoSource::WaitForAcquisitionWithTimeout	(	double	maximumWaitTimeInSeconds,
		int	sleepQuantumMilliseconds = `10`
	)

Definition at line 1471 of file vtkPlusAndorVideoSource.cxx.

◆ WaitForCooldown()

void vtkPlusAndorVideoSource::WaitForCooldown ( )

Wait for the camera to reach operating temperature (e.g. -70°C).

Definition at line 501 of file vtkPlusAndorVideoSource.cxx.

◆ WaitForWarmup()

void vtkPlusAndorVideoSource::WaitForWarmup ( )

Wait for the camera to reach safe temperature for poweroff (e.g. -20°C). From Andor Employee: Only Classic, ICCD and cameras with a fibre attached must have their cooling and warming up controlled at a particular rate. For everything else you can just call ShutDown and the camera will safely return to room temperature. Classic systems are cameras that use our original PCI controller cards eg CCI-010 or CCI-001.

Definition at line 520 of file vtkPlusAndorVideoSource.cxx.

◆ WriteConfiguration()

PlusStatus vtkPlusAndorVideoSource::WriteConfiguration ( vtkXMLDataElement * config )

virtual

Write configuration to xml data

Reimplemented from vtkPlusDevice.

Definition at line 159 of file vtkPlusAndorVideoSource.cxx.

Member Data Documentation

◆ badPixelCorrection

std::string vtkPlusAndorVideoSource::badPixelCorrection

protected

Definition at line 391 of file vtkPlusAndorVideoSource.h.

◆ biasDarkCorrection

std::string vtkPlusAndorVideoSource::biasDarkCorrection

protected

Definition at line 393 of file vtkPlusAndorVideoSource.h.

◆ BLICorrected

DataSourceArray vtkPlusAndorVideoSource::BLICorrected

protected

Definition at line 397 of file vtkPlusAndorVideoSource.h.

◆ BLIRaw

DataSourceArray vtkPlusAndorVideoSource::BLIRaw

protected

Definition at line 396 of file vtkPlusAndorVideoSource.h.

◆ cameraIntrinsics

double vtkPlusAndorVideoSource::cameraIntrinsics[9] = { 0 }

protected

Definition at line 389 of file vtkPlusAndorVideoSource.h.

◆ CoolerMode

int vtkPlusAndorVideoSource::CoolerMode = 0

protected

Temperatures are in °C (degrees Celsius)

Definition at line 377 of file vtkPlusAndorVideoSource.h.

◆ CoolTemperature

int vtkPlusAndorVideoSource::CoolTemperature = -50

protected

Definition at line 378 of file vtkPlusAndorVideoSource.h.

◆ CurrentTemperature

float vtkPlusAndorVideoSource::CurrentTemperature = 0.123456789

protected

Definition at line 380 of file vtkPlusAndorVideoSource.h.

◆ currentTime

double vtkPlusAndorVideoSource::currentTime = UNDEFINED_TIMESTAMP

protected

Definition at line 384 of file vtkPlusAndorVideoSource.h.

◆ CustomFields

igsioFieldMapType vtkPlusAndorVideoSource::CustomFields

protected

Definition at line 407 of file vtkPlusAndorVideoSource.h.

◆ distortionCoefficients

double vtkPlusAndorVideoSource::distortionCoefficients[4] = { 0 }

protected

Definition at line 390 of file vtkPlusAndorVideoSource.h.

◆ effectiveExpTime

float vtkPlusAndorVideoSource::effectiveExpTime = 1.0

protected

Acquisition parameters used in the acquisition thread.

Definition at line 356 of file vtkPlusAndorVideoSource.h.

◆ effectiveHBins

int vtkPlusAndorVideoSource::effectiveHBins = 1

protected

Definition at line 357 of file vtkPlusAndorVideoSource.h.

◆ effectiveHSInd

int vtkPlusAndorVideoSource::effectiveHSInd = 1

protected

Definition at line 359 of file vtkPlusAndorVideoSource.h.

◆ effectiveShutter

vtkPlusAndorVideoSource::ShutterMode vtkPlusAndorVideoSource::effectiveShutter = ShutterMode::FullyAuto

protected

Definition at line 361 of file vtkPlusAndorVideoSource.h.

◆ effectiveShutterClosingTimeMilliseconds

int vtkPlusAndorVideoSource::effectiveShutterClosingTimeMilliseconds = 0

protected

Definition at line 363 of file vtkPlusAndorVideoSource.h.

◆ effectiveShutterOpeningTimeMilliseconds

int vtkPlusAndorVideoSource::effectiveShutterOpeningTimeMilliseconds = 0

protected

Definition at line 362 of file vtkPlusAndorVideoSource.h.

◆ effectiveVBins

int vtkPlusAndorVideoSource::effectiveVBins = 1

protected

Definition at line 358 of file vtkPlusAndorVideoSource.h.

◆ effectiveVSInd

int vtkPlusAndorVideoSource::effectiveVSInd = 1

protected

Definition at line 360 of file vtkPlusAndorVideoSource.h.

◆ ExposureTime

float vtkPlusAndorVideoSource::ExposureTime = 1.0

protected

Definition at line 346 of file vtkPlusAndorVideoSource.h.

◆ flatCorrection

std::string vtkPlusAndorVideoSource::flatCorrection

protected

Definition at line 392 of file vtkPlusAndorVideoSource.h.

◆ frameSize

FrameSizeType vtkPlusAndorVideoSource::frameSize = {1024, 1024, 1}

protected

Definition at line 382 of file vtkPlusAndorVideoSource.h.

◆ GrayCorrected

DataSourceArray vtkPlusAndorVideoSource::GrayCorrected

protected

Definition at line 399 of file vtkPlusAndorVideoSource.h.

◆ GrayRaw

DataSourceArray vtkPlusAndorVideoSource::GrayRaw

protected

Definition at line 398 of file vtkPlusAndorVideoSource.h.

◆ HorizontalBins

int vtkPlusAndorVideoSource::HorizontalBins = 1

protected

Definition at line 347 of file vtkPlusAndorVideoSource.h.

◆ HSSpeed

int vtkPlusAndorVideoSource::HSSpeed[2] = { 0, 1 }

protected

Definition at line 349 of file vtkPlusAndorVideoSource.h.

◆ imageToReferenceTransform

std::array<float, 16> vtkPlusAndorVideoSource::imageToReferenceTransform = { 0 }

protected

Frame field for image transform. Since applications of this device are mainly stationary, don't use a tracker and just set the transform manually.

Definition at line 405 of file vtkPlusAndorVideoSource.h.

◆ InitializeCoolerState

bool vtkPlusAndorVideoSource::InitializeCoolerState = true

protected

Definition at line 332 of file vtkPlusAndorVideoSource.h.

◆ m_AcquisitionMode

AcquisitionMode vtkPlusAndorVideoSource::m_AcquisitionMode = AcquisitionMode::SingleScan

protected

From AndorSDK:=> 1: Single Scan 2: Accumulate 3: Kinetics 4: Fast Kinetics 5: Run till abort

Definition at line 368 of file vtkPlusAndorVideoSource.h.

◆ m_ReadMode

ReadMode vtkPlusAndorVideoSource::m_ReadMode = ReadMode::Image

protected

From AndorSDK:=> 0: Full Vertical Binning 1: Multi-Track 2: Random-Track 3: Single-Track 4: Image

Definition at line 371 of file vtkPlusAndorVideoSource.h.

◆ m_TriggerMode

TriggerMode vtkPlusAndorVideoSource::m_TriggerMode = TriggerMode::Internal

protected

From AndorSDK:=> 0. Internal 1. External 6. External Start 7. External Exposure(Bulb) 9. External FVB EM(only valid for EM Newton models in FVB mode) 10. Software Trigger 12. External Charge Shifting

Definition at line 374 of file vtkPlusAndorVideoSource.h.

◆ OutputSpacing

double vtkPlusAndorVideoSource::OutputSpacing[3] = { 0 }

protected

Definition at line 401 of file vtkPlusAndorVideoSource.h.

◆ PreAmpGainIndex

int vtkPlusAndorVideoSource::PreAmpGainIndex = 0

protected

Definition at line 351 of file vtkPlusAndorVideoSource.h.

◆ rawFrame

std::vector<uint16_t> vtkPlusAndorVideoSource::rawFrame

protected

Definition at line 383 of file vtkPlusAndorVideoSource.h.

◆ RequireCoolTemp

bool vtkPlusAndorVideoSource::RequireCoolTemp = true

protected

Dev flag whether to require the Camera to be at the Cool Temperature to acquire frames. It can be set to false to acquire frames even though not at the cool temperature.

Definition at line 337 of file vtkPlusAndorVideoSource.h.

◆ SafeTemperature

int vtkPlusAndorVideoSource::SafeTemperature = 5

protected

Definition at line 379 of file vtkPlusAndorVideoSource.h.

◆ saveCorrectionPath

std::string vtkPlusAndorVideoSource::saveCorrectionPath

protected

Definition at line 394 of file vtkPlusAndorVideoSource.h.

◆ Shutter

vtkPlusAndorVideoSource::ShutterMode vtkPlusAndorVideoSource::Shutter = ShutterMode::FullyAuto

protected

Internal variables.

Definition at line 343 of file vtkPlusAndorVideoSource.h.

◆ ShutterClosingTimeMilliseconds

int vtkPlusAndorVideoSource::ShutterClosingTimeMilliseconds = 0

protected

Definition at line 345 of file vtkPlusAndorVideoSource.h.

◆ ShutterOpeningTimeMilliseconds

int vtkPlusAndorVideoSource::ShutterOpeningTimeMilliseconds = 0

protected

Definition at line 344 of file vtkPlusAndorVideoSource.h.

◆ Threader

vtkMultiThreader* vtkPlusAndorVideoSource::Threader = vtkMultiThreader::New()

protected

Use a separate thread for acquisition tasks.

Definition at line 410 of file vtkPlusAndorVideoSource.h.

◆ threadID

int vtkPlusAndorVideoSource::threadID = -1

protected

Definition at line 411 of file vtkPlusAndorVideoSource.h.

◆ UseCosmicRayCorrection

bool vtkPlusAndorVideoSource::UseCosmicRayCorrection = true

protected

Definition at line 353 of file vtkPlusAndorVideoSource.h.

◆ UseFrameCorrections

bool vtkPlusAndorVideoSource::UseFrameCorrections = true

protected

Definition at line 352 of file vtkPlusAndorVideoSource.h.

◆ VerticalBins

int vtkPlusAndorVideoSource::VerticalBins = 1

protected

Definition at line 348 of file vtkPlusAndorVideoSource.h.

◆ VSSpeedIndex

int vtkPlusAndorVideoSource::VSSpeedIndex = 0

protected

Definition at line 350 of file vtkPlusAndorVideoSource.h.

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

src/PlusDataCollection/Andor/vtkPlusAndorVideoSource.h
src/PlusDataCollection/Andor/vtkPlusAndorVideoSource.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DataSourceArray

◆ Superclass

Member Enumeration Documentation

◆ AcquisitionMode

◆ ReadMode

◆ ShutterMode

◆ TriggerMode

Constructor & Destructor Documentation

◆ vtkPlusAndorVideoSource() [1/2]

◆ vtkPlusAndorVideoSource() [2/2]

◆ ~vtkPlusAndorVideoSource()

Member Function Documentation

◆ AbortAcquisition()

◆ AcquireBLIFrameThread()

◆ AcquireCorrectionFrameThread()

◆ AcquireFrame()

◆ AcquireGrayscaleFrameThread()

◆ AddFrameToDataSource()

◆ AdjustBuffers()

◆ AdjustSpacing()

◆ ApplyCosmicRayCorrection()

◆ ApplyFrameCorrections()

◆ checkStatus()

◆ CorrectBadPixels()

◆ FindBadCells()

◆ GetAcquisitionMode()

◆ GetBadPixelCorrectionImage()

◆ GetBiasDarkCorrectionImage()

◆ GetCameraIntrinsics()

◆ GetCCDStatus()

◆ GetClassName()

◆ GetCoolerMode()

◆ GetCoolTemperature()

◆ GetCurrentTemperature()

◆ GetDistortionCoefficients()

◆ GetExposureTime()

◆ GetFlatCorrectionImage()

◆ GetHSSpeed()

◆ GetPreAmpGain()

◆ GetPreAmpGainIndex()

◆ GetReadMode()

◆ GetRequireCoolTemp()

◆ GetSafeTemperature()

◆ GetSdkVersion()

◆ GetShutter()

◆ GetSpacing()

◆ GetTriggerMode()

◆ GetUseCosmicRayCorrection()

◆ GetUseFrameCorrections()

◆ GetVSSpeed()

◆ GetVSSpeedIndex()

◆ InitializeAndorCamera()

◆ InitializePort()

◆ InternalConnect()

◆ InternalDisconnect()

◆ InternalStartRecording()

◆ InternalStopRecording()

◆ InternalUpdate()

◆ IsA()

◆ IsAcquisitionThreadRunning()

◆ IsCCDAcquiring()

◆ IsCoolerOn()

◆ IsTracker()

◆ IsTypeOf()

◆ New()

◆ NotifyConfigured()

◆ operator=()

◆ PrepareAcquisition()

◆ PrintSelf()

◆ ReadConfiguration()