interferogram: Interferogram object

Description Usage Arguments Details Value Note Author(s) See Also Examples

Description

Creates an instance of an interferogram object.

Usage

1
interferogram(filename)

Arguments

filename

The name of a graphics file in “Portable Anymap” format

Details

Provides an “object oriented” framework for analysis of interferograms. A call of the form .thisint <- interferogram("myinterferogram.ppm") creates an “instance” of an interferogram object. All functions for processing the interferometry data are returned with the function call.

The current version only supports graphics files in “Portable Anymap” format, and RGB files are converted to grayscale using the R channel only on the assumption that almost all interferograms will use a He-Ne source.

If interferogram() is called from the Rfringe GUI ImageMagick's (http://www.imagemagick.org) convert tool is used if necessary to convert from any graphics format supported by ImageMagick to pnm format. This means that convert must be present and on the search path if this feature is to be utilized. In Windows it also means that the path to the ImageMagick installation must be placed earlier in the path list than system files, since there is also a system convert command.

Value

A list with the following components:

ev

The environment of the interferogram() function call

isInterferogram

Identifies this object as an interferogram

image.info

Data entry function - Basic image information

analysis.info

Data entry function - Information required in wavefront analysis

target.conic.info

Data entry function - Target conic in single pass tests

circle.pars

Image analysis function - Outline aperture edge

obstruct.pars

Image analysis function - Outline obstruction (perforation)

plot.fringes

Plot function - Plots fringe trace

autotrace

Image analysis function - (Semi) automatic fringe tracing

clearpoints

Image analysis function - Fringe editing

addpoints

Image analysis function - Fringe editing

clearfringe

Image analysis function - Fringe editing

retrace

Image analysis function - Fringe editing

addsegment

Image analysis function - Fringe editing

insertfringe

Image analysis function - Fringe editing

fitzernikes

Image analysis function - Least squares fit to fringe centers

plot.si

Plot function - Synthetic interferogram

plot.wf

Plot function - Wavefront map

plot.contour

Plot function - Cross sections of wavefront along selected diameters

plot.wf3d

Plot function - Interactive 3d plot of wavefront (requires package rgl)

plot.residuals

Plot function - Some possibly useful diagnostic plots of residuals from least squares fit

plot.startest

Plot function - Star test simulation with optional MTF plot

print.summary

Output function - Prints basic summary statistics to the console window

print.details

Output function - Prints more details of estimated Zernike coefficients

print.latex

Output function - A printable detailed report, in pdf format (requires pdflatex)

Note

These functions will rarely be accessed directly at the command line if the GUI is used.

Author(s)

M.L. Peck mpeck1@ix.netcom.com. Thanks to Steven Koehler for valuable programming ideas, especially his approach to object instantiation in R.

See Also

Rfringe, project, pixmap.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
  ## Not run: 
    .thisint <- interferogram("myinterferogram.ppm")  # create an interferogram object
    .thisint$circle.pars()	#interactively outline the aperture edge
    .thisint$obstruct.pars()	#outline the obstruction
    .thisint$autotrace()	#trace the fringes
    .thisint$fitzernikes()	#do the least squares fit
    .thisint$plot.wf()		#plot the wavefront
    .thisint$print.summary()	#print some basic summary stats
  
## End(Not run)

matwey/Rfringe documentation built on May 12, 2019, 8:43 a.m.