project: Interfometry project

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

Description

Creates an instance of an interferometry project.

Usage

1
project(project.id, project.notes=NULL, project.tester=NULL, project.date=NULL)

Arguments

project.id

Character string - an identifier for the project

project.notes

Optional character string - additional project notes

project.tester

Optional character string - the tester (or any other useful information)

project.date

Optional character string - date of the test (or other information)

Details

Provides an "object oriented" framework for the analysis of multiple interferograms as a group. A call of the form .thisproject <- project("myproject") creates an "instance" of a project object. All functions for processing the grouped data are returned with the function call.

Value

A list with the following components:

ev

The environment of the project() function call

isIntProject

Identifies this object as an interferometry project

project.addto

Utility function - copies data from an interferogram into project object

project.removefrom

Utility function - removes interferogram data from project object

plot.wf

Plot function - Wavefront map

plot.contour

Plot function - Cross sections of wavefront along selected diameters

plot.startest

Plot function - Star test simulation with optional MTF plot

plot.wf3d

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

plot.spm

Plot function - Coplots of RMS, P-V, and Strehl from individual interferograms

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, interferogram,

Examples

1
2
3
4
5
6
7
8
9
  ## Not run: 
    .thisproject <- project("myproject")  # create a project object
    .thisproject$project.addto(.thisint$ev)	#note you add an interferogram 
    						# by passing its environment
    .thisproject$plot.wf()	#Plot averaged wavefront
    .thisproject$plot.spm()	#Possibly interesting comparisons of interferograms
    .thisproject$print.summary()	#Some basic summary statistics
  
## End(Not run)

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