stella.adapter
Interface Guiding

All Known Implementing Classes:

AbstractAltAzGuider, AbstractNasmythGuider, AbstractStarGuider, AdapterGuider, AuxiliaryGuider, E2VGuider, GregorGuider, JGregorAuxiliaryGuider, JGregorGuider, NasmythGuider, PrimeFocusGuider, StellaGuider, VideoGuider, WifsipGuider

public interface Guiding

The guiding interface comprises all methods necessary for the AdapterMaster to acquire and guide. It is based on the assumption that a guiding CCD is present that can operate in windowing mode. It is read and interpreted by the implementing class.

Nested Class Summary

static interface	Guiding.RawFrame An interface definition used for setting reductional parameters in the guider frame.
static interface	Guiding.RawStar The interface defintion for raw stars.

Method Summary

List<Guiding.RawStar>	getGuidingStars(Guiding.RawFrame frame, long expt, int datamin, int datamax, int search, String type) Takes a guiding frame and processes it in a way that any steps necessary to derive star positions out of it.
Point2D	match(List<? extends Guiding.RawStar> raw, List<? extends Guiding.RawStar> catalog, double poserror, double magerr) Matches a list of Guiding.RawStars measured against a list of Guiding.RawStars constructed from a catalog.
void	registerCcd(CcdDriver ccd) Assigns a CCD to the guidng instance.

Method Detail

registerCcd

void registerCcd(CcdDriver ccd)

Assigns a CCD to the guidng instance. The ccd must be ready for taking images, i.e. it must be initialized within the caller.

getGuidingStars

List<Guiding.RawStar> getGuidingStars(Guiding.RawFrame frame,
                                      long expt,
                                      int datamin,
                                      int datamax,
                                      int search,
                                      String type)
                                      throws IOException,
                                             IllegalWindowException,
                                             IllegalSearchBoxException

Takes a guiding frame and processes it in a way that any steps necessary to derive star positions out of it. The returned list is a list of Guiding.RawStars. The search box is a dimension in pixel.

Parameters:

guide - A rectangle specifying the guiding frame in pixel.

binx - Binning factor in x.

biny - Binning factor in y.

expt - The exposure time in ms.

search - The width and height of the search box in pixel. Normally quadratic.

datamin - Minimum data value to consider.

datamax - Maximum data value to consider to exclude cosmics.

search - Size of search box in pixel.

isacquire - The type of the frame. Implementation specific

Returns:

A list of Guiding.RawStars.

Throws:

IllegalWindowException - If the rectangle is invalid, i.e. if the size and/or the upper left coordinate cannot be realized on the guider CCD.

IllegalSearchBoxException - If the search box is too large.

IOException - If the CCD cannot be read.

match

Point2D match(List<? extends Guiding.RawStar> raw,
              List<? extends Guiding.RawStar> catalog,
              double poserror,
              double magerr)
              throws AmbiguousPatternException,
                     NoStarException,
                     CannotMatchException

Matches a list of Guiding.RawStars measured against a list of Guiding.RawStars constructed from a catalog. In constructing the list from a catalog, an extra border is applied to account for possible misspointings of the telescope. The supplied pixel values are applied to both sides of the guiding frame.

Parameters:

raw - The list of Guiding.RawStars. The master deletes all invalid (i.e. non-star objects) from the list returned by getGuidingStars(stella.adapter.Guiding.RawFrame, long, int, int, int, java.lang.String).

catalog - The list of Guiding.RawStarss provided by the AdapterMaster, calculated from a star catalog. This list will comprise a bigger field then the expected actual guider field.

width - The additional frame thickness between catalog and image in pixel.

height - The additional frame thickness between catalog and image in pixel.

poserror - An estimate in pixel of the position errors in the catalog stars.

magerr - An estimate magnitudes of the catalog to image mags.

Returns:

The shift of the catalog position minus the measured position.

Throws:

AmbiguousPatternException - If more stars are seen in the raw data than can be matched to the catalog.

NoStarException - If the supplied list of raw stars is empty.

CannotMatchException - If matching fails for any other reason.