org.lsst.ccs.utilities.ccd

Class Geometry<T extends Geometry>

java.lang.Object

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

Type Parameters:

T - The template of the classes that can be added to this Geometry

Direct Known Subclasses:

CCD, FocalPlane, Raft, Segment

public abstract class Geometry<T extends Geometry>
extends Object

Base Geometry: a rectangle inside which it is possible to add other Geometries. Note on coordinate system and dimensions. The (x,y) coordinate system refers to Java Image/Component convention. (0,0) is the upper left corner with x increasing to the right and y increasing downward. For simplicity (x,y) cannot be negative. The "width" of a Geometry is its maximum extent along the x direction and the "height" is along the y direction. Since this class is designed to describe Camera components inside the Focal Plane (Rafts, Rebs, CCDs, Segments) we also support a coordinate system to numerically describe the position of a component inside its parent. For uniformity with the Camera Coordinate System we will call this coordinate system parallel vs serial. This coordinate system is used to count components within a parent. It has nothing to do with dimensions. The parallel coordinate is parallel to the x direction growing to the left. The serial coordinate is parallel to the y direction growing upward. The origin of the (p,s) coordinate system is at the bottom right corner of the Geometry object. So for a parent containing 4 children in the x direction and 3 in the y direction the children will be represented as follows: - child (0,0) is at the bottom right corner - child (0,2) is at the top right corner - child (3,0) is at the bottom left corner - child (3,2) is at the top left corner This class is designed to contain a rectangular pattern of homogenous children. Not all slots have to be filled with children. This class is not thread safe.

Author:

The LSST CCS Team

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name

Constructor Summary

Constructors

Constructor and Description
Geometry(String name, Dimension dimension) Create a new Geometry with no children.
Geometry(String name, Dimension dimension, int p, int s) Create a new Geometry with a maximum set of components in the (p,s) coordinate system.

Method Summary

Modifier and Type	Method and Description
void	addChildGeometry(T child, int p, int s) Add a child to the grid to a given position in the parallel,serial coordinate system.
protected void	addGeometry(T child, int x, int y) Add a Geometry to this Geometry at a given (x,y) location.
protected abstract void	addGeometryToGrid(T child, int p, int s) This method must be implemented by all classes extending Geometry.
Geometry	findGeometry(String geometryUniqueId) Find a Geometry by name.
Geometry<?>	findParentOfType(Class clazz) Find the closest containing Geometry of a given type.
Point	getAbsolutePoint(Point p) Convert a point within this Geometry to the absolute coordinate system of the topmost Geometry.
T	getChild(int p, int s) Get child at position (p,s).
List<T>	getChildrenList() Get the list of children for this Geometry.
Map<Geometry,Point>	getChildrenWithAbsoluteCoordinates() Get a map for all the children contained in this Geometry with the corresponding Point which represent the location of the child Geometry in the topmost geometry.
Dimension	getDimension() Get the Dimension of this Geometry.
Point	getGeometryAbsolutePosition() Get the absolute location of this Geometry with respect to the topmost geometry, that is the one without a parent.
Point	getGeometryPoint(Geometry geometry) Get the location Point of a child Geometry within this Geometry.
int	getHeight() Get the Geometry height;
String	getName() Get the Geometry name
int	getNumberOfChildren() Get the number of children added to this Geometry.
int	getParallelChildrenCount() The maximum number of children in the parallel direction.
int	getParallelPosition() The parallel position of this Geometry within its parent.
Geometry	getParent() Get the parent of this Geometry.
int	getSerialChildrenCount() The maximum number of children in the serial direction.
int	getSerialPosition() The serial position of this Geometry within its parent.
String	getUniqueId() Get this Geometry unique id.
int	getWidth() Get the Geometry width.
boolean	hasChildren() Check if this Geometry has children.
boolean	hasParent() Check if this Geometry has a Parent.
protected void	replaceExistingGeometry(T oldChild, T newChild) Replace a Geometry with a new one in the same place.
protected void	setParallelPosition(int parallelPosition)
protected void	setParent(Geometry parent)
protected void	setSerialPosition(int serialPosition)

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

Constructor Detail

Geometry

public Geometry(String name,
                Dimension dimension,
                int p,
                int s)

Create a new Geometry with a maximum set of components in the (p,s) coordinate system. Subclasses of Geometries that allow children to be added must override method addGeometryToGrid.

Parameters:

name - The name of this Geometry

dimension - The dimension of this Geometry. Children must fit within this dimension.

p - The number of allowed components in the parallel direction.

s - The number of allowed components in the serial direction

Geometry

public Geometry(String name,
                Dimension dimension)

Create a new Geometry with no children. If an attempt is made to add children an exception will be thrown.

Parameters:

name - The name of this Geometry

dimension - The dimension of this Geometry.

Method Detail

getName

public String getName()

Get the Geometry name

Returns:

The Geometry name.

getWidth

public int getWidth()

Get the Geometry width.

Returns:

The width of the Geometry;

getHeight

public int getHeight()

Get the Geometry height;

Returns:

The height of the Geometry;

getDimension

public Dimension getDimension()

Get the Dimension of this Geometry.

Returns:

The Dimension of this Geometry.

getParent

public Geometry getParent()

Get the parent of this Geometry. Null will be returned if this is an orphan.

Returns:

The parent (null if this is an orphan).

findParentOfType

public Geometry<?> findParentOfType(Class clazz)

Find the closest containing Geometry of a given type.

Parameters:

clazz - The type of the parent to be found

Returns:

The closest enclosing geometry for the given type.

hasParent

public boolean hasParent()

Check if this Geometry has a Parent.

Returns:

true if this Geometry has a parent.

setParent

protected final void setParent(Geometry parent)

addGeometry

protected void addGeometry(T child,
                           int x,
                           int y)

Add a Geometry to this Geometry at a given (x,y) location. This method is protected because it should only be used internally by classes extending the Geometry class. Users will have to use the addChildGeometry method to place a geometry in the (p,s) coordinate system. The convention is the the new Geometry upper left corner will be placed at (x,y). Child Geometries cannot be added to a Geometry that already has a parent AND does not have a fixed dimension. The reason for this choice is to simplify the logic of boundaries breaking. Coordinate x and y must be positive otherwise an exception will be thrown. If the this parent Geometry has fixed boundaries an exception will be thrown if the child Geometry to be added does not fit inside its boundaries. An exception will be thrown if the child Geometry being added already belongs to another Geometry.

Parameters:

child - The Geometry to be added

x - The x coordinate of the child Geometry location

y - The y coordinate of the child Geometry location

replaceExistingGeometry

protected void replaceExistingGeometry(T oldChild,
                                       T newChild)

Replace a Geometry with a new one in the same place.

Parameters:

oldChild - The existing child.

newChild - The new child.

getSerialChildrenCount

public int getSerialChildrenCount()

The maximum number of children in the serial direction.

Returns:

The maximum number of children in the serial direction.

getParallelChildrenCount

public int getParallelChildrenCount()

The maximum number of children in the parallel direction.

Returns:

The maximum number of children in the parallel direction.

getSerialPosition

public int getSerialPosition()

The serial position of this Geometry within its parent.

Returns:

The serial position of this Geometry within its parent.

getParallelPosition

public int getParallelPosition()

The parallel position of this Geometry within its parent.

Returns:

The parallel position of this Geometry within its parent.

setSerialPosition

protected void setSerialPosition(int serialPosition)

setParallelPosition

protected void setParallelPosition(int parallelPosition)

addChildGeometry

public void addChildGeometry(T child,
                             int p,
                             int s)

Add a child to the grid to a given position in the parallel,serial coordinate system.

Parameters:

child - The child to be added

s - The serial position to add it to

p - The parallel position to add it to

addGeometryToGrid

protected abstract void addGeometryToGrid(T child,
                                          int p,
                                          int s)

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.

Parameters:

child - The child to be added.

p - The parallel position

s - The serial position.

getChild

public T getChild(int p,
                  int s)

Get child at position (p,s).

Parameters:

p - The parallel position to add it to

s - The serial position to add it to

Returns:

The child at the given position.

hasChildren

public boolean hasChildren()

Check if this Geometry has children.

Returns:

true if this Geometry has children.

getChildrenWithAbsoluteCoordinates

public final Map<Geometry,Point> getChildrenWithAbsoluteCoordinates()

Get a map for all the children contained in this Geometry with the corresponding Point which represent the location of the child Geometry in the topmost geometry.

Returns:

A map of Geometry, Point

getChildrenList

public final List<T> getChildrenList()

Get the list of children for this Geometry. The order of the children depends on how they were added to the geometry.

Returns:

A list of children Geometry objects

getUniqueId

public String getUniqueId()

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

Returns:

The Geometry unique id.

findGeometry

public final Geometry findGeometry(String geometryUniqueId)

Find a Geometry by name.

Parameters:

geometryUniqueId - The unique id of the geometry to be found.

Returns:

The geometry or null if the geometry is not found

getNumberOfChildren

public final int getNumberOfChildren()

Get the number of children added to this Geometry.

Returns:

the number of children in the geometry.

getGeometryAbsolutePosition

public Point getGeometryAbsolutePosition()

Get the absolute location of this Geometry with respect to the topmost geometry, that is the one without a parent.

Returns:

The absolute location for this Geometry.

getAbsolutePoint

public Point getAbsolutePoint(Point p)

Convert a point within this Geometry to the absolute coordinate system of the topmost Geometry.

Parameters:

p - The point to convert.

Returns:

The absolute Point representing the provided point.

getGeometryPoint

public Point getGeometryPoint(Geometry geometry)

Get the location Point of a child Geometry within this Geometry.

Parameters:

geometry - The child Geometry.

Returns:

The Point where the provided Geometry is attached to this Geometry.