DESY ACOP Beans Home

de.desy.acop.video.displayer
Class VideoHeaderV3

java.lang.Object
  de.desy.acop.video.displayer.VideoHeaderV3

All Implemented Interfaces:

java.lang.Cloneable

Deprecated. functionality replaced by IMAGE class, not needed use directly IMAGE instead

public final class VideoHeaderV3
extends java.lang.Object
implements java.lang.Cloneable

VideoHeaderV3 implements reference caching of a Video System v3 (VSv3) data array known as TINE IMAGE datatype for usage with the rest of Video System v3 Java code.
It contains useful helper functions to decode certain properties of VSv3 header into human-readable format.

Note:This class is only a very basic construct and might be substantially changed in future. It fits its purpose currently but will not win a price for meaningful class design!

Author:

sweisse, mdavid

Field Summary

static int	CF_IMAGE_INITIAL_VERSION Deprecated. use de.desy.tine.types.IMAGE#IMAGE_INITIAL_VERSION instead
static int	CF_IMAGE_MAGIC_01 Deprecated. use de.desy.tine.types.IMAGE#DEFAULT_BASE_TAG instead
static int	CF_IMAGE_MAX_VERSION Deprecated. use de.desy.tine.types.IMAGE#IMAGE_MAX_VERSION instead
static int	CF_IMAGE_NO_CAMERA_PORT_ID Deprecated. use de.desy.tine.types.IMAGE#DEFAULT_CAMERA_PORT_ID instead
static int	CF_IMAGE_VERSION Deprecated. use de.desy.tine.types.IMAGE#IMAGE_VERSION instead
de.desy.tine.types.IMAGE.FrameHeader	frameHeader Deprecated. referenced frameHeader of private TINE IMAGE
static int	HDRSIZE Deprecated. use IMAGE.HEADER_SIZE instead
de.desy.tine.types.IMAGE.SourceHeader	sourceHeader Deprecated. referenced sourceHeader of private TINE IMAGE
static int	TRANSPORT_LENGTH_V3 Deprecated. use IMAGE.DEFAULT_DATA_SIZE instead

Constructor Summary

VideoHeaderV3(de.desy.tine.types.IMAGE img)
Deprecated. The new instance of the class will be a reference to the passed image data.

Method Summary

VideoHeaderV3	clone() Deprecated. mdavid: moved from ImageDisplayer class mdavid: removed first argument (source video image) clones (1:1 copy) a video frame header and bits.
int	getAppendedHeight() Deprecated. in order to get the real height of the image bits appended this function must be used.
int	getAppendedWidth() Deprecated. in order to get the real width of the image bits appended this function must be used.
de.desy.tine.types.IMAGE	getImage() Deprecated. returns the image reference currently cached in class.
java.util.Date	getTimestampAsDate() Deprecated. decodes timestamp of video frame into java Date class

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

frameHeader

public de.desy.tine.types.IMAGE.FrameHeader frameHeader

Deprecated.

referenced frameHeader of private TINE IMAGE

sourceHeader

public de.desy.tine.types.IMAGE.SourceHeader sourceHeader

Deprecated.

referenced sourceHeader of private TINE IMAGE

HDRSIZE

public static final int HDRSIZE

Deprecated. use IMAGE.HEADER_SIZE instead

size in bytes of a VSv3 header on transport level

See Also:

Constant Field Values

TRANSPORT_LENGTH_V3

public static final int TRANSPORT_LENGTH_V3

Deprecated. use IMAGE.DEFAULT_DATA_SIZE instead

maximum size in bytes of a VSv3 image (without header)

See Also:

Constant Field Values

CF_IMAGE_MAGIC_01

public static final int CF_IMAGE_MAGIC_01

Deprecated. use de.desy.tine.types.IMAGE#DEFAULT_BASE_TAG instead

first magic id for VSv3 'VSV3'

See Also:

Constant Field Values

CF_IMAGE_NO_CAMERA_PORT_ID

public static final int CF_IMAGE_NO_CAMERA_PORT_ID

Deprecated. use de.desy.tine.types.IMAGE#DEFAULT_CAMERA_PORT_ID instead

cameraPortId is put to if no camera port is set there

See Also:

Constant Field Values

CF_IMAGE_INITIAL_VERSION

public static final int CF_IMAGE_INITIAL_VERSION

Deprecated. use de.desy.tine.types.IMAGE#IMAGE_INITIAL_VERSION instead

initial IMAGE version

See Also:

Constant Field Values

CF_IMAGE_VERSION

public static final int CF_IMAGE_VERSION

Deprecated. use de.desy.tine.types.IMAGE#IMAGE_VERSION instead

current IMAGE version

See Also:

Constant Field Values

CF_IMAGE_MAX_VERSION

public static final int CF_IMAGE_MAX_VERSION

Deprecated. use de.desy.tine.types.IMAGE#IMAGE_MAX_VERSION instead

maximum IMAGE version

See Also:

Constant Field Values

Constructor Detail

VideoHeaderV3

public VideoHeaderV3(de.desy.tine.types.IMAGE img)

Deprecated.

The new instance of the class will be a reference to the passed image data.

Parameters:

img - image data to wrap inside this class

Method Detail

getImage

public de.desy.tine.types.IMAGE getImage()

Deprecated.

returns the image reference currently cached in class.

Returns:

image reference currently cached in class

getTimestampAsDate

public final java.util.Date getTimestampAsDate()

Deprecated.

decodes timestamp of video frame into java Date class

Returns:

date representation of sourceHeader.timestamp(Seconds+Microseconds)

getAppendedWidth

public int getAppendedWidth()

Deprecated.

in order to get the real width of the image bits appended this function must be used. In case if the area of interest is set, one can not directly look at sourceWidth because aoiWidth depict the height of the appended image in such case

Returns:

the width in pixels of the appended image data bits

getAppendedHeight

public int getAppendedHeight()

Deprecated.

in order to get the real height of the image bits appended this function must be used. In case if the area of interest is set, one can not directly look at sourceHeight because aoiHeight depict the height of the appended image in such case

Returns:

the height in pixels of the appended image data bits

clone

public VideoHeaderV3 clone()

Deprecated.

mdavid: moved from ImageDisplayer class mdavid: removed first argument (source video image) clones (1:1 copy) a video frame header and bits. It is used to have an unchanged video header for meta information printing and a changed header and bits for displaying later on.

Overrides:

clone in class java.lang.Object

Returns:

cloned VideoHeaderV3 object