org.lsst.ccs.utilities.ccd

Interface SegmentInterface

All Known Implementing Classes:

CCDGeometry.CCDSegment, Segment

public interface SegmentInterface

An interface to describe Segments.

Author:

turri

Method Summary

Modifier and Type	Method and Description
CCDType	getCCDType() Get the type of CCD.
int	getChannel() Get the Channel number for this Segment
int	getParallelPosition() Get the parallel position of this Segment in the CCD.
CCDInterface	getParentCCD() Get the parent CCDInterface this segment belongs to
int	getSegmentParallelActiveSize() Get the Segment parallel active size.
int	getSegmentParallelOverscanSize() Get the Segment parallel overscan size.
int	getSegmentSerialActiveSize() Get the Segment serial active size.
int	getSegmentSerialOverscanSize() Get the Segment serial overscan size.
int	getSegmentSerialPrescanSize() Get the Segment serial prescan size.
default int	getSegmentTotalParallelSize() Get the Segment total parallel size: overscan and active size.
default int	getSegmentTotalSerialSize() Get the Segment total serial size: prescan, overscan and active size.
int	getSerialPosition() Get the serial position of this Segment in the CCD.
boolean	isReadoutDown() Is this segment read down in the parallel direction.
boolean	isReadoutLeft() Is this segment read left in the parallel direction.

Method Detail

getSerialPosition

int getSerialPosition()

Get the serial position of this Segment in the CCD.

Returns:

the serial position.

getParallelPosition

int getParallelPosition()

Get the parallel position of this Segment in the CCD.

Returns:

the parallel position.

getChannel

int getChannel()

Get the Channel number for this Segment

Returns:

the Channel number

getSegmentTotalSerialSize

default int getSegmentTotalSerialSize()

Get the Segment total serial size: prescan, overscan and active size.

Returns:

The Segment total serial size.

getSegmentSerialActiveSize

int getSegmentSerialActiveSize()

Get the Segment serial active size.

Returns:

The Segment serial active size.

getSegmentSerialPrescanSize

int getSegmentSerialPrescanSize()

Get the Segment serial prescan size.

Returns:

The Segment serial prescan size.

getSegmentSerialOverscanSize

int getSegmentSerialOverscanSize()

Get the Segment serial overscan size.

Returns:

The Segment serial overscan size.

getSegmentTotalParallelSize

default int getSegmentTotalParallelSize()

Get the Segment total parallel size: overscan and active size.

Returns:

The Segment total parallel size.

getSegmentParallelActiveSize

int getSegmentParallelActiveSize()

Get the Segment parallel active size.

Returns:

The Segment parallel active size.

getSegmentParallelOverscanSize

int getSegmentParallelOverscanSize()

Get the Segment parallel overscan size.

Returns:

The Segment parallel overscan size.

isReadoutDown

boolean isReadoutDown()

Is this segment read down in the parallel direction.

Returns:

true if the Segment is read down in the parallel direction.

isReadoutLeft

boolean isReadoutLeft()

Is this segment read left in the parallel direction.

Returns:

true if the Segment is read left in the parallel direction.

getParentCCD

CCDInterface getParentCCD()

Get the parent CCDInterface this segment belongs to

Returns:

The parent of this segment.

getCCDType

CCDType getCCDType()

Get the type of CCD.

Returns:

The CCDType.