OffAxisCatalog

java.lang.Object
- util.PropertyContainer
- - stella.util.OffAxisCatalog

All Implemented Interfaces:

Cloneable, PropertySupplying
```
public class OffAxisCatalog
extends PropertyContainer
```
Author:

wooz

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OffAxisCatalog.GuideStar
Test the class by providing a ra/de pair.

Nested Classes
Modifier and Type	Class and Description
`static class`	`OffAxisCatalog.GuideStar` Test the class by providing a ra/de pair.

Field Summary

Fields
Modifier and Type	Field and Description
`private static double`	`DEFBRIGHTMAG` Brightness limit for bright guiding stars, mag.
`private static Dimension`	`DEFCHIPSIZE` Size of off-axis guider chip in pixel.
`private static double`	`DEFDEOFFSET` The difference of CCD center-de minus off-axis center-de, degrees.
`private static double`	`DEFFAINTMAG` Brightness limit for faint guiding stars, mag.
`private static int`	`DEFFRAMESIZE` Minimum distance to chip edge.
`private static double`	`DEFPIXSCALE` Pixel scale on off-axis guider, arcsec per pixel.
`private static double`	`DEFPSIOFFSET` Angle to add to derotator angle for guider center position.
`private static double`	`DEFRADIUS` Radial distance of guider center to off-axis rotation center, degs.
`private static double`	`DEFRAOFFSET` The distance of CCD center-ra minus off-axis center-ra, degrees.
`static String`	`KEY_BRIGHTMAG` Brightness limit for bright guiding stars, mag.
`static String`	`KEY_CHIPSIZE` Size of off-axis guider chip in pixel.
`static String`	`KEY_DEOFFSET` The difference of CCD center-de minus off-axis center-de, degrees.
`static String`	`KEY_FAINTMAG` Brightness limit for faint guiding stars, mag.
`static String`	`KEY_FRAMESIZE` Minimum distance to chip edge.
`static String`	`KEY_PIXSCALE` Pixel scale on off-axis guider, arcsec per pixel.
`static String`	`KEY_PSIOFFSET` Angle to add to derotator angle for guider center position.
`static String`	`KEY_RADIUS` Radial distance of guider center to off-axis rotation center, degs.
`static String`	`KEY_RAOFFSET` The distance of CCD center-ra minus off-axis center-ra, degrees.

Fields inherited from class util.PropertyContainer
KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying
CONFIG, KEY_CLASS

Constructor Summary

Constructors
Constructor and Description

OffAxisCatalog(Map<String,String> props)
Defaults all parameters

Constructors
Constructor and Description
`OffAxisCatalog(Map<String,String> props)` Defaults all parameters

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<OffAxisRank>`	`getBrightGuideStars(List<Star> fov, double ra0, double de0)` From a field-of-view that is big enough to include all possible guide stars around the center of the science CCD, we generate an unsorted list of possible bright guide stars.
`List<OffAxisRank>`	`getFaintGuideStars(List<Star> fov, double ra0, double de0)` From a field-of-view that is big enough to include all possible guide stars around the center of the science CCD, we generate an unsorted list of possible bright guide stars.
`double`	`getGuiderFoV()` Gets the size of the guider-ccd half-diagonal in degrees.
`private Pair<List<OffAxisRank>,List<OffAxisRank>>`	`getGuideStars(List<Star> fov, double ra0, double de0)` From a field-of-view that is big enough to include all possible guide stars around the center of the science CCD, we generate an unsorted list of possible bright guide stars.
`private Vector3D`	`getInnerOuterCosChi()` Calculates the geometry of the visible off-axis view as the inner and outer applicable radius as well as the cosine of chi, which is the viewing angle of the outer guider edges from the rotational center.
`double`	`getInnerRadius()` Calculates the inner applicable radius accessible to the off-axis viewing camera.
`double`	`getOuterRadius()` Calculates the outer applicable radius accessible to the off-axis viewing camera.
`private static OffAxisRank`	`getRank(Star s, boolean b, double ra0, double de0, double psi0, double sinpsi0, double cospsi0, double radius, double rin, double rout, double chi, double sinchi, double coschi, double scale, Dimension chip, int thick)` From a star, we create its rank as a possible off-axis guide star.
`Vector2D`	`getVisibleShift(OffAxisRank guide)` If the offset of the star on the CCD differs from 0, there is a shift from the pointing to the visible center.

Methods inherited from class util.PropertyContainer
augment, augment, augment, augment, augment, clone, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, initProperties, isNew, parseObject, parseObject, reload, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties, toString

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

- Field Detail
  - KEY_RAOFFSET
```
public static final String KEY_RAOFFSET
```
    The distance of CCD center-ra minus off-axis center-ra, degrees.
    
    See Also:
    
    Constant Field Values
  - KEY_DEOFFSET
```
public static final String KEY_DEOFFSET
```
    The difference of CCD center-de minus off-axis center-de, degrees.
    
    See Also:
    
    Constant Field Values
  - KEY_PSIOFFSET
```
public static final String KEY_PSIOFFSET
```
    Angle to add to derotator angle for guider center position.
    
    See Also:
    
    Constant Field Values
  - KEY_RADIUS
```
public static final String KEY_RADIUS
```
    Radial distance of guider center to off-axis rotation center, degs.
    
    See Also:
    
    Constant Field Values
  - KEY_PIXSCALE
```
public static final String KEY_PIXSCALE
```
    Pixel scale on off-axis guider, arcsec per pixel.
    
    See Also:
    
    Constant Field Values
  - KEY_CHIPSIZE
```
public static final String KEY_CHIPSIZE
```
    Size of off-axis guider chip in pixel.
    
    See Also:
    
    Constant Field Values
  - KEY_FRAMESIZE
```
public static final String KEY_FRAMESIZE
```
    Minimum distance to chip edge.
    
    See Also:
    
    Constant Field Values
  - KEY_BRIGHTMAG
```
public static final String KEY_BRIGHTMAG
```
    Brightness limit for bright guiding stars, mag.
    
    See Also:
    
    Constant Field Values
  - KEY_FAINTMAG
```
public static final String KEY_FAINTMAG
```
    Brightness limit for faint guiding stars, mag.
    
    See Also:
    
    Constant Field Values
  - DEFRAOFFSET
```
private static final double DEFRAOFFSET
```
    The distance of CCD center-ra minus off-axis center-ra, degrees.
    
    See Also:
    
    Constant Field Values
  - DEFDEOFFSET
```
private static final double DEFDEOFFSET
```
    The difference of CCD center-de minus off-axis center-de, degrees.
    
    See Also:
    
    Constant Field Values
  - DEFPSIOFFSET
```
private static final double DEFPSIOFFSET
```
    Angle to add to derotator angle for guider center position.
    
    See Also:
    
    Constant Field Values
  - DEFRADIUS
```
private static final double DEFRADIUS
```
    Radial distance of guider center to off-axis rotation center, degs.
    
    See Also:
    
    Constant Field Values
  - DEFPIXSCALE
```
private static final double DEFPIXSCALE
```
    Pixel scale on off-axis guider, arcsec per pixel.
    
    See Also:
    
    Constant Field Values
  - DEFCHIPSIZE
```
private static final Dimension DEFCHIPSIZE
```
    Size of off-axis guider chip in pixel.
  - DEFFRAMESIZE
```
private static final int DEFFRAMESIZE
```
    Minimum distance to chip edge.
    
    See Also:
    
    Constant Field Values
  - DEFBRIGHTMAG
```
private static final double DEFBRIGHTMAG
```
    Brightness limit for bright guiding stars, mag.
    
    See Also:
    
    Constant Field Values
  - DEFFAINTMAG
```
private static final double DEFFAINTMAG
```
    Brightness limit for faint guiding stars, mag. May go down to 14.5
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OffAxisCatalog
```
public OffAxisCatalog(Map<String,String> props)
```
    Defaults all parameters
    
    Parameters:
    
    props - Overrides defaults
- Method Detail
  - getBrightGuideStars
```
public List<OffAxisRank> getBrightGuideStars(List<Star> fov,
                                             double ra0,
                                             double de0)
```
    From a field-of-view that is big enough to include all possible guide stars around the center of the science CCD, we generate an unsorted list of possible bright guide stars. Bright means all stars with a magnitude not lower than KEY_BRIGHTMAG.
    
    Parameters:
    
    fov - A list of catalog stars around the CCD center
    
    ra0 - Center of CCD, right ascension, degrees.
    
    de0 - Center of CCD, declination, degrees.
    
    Returns:
  - getFaintGuideStars
```
public List<OffAxisRank> getFaintGuideStars(List<Star> fov,
                                            double ra0,
                                            double de0)
```
    From a field-of-view that is big enough to include all possible guide stars around the center of the science CCD, we generate an unsorted list of possible bright guide stars. Bright means all stars with a magnitude not lower than KEY_BRIGHTMAG.
    
    Parameters:
    
    fov - A list of catalog stars around the CCD center
    
    ra0 - Center of CCD, right ascension, degrees.
    
    de0 - Center of CCD, declination, degrees.
    
    Returns:
  - getInnerRadius
```
public double getInnerRadius()
```
    Calculates the inner applicable radius accessible to the off-axis viewing camera. Depends on the chip size and frame width set, as well as the physical distance of the derotator axis to the camera.
    
    Returns:
    
    The inner radius in degrees.
  - getOuterRadius
```
public double getOuterRadius()
```
    Calculates the outer applicable radius accessible to the off-axis viewing camera. Depends on the chip size and frame width set, as well as the physical distance of the derotator axis to the camera.
    
    Returns:
    
    The outer radius in degrees.
  - getVisibleShift
```
public Vector2D getVisibleShift(OffAxisRank guide)
```
    If the offset of the star on the CCD differs from 0, there is a shift from the pointing to the visible center.
  - getGuiderFoV
```
public double getGuiderFoV()
```
    Gets the size of the guider-ccd half-diagonal in degrees. Measures the possible field-of-view.
  - getGuideStars
```
private Pair<List<OffAxisRank>,List<OffAxisRank>> getGuideStars(List<Star> fov,
                                                                double ra0,
                                                                double de0)
```
    From a field-of-view that is big enough to include all possible guide stars around the center of the science CCD, we generate an unsorted list of possible bright guide stars. Bright means all stars with a magnitude not lower than KEY_BRIGHTMAG.
    
    Parameters:
    
    fov - A list of catalog stars around the CCD center
    
    ra0 - Center of CCD, right ascension, degrees.
    
    de0 - Center of CCD, declination, degrees.
    
    Returns:
  - getInnerOuterCosChi
```
private Vector3D getInnerOuterCosChi()
```
    Calculates the geometry of the visible off-axis view as the inner and outer applicable radius as well as the cosine of chi, which is the viewing angle of the outer guider edges from the rotational center.
    
    Returns:
    
    A 3d-vector x is inner, y outer radius in deg and z cos chi.
  - getRank
```
private static OffAxisRank getRank(Star s,
                                   boolean b,
                                   double ra0,
                                   double de0,
                                   double psi0,
                                   double sinpsi0,
                                   double cospsi0,
                                   double radius,
                                   double rin,
                                   double rout,
                                   double chi,
                                   double sinchi,
                                   double coschi,
                                   double scale,
                                   Dimension chip,
                                   int thick)
```
    From a star, we create its rank as a possible off-axis guide star. The ra/de pair handed over is already rectified to point to the center of the circle defining the center of the off axis-guider.
    
    Parameters:
    
    s - The star operated under off axis guiding.
    
    b - True if bright star
    
    ra0 - Center of off-axis circle
    
    de0 - Centerof off-axis circle
    
    Returns:

Class OffAxisCatalog

Nested Class Summary

Field Summary

Fields inherited from class util.PropertyContainer

Fields inherited from interface util.PropertySupplying

Constructor Summary

Method Summary

Methods inherited from class util.PropertyContainer

Methods inherited from class java.lang.Object

Field Detail

KEY_RAOFFSET

KEY_DEOFFSET

KEY_PSIOFFSET

KEY_RADIUS

KEY_PIXSCALE

KEY_CHIPSIZE

KEY_FRAMESIZE

KEY_BRIGHTMAG

KEY_FAINTMAG

DEFRAOFFSET

DEFDEOFFSET

DEFPSIOFFSET

DEFRADIUS

DEFPIXSCALE

DEFCHIPSIZE

DEFFRAMESIZE

DEFBRIGHTMAG

DEFFAINTMAG

Constructor Detail

OffAxisCatalog

Method Detail

getBrightGuideStars

getFaintGuideStars

getInnerRadius

getOuterRadius

getVisibleShift

getGuiderFoV

getGuideStars

getInnerOuterCosChi

getRank