org.lsst.ccs.utilities.ccd

Interface CCDTransform

All Known Implementing Classes:

CCDTransform.ActiveTransform, CCDTransform.GlobalTransform

public interface CCDTransform

Allows transforms between CCD coordinate system and CCD segment (amplifier) coordinate systems. The CCD coordinate system uses the conventions of the camera coordinate system (confusingly called CCS). Any set method may be used to set the currently selected coordinate, and all get methods will then return coordinates corresponding to the selected coordinate. The precise meaning of the x,y coordinates depends on which method was used to obtain the transform.

Author:

tonyj

See Also:

CCDGeometry#getGlobalTransform(), CCDGeometry#getActiveTransform()

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CCDTransform.ActiveTransform A CCDTransform which only considers active pixels for the absolute x,y coordinates.
static class	CCDTransform.GlobalTransform A CCDTransform which considers all pixels for the absolute x,y coordinates.
static class	CCDTransform.PixelType Enumerate the different types of pixel that can be read out.

Method Summary

Modifier and Type	Method and Description
static CCDTransform	getActiveTransform(CCD ccd) Create a CCDTransform which only considers active pixels for the absolute x,y coordinates.
static CCDTransform	getActiveTransform(CCD ccd, ReadOutParameters readOutParameters) Create a CCDTransform which only considers active pixels for the absolute x,y coordinates.
static CCDTransform	getGlobalTransform(CCD ccd) Create a CCDTransform which considers all pixels for the absolute x,y coordinates.
static CCDTransform	getGlobalTransform(CCD ccd, ReadOutParameters readOutParameters) Create a CCDTransform which considers all pixels for the absolute x,y coordinates.
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.

Method Detail

setXY

void setXY(int x,
           int y)

Select the absolute x,y CCD coordinate.

Parameters:

x - The x coordinate in the CCD coordinate system

y - The u coordinate in the CCD coordinate system

getX

int getX()

Get the CCD x coordinate

Returns:

The selected CCD x coordinate

getY

int getY()

Get the CCD selected y coordinate system

Returns:

The CCD y coordinate

setSegmentSerialParallel

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).

Parameters:

segment - The CCD segment (amplifier)

serial - The serial coordinate within the CCD segment

parallel - The parallel coordinate within the CCD segment

getSegment

Segment getSegment()

The CCD segment corresponding to the currently selected coordinate.

Returns:

The segment

getSerial

int getSerial()

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

Returns:

The serial coordinate

getParallel

int getParallel()

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

Returns:

The parallel coordinate

getPixelType

CCDTransform.PixelType getPixelType()

The type of pixel corresponding to the currently selected coordinate.

Returns:

The pixel type

getGlobalX

int getGlobalX()

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.

Returns:

The global x coordinate

getGlobalY

int getGlobalY()

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.

Returns:

The global y coordinate

getReadOutParameters

ReadOutParameters getReadOutParameters()

Get the ReadOutParameters object used internally by the CCDTransform instance.

Returns:

the ReadOutParameters object.

getGlobalTransform

static CCDTransform getGlobalTransform(CCD ccd,
                                       ReadOutParameters readOutParameters)

Create a CCDTransform which considers all pixels for the absolute x,y coordinates.

Parameters:

ccd - The CCD on which this transformation acts.

readOutParameters - The ReadOutParameters used to define the pre and over scan regions

Returns:

The CCDTransform for global coordinates

getGlobalTransform

static CCDTransform getGlobalTransform(CCD ccd)

Create a CCDTransform which considers all pixels for the absolute x,y coordinates. Internally it will use the default ReadOutParameters for the ccd type.

Parameters:

ccd - The CCD on which this transformation acts.

Returns:

The CCDTransform for global coordinates

getActiveTransform

static CCDTransform getActiveTransform(CCD ccd,
                                       ReadOutParameters readOutParameters)

Create 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.

Parameters:

ccd - The CCD on which this transformation acts.

readOutParameters - The ReadOutParameters used to define the pre and over scan regions

Returns:

The CCDTransform for active coordinates.

getActiveTransform

static CCDTransform getActiveTransform(CCD ccd)

Create 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. Internally it will use the default ReadOutParameters for the ccd type.

Parameters:

ccd - The CCD on which this transformation acts.

Returns:

The CCDTransform for active coordinates.