optics
Class WaveFrontImage

java.lang.Object
  optics.Optics
      optics.OpticalSurface
          optics.OpticalPlane
              optics.OpticalImage
                  optics.WaveFrontImage

All Implemented Interfaces:

Diagram2DComponent

public class WaveFrontImage
extends OpticalImage

Class to implement a WaveFront in a particular plane with the values holding the aberrations.

Field Summary

protected CircularMask

mask The mask applied to the image

Fields inherited from class optics.OpticalImage

colourScale, data, grid, max, waveLength

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

WaveFrontImage(Position p, int size)
Form WaveFrontImage with spefied position, size with range defaulting to 2.0 and outer radius to 1.0.

WaveFrontImage(Position p, int size, double range)
Form WaveFrontImage with spefied position, size and range outer radius defaults to 0.5 range.

WaveFrontImage(Position p, int size, double range, double outerRadius)
Form WaveFrontImage with spefied position, size, range, abd default circukar mask of specifed outerradius.

Method Summary

void	fill(optics.analysis.OpticalExpansion oe) Method to fill with OpticalExpansion.
void	fill(optics.analysis.OpticalExpansion oe, double range) Method to fill with OpticalExpansion.
void	fill(SurfaceFunction s) Method to set the Wavefrom image with a general surface.
jfftw.ComplexDataArray	getComplexDataArray() Method to get the ComplexDataArray with its phase set by the WavefrontImage.
double	getOuterRadius() Method to get the outer radius
OpticalImage	getPsf() Method to get the intensity psf by taking the two-dimensional FFT of the complex wavefront.
void	setOuterRadius(double r) Method to set the outer radius.

Methods inherited from class optics.OpticalImage

add, add, add, add, add, calculateIntensityRange, clear, draw, getBufferedImage, getColourScale, getDataArray, getGrid, getHeight, getLocation, getLocation, getMaxIntensity, getMaxRadius, getMinIntensity, getPixel, getPixel, getPixel, getPosition, getPosition, getSample, getSourcePoint, getSourcePoint, getWaveLength, getWidth, imagedThrough, imagedThrough, setColourScale, setPixel, setPixel, setRange, setSampleGrid, setSurfacePoint, setTestGrid, setWaveLength

Methods inherited from class optics.OpticalPlane

clone, distance, getBounds, getCurvature, getEdgePlane, getNormal, getPlaneNormal, pointInPlane, scale, setMaxRadius, setPlaneNormal, toString

Methods inherited from class optics.OpticalSurface

distance, edit, entranceAperture, exitAperture, fromString, fromTokens, getGroup, getIndex, getNormal, getPoint, getRefractiveIndex, getSurfacePoint, getSurfaceType, getSurfaceType, makeStandAlone, pointInPlane, setGroup, setRefractiveIndex, 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

Field Detail

mask

protected CircularMask mask

The mask applied to the image

Constructor Detail

WaveFrontImage

public WaveFrontImage(Position p,
                      int size,
                      double range,
                      double outerRadius)

Form WaveFrontImage with spefied position, size, range, abd default circukar mask of specifed outerradius.

Parameters:

p - the surface point

size - the wavefront image size (always square)

range - the used to set the sample internal

outerRadius - the outer radius

WaveFrontImage

public WaveFrontImage(Position p,
                      int size,
                      double range)

Form WaveFrontImage with spefied position, size and range outer radius defaults to 0.5 range.

Parameters:

p - the surface point

size - the wavefront image size (always square)

WaveFrontImage

public WaveFrontImage(Position p,
                      int size)

Form WaveFrontImage with spefied position, size with range defaulting to 2.0 and outer radius to 1.0.

Parameters:

p - the surface point

size - the wavefront image size (always square)

Method Detail

setOuterRadius

public void setOuterRadius(double r)

Method to set the outer radius.

Parameters:

r - the outer radius

getOuterRadius

public double getOuterRadius()

Method to get the outer radius

Returns:

double the outer radius

fill

public void fill(SurfaceFunction s)

Method to set the Wavefrom image with a general surface. The regaions outside the apetrure is set to Double.NaN.

Parameters:

s - the surface.

fill

public void fill(optics.analysis.OpticalExpansion oe)

Method to fill with OpticalExpansion. The range of the image is set to match the size of the expansion.

Parameters:

oe - the OpticalExpansion.

fill

public void fill(optics.analysis.OpticalExpansion oe,
                 double range)

Method to fill with OpticalExpansion. The outerRadius is set to match the MaxRadius of the expansion. The regions outsize the outerRadius are set to Double.NaN.

Parameters:

oe - the OpticalExpansion.

range - the range of the wavefront image

getComplexDataArray

public jfftw.ComplexDataArray getComplexDataArray()

Method to get the ComplexDataArray with its phase set by the WavefrontImage.

Returns:

ComplexDataAttay the ComplexImage

getPsf

public OpticalImage getPsf()

Method to get the intensity psf by taking the two-dimensional FFT of the complex wavefront.