AveragePinhole

java.lang.Object
- util.PropertyContainer
- - stella.adapter.AbstractPinholeShift
  - - stella.adapter.AbstractPinholeModel
    - - stella.adapter.AveragePinhole

All Implemented Interfaces:

Cloneable, PinholeShift, Initializable, PropertySupplying
```
public class AveragePinhole
extends AbstractPinholeModel
```
Class that determines the pixel shift between pinhole and star plus the pinhole drift to the zero position, all by modelling the star plus pinhole. This should be used on high signal-to-noise data, like averaged guiding frames. To allow for smeared images, we do not use a moffat function, but rather a gauss profile. The pinhole is moddeled as
```
 ph(r)=1+(atan(k*(x-FWHM/2))-atan(k*(x+FWHM/2)))/π,
 
```
where bigger k's mean steeper slope. A plot can be found . This class models the fwhm of the pinhole, its steepness factor k and its remainder reflectivity, all these must have good starting values in the pinhole parameters named size, steep, deep. Additionally to the shift of the pinhole, we also get a hold on the seeing and total flux of the star.
This class is similar to ModelShift, but it goes a step further and also models pinhole movements. This can only be used on very high S/N date.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AveragePinhole.FullPinhole` A pinhole model is the model of a star with fitted intensity and FWHM close to the fixed pinhole position at the given coordinates.
`static class`	`AveragePinhole.Test` Test class.

Nested classes/interfaces inherited from class stella.adapter.AbstractPinholeModel
AbstractPinholeModel.AbstractPinholeFits

Nested classes/interfaces inherited from class stella.adapter.AbstractPinholeShift
AbstractPinholeShift.Background, AbstractPinholeShift.Evaluate, AbstractPinholeShift.Reconstruct

Field Summary

Fields
Modifier and Type	Field and Description
`private static boolean`	`DEFFITDEEP`
`private static boolean`	`DEFFITFLUX`
`private static boolean`	`DEFFITPOSITION`
`private static boolean`	`DEFFITSIZE`
`private static boolean`	`DEFFITSTAR`
`private static boolean`	`DEFFITSTEEP`
`private static double`	`DEFMOFFATBETA` The moffat-beta, 4.765 is literature value.
`private static double`	`DEFPINHOLEDEEP` Broad-band anti-reflective coating, typically.
`private static double`	`DEFPINHOLESIZE` Default size (FWHM) of pinhole, pixel.
`private static double`	`DEFPINHOLESTEEP` Pinhole model steepness.
`private static double`	`DEFSTARSIZEFRAC`
`private static double`	`DEFVANISH`
`private double`	`firstflux`
`static String`	`KEY_FITDEEP` The pinhole model minimum transmission .
`static String`	`KEY_FITFLUX` The pinhole model minimum transmission .
`static String`	`KEY_FITPOSITION` The pinhole model minimum transmission .
`static String`	`KEY_FITSFWHM` The pinhole model minimum transmission .
`static String`	`KEY_FITSTAR` The pinhole model minimum transmission .
`static String`	`KEY_FITSTEEP` The pinhole model minimum transmission .
`static String`	`KEY_MOFFATBETA` The moffat-beta, 4.765 is literature value.
`static String`	`KEY_PINHOLEDEEP` The pinhole model minimum transmission .
`static String`	`KEY_PINHOLESIZE` The pinhole diameter.
`static String`	`KEY_PINHOLESTEEP` The pinhole model steepness .
`static String`	`KEY_STARSIZEFRAC` The star to pinhole FWHM
`static String`	`KEY_VANISH` The normal vanish fraction

Fields inherited from class stella.adapter.AbstractPinholeModel
fit, KEY_MU, KEY_PIXELSCALE, KEY_USESIMPLEX

Fields inherited from class stella.adapter.AbstractPinholeShift
KEY_ADNOISE, KEY_APPLICABLE, KEY_GAIN, KEY_PINHOLE, KEY_SIGMACLIP, KEY_SKYTHICK

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

AveragePinhole(Map<String,String> prop)
Constructs a model-shift.

Constructors
Constructor and Description
`AveragePinhole(Map<String,String> prop)` Constructs a model-shift.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected AbstractPinholeModel.AbstractPinholeFits`	`generatePinholeModel(MImageHDU hdu, Rectangle frame, double back, double backerr, Point2D pinhole)` This method intializes the pinhole model used in the fitting process during `AbstractPinholeModel.initFiberView(fits.hdu.MFits)`.
`Vector2D`	`getBackground(MImageHDU hdu)` This method calculates the background as the median of a frame at the outer edge of the applicable window.
`double`	`getFlux()` Returns the total flux from the last solution, if possible.
`double`	`getFwhm()` Returns the fwhm from the last solution, if possible.
`Point2D`	`getPinholePosition()` Returns the pinhole position.
`Point2D`	`getStarPosition()` Returns the star position.

Methods inherited from class stella.adapter.AbstractPinholeModel
getBox, getGnuPlotLines, getMeasures, getModel, getModel, getRelativeStarModel, getRemainingFlux, getResiduals, getRms, getSolution, getStarModel, initFiberView, solveFiberView, sumup

Methods inherited from class stella.adapter.AbstractPinholeShift
backgroundFrameMean, backgroundFrameMedian, backgroundMean, backgroundMedian, getAduSignal, getApplicableWindow, getSignalToNoise, init

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_MOFFATBETA
```
public static final String KEY_MOFFATBETA
```
    The moffat-beta, 4.765 is literature value.
    
    See Also:
    
    Constant Field Values
  - KEY_VANISH
```
public static final String KEY_VANISH
```
    The normal vanish fraction
    
    See Also:
    
    Constant Field Values
  - KEY_STARSIZEFRAC
```
public static final String KEY_STARSIZEFRAC
```
    The star to pinhole FWHM
    
    See Also:
    
    Constant Field Values
  - KEY_PINHOLESIZE
```
public static final String KEY_PINHOLESIZE
```
    The pinhole diameter.
    
    See Also:
    
    Constant Field Values
  - KEY_PINHOLESTEEP
```
public static final String KEY_PINHOLESTEEP
```
    The pinhole model steepness .
    
    See Also:
    
    Constant Field Values
  - KEY_PINHOLEDEEP
```
public static final String KEY_PINHOLEDEEP
```
    The pinhole model minimum transmission .
    
    See Also:
    
    Constant Field Values
  - KEY_FITFLUX
```
public static final String KEY_FITFLUX
```
    The pinhole model minimum transmission .
    
    See Also:
    
    Constant Field Values
  - KEY_FITSTAR
```
public static final String KEY_FITSTAR
```
    The pinhole model minimum transmission .
    
    See Also:
    
    Constant Field Values
  - KEY_FITPOSITION
```
public static final String KEY_FITPOSITION
```
    The pinhole model minimum transmission .
    
    See Also:
    
    Constant Field Values
  - KEY_FITSFWHM
```
public static final String KEY_FITSFWHM
```
    The pinhole model minimum transmission .
    
    See Also:
    
    Constant Field Values
  - KEY_FITDEEP
```
public static final String KEY_FITDEEP
```
    The pinhole model minimum transmission .
    
    See Also:
    
    Constant Field Values
  - KEY_FITSTEEP
```
public static final String KEY_FITSTEEP
```
    The pinhole model minimum transmission .
    
    See Also:
    
    Constant Field Values
  - DEFMOFFATBETA
```
private static final double DEFMOFFATBETA
```
    The moffat-beta, 4.765 is literature value.
    
    See Also:
    
    Constant Field Values
  - DEFVANISH
```
private static final double DEFVANISH
```
    See Also:
    
    Constant Field Values
  - DEFSTARSIZEFRAC
```
private static final double DEFSTARSIZEFRAC
```
    See Also:
    
    Constant Field Values
  - DEFPINHOLESIZE
```
private static final double DEFPINHOLESIZE
```
    Default size (FWHM) of pinhole, pixel.
    
    See Also:
    
    Constant Field Values
  - DEFPINHOLESTEEP
```
private static final double DEFPINHOLESTEEP
```
    Pinhole model steepness.
    
    See Also:
    
    Constant Field Values
  - DEFPINHOLEDEEP
```
private static final double DEFPINHOLEDEEP
```
    Broad-band anti-reflective coating, typically.
    
    See Also:
    
    Constant Field Values
  - DEFFITFLUX
```
private static final boolean DEFFITFLUX
```
    See Also:
    
    Constant Field Values
  - DEFFITSTAR
```
private static final boolean DEFFITSTAR
```
    See Also:
    
    Constant Field Values
  - DEFFITPOSITION
```
private static final boolean DEFFITPOSITION
```
    See Also:
    
    Constant Field Values
  - DEFFITSIZE
```
private static final boolean DEFFITSIZE
```
    See Also:
    
    Constant Field Values
  - DEFFITSTEEP
```
private static final boolean DEFFITSTEEP
```
    See Also:
    
    Constant Field Values
  - DEFFITDEEP
```
private static final boolean DEFFITDEEP
```
    See Also:
    
    Constant Field Values
  - firstflux
```
private double firstflux
```
- Constructor Detail
  - AveragePinhole
```
public AveragePinhole(Map<String,String> prop)
```
    Constructs a model-shift.
- Method Detail
  - getBackground
```
public Vector2D getBackground(MImageHDU hdu)
```
    This method calculates the background as the median of a frame at the outer edge of the applicable window.
    
    Returns:
    
    The background ADU in x and its ADU-sigma in y.
  - generatePinholeModel
```
protected AbstractPinholeModel.AbstractPinholeFits generatePinholeModel(MImageHDU hdu,
                                                                        Rectangle frame,
                                                                        double back,
                                                                        double backerr,
                                                                        Point2D pinhole)
                                                                 throws BasicFitsException
```
    This method intializes the pinhole model used in the fitting process during AbstractPinholeModel.initFiberView(fits.hdu.MFits). We supply the image data, the applicable image rectangle, the background estimate plus its error and the zero-order pinhole position.
    
    Specified by:
    
    generatePinholeModel in class AbstractPinholeModel
    
    Throws:
    
    BasicFitsException
  - getPinholePosition
```
public Point2D getPinholePosition()
```
    Returns the pinhole position.
    
    Specified by:
    
    getPinholePosition in interface PinholeShift
    
    Overrides:
    
    getPinholePosition in class AbstractPinholeShift
  - getStarPosition
```
public Point2D getStarPosition()
```
    Returns the star position.
    
    Specified by:
    
    getStarPosition in class AbstractPinholeModel
  - getFlux
```
public double getFlux()
```
    Returns the total flux from the last solution, if possible.
    
    Specified by:
    
    getFlux in interface PinholeShift
    
    Overrides:
    
    getFlux in class AbstractPinholeShift
  - getFwhm
```
public double getFwhm()
```
    Returns the fwhm from the last solution, if possible.
    
    Specified by:
    
    getFwhm in interface PinholeShift
    
    Overrides:
    
    getFwhm in class AbstractPinholeShift

Class AveragePinhole

Nested Class Summary

Nested classes/interfaces inherited from class stella.adapter.AbstractPinholeModel

Nested classes/interfaces inherited from class stella.adapter.AbstractPinholeShift

Field Summary

Fields inherited from class stella.adapter.AbstractPinholeModel

Fields inherited from class stella.adapter.AbstractPinholeShift

Fields inherited from class util.PropertyContainer

Fields inherited from interface util.PropertySupplying

Constructor Summary

Method Summary

Methods inherited from class stella.adapter.AbstractPinholeModel

Methods inherited from class stella.adapter.AbstractPinholeShift

Methods inherited from class util.PropertyContainer

Methods inherited from class java.lang.Object

Field Detail

KEY_MOFFATBETA

KEY_VANISH

KEY_STARSIZEFRAC

KEY_PINHOLESIZE

KEY_PINHOLESTEEP

KEY_PINHOLEDEEP

KEY_FITFLUX

KEY_FITSTAR

KEY_FITPOSITION

KEY_FITSFWHM

KEY_FITDEEP

KEY_FITSTEEP

DEFMOFFATBETA

DEFVANISH

DEFSTARSIZEFRAC

DEFPINHOLESIZE

DEFPINHOLESTEEP

DEFPINHOLEDEEP

DEFFITFLUX

DEFFITSTAR

DEFFITPOSITION

DEFFITSIZE

DEFFITSTEEP

DEFFITDEEP

firstflux

Constructor Detail

AveragePinhole

Method Detail

getBackground

generatePinholeModel

getPinholePosition

getStarPosition

getFlux

getFwhm