org.lsst.ccs.utilities.ccd

Class Segment

java.lang.Object

org.lsst.ccs.utilities.ccd.Geometry

org.lsst.ccs.utilities.ccd.Segment

All Implemented Interfaces:

RawImageDataProvider, ImageSensitiveArea

public class Segment
extends Geometry
implements RawImageDataProvider, ImageSensitiveArea

An class to represent a CCD Segment. Each Segment is defined by its geometry constants, the parameters for reading it out (prescan and overscans) and the order in which it is read out. A Segment also has a channel number which is used to write the extended headers in fits files. These quantities are as specified in LCA-13501 A Segment implements: - ImageSensitiveArea so that it can be exposed to simulated images - RawImageDataProvider because it is the source of image data TO-DO: Can the Image related interfaces be moved elsewhere? Create a wrapper around Segment?

Author:

The LSST CCS Team

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.utilities.ccd.image.data.RawImageDataProvider

RawImageDataProvider.InnerRawImageDataListener

Field Summary

Fields inherited from class org.lsst.ccs.utilities.ccd.Geometry

name

Fields inherited from interface org.lsst.ccs.utilities.ccd.image.data.RawImageDataProvider

LISTENERS

Method Summary

Modifier and Type	Method and Description
protected void	addGeometryToGrid(Geometry child, int p, int s) This method must be implemented by all classes extending Geometry.
void	exposeToImage(ImagePixelData imagePixelData) Methods required by ImageSensitiveArea.
int	getChannel() The Segment channel number.
ImagePixelData	getImagePixelData() Get the ImagePixelData for this object, if present.
RawImageData	getRawImageData(ReadOutParameters readOutParameters) Get the buffer of image data accumulated by this Segment.
int	getSegmentParallelActiveSize() The Segment active parallel size in pixels.
int	getSegmentSerialActiveSize() The Segment active serial size in pixels.
boolean	hasPixelData() Check if this object has data.
boolean	isReadoutDown() Returns true if the Segment is read from top to bottom in the serial direction.
boolean	isReadoutLeft() Returns true if the Segment is read from left to right in the parallel direction.

Methods inherited from class org.lsst.ccs.utilities.ccd.Geometry

addChildGeometry, addGeometry, findGeometry, findParentOfType, getAbsolutePoint, getChild, getChildrenList, getChildrenWithAbsoluteCoordinates, getGeometryAbsolutePosition, getGeometryPoint, getHeight, getName, getNumberOfChildren, getParallelChildrenCount, getParallelPosition, getParent, getSerialChildrenCount, getSerialPosition, getUniqueId, getWidth, hasChildren, hasParent, replaceExistingGeometry, setParallelPosition, setParent, setSerialPosition

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.utilities.ccd.image.data.RawImageDataProvider

addRawImageDataListener, notifyRawImageDataListeners, removeRawImageDataListener

Method Detail

getChannel

public int getChannel()

The Segment channel number.

Returns:

The Segment channel

getSegmentSerialActiveSize

public int getSegmentSerialActiveSize()

The Segment active serial size in pixels.

Returns:

The Segment active serial size.

getSegmentParallelActiveSize

public int getSegmentParallelActiveSize()

The Segment active parallel size in pixels.

Returns:

The Segment parallel serial size.

isReadoutDown

public boolean isReadoutDown()

Returns true if the Segment is read from top to bottom in the serial direction.

Returns:

true if the segment is read down along the serial direction.

isReadoutLeft

public boolean isReadoutLeft()

Returns true if the Segment is read from left to right in the parallel direction.

Returns:

true if the segment is read from the left along the parallel direction.

addGeometryToGrid

protected void addGeometryToGrid(Geometry child,
                                 int p,
                                 int s)

Description copied from class: Geometry

This method must be implemented by all classes extending Geometry. It should internally convert the (p,s) coordinate for the child to its (x,y) position within this geometry.

Specified by:

addGeometryToGrid in class Geometry

Parameters:

child - The child to be added.

p - The parallel position

s - The serial position.

getRawImageData

public RawImageData getRawImageData(ReadOutParameters readOutParameters)

Get the buffer of image data accumulated by this Segment.

Specified by:

getRawImageData in interface RawImageDataProvider

Parameters:

readOutParameters - The ReadOutParameters for the acquisition.

Returns:

The ByteBuffer with the data;

exposeToImage

public void exposeToImage(ImagePixelData imagePixelData)

Methods required by ImageSensitiveArea.

Specified by:

exposeToImage in interface ImageSensitiveArea

Parameters:

imagePixelData - The ImagePixelData this ImageSensitiveArea is exposed to.

hasPixelData

public boolean hasPixelData()

Description copied from interface: ImageSensitiveArea

Check if this object has data.

Specified by:

hasPixelData in interface ImageSensitiveArea

Returns:

true if there is data.

getImagePixelData

public ImagePixelData getImagePixelData()

Description copied from interface: ImageSensitiveArea

Get the ImagePixelData for this object, if present. Null otherwise.

Specified by:

getImagePixelData in interface ImageSensitiveArea

Returns:

The latest accumulated ImagePixelData.