org.lsst.ccs.utilities.ccd

Enum SegmentReadOutOrder

java.lang.Object

java.lang.Enum<SegmentReadOutOrder>

org.lsst.ccs.utilities.ccd.SegmentReadOutOrder

All Implemented Interfaces:

Serializable, Comparable<SegmentReadOutOrder>

public enum SegmentReadOutOrder
extends Enum<SegmentReadOutOrder>

The Segment readout point with respect to the (parallel,serial) Camera Coordinate System. With the parallel direction along the x axis and growing to the left and the serial direction along y growing upward we define: - Left and Right along the parallel direction, Left growing, Right decreasing. - Up and Down along the serial direction, Up growing, Down decreasing.

Author:

The LSST CCS Team

Enum Constant Summary

Enum Constants

Enum Constant and Description
LeftDown
LeftUp
RightDown
RightUp

Method Summary

Modifier and Type	Method and Description
boolean	isReadoutDown() Returns true if the Segment is read from top to bottom in the serial direction.
boolean	isReadoutLeft() Returns true if the Segment is read from left to right in the parallel direction.
static SegmentReadOutOrder	valueOf(String name) Returns the enum constant of this type with the specified name.
static SegmentReadOutOrder[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LeftDown

public static final SegmentReadOutOrder LeftDown

LeftUp

public static final SegmentReadOutOrder LeftUp

RightDown

public static final SegmentReadOutOrder RightDown

RightUp

public static final SegmentReadOutOrder RightUp

Method Detail

values

public static SegmentReadOutOrder[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SegmentReadOutOrder c : SegmentReadOutOrder.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SegmentReadOutOrder valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isReadoutDown

public boolean isReadoutDown()

Returns true if the Segment is read from top to bottom in the serial direction.

Returns:

true if the segment is read down along the serial direction.

isReadoutLeft

public boolean isReadoutLeft()

Returns true if the Segment is read from left to right in the parallel direction.

Returns:

true if the segment is read from the left along the parallel direction.