org.lsst.ccs.utilities.ccd

Class CCDGeometry

java.lang.Object

org.lsst.ccs.utilities.ccd.CCDGeometry

All Implemented Interfaces:

CCDInterface

public class CCDGeometry
extends Object
implements CCDInterface

Defines the geometry of a CCD. See LCA-10103, in particular the diagram on page 7.

See Also:

LCA-10103

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CCDGeometry.CCDSegment Class representing a single segment (amplifier) within a CCD.
static class	CCDGeometry.ReadoutOrder Define the readout order for a particular amplifier.

Constructor Summary

Constructors

Constructor and Description
CCDGeometry(int segmentRowCount, int segmentColumnCount, int serialActive, int parallelActive, int serialPrescan, int serialOverscan, int parallelOverscan, CCDType type) Create a CCDGeomtry object.

Method Summary

Modifier and Type	Method and Description
void	addSegment(int channel, int row, int column, CCDGeometry.ReadoutOrder readoutOrder) Used when constructing the geometry to add segments (amplifiers) to the geometry.
int	getActiveParallelSize() The active parallel size of this CCD.
int	getActiveSerialSize() The active serial size of this CCD.
int	getParallelActiveCount()
int	getParallelOverscanCount()
int	getParallelSegmentCount() Get the number of segments in the Parallel direction
CCDGeometry	getROIGeometry(int rows, int cols, int overRows, int overCols)
SegmentInterface	getSegment(int row, int column) Get the CCDSegment corresponding to the given row and column
List<SegmentInterface>	getSegments() The list of segments in readout order.
int	getSerialActiveCount()
int	getSerialOverscanCount()
int	getSerialPrescanCount()
int	getSerialSegmentCount() Get the number of segments in the Serial direction
int	getTotalParallelCount() Total parallel pixels per segment.
int	getTotalParallelSize() The total parallel size of this CCD.
int	getTotalSerialCount() Total serial pixels per segment.
int	getTotalSerialSize() The total serial size of this CCD.
CCDType	getType() Get the CCDTye for this CCD.

Methods inherited from class java.lang.Object

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

Constructor Detail

CCDGeometry

public CCDGeometry(int segmentRowCount,
                   int segmentColumnCount,
                   int serialActive,
                   int parallelActive,
                   int serialPrescan,
                   int serialOverscan,
                   int parallelOverscan,
                   CCDType type)

Create a CCDGeomtry object. To create geometry objects for standard CCD types see the CCDType class.

Parameters:

segmentRowCount - The number of segments in the horizonal (serial) direction

segmentColumnCount - The number of segments in the vertical (parallel) direction

serialActive - The number of active pixels in the serial direction

parallelActive - The number active pixels in the parallel direction

serialPrescan - The number of serial prescan pixels for each segment.

serialOverscan - The number of overscan pixels in the serial direction

parallelOverscan - The number of overscan pixels in the parallel direction

Method Detail

getROIGeometry

public CCDGeometry getROIGeometry(int rows,
                                  int cols,
                                  int overRows,
                                  int overCols)

getSerialPrescanCount

public int getSerialPrescanCount()

getParallelActiveCount

public int getParallelActiveCount()

getSerialActiveCount

public int getSerialActiveCount()

getSerialOverscanCount

public int getSerialOverscanCount()

getParallelOverscanCount

public int getParallelOverscanCount()

getTotalSerialCount

public int getTotalSerialCount()

Total serial pixels per segment.

Returns:

The total number of active+prescan+overscan pixels in the serial direction.

getTotalParallelCount

public int getTotalParallelCount()

Total parallel pixels per segment.

Returns:

The total number of active+overscan pixels in the parallel direction.

getTotalSerialSize

public int getTotalSerialSize()

Description copied from interface: CCDInterface

The total serial size of this CCD. This takes into account the exposed part of a CCD and the over and pre scan regions.

Specified by:

getTotalSerialSize in interface CCDInterface

Returns:

The total serial size of this CCD.

getActiveSerialSize

public int getActiveSerialSize()

Description copied from interface: CCDInterface

The active serial size of this CCD. This takes into account only the exposed part of a CCD and does not account for the over and pre scan regions.

Specified by:

getActiveSerialSize in interface CCDInterface

Returns:

The overall serial active size of this CCD.

getTotalParallelSize

public int getTotalParallelSize()

Description copied from interface: CCDInterface

The total parallel size of this CCD. This takes into account the exposed size of the CCD and the over scan regions.

Specified by:

getTotalParallelSize in interface CCDInterface

Returns:

The total parallel size of this CCD.

getActiveParallelSize

public int getActiveParallelSize()

Description copied from interface: CCDInterface

The active parallel size of this CCD. This takes into account only the exposed part of a CCD and does not account for the over scan region.

Specified by:

getActiveParallelSize in interface CCDInterface

Returns:

The overall parallel active size of this CCD.

getType

public CCDType getType()

Description copied from interface: CCDInterface

Get the CCDTye for this CCD.

Specified by:

getType in interface CCDInterface

Returns:

The CCDType

getSegment

public SegmentInterface getSegment(int row,
                                   int column)

Get the CCDSegment corresponding to the given row and column

Specified by:

getSegment in interface CCDInterface

Parameters:

row - The input row

column - The input column

Returns:

The CCDSegment and the specified row and column.

getSegments

public List<SegmentInterface> getSegments()

Description copied from interface: CCDInterface

The list of segments in readout order.

Specified by:

getSegments in interface CCDInterface

Returns:

An unmodifiable list of segments, with item 0 corresponding to amplifier 1.

addSegment

public void addSegment(int channel,
                       int row,
                       int column,
                       CCDGeometry.ReadoutOrder readoutOrder)

Used when constructing the geometry to add segments (amplifiers) to the geometry.

Parameters:

channel - The channel number (amplifier number) of the segment (numbered from 1)

row - The row containing the segment, numbered from 0 in the +Y direction

column - The column containing the segment, numbered from 0 in the +X direction

readoutOrder - The readout direction for the amplifier.

getParallelSegmentCount

public int getParallelSegmentCount()

Description copied from interface: CCDInterface

Get the number of segments in the Parallel direction

Specified by:

getParallelSegmentCount in interface CCDInterface

Returns:

the number of segments in the parallel direction.

getSerialSegmentCount

public int getSerialSegmentCount()

Description copied from interface: CCDInterface

Get the number of segments in the Serial direction

Specified by:

getSerialSegmentCount in interface CCDInterface

Returns:

the number of segments in the serial direction.