org.lsst.ccs.utilities.ccd

Class CCDTransform.ActiveTransform

java.lang.Object

org.lsst.ccs.utilities.ccd.CCDTransform.ActiveTransform

All Implemented Interfaces:

CCDTransform

Enclosing interface:

CCDTransform

public static class CCDTransform.ActiveTransform
extends Object
implements CCDTransform

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 getGlobalX() and getGlobalY() methods can be used to obtain the global coordinate corresponding to the x,y given.

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.utilities.ccd.CCDTransform

CCDTransform.ActiveTransform, CCDTransform.GlobalTransform, CCDTransform.PixelType

Method Summary

Modifier and Type	Method and Description
int	getGlobalX() The global coordinate corresponding to the currently selected coordinate.
int	getGlobalY() The global coordinate corresponding to the currently selected coordinate.
int	getParallel() The parallel coordinate of the currently selected pixel within the current CCD segment.
CCDTransform.PixelType	getPixelType() The type of pixel corresponding to the currently selected coordinate.
ReadOutParameters	getReadOutParameters() Get the ReadOutParameters object used internally by the CCDTransform instance.
Segment	getSegment() The CCD segment corresponding to the currently selected coordinate.
int	getSerial() The serial position of the currently selected pixel within the current CCD segment.
int	getX() Get the CCD x coordinate
int	getY() Get the CCD selected y coordinate system
void	setSegmentSerialParallel(Segment segment, int serial, int parallel) Set the current segment, and serial and parallel pixel position within the segment (in segment readout order).
void	setXY(int x, int y) Select the absolute x,y CCD coordinate.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.utilities.ccd.CCDTransform

getActiveTransform, getActiveTransform, getGlobalTransform, getGlobalTransform

Method Detail

setXY

public void setXY(int x,
                  int y)

Description copied from interface: CCDTransform

Select the absolute x,y CCD coordinate.

Specified by:

setXY in interface CCDTransform

Parameters:

x - The x coordinate in the CCD coordinate system

y - The u coordinate in the CCD coordinate system

getSegment

public Segment getSegment()

Description copied from interface: CCDTransform

The CCD segment corresponding to the currently selected coordinate.

Specified by:

getSegment in interface CCDTransform

Returns:

The segment

getSerial

public int getSerial()

Description copied from interface: CCDTransform

The serial position of the currently selected pixel within the current CCD segment.

Specified by:

getSerial in interface CCDTransform

Returns:

The serial coordinate

getParallel

public int getParallel()

Description copied from interface: CCDTransform

The parallel coordinate of the currently selected pixel within the current CCD segment.

Specified by:

getParallel in interface CCDTransform

Returns:

The parallel coordinate

getPixelType

public CCDTransform.PixelType getPixelType()

Description copied from interface: CCDTransform

The type of pixel corresponding to the currently selected coordinate.

Specified by:

getPixelType in interface CCDTransform

Returns:

The pixel type

getGlobalX

public int getGlobalX()

Description copied from interface: CCDTransform

The global coordinate corresponding to the currently selected coordinate. If the CCDTransform was obtained via CCDGeometry#getGlobalTransform() then it will be equivalent the the x coordinate, but if it was obtained via CCDGeometry#getActiveParallelSize() it will return the global x coordinate corresponding to the currently selected active pixel.

Specified by:

getGlobalX in interface CCDTransform

Returns:

The global x coordinate

getGlobalY

public int getGlobalY()

Description copied from interface: CCDTransform

The global coordinate corresponding to the currently selected coordinate. If the CCDTransform was obtained via CCDGeometry#getGlobalTransform() then it will be equivalent the the y coordinate, but if it was obtained via CCDGeometry#getActiveParallelSize() it will return the global y coordinate corresponding to the currently selected active pixel.

Specified by:

getGlobalY in interface CCDTransform

Returns:

The global y coordinate

toString

public String toString()

Overrides:

toString in class Object

setSegmentSerialParallel

public void setSegmentSerialParallel(Segment segment,
                                     int serial,
                                     int parallel)

Description copied from interface: CCDTransform

Set the current segment, and serial and parallel pixel position within the segment (in segment readout order).

Specified by:

setSegmentSerialParallel in interface CCDTransform

Parameters:

segment - The CCD segment (amplifier)

serial - The serial coordinate within the CCD segment

parallel - The parallel coordinate within the CCD segment

getX

public int getX()

Description copied from interface: CCDTransform

Get the CCD x coordinate

Specified by:

getX in interface CCDTransform

Returns:

The selected CCD x coordinate

getY

public int getY()

Description copied from interface: CCDTransform

Get the CCD selected y coordinate system

Specified by:

getY in interface CCDTransform

Returns:

The CCD y coordinate

getReadOutParameters

public ReadOutParameters getReadOutParameters()

Description copied from interface: CCDTransform

Get the ReadOutParameters object used internally by the CCDTransform instance.

Specified by:

getReadOutParameters in interface CCDTransform

Returns:

the ReadOutParameters object.