org.lsst.ccs.utilities.ccd

Class CCDGeometry

java.lang.Object

org.lsst.ccs.utilities.ccd.CCDGeometry

public class CCDGeometry
extends Object

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) Create a CCDGeomtry object.

Method Summary

Modifier and Type	Method and Description
int	getActiveParallelSize()
int	getActiveSerialSize()
CCDTransform	getActiveTransform() Create a CCDTransform which only considers active pixels for the absolute x,y coordinates.
CCDTransform	getGlobalTransform() Create a CCDTransform which considers all pixels for the absolute x,y coordinates.
int	getParallelActiveCount()
int	getParallelOverscanCount()
Map<String,Object>	getPrimaryHeaders() Create fits headers for the primary header.
CCDGeometry.CCDSegment	getSegment(int row, int column) Get the CCDSegment corresponding to the given row and column
int	getSegmentColumnCount()
int	getSegmentRowCount()
List<CCDGeometry.CCDSegment>	getSegments() The list of segments in readout order.
int	getSerialActiveCount()
int	getSerialOverscanCount()
int	getSerialPrescanCount()
int	getTotalParallelCount() Total parallel pixels per segment.
int	getTotalParallelSize() The total width of the CCD in pixels
int	getTotalSerialCount() Total serial pixels per segment.
int	getTotalSerialSize() The total height of the CCD in pixels

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)

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

getSerialPrescanCount

public int getSerialPrescanCount()

getParallelActiveCount

public int getParallelActiveCount()

getSerialActiveCount

public int getSerialActiveCount()

getSerialOverscanCount

public int getSerialOverscanCount()

getParallelOverscanCount

public int getParallelOverscanCount()

getSegmentRowCount

public int getSegmentRowCount()

getSegmentColumnCount

public int getSegmentColumnCount()

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()

The total height of the CCD in pixels

Returns:

The total height in pixels, including active+prescan+overscan pixels.

getActiveSerialSize

public int getActiveSerialSize()

getTotalParallelSize

public int getTotalParallelSize()

The total width of the CCD in pixels

Returns:

The total width in pixels, including active+overscan pixels

getActiveParallelSize

public int getActiveParallelSize()

getGlobalTransform

public CCDTransform getGlobalTransform()

Create a CCDTransform which considers all pixels for the absolute x,y coordinates.

Returns:

The CCDTransform for global coordinates

getActiveTransform

public CCDTransform getActiveTransform()

Create a CCDTransform which only considers active pixels for the absolute x,y coordinates. When using this transform PixelType will always be active. Setting a CCD coordinate which does not correspond to an active pixel will result in an error. The CCDTransform.getGlobalX() and CCDTransform.getGlobalY() methods can be used to obtain the global coordinate corresponding to the x,y given.

Returns:

The CCDTransform for active coordinates.

getSegment

public CCDGeometry.CCDSegment getSegment(int row,
                                         int column)

Get the CCDSegment corresponding to the given row and column

Parameters:

row - The input row

column - The input column

Returns:

The CCDSegment and the specified row and column.

getSegments

public List<CCDGeometry.CCDSegment> getSegments()

The list of segments in readout order.

Returns:

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

getPrimaryHeaders

public Map<String,Object> getPrimaryHeaders()

Create fits headers for the primary header.

Returns:

A map containing the fits header names and values.