Package jpiv2

JPIV particle image velocimetry source code documentation.

See: Description

Class Summary

Class	Description
CmdFrame	A text frame providing some editing and scripting functionality.
CmdInterpreter	Executes external applications, shell commands, and interpretes javacode.
ColorChooserDlg	A simplified color chooser dialog.
DisplayImgFrame	Displays pixel images on the screen.
DisplayPanel	A display panel enabling one to show different parts of an image.
DisplayVecFrame	Displays a vector field.
EnumerationListCellRenderer	Numbers JList elements.
FileHandling	A collection of convenience methods for file handling.
FlexFileChooser	A configurable file chooser dialog.
FloatingFrame	An always visible, borderless frame.
ImgProc
JPiv	Main class of the jpiv2 package.
JpivFileFilter	Some file filters that are used by the jpiv2.FlexFileChooser.
ListFrame	Internal Frame holding a list of filenames.
PivData	This class provides some functionality for 2D-PIV-data processing.
PivDataFilter	Filters for PIV data.
PivDataReduce	PIV Data reduction.
PivEvaluation	PIV Evaluation.
PivImg	A double frame pixel image representation.
PivUtil	Calculates the two dimensional cross-correlation function of two images.
ScriptDlg	A customizable dialog for user input.
Settings	Serializable object encapsulating all program settings.
SettingsFrame	An internal frame providing access to all program settings via a tree structure.
SinglePixelCorr	Single pixel ensemble correlation
SplashScreen	An always on top, borderless frame.
Statistics	Some convenient methods for calculating statistical data.
SystemOutStream	This class is used to copy system output to a jpiv2.CmdFrame.
ThirdComponentReconstruction	Reconstruction of the third velocity component from a stack of 2d measurements under the assumption of mass-conservation.
VecImg	Pixel image representing vector data.
VerifierFloat	Float Verifier.
VerifierInt	Integer verifier.
VerifierUFloat	Unsigned Float Input Verifier.
VerifierUInt	Unsigned Integer Input Verifier.

Package jpiv2 Description

JPIV particle image velocimetry source code documentation. Roughly speaking, this package can be devided into two different sorts of classes:
1. Classes forming a user interface for PIV evaluations, image and vector field display.
2. Classes for image analysis and PIV data processing.

You can make yourself familiar with this package, by just reading the description of the different classes. The full list of classes is provided in the table above. The most important classes are mentioned below to give a first quick overview.

Important classes of the first category are:

JPiv
This is the main jpiv window. When you start jpiv, a jpiv2.JPiv() object is created and shown on screen. Three child frames are also created on startup and shown, their classes are: SettingsFrame, CmdFrame, and ListFrame.
SettingsFrame
An object of this class is used to edit all jpiv settings.
CmdFrame
An object of this class is used for displaying system output and for BeanShell scripting.
ListFrame
A ListFrame object holds the links to the files, that the user is currently working with.

Important classes of the second category are Settings, PivData, and PivEvaluation.

Settings
This class is basically a list of all variables used in jpiv. This object is serializable, that means it can be saved to a file and restored from a file.
PivData
A PivData object might be created from a file, a list of files or an array of data. A PivData object has a lot of methods to process this data, like normalizedMedianTest(parameters), resample(parameters), or writeDataToFile(parameters).
PivEvaluation
This class is performing the PIV image analysis. The actual image correlation is implemented in the class PivUtils.


Have a lot of fun!


Peter