Contains basic statistical information. More...

Inheritance diagram for Statistics:

Public Member Functions
synchronized void	delete ()

PropertyI	getAbortedRequestsCount ()
	An integer property (read-only) containing the overall count of image requests which have been aborted since the.

PropertyF	getBandwidthConsumed ()
	A float property (read-only) containing the current bandwidth consumed by this device in KB/s based on the average buffer size and the timestamps delivered from the device driver.

PropertyF	getCaptureTime_s ()
	A float property (read-only) containing the overall time an image request spent in the device drivers processing chain.

PropertyI	getErrorCount ()
	An integer property (read-only) containing the overall count of image requests which returned with an error since the.

PropertyF	getFormatConvertTime_s ()
	An integer property (read-only) containing the time (in seconds) needed to convert the image data delivered by the hardware and/or active internal driver filter nodes to the format specified by mvIMPACT.acquire.ImageDestination.getPixelFormat() internally.

PropertyI	getFrameCount ()
	An integer property (read-only) containing the overall count of images captured since the.

PropertyI	getFramesIncompleteCount ()
	An integer property (read-only) containing the overall count of image requests which haven't been captured completely since the mvIMPACT.acquire.Device has been opened.

PropertyF	getFramesPerSecond ()
	A float property (read-only) containing the current number of frames captured per second.

PropertyF	getImageProcTime_s ()
	An integer property (read-only) containing the time (in seconds) needed to process the image data internally.

PropertyI	getLostImagesCount ()
	An integer property (read-only) containing the number of images that have been lost from a continuous image stream coming from a video signal source.

PropertyF	getMissingDataAverage_pc ()
	A float property (read-only) containing the average amount of data missing in frames that haven't been captured completely since the mvIMPACT.acquire.Device has been opened OR since the last call to mvIMPACT.acquire.Statistics.reset().

PropertyF	getQueueTime_s ()
	A float property (read-only) containing the average time (in seconds) a mvIMPACT.acquire.Request object spends in the request queue of the device.

PropertyI64	getRetransmitCount ()
	A 64 bit integer property (read-only) containing the number of retransmit requests issued due to temporary bus bandwidth shortages or other transmission problems since this mvIMPACT.acquire.Device has been opened OR since the last call to mvIMPACT.acquire.Statistics.reset().

PropertyI	getTimedOutRequestsCount ()
	An integer property (read-only) containing the overall count of image requests which have timed out since the.

int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.

int	reset ()
	Resets all statistical properties.

ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

	Statistics (Device pDev)

Protected Member Functions
void	finalize ()

	Statistics (long cPtr, boolean cMemoryOwn)

Static Protected Member Functions
static long	swigRelease (ComponentCollection obj)

static long	swigRelease (Statistics obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

Contains basic statistical information.

This class contains basic statistical information about the mvIMPACT.acquire.Device and the the current image acquisition progress.

Constructor & Destructor Documentation

◆ Statistics() [1/2]

Statistics	(	long	cPtr,
		boolean	cMemoryOwn )

protected

◆ Statistics() [2/2]

Statistics ( Device pDev )

Member Function Documentation

◆ delete()

synchronized void delete ( )

Reimplemented from ComponentCollection.

◆ finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

◆ getAbortedRequestsCount()

PropertyI getAbortedRequestsCount ( )

An integer property (read-only) containing the overall count of image requests which have been aborted since the.

mvIMPACT.acquire.Device has been opened OR since the last call to mvIMPACT.acquire.Statistics.reset().

◆ getBandwidthConsumed()

PropertyF getBandwidthConsumed ( )

A float property (read-only) containing the current bandwidth consumed by this device in KB/s based on the average buffer size and the timestamps delivered from the device driver.

Since: 2.12.3

◆ getCaptureTime_s()

PropertyF getCaptureTime_s ( )

A float property (read-only) containing the overall time an image request spent in the device drivers processing chain.

This time is NOT the reciprocal of the frame rate, but usually a much longer period of time as it includes the time elapsed from sending the request into the capture queue until the buffer has been placed back into one of the result queues again. This time increases with the amount of requests being used.

◆ getErrorCount()

PropertyI getErrorCount ( )

An integer property (read-only) containing the overall count of image requests which returned with an error since the.

mvIMPACT.acquire.Device has been opened OR since the last call to mvIMPACT.acquire.Statistics.reset().

◆ getFormatConvertTime_s()

PropertyF getFormatConvertTime_s ( )

An integer property (read-only) containing the time (in seconds) needed to convert the image data delivered by the hardware and/or active internal driver filter nodes to the format specified by mvIMPACT.acquire.ImageDestination.getPixelFormat() internally.

This time will be almost 0 when no custom destination pixel format has been specified and if a custom destination format was selected and this format differs from the pixel format that is transferred by the hardware this time will be a part (or all, but never more) than the time reported by mvIMPACT.acquire.Statistics.getImageProcTime_s().

Since: 1.12.58

◆ getFrameCount()

PropertyI getFrameCount ( )

An integer property (read-only) containing the overall count of images captured since the.

mvIMPACT.acquire.Device has been opened OR since the last call to mvIMPACT.acquire.Statistics.reset(). This counter is incremented regardless of the result a request is returned with thus also e.g. if a request did time out, was aborted(e.g. due to a call to mvIMPACT.acquire.FunctionInterface.imageRequestReset or mvIMPACT.acquire.FunctionInterface.acquisitionStop) or the data was not completely captured.

◆ getFramesIncompleteCount()

PropertyI getFramesIncompleteCount ( )

An integer property (read-only) containing the overall count of image requests which haven't been captured completely since the mvIMPACT.acquire.Device has been opened.

This value is a good indicator for bandwidth problems on the device to host connection.

Note: This feature is supported by every device driver. If a device does not seem to support this feature (calling mvIMPACT.acquire.Component.isValid returns false) a driver update will fix this.

◆ getFramesPerSecond()

PropertyF getFramesPerSecond ( )

A float property (read-only) containing the current number of frames captured per second.

This property is calculated from a running average where the current difference between 2 consecutive frames contributes 30 percent to the new value while the remaining 70 percent are used from the previous value to avoid sudden strong fluctuations in case a frame is missing of trigger frequencies are not constant.

This property is reset to 0.0 automatically if the acquisition either has been stopped by calling mvIMPACT.acquire.FunctionInterface.acquisitionStop() or mvIMPACT.acquire.FunctionInterface.imageRequestReset() or the internal request queue has run out of buffers for more than 200 milliseconds.

See also: The Capture Process

◆ getImageProcTime_s()

PropertyF getImageProcTime_s ( )

An integer property (read-only) containing the time (in seconds) needed to process the image data internally.

This time might be interesting e.g. if the image data is transformed into a color image by the driver (e.g. when working with Bayer mosaic cameras) or if any other processing function is applied to the image before it is transferred to the user.

◆ getLostImagesCount()

PropertyI getLostImagesCount ( )

An integer property (read-only) containing the number of images that have been lost from a continuous image stream coming from a video signal source.

Note: For some devices this value is based on an assumption so it's by no means absolutely accurate, but when this value starts to increase this might indicate that a problem is present.

Possible causes (among others) might be:

the capture device or device driver can't cope with the amount of data the video signal source is delivering in the current mode of operation
the capture device or device driver can't transfer all the data to the host PC because of bus bandwidth shortages
the capture device or device driver image request queue ran low because the system is busy doing other things or because of a bug in the application

Note: This feature is supported by every device driver. If a device does not seem to support this feature (calling mvIMPACT.acquire.Component.isValid returns false) a driver update will fix this.

◆ getMissingDataAverage_pc()

PropertyF getMissingDataAverage_pc ( )

A float property (read-only) containing the average amount of data missing in frames that haven't been captured completely since the mvIMPACT.acquire.Device has been opened OR since the last call to mvIMPACT.acquire.Statistics.reset().

This value is a good indicator for bandwidth problems on the device to host connection.

Note: This feature is supported by every device driver. If a device does not seem to support this feature (calling mvIMPACT.acquire.Component.isValid returns false) a driver update will fix this.

◆ getQueueTime_s()

PropertyF getQueueTime_s ( )

A float property (read-only) containing the average time (in seconds) a mvIMPACT.acquire.Request object spends in the request queue of the device.

This is the time between a call to mvIMPACT.acquire.FunctionInterface.imageRequestSingle() and the time the driver actually uses this buffer to capture data into it or to forward it into a kernel driver.

◆ getRetransmitCount()

PropertyI64 getRetransmitCount ( )

A 64 bit integer property (read-only) containing the number of retransmit requests issued due to temporary bus bandwidth shortages or other transmission problems since this mvIMPACT.acquire.Device has been opened OR since the last call to mvIMPACT.acquire.Statistics.reset().

This value can be an indicator for transmission problems because of bad signal quality or bus bandwidth shortages in the system. Ideally this property should stay 0 all the time if the system can cope with the amount of data transferred and the signal quality is good. However it might increase slowly and still every frame will be flawless as the driver internally was able to restore the lost data by re-requesting it from the video signal source again.

Note: This feature is supported by every device driver. If a device does not seem to support this feature (calling mvIMPACT.acquire.Component.isValid returns false) a driver update will fix this.

◆ getTimedOutRequestsCount()

PropertyI getTimedOutRequestsCount ( )

An integer property (read-only) containing the overall count of image requests which have timed out since the.

mvIMPACT.acquire.Device has been opened OR since the last call to mvIMPACT.acquire.Statistics.reset().

◆ hObj()

int hObj ( )

inherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mvIMPACT.acquire.ComponentList.

Returns: A unique identifier for the component referenced by this object.

◆ reset()

int reset ( )

Resets all statistical properties.

Returns

mvIMPACT.acquire.TDMR_ERROR.DMR_NO_ERROR if successful.
A negative error code of type mvIMPACT.acquire.TDMR_ERROR otherwise.

◆ restoreDefault()

ComponentCollection restoreDefault ( )

inherited

Restores the default for every component of this collection.

Calling this function will restore the default value for every component belonging to this collection.

Note: The caller must have the right to modify the component. Otherwise an exception will be thrown.

Returns: A const reference to the component.

◆ swigRelease() [1/2]

static long swigRelease ( ComponentCollection obj )

staticprotectedinherited

◆ swigRelease() [2/2]

static long swigRelease ( Statistics obj )

staticprotected

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn

protectedinherited

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Statistics() [1/2]

◆ Statistics() [2/2]

Member Function Documentation

◆ delete()

◆ finalize()

◆ getAbortedRequestsCount()

◆ getBandwidthConsumed()

◆ getCaptureTime_s()

◆ getErrorCount()

◆ getFormatConvertTime_s()

◆ getFrameCount()

◆ getFramesIncompleteCount()

◆ getFramesPerSecond()

◆ getImageProcTime_s()

◆ getLostImagesCount()

◆ getMissingDataAverage_pc()

◆ getQueueTime_s()

◆ getRetransmitCount()

◆ getTimedOutRequestsCount()

◆ hObj()

◆ reset()

◆ restoreDefault()

◆ swigRelease() [1/2]

◆ swigRelease() [2/2]

Member Data Documentation

◆ swigCMemOwn