org.lsst.ccs.drivers.reb

Class Image

java.lang.Object

org.lsst.ccs.drivers.reb.ImageMetadata

org.lsst.ccs.drivers.reb.Image

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SimulatedImage

public class Image
extends ImageMetadata

Image data

Author:

Owen Saxton

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	interleaved
static int	MAX_CCDS
static int	STATUS_GOOD
static int	STATUS_INCOMPLETE
static int	STATUS_MISSING

Fields inherited from class org.lsst.ccs.drivers.reb.ImageMetadata

address, clientVersion, cluster, element, event, format, length, members, name, numCcds, partition, platform, REB_TYPE_GUIDER, REB_TYPE_SCIENCE, REB_TYPE_WAVEFRONT, registers, schema, sciId, sciVersion, sensorType, serverVersion, stripes, tag, timestamp, version

Constructor Summary

Constructors

Constructor and Description
Image()
Image(long tag, int length, int format, int schema, int version, int address, int cluster, int element, ByteBuffer data)
Image(long tag, int length, int format, int schema, int version, int address, int cluster, int element, long mdata, ImageClient.Impl client)
Image(String name, long timestamp, int length, int address, long sciId, int sensorType, int stripes, int[] registers, int sciVersion, String clientVersion, String serverVersion, long event, int[] members, ByteBuffer data)
Image(String name, long timestamp, int length, int address, long sciId, int sensorType, int stripes, int[] registers, int sciVersion, String clientVersion, String serverVersion, long event, int[] members, long mdata, ImageClient.Impl client)
Image(String name, long timestamp, int length, String partition, int address, long sciId, int sensorType, int numCcds, int stripes, int[] registers, int sciVersion, String clientVersion, String serverVersion, String platform, int[] members, ByteBuffer[] data)
Image(String name, long timestamp, int length, String partition, int address, long sciId, int sensorType, int numCcds, int stripes, int[] registers, int sciVersion, String clientVersion, String serverVersion, String platform, int[] members, ImageClient.Impl client)

Method Summary

Modifier and Type	Method and Description
void	deleteMetadataRef() Deletes the metadata reference.
void	finalize() Performs finalization.
ByteBuffer	getData() Gets the old-style (interleaved) image pixel data.
ByteBuffer	getData(int ccdNum) Gets the new-style (per-CCD) image pixel data.
ImageMetadata	getMetadata() Gets the image metadata.
int	getStatus() Gets the image pixel data status.
boolean	isInterleaved() Gets whether the image pixel data is interleaved.

Methods inherited from class org.lsst.ccs.drivers.reb.ImageMetadata

getAddress, getClientVersion, getCluster, getElement, getEvent, getFormat, getLength, getMembers, getName, getNumCcds, getPartition, getPlatform, getRegisters, getSchema, getSciId, getSciVersion, getSensorType, getServerVersion, getStripes, getTag, getTimestamp, getVersion, toString

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MAX_CCDS

public static final int MAX_CCDS

See Also:

Constant Field Values

STATUS_GOOD

public static final int STATUS_GOOD

See Also:

Constant Field Values

STATUS_MISSING

public static final int STATUS_MISSING

See Also:

Constant Field Values

STATUS_INCOMPLETE

public static final int STATUS_INCOMPLETE

See Also:

Constant Field Values

interleaved

protected boolean interleaved

Constructor Detail

Image

public Image()

Image

public Image(String name,
             long timestamp,
             int length,
             String partition,
             int address,
             long sciId,
             int sensorType,
             int numCcds,
             int stripes,
             int[] registers,
             int sciVersion,
             String clientVersion,
             String serverVersion,
             String platform,
             int[] members,
             ImageClient.Impl client)

Image

public Image(String name,
             long timestamp,
             int length,
             String partition,
             int address,
             long sciId,
             int sensorType,
             int numCcds,
             int stripes,
             int[] registers,
             int sciVersion,
             String clientVersion,
             String serverVersion,
             String platform,
             int[] members,
             ByteBuffer[] data)

Image

public Image(String name,
             long timestamp,
             int length,
             int address,
             long sciId,
             int sensorType,
             int stripes,
             int[] registers,
             int sciVersion,
             String clientVersion,
             String serverVersion,
             long event,
             int[] members,
             long mdata,
             ImageClient.Impl client)

Image

public Image(String name,
             long timestamp,
             int length,
             int address,
             long sciId,
             int sensorType,
             int stripes,
             int[] registers,
             int sciVersion,
             String clientVersion,
             String serverVersion,
             long event,
             int[] members,
             ByteBuffer data)

Image

public Image(long tag,
             int length,
             int format,
             int schema,
             int version,
             int address,
             int cluster,
             int element,
             long mdata,
             ImageClient.Impl client)

Image

public Image(long tag,
             int length,
             int format,
             int schema,
             int version,
             int address,
             int cluster,
             int element,
             ByteBuffer data)

Method Detail

getStatus

public int getStatus()

Gets the image pixel data status.

Returns:

The status code

isInterleaved

public boolean isInterleaved()

Gets whether the image pixel data is interleaved.

Returns:

Whether interleaved

getData

public ByteBuffer getData()

Gets the old-style (interleaved) image pixel data.

Returns:

The image's pixel data if it has been successfully read, or null if it hasn't been. The data returned is a read-only wrapper around the image data to assure the user cannot change the state of the image.

getData

public ByteBuffer getData(int ccdNum)

Gets the new-style (per-CCD) image pixel data.

Parameters:

ccdNum - The CCD number

Returns:

The image's pixel data if it has been successfully read, or null if it hasn't been. The data returned is a read-only wrapper around the image data to assure the user cannot change the state of the image.

getMetadata

public ImageMetadata getMetadata()

Gets the image metadata.

Returns:

The image's metadata

deleteMetadataRef

public void deleteMetadataRef()

Deletes the metadata reference.

finalize

public void finalize()
              throws Throwable

Performs finalization. Allocated non-java memory (in this case the C++ image metadata object) has to be freed.

Overrides:

finalize in class Object

Throws:

Throwable