optics
Class AnnularMask

java.lang.Object
  optics.Optics
      optics.Mask
          optics.CircularMask
              optics.AnnularMask

public class AnnularMask
extends CircularMask

Method to implement an annular mask.

Field Summary

protected double

innerRadius Outer inner radius of mask.

Fields inherited from class optics.CircularMask

outerRadius

Fields inherited from class optics.Mask

centre

Fields inherited from class optics.Optics

DEFAULT_WAVELENGTH, errorStream, fmt, MICRONS

Constructor Summary

AnnularMask(double inner, double outer)
Form a annular mask of specified inner and outer radius with a default origin at (0,0).

AnnularMask(double inner, double outer, javax.vecmath.Point2d c)
Form a annular mask of specified inner and outer radius with specifed centre.

Method Summary

double	getInnerRadius() Method to get the inner radius
protected boolean	isClearAbs(double x, double y) Method to define the annular mask
void	scale(double a) Method to scale by a factor a
void	setInnerRadius(double r) Method to set the radius of the mask

Methods inherited from class optics.CircularMask

getOuterRadius, setOuterRadius

Methods inherited from class optics.Mask

getCentre, isClear, isClear, setCentre, setCentre

Methods inherited from class optics.Optics

getDefaultWaveLength, getErrorStream, getFormatString, getName, getStaticName, getVersion, printError, setDefaultWaveLength, setErrorStream, setFormatString, setMicrons

Methods inherited from class java.lang.Object

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

Field Detail

innerRadius

protected double innerRadius

Outer inner radius of mask.

Constructor Detail

AnnularMask

public AnnularMask(double inner,
                   double outer)

Form a annular mask of specified inner and outer radius with a default origin at (0,0).

Parameters:

inner - the inner radius

outer - the outer radius

AnnularMask

public AnnularMask(double inner,
                   double outer,
                   javax.vecmath.Point2d c)

Form a annular mask of specified inner and outer radius with specifed centre.

Parameters:

inner - the inner radius

outer - the outer radius

c - the centre

Method Detail

setInnerRadius

public void setInnerRadius(double r)

Method to set the radius of the mask

Parameters:

r - the radius

getInnerRadius

public double getInnerRadius()

Method to get the inner radius

Returns:

double the inner radius

scale

public void scale(double a)

Method to scale by a factor a

Overrides:

scale in class CircularMask

Parameters:

a - the scale factor

isClearAbs

protected boolean isClearAbs(double x,
                             double y)

Method to define the annular mask

Overrides:

isClearAbs in class CircularMask

Parameters:

x - the x location

y - the y location.

Returns:

boolean true if transparent