Geometry (LSST CCS - Image Utilities 1.5.4 API)

java.lang.Object
- org.lsst.ccs.geometry.Geometry<T>

Type Parameters:

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

Direct Known Subclasses:

CCD, FocalPlane, Raft, Reb, Segment
```
public 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. In the Camera Coordinate System (CCS) the coordinates are defined as follows: - (x,y) The x direction grows to the left, the y upward. In this coordinate system the focal plan is as viewed from L3, i.e. looking down at the CCDs - (p,s) The parallel, serial coordinate system is aligned along the (x,y) Camera Coordinate System: the parallel direction grows along x and the serial direction grows along the y direction. A Geometry upper left corner is ALWAYS (0,0). This point will be always used when evaluating dimensions. In the Camera Coordinate System the bottom right corner of Segment00, CCD00, Raft00 is defined as (1,1). The pixels grow along the (x,y) Camera Coordinate System This class is not thread safe.

Author:

turri

Field Summary

Fields
Modifier and Type Field and Description

protected int parallelChildrenCount

protected int parallelPosition

protected int serialChildrenCount

protected int serialPosition

Fields
Modifier and Type	Field and Description
`protected int`	`parallelChildrenCount`
`protected int`	`parallelPosition`
`protected int`	`serialChildrenCount`
`protected int`	`serialPosition`

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChildGeometry(T child, int p, int s)` Add a child to the grid to a given position.
`protected void`	`addGeometry(T child, int x, int y)` Add a Geometry to this Geometry at a given (x,y) location.
`protected void`	`addGeometryToGrid(T child, int p, int s)`
`Geometry`	`findGeometry(String geometryUniqueId)` Find a Geometry by name.
`Point`	`getAbsolutePoint(Point p)`
`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 the children for this Geometry.
`Dimension`	`getDimension()` Get the Dimension of this Geometry.
`Point`	`getGeometryAbsolutePosition()`
`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 in this Geometry.
`int`	`getParallelChildrenCount()`
`int`	`getParallelPosition()`
`Geometry`	`getParent()` Get the parent of this Geometry.
`int`	`getSerialChildrenCount()`
`int`	`getSerialPosition()`
`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.
`void`	`setParallelPosition(int parallelPosition)`
`protected void`	`setParent(Geometry parent)`
`void`	`setSerialPosition(int serialPosition)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - serialChildrenCount
```
protected final int serialChildrenCount
```
  - parallelChildrenCount
```
protected final int parallelChildrenCount
```
  - serialPosition
```
protected int serialPosition
```
  - parallelPosition
```
protected int parallelPosition
```
- 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).
  - 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. 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
  - getSerialChildrenCount
```
public int getSerialChildrenCount()
```
  - getParallelChildrenCount
```
public int getParallelChildrenCount()
```
  - getSerialPosition
```
public int getSerialPosition()
```
  - getParallelPosition
```
public int getParallelPosition()
```
  - setSerialPosition
```
public void setSerialPosition(int serialPosition)
```
  - setParallelPosition
```
public void setParallelPosition(int parallelPosition)
```
  - addChildGeometry
```
public void addChildGeometry(T child,
                             int p,
                             int s)
```
    Add a child to the grid to a given position.
    
    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 void addGeometryToGrid(T child,
                                 int p,
                                 int s)
```
  - 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 the children for this Geometry. It returns a map of Geometry, Point where the Point is 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.
    
    Returns:
    
    A list of children Geometry objects
  - getUniqueId
```
public final 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 in this Geometry.
    
    Returns:
    
    the number of children in the geometry.
  - getGeometryAbsolutePosition
```
public Point getGeometryAbsolutePosition()
```
  - getAbsolutePoint
```
public Point getAbsolutePoint(Point p)
```
  - 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.

Class Geometry<T extends Geometry>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialChildrenCount

parallelChildrenCount

serialPosition

parallelPosition

Constructor Detail

Geometry

Geometry

Method Detail

getName

getWidth

getHeight

getDimension

getParent

hasParent

setParent

addGeometry

getSerialChildrenCount

getParallelChildrenCount

getSerialPosition

getParallelPosition

setSerialPosition

setParallelPosition

addChildGeometry

addGeometryToGrid

getChild

hasChildren

getChildrenWithAbsoluteCoordinates

getChildrenList

getUniqueId

findGeometry

getNumberOfChildren

getGeometryAbsolutePosition

getAbsolutePoint

getGeometryPoint