optics
Class CircularAperture

java.lang.Object
  optics.Optics
      optics.OpticalSurface
          optics.OpticalPlane
              optics.Aperture
                  optics.CircularAperture

All Implemented Interfaces:

Diagram2DComponent

public class CircularAperture
extends Aperture

Method to implement a circular aperture in the x/y plane with outer and inner radius. The centre of the aperture is determined by the surface refence point, which does not require to be on-axis.

Field Summary

Fields inherited from class optics.Aperture

mask

Fields inherited from class optics.OpticalPlane

blockedNormal, maxRadius, planeNormal

Fields inherited from class optics.OpticalSurface

CLEAR, group, REFLECTING, REFRACTING, refractiveIndex, surfacePoint, surfaceType

Fields inherited from class optics.Optics

DEFAULT_WAVELENGTH, errorStream, fmt, MICRONS

Constructor Summary

CircularAperture(CircularAperture a)
Circular aperture specifed by specified circular aperture except OpticalGroup.

CircularAperture(double z, double outer)
Circular aperture with specified position centred on the z-axis and specified outer radius.

CircularAperture(Position p, double outer)
Circular aperture with specified three dimensional point and specified outer radius.

Method Summary

CircularAperture	clone() Method to clone the current circular aperture but leaving the OpticalGroup unset.
void	draw(java.awt.Graphics2D g) Method to draw the circular in 2D context.
double	getOuterRadius() Method to get the Outer Radius
void	setOuterRadius(double r) Void to set the outer radius, also the underlying maximum plane radius.
java.lang.String	toString() Metod to format as a String

Methods inherited from class optics.Aperture

getMask, getNormal, scale, setMask

Methods inherited from class optics.OpticalPlane

distance, getBounds, getCurvature, getEdgePlane, getMaxRadius, getPlaneNormal, pointInPlane, setMaxRadius, setPlaneNormal

Methods inherited from class optics.OpticalSurface

distance, edit, entranceAperture, exitAperture, fromString, fromTokens, getGroup, getIndex, getNormal, getPoint, getRefractiveIndex, getSurfacePoint, getSurfaceType, getSurfaceType, makeStandAlone, pointInPlane, setGroup, setRefractiveIndex, setSurfacePoint, setSurfaceType

Methods inherited from class optics.Optics

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CircularAperture

public CircularAperture(Position p,
                        double outer)

Circular aperture with specified three dimensional point and specified outer radius.

Parameters:

p - The centre of the aperture

outer - the outer radius

CircularAperture

public CircularAperture(double z,
                        double outer)

Circular aperture with specified position centred on the z-axis and specified outer radius.

Parameters:

z - position on the z-axis

outer - the outer radius.

CircularAperture

public CircularAperture(CircularAperture a)

Circular aperture specifed by specified circular aperture except OpticalGroup.

Parameters:

a - circular aperture

Method Detail

clone

public CircularAperture clone()

Method to clone the current circular aperture but leaving the OpticalGroup unset.

Overrides:

clone in class OpticalPlane

Returns:

CircularAperture clone of current

setOuterRadius

public void setOuterRadius(double r)

Void to set the outer radius, also the underlying maximum plane radius.

Parameters:

r - The outer radius

getOuterRadius

public double getOuterRadius()

Method to get the Outer Radius

Returns:

double The outer radius

toString

public java.lang.String toString()

Metod to format as a String

Overrides:

toString in class OpticalPlane

draw

public void draw(java.awt.Graphics2D g)

Method to draw the circular in 2D context. Overloads draw in OpticalPlane.

Specified by:

draw in interface Diagram2DComponent

Overrides:

draw in class OpticalPlane

Parameters:

g - the Graphics2D context.