org.lsst.ccs.daq.ims

Class Source

java.lang.Object

org.lsst.ccs.daq.ims.Source

All Implemented Interfaces:

Comparable<Source>

public class Source
extends Object
implements Comparable<Source>

A reference to a source within an image. Each source represents the data from the set of CCDs connected to a given REB.

Author:

tonyj

See Also:

Image.listSources()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Source.ChannelMode

Method Summary

Modifier and Type	Method and Description
int	compareTo(Source o)
Image	getImage()
org.lsst.ccs.utilities.location.Location	getLocation() Get the location within the focal plane of this source
SourceMetaData	getMetaData() Get meta-data associated with this source
org.lsst.ccs.utilities.location.Location.LocationType	getSourceType() The type of REB this source corresponds to.
ByteChannel	openChannel(Source.ChannelMode mode) Open a channel for reading or writing data to this source.
ByteChannel	openChannel(Store store, Source.ChannelMode mode) Open a channel for reading or writing data to this source.
long	size() The total size of the raw data associated with this source.This may be zero of the source has been newly created and not yet written, or if the source is in the process of being streamed to the DAQ store.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getMetaData

public SourceMetaData getMetaData()
                           throws DAQException

Get meta-data associated with this source

Returns:

The associate metadata.

Throws:

DAQException

getLocation

public org.lsst.ccs.utilities.location.Location getLocation()

Get the location within the focal plane of this source

Returns:

THe location.

size

public long size()
          throws DAQException

The total size of the raw data associated with this source.This may be zero of the source has been newly created and not yet written, or if the source is in the process of being streamed to the DAQ store.

Returns:

The image size, or 0 if the image is not completely written.

Throws:

DAQException

getSourceType

public org.lsst.ccs.utilities.location.Location.LocationType getSourceType()
                                                                    throws DAQException

The type of REB this source corresponds to.

Returns:

The source type.

Throws:

DAQException

getImage

public Image getImage()

openChannel

public ByteChannel openChannel(Source.ChannelMode mode)
                        throws DAQException

Open a channel for reading or writing data to this source.

Parameters:

mode - The mode to open the channel.

Returns:

The created channel.

Throws:

DAQException - If the mode is invalid for the current state of this source, or some other error occurs.

openChannel

public ByteChannel openChannel(Store store,
                               Source.ChannelMode mode)
                        throws DAQException

Open a channel for reading or writing data to this source.

Parameters:

store - The store to be used for read/write operations. For multi-threaded reading-writing there must be one store per channel

mode - The mode to open the channel.

Returns:

The created channel.

Throws:

DAQException - If the mode is invalid for the current state of this source, or some other error occurs.

compareTo

public int compareTo(Source o)

Specified by:

compareTo in interface Comparable<Source>

toString

public String toString()

Overrides:

toString in class Object