org.lsst.ccs.utilities.ccd

Class Segment

java.lang.Object

org.lsst.ccs.geometry.Geometry

org.lsst.ccs.utilities.ccd.Segment

All Implemented Interfaces:

ImageSensitiveArea, RawImageDataProvider, SegmentInterface

public class Segment
extends Geometry
implements RawImageDataProvider, ImageSensitiveArea, SegmentInterface

An class to represent a CCD Segment.

Author:

turri

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Segment.SegmentReadOutPoint The Segment readout point with respect to the serial and parallel direction.

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.geometry.Geometry

parallelChildrenCount, serialChildrenCount

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

listeners

Method Summary

Modifier and Type	Method and Description
static Segment	createCCDSegment(CCDType ccdType, String label, int serialPosition, int parallelPosition, int channel) Utility function to create CCDSegments by type.
void	exposeToImage(ImagePixelData imagePixelData) Expose the current object to the ImagePixelData.
int	getChannel() Get the Channel number for this Segment
ImagePixelData	getImagePixelData() Get the ImagePixelData for this object, if present.
int	getParallelPosition() Get the parallel position of this Segment in the CCD.
CCDInterface	getParentCCD() Get the parent CCDInterface this segment belongs to
RawImageData	getRawImageData() Get the buffer of image data accumulated by this Segment.
int	getSegmentParallelActiveSize() Get the Segment parallel active size.
int	getSegmentParallelOverscanSize() Get the Segment parallel overscan size.
Segment.SegmentReadOutPoint	getSegmentReadOutPoint()
int	getSegmentSerialActiveSize() Get the Segment serial active size.
int	getSegmentSerialOverscanSize() Get the Segment serial overscan size.
int	getSegmentSerialPrescanSize() Get the Segment serial prescan size.
int	getSegmentTotalParallelSize() Get the Segment total parallel size: overscan and active size.
int	getSegmentTotalSerialSize() Get the Segment total serial size: prescan, overscan and active size.
int	getSerialPosition() Get the serial position of this Segment in the CCD.
boolean	hasPixelData() Check if this object has data.
boolean	isReadoutDown() Is this segment read down in the parallel direction.
boolean	isReadoutLeft() Is this segment read left in the parallel direction.
protected void	setExpandedView(boolean expandedView)

Methods inherited from class org.lsst.ccs.geometry.Geometry

addChildGeometry, addGeometry, addGeometryToGrid, convertToExpandedView, findGeometry, getAbsolutePoint, getChild, getChildrenList, getChildrenWithAbsoluteCoordinates, getDimension, getGeometryAbsolutePosition, getGeometryPoint, getHeight, getName, getNumberOfChildren, getParallelChildrenCount, getParent, getSerialChildrenCount, getUniqueId, getWidth, hasChildren, hasParent, setDimension, setParent

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

setExpandedView

protected void setExpandedView(boolean expandedView)

Overrides:

setExpandedView in class Geometry

getChannel

public int getChannel()

Description copied from interface: SegmentInterface

Get the Channel number for this Segment

Specified by:

getChannel in interface SegmentInterface

Returns:

the Channel number

getParallelPosition

public int getParallelPosition()

Description copied from interface: SegmentInterface

Get the parallel position of this Segment in the CCD.

Specified by:

getParallelPosition in interface SegmentInterface

Overrides:

getParallelPosition in class Geometry

Returns:

the parallel position.

getSerialPosition

public int getSerialPosition()

Description copied from interface: SegmentInterface

Get the serial position of this Segment in the CCD.

Specified by:

getSerialPosition in interface SegmentInterface

Overrides:

getSerialPosition in class Geometry

Returns:

the serial position.

getSegmentReadOutPoint

public Segment.SegmentReadOutPoint getSegmentReadOutPoint()

getSegmentSerialPrescanSize

public int getSegmentSerialPrescanSize()

Description copied from interface: SegmentInterface

Get the Segment serial prescan size.

Specified by:

getSegmentSerialPrescanSize in interface SegmentInterface

Returns:

The Segment serial prescan size.

getSegmentSerialOverscanSize

public int getSegmentSerialOverscanSize()

Description copied from interface: SegmentInterface

Get the Segment serial overscan size.

Specified by:

getSegmentSerialOverscanSize in interface SegmentInterface

Returns:

The Segment serial overscan size.

getSegmentParallelOverscanSize

public int getSegmentParallelOverscanSize()

Description copied from interface: SegmentInterface

Get the Segment parallel overscan size.

Specified by:

getSegmentParallelOverscanSize in interface SegmentInterface

Returns:

The Segment parallel overscan size.

getSegmentSerialActiveSize

public int getSegmentSerialActiveSize()

Description copied from interface: SegmentInterface

Get the Segment serial active size.

Specified by:

getSegmentSerialActiveSize in interface SegmentInterface

Returns:

The Segment serial active size.

getSegmentParallelActiveSize

public int getSegmentParallelActiveSize()

Description copied from interface: SegmentInterface

Get the Segment parallel active size.

Specified by:

getSegmentParallelActiveSize in interface SegmentInterface

Returns:

The Segment parallel active size.

getSegmentTotalSerialSize

public int getSegmentTotalSerialSize()

Description copied from interface: SegmentInterface

Get the Segment total serial size: prescan, overscan and active size.

Specified by:

getSegmentTotalSerialSize in interface SegmentInterface

Returns:

The Segment total serial size.

getSegmentTotalParallelSize

public int getSegmentTotalParallelSize()

Description copied from interface: SegmentInterface

Get the Segment total parallel size: overscan and active size.

Specified by:

getSegmentTotalParallelSize in interface SegmentInterface

Returns:

The Segment total parallel size.

isReadoutDown

public boolean isReadoutDown()

Description copied from interface: SegmentInterface

Is this segment read down in the parallel direction.

Specified by:

isReadoutDown in interface SegmentInterface

Returns:

true if the Segment is read down in the parallel direction.

isReadoutLeft

public boolean isReadoutLeft()

Description copied from interface: SegmentInterface

Is this segment read left in the parallel direction.

Specified by:

isReadoutLeft in interface SegmentInterface

Returns:

true if the Segment is read left in the parallel direction.

getParentCCD

public CCDInterface getParentCCD()

Description copied from interface: SegmentInterface

Get the parent CCDInterface this segment belongs to

Specified by:

getParentCCD in interface SegmentInterface

Returns:

The parent of this segment.

getRawImageData

public RawImageData getRawImageData()

Get the buffer of image data accumulated by this Segment.

Specified by:

getRawImageData in interface RawImageDataProvider

Returns:

The ByteBuffer with the data;

createCCDSegment

public static Segment createCCDSegment(CCDType ccdType,
                                       String label,
                                       int serialPosition,
                                       int parallelPosition,
                                       int channel)

Utility function to create CCDSegments by type.

Parameters:

ccdType - The type of the CCD.

label - The label of the segment.

Returns:

The Segment for the provided type.

exposeToImage

public void exposeToImage(ImagePixelData imagePixelData)

Description copied from interface: ImageSensitiveArea

Expose the current object to the ImagePixelData.

Specified by:

exposeToImage in interface ImageSensitiveArea

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 accumulated ImagePixelData.