org.lsst.ccs.daq.ims

Class Image

java.lang.Object

org.lsst.ccs.daq.ims.Image

All Implemented Interfaces:

Comparable<Image>

public class Image
extends Object
implements Comparable<Image>

Image is a reference to an image instance, which may contain multiple Sources. Existing images can be obtained from folders, or by listening for newly created images. New writable images can be created within a folder. Each source within the image corresponds to one REB.

Author:

tonyj

See Also:

Folder.listImages(), Folder.find(java.lang.String), Folder.insert(ImageMetaData), Store.addImageListener(ImageListener)

Method Summary

Modifier and Type	Method and Description
Source	addSource(org.lsst.ccs.utilities.location.Location location, int[] registerValues) Adds a new source to an image.This method will only succeed if the image is writable
int	compareTo(Image o)
void	delete() Deletes the image, This includes deleting its: data buckets metadata buckets Catalog entry
boolean	equals(Object obj)
Source	findSource(org.lsst.ccs.utilities.location.Location location) Find the source corresponding to the given location
ImageMetaData	getMetaData() Get the metadata associated with this image
Store	getStore() Get the store in which this image resides.
int	hashCode()
List<Source>	listSources() List the sources associated with this image.Each source represents the data obtained from a single REB.
void	moveTo(String folderName) Move the image to a different folder
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getMetaData

public ImageMetaData getMetaData()

Get the metadata associated with this image

Returns:

The corresponding metadata

listSources

public List<Source> listSources()
                         throws DAQException

List the sources associated with this image.Each source represents the data obtained from a single REB.

Returns:

The list of sources.

Throws:

DAQException

delete

public void delete()
            throws DAQException

Deletes the image, This includes deleting its:

• data buckets
• metadata buckets
• Catalog entry

Throws:

DAQException - If something goes wrong.

moveTo

public void moveTo(String folderName)
            throws DAQException

Move the image to a different folder

Parameters:

folderName - The folder to move to

Throws:

DAQException - If the image move fails

addSource

public Source addSource(org.lsst.ccs.utilities.location.Location location,
                        int[] registerValues)
                 throws DAQException

Adds a new source to an image.This method will only succeed if the image is writable

Parameters:

location - The location corresponding to the source to be added.

registerValues - The register values (meta-data) to be associated with the new source.

Returns:

The created source

Throws:

DAQException

See Also:

Folder.insert(ImageMetaData)

findSource

public Source findSource(org.lsst.ccs.utilities.location.Location location)

Find the source corresponding to the given location

Parameters:

location - The location to search for

Returns:

The corresponding Source

Throws:

IllegalArgumentException - If the specified source does not exist in this image.

getStore

public Store getStore()

Get the store in which this image resides.

Returns:

The store.

compareTo

public int compareTo(Image o)

Specified by:

compareTo in interface Comparable<Image>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object