stella.globals

Class DitherParameter

java.lang.Object

util.PropertyContainer

util.PropertyResources

globals.parameter.AbstractParameter

stella.globals.AbstractTargetParameter

stella.globals.DitherParameter

All Implemented Interfaces:

Parameter, ParameterDepending, TargetDependingParameter, Cloneable, TargetDepending, ExitCleaning, Initializable, PropertySupplying, ResourceSupplying

public class DitherParameter
extends AbstractTargetParameter
implements ParameterDepending

A dithering parameter supports exposure-number based dithering of an imaging instrument. It supports both, regular and random patterns and is driven by the dither offset in ra and de, and the dithersteps. All non-default information is found in the target definition, in a setup with the name ReservedConstants#.
For a fixed dither pattern, setup a target like

 Setup id="dithering"
 Constantname
 ragrid
 Constantvalue
 5
 

The constant names must be equal to the properties. A regular dither is always conducted along a spiral. The grid values are pixel offsets, the steps is the number of grid offsets to either direction, e.g. in the above case with a step=2 we would get five ra offsets at, -10 -5, 0, +5 and +10 pixels on the CCD. If combined with degrid=7, we would get as pattern

  0,  0;
  5,  0;
  5, -7;
  0, -7;
 -5, -7;
 -5,  0;
 -5,  7;
  0,  7;
  5,  7;
 10,  7;
 10,  0;
 10, -7;
 10, -14;
  5, -14;
  0, -14;
 -5, -14;
-10, -14;
-10,  -7;
-10,   0;
-10,   7;
-10,  14;
 -5,  14;
  0,  14;
  5,  14;
 10,  14;
 

If a randomized offset is given, an additional maximum offset of rarandom and derandom is added to the pattern.

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields

Modifier and Type	Field and Description
private Value	count The parameter that counts the actual exposure number.
private static double	DEFDEGRID Default de-step, zero.
private static double	DEFDERANDOM Default ra-step, zero.
private static String	DEFEXPOSURECOUNT Default exposure counter name.
private static int	DEFGRIDSTEP Default grid size, zero.
private static double	DEFRAGRID Default ra-step, zero.
private static double	DEFRARANDOM Default ra-step, zero.
private double	degrid This value is changed with each new target.
private double	derandom This value is changed with each new target.
private int	gridstep This value is changed with each new target.
static String	KEY_DEGRID Size of de-like step, in pixel.
static String	KEY_DERANDOM Size of ra-like step, in pixel.
static String	KEY_EXPOSURECOUNT The parameter that counts the exposure number.
static String	KEY_GRIDSTEP Size of grid, to both directions.
static String	KEY_RAGRID Size of ra-like step, in pixel.
static String	KEY_RARANDOM Size of ra-like random step, in pixel.
private double	ragrid This value is changed with each new target.
private double	rarandom This value is changed with each new target.

Fields inherited from class stella.globals.AbstractTargetParameter

KEY_INDEX

Fields inherited from class globals.parameter.AbstractParameter

KEY_FORMAT, KEY_NAME, KEY_PRESERVE, UNKNOWN

Fields inherited from class util.PropertyResources

KEY_NOINITONCREATE, POSTFIX_ALPHABET, POSTFIX_BYTES, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_MODTIME, POSTFIX_URL

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Fields inherited from interface util.ResourceSupplying

KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Constructor Summary

Constructors

Constructor and Description
DitherParameter(Map<String,String> prop) Constructs a new dither parameter, defaulting all values to zero.

Method Summary

Modifier and Type	Method and Description
private static Vector2D	calculateDither(int index, double rapix, double depix, double rarand, double derand, int size) Calculates a spiral-like pattern dither, where the first number is the current dither count.
private void	defaultDither() Default dither values loaded from properties.
Vector2D	get() We return from a previously registered target and the actual exposure number the qulified pixel ofset in pseude ra/de.
Vector2D	getForTarget(TargetDefinition td) Returns the dither offsets for the given target, using the actual exposure count.
void	init() On init, we set our grid size and steps to the default values.
void	registerParameter(Parameter c) We need a parameter that counts the ongoing exposures, normally an ExposureCount.
void	registerTarget(TargetDefinition td) On target registering, we see if a dithering setup exists, if not we load the default values from the properties.
private static Number[]	scanTarget(TargetDefinition td) We scan the target for the specific setup with the name ReservedConstants.DITHERING.
Object	set(Object to) Not allowed.

Methods inherited from class stella.globals.AbstractTargetParameter

getAsStar, getConstant, getFormattedFor, getSetup

Methods inherited from class globals.parameter.AbstractParameter

createParameter, delivers, exit, getFormatted, getFormatted, getName, getPreserveFile, getString, getString, overrideDefaultName, register, rescanned, setName, toString

Methods inherited from class util.PropertyResources

clone, createFrom, createFrom, createFrom, createInstance, getApplet, getAsResources, getLocate, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, hasLocalURLs, initProperties, keyCreate, keyCreate, reload, setApplet

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, 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, isNew, parseObject, parseObject, reload, removeProperty, requires, setObject, setProperties, setProperty, stringProperties

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface globals.Parameter

getFormatted, getName, getString

Methods inherited from interface util.PropertySupplying

defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Field Detail

KEY_RAGRID

public static final String KEY_RAGRID

Size of ra-like step, in pixel.

See Also:

Constant Field Values

KEY_DEGRID

public static final String KEY_DEGRID

Size of de-like step, in pixel.

See Also:

Constant Field Values

KEY_GRIDSTEP

public static final String KEY_GRIDSTEP

Size of grid, to both directions.

See Also:

Constant Field Values

KEY_RARANDOM

public static final String KEY_RARANDOM

Size of ra-like random step, in pixel.

See Also:

Constant Field Values

KEY_DERANDOM

public static final String KEY_DERANDOM

Size of ra-like step, in pixel.

See Also:

Constant Field Values

KEY_EXPOSURECOUNT

public static final String KEY_EXPOSURECOUNT

The parameter that counts the exposure number.

See Also:

Constant Field Values

DEFRAGRID

private static final double DEFRAGRID

Default ra-step, zero.

See Also:

Constant Field Values

DEFDEGRID

private static final double DEFDEGRID

Default de-step, zero.

See Also:

Constant Field Values

DEFGRIDSTEP

private static final int DEFGRIDSTEP

Default grid size, zero.

See Also:

Constant Field Values

DEFRARANDOM

private static final double DEFRARANDOM

Default ra-step, zero.

See Also:

Constant Field Values

DEFDERANDOM

private static final double DEFDERANDOM

Default ra-step, zero.

See Also:

Constant Field Values

DEFEXPOSURECOUNT

private static final String DEFEXPOSURECOUNT

Default exposure counter name.

See Also:

Constant Field Values

gridstep

private int gridstep

This value is changed with each new target.

ragrid

private double ragrid

This value is changed with each new target.

degrid

private double degrid

This value is changed with each new target.

rarandom

private double rarandom

This value is changed with each new target.

derandom

private double derandom

This value is changed with each new target.

count

private Value count

The parameter that counts the actual exposure number.

Constructor Detail

DitherParameter

public DitherParameter(Map<String,String> prop)

Constructs a new dither parameter, defaulting all values to zero.

Method Detail

init

public void init()
          throws InitException

On init, we set our grid size and steps to the default values.

Specified by:

init in interface Initializable

Overrides:

init in class AbstractParameter

Throws:

InitException

defaultDither

private void defaultDither()

Default dither values loaded from properties.

registerParameter

public void registerParameter(Parameter c)

We need a parameter that counts the ongoing exposures, normally an ExposureCount.

Specified by:

registerParameter in interface ParameterDepending

registerTarget

public void registerTarget(TargetDefinition td)

On target registering, we see if a dithering setup exists, if not we load the default values from the properties. If the dither setup exists, we scan the five relevant keys and update the grid definition accordingly.

Specified by:

registerTarget in interface TargetDepending

getForTarget

public Vector2D getForTarget(TargetDefinition td)

Returns the dither offsets for the given target, using the actual exposure count.

Specified by:

getForTarget in interface TargetDependingParameter

get

public Vector2D get()

We return from a previously registered target and the actual exposure number the qulified pixel ofset in pseude ra/de.

Specified by:

get in interface Parameter

set

public Object set(Object to)
           throws UnsupportedOperationException

Not allowed.

Specified by:

set in interface Parameter

Returns:

The previous value of this parameter.

Throws:

UnsupportedOperationException - If this parameter is read-only.

scanTarget

private static Number[] scanTarget(TargetDefinition td)

We scan the target for the specific setup with the name ReservedConstants.DITHERING. If found, we return the ragrid, degrid, rarandom, derandom, and gridsize as a five-dim number array in exactly this order. Non-defined constants are null.

calculateDither

private static Vector2D calculateDither(int index,
                                        double rapix,
                                        double depix,
                                        double rarand,
                                        double derand,
                                        int size)

Calculates a spiral-like pattern dither, where the first number is the current dither count. Never returns null.