OffAxisRank

java.lang.Object
- stella.util.OffAxisRank

All Implemented Interfaces:

Serializable, Comparable<OffAxisRank>
```
public class OffAxisRank
extends Object
implements Comparable<OffAxisRank>, Serializable
```
Helper class to work with off axis catalog. Create the return for filtering FoV lists.

Author:

wooz

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`bright` If true, we are a preferable bright star.
`private Vector2D`	`ccd` Point to guide on off-axis guider CCD.
`private Star`	`offaxis` The guide star.
`private double`	`offset` Offset required from center, degrees.
`private double`	`psi` Derotator offset.
`private Vector2D`	`rade` Pointing center.
`private static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description
`OffAxisRank(Star offaxis, Vector2D rade, double off, double psi, Vector2D ccd, boolean bright)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(OffAxisRank o)` Allows a standard ranking of the possible guide stars.
`static List<OffAxisRank>`	`dropShifts(List<OffAxisRank> oar, double degmax)`
`boolean`	`equals(Object obj)`
`static List<Star>`	`extractStars(List<OffAxisRank> oar)`
`Vector2D`	`getCcd()` To minimize shift and/or derotator setting, the hot-point on the guider ccd can be changed from the center to this point.
`Star`	`getOffAxisGuideStar()` The star description for the guide star.
`double`	`getOffset()` The required displacement to get the offaxis guide star in the field of the guider CCD.
`double`	`getPsi()` Required derotator setting to get the guide star on the guider CCD.
`static int`	`getQuadrant(double derot)`
`Vector2D`	`getRaDe()` The required pointing center ton get the guide star to the center of the guider CCD.
`static double`	`getTilt(double derot)` From a derotator offset, we return the tilt, which is zero for derotator offsets of 0, 90, 180, and 270 degrees.
`int`	`hashCode()`
`boolean`	`isBright()` If guide star is bright.
`String`	`toString()`

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

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - offaxis
```
private final Star offaxis
```
    The guide star.
  - rade
```
private final Vector2D rade
```
    Pointing center.
  - offset
```
private final double offset
```
    Offset required from center, degrees. Great-circle distance.
  - psi
```
private final double psi
```
    Derotator offset.
  - ccd
```
private final Vector2D ccd
```
    Point to guide on off-axis guider CCD.
  - bright
```
private final boolean bright
```
    If true, we are a preferable bright star.
- Constructor Detail
  - OffAxisRank
```
public OffAxisRank(Star offaxis,
                   Vector2D rade,
                   double off,
                   double psi,
                   Vector2D ccd,
                   boolean bright)
```
    Parameters:
    
    radeoff -
    
    psi -
    
    ccd -
    
    bright -
- Method Detail
  - getOffAxisGuideStar
```
public Star getOffAxisGuideStar()
```
    The star description for the guide star.
    
    Returns:
    
    the offaxis guide star.
  - getRaDe
```
public Vector2D getRaDe()
```
    The required pointing center ton get the guide star to the center of the guider CCD. This will be the move position for the telescope
    
    Returns:
    
    the rade, both in degrees.
  - getOffset
```
public double getOffset()
```
    The required displacement to get the offaxis guide star in the field of the guider CCD. Measured along a great circle, degrees
    
    Returns:
    
    the radeoff in degrees.
  - getPsi
```
public double getPsi()
```
    Required derotator setting to get the guide star on the guider CCD.
    
    Returns:
    
    the psi in degrees.
  - getCcd
```
public Vector2D getCcd()
```
    To minimize shift and/or derotator setting, the hot-point on the guider ccd can be changed from the center to this point.
    
    Returns:
    
    the ccd
  - isBright
```
public boolean isBright()
```
    If guide star is bright.
    
    Returns:
    
    the bright
  - compareTo
```
public int compareTo(OffAxisRank o)
```
    Allows a standard ranking of the possible guide stars. Should be used separately on bright and faint lists, but if types are intermixed, ordering is such that all bright stars are before faint ones. The ranking is based on the required displacement - lesser is better. For equal displacements (means no displacement necessary), the smaller tilt wins. For equal tilts (=no tilt), the bright guide star is selected.
    
    Specified by:
    
    compareTo in interface Comparable<OffAxisRank>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getTilt
```
public static final double getTilt(double derot)
```
    From a derotator offset, we return the tilt, which is zero for derotator offsets of 0, 90, 180, and 270 degrees. For values in the range, e.g., 45-90, 90-derotator is returned.
  - getQuadrant
```
public static final int getQuadrant(double derot)
```
  - extractStars
```
public static List<Star> extractStars(List<OffAxisRank> oar)
```
  - dropShifts
```
public static List<OffAxisRank> dropShifts(List<OffAxisRank> oar,
                                           double degmax)
```

Class OffAxisRank

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

offaxis

rade

offset

psi

ccd

bright

Constructor Detail

OffAxisRank

Method Detail

getOffAxisGuideStar

getRaDe

getOffset

getPsi

getCcd

isBright

compareTo

hashCode

equals

toString

getTilt

getQuadrant

extractStars

dropShifts