org.lsst.ccs.utilities.ccd

Class FocalPlane

java.lang.Object

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

org.lsst.ccs.utilities.ccd.FocalPlane

public class FocalPlane
extends Geometry<Raft>

A Geometry class defining the Camera Focal Plane. It contains a 5x5 array of Rafts. Not all of them have to be present as there could be a partially filled focal plane. This class needs a RaftGeometryConstants object to get the Raft Geometry dimensions, both to determine the size of the FocalPlane and to place the Raft children in the array. Since the E2V and the ITL Rafts height and width are the same, we use chose to internally use the Raft geometry constants for an E2V CCD type. We might want to revisit this choice if the above condition changes. The constants are as defined in LCA-13501

Author:

The LSST CCS Team

Field Summary

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

name

Constructor Summary

Constructors

Constructor and Description
FocalPlane() Build a Camera FocalPlane object.
FocalPlane(String definition)

Method Summary

Modifier and Type	Method and Description
protected void	addGeometryToGrid(Raft child, int p, int s) This method must be implemented by all classes extending Geometry.
static FocalPlane	createFocalPlane()
static FocalPlane	createFocalPlane(String definition) Utility static method to create a FocalPlane for the provided input String.
String	getName() Get the Geometry name
List<Raft>	getRafts()
Reb	getReb(String fullName)
Reb	getRebAtLocation(Location location) Get the REB at a given location.
List<Reb>	getRebs()

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

addChildGeometry, addGeometry, findGeometry, findParentOfType, getAbsolutePoint, getChild, getChildrenList, getChildrenWithAbsoluteCoordinates, getDimension, getGeometryAbsolutePosition, getGeometryPoint, getHeight, 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

Constructor Detail

FocalPlane

public FocalPlane()

Build a Camera FocalPlane object. This object has no Rafts. They need to be added.

FocalPlane

public FocalPlane(String definition)

Method Detail

getName

public String getName()

Description copied from class: Geometry

Get the Geometry name

Overrides:

getName in class Geometry<Raft>

Returns:

The Geometry name.

addGeometryToGrid

protected void addGeometryToGrid(Raft 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<Raft>

Parameters:

child - The child to be added.

p - The parallel position

s - The serial position.

getRafts

public List<Raft> getRafts()

getRebs

public List<Reb> getRebs()

getReb

public Reb getReb(String fullName)

getRebAtLocation

public Reb getRebAtLocation(Location location)

Get the REB at a given location.

Parameters:

location - The location to search for

Returns:

The REB if found

Throws:

RuntimeException - If no REB found at the given location

createFocalPlane

public static FocalPlane createFocalPlane(String definition)

Utility static method to create a FocalPlane for the provided input String.

Parameters:

definition - The FocalPlane String representation. Example of focal plane definition: "[R33:[ccdType:e2v,rebs:[Reb0:[ccdType:itl],Reb1,Reb2]]]"

Returns:

A FocalPlane.

createFocalPlane

public static FocalPlane createFocalPlane()