org.lsst.ccs.utilities.ccd

Class CCD

java.lang.Object

org.lsst.ccs.utilities.ccd.Geometry<Segment>

org.lsst.ccs.utilities.ccd.CCD

Direct Known Subclasses:

GuiderCCD, WavefrontCCD

public class CCD
extends Geometry<Segment>

A class describing a CCD. Its default constructor is designed to contain 2 Segments along the parallel position and 8 in the serial direction. The CCD dimensions and the Segments readout parameters are described in the CCDType provided at construction time.

Author:

The LSST CCS Team.

Field Summary

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

name

Method Summary

Modifier and Type	Method and Description
protected void	addGeometryToGrid(Segment segment, int p, int s) Add a Segment to this CCD at a given serial and parallel position.
static CCD	createCCD(CCDType ccdType) Utility method to create a CCD for a given CCDType filled with Segments.
int	getActiveParallelSize() The active parallel pixel size of this CCD for all the Segments.
int	getActiveSerialSize() The active serial pixel size of this CCD for all the Segments.
Segment	getSegmentByName(String name) Get a Segment by name.
List<String>	getSegmentNames() Deprecated.
List<Segment>	getSegments() Get the ordered list for all the Segments in this CCD.
CCDType	getType() Get the CCDType for this CCD.
String	getUniqueId() Get this Geometry unique id.

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

addChildGeometry, addGeometry, findGeometry, findParentOfType, getAbsolutePoint, getChild, getChildrenList, getChildrenWithAbsoluteCoordinates, getDimension, getGeometryAbsolutePosition, getGeometryPoint, getHeight, getName, getNumberOfChildren, getParallelChildrenCount, getParallelPosition, getParent, getSerialChildrenCount, getSerialPosition, 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

Method Detail

addGeometryToGrid

protected void addGeometryToGrid(Segment segment,
                                 int p,
                                 int s)

Add a Segment to this CCD at a given serial and parallel position.

Specified by:

addGeometryToGrid in class Geometry<Segment>

Parameters:

segment - The Segment to add to the CCD.

s - The Segment serial position.

p - The Segment parallel position.

getUniqueId

public String getUniqueId()

Description copied from class: Geometry

Get this Geometry unique id. This is built by going over the parents and concatenating their name separated by columns.

Overrides:

getUniqueId in class Geometry<Segment>

Returns:

The Geometry unique id.

getActiveSerialSize

public int getActiveSerialSize()

The active serial pixel size of this CCD for all the Segments. It is the geometrical pixel size for all Segments. It does not include prescan and overscan in the serial direction. It does not count for gaps at the edges.

Returns:

getActiveParallelSize

public int getActiveParallelSize()

The active parallel pixel size of this CCD for all the Segments. It is the geometrical pixel size for all Segments. It does not the overscan in the parallel direction. It does not count for gaps at the edges.

Returns:

getType

public CCDType getType()

Get the CCDType for this CCD.

Returns:

The CCDType for this CCD.

getSegments

public List<Segment> getSegments()

Get the ordered list for all the Segments in this CCD. The list order is ascending using the Segment channel information. It is the order in which they are written.

Returns:

The order list of the Segments in the CCD.

getSegmentNames

@Deprecated
public List<String> getSegmentNames()

Deprecated.

Get the ordered list for all the Segment names in this CCD. The list order is ascending using the Segment channel information. It is the order in which they are written.

Returns:

The order list of the Segment names in the CCD.

getSegmentByName

public Segment getSegmentByName(String name)

Get a Segment by name.

Parameters:

name - The name of the Segment.

Returns:

The Segment for the provided name;

createCCD

public static CCD createCCD(CCDType ccdType)

Utility method to create a CCD for a given CCDType filled with Segments.

Parameters:

ccdType - The CCDType for this CCD

Returns:

A fully Segment populated CCD for the given CCDType.