edu.swri.swiftvis.filters
Class WakePeakFilter

java.lang.Object
  extended by edu.swri.swiftvis.filters.AbstractSingleSourceFilter
      extended by edu.swri.swiftvis.filters.WakePeakFilter
All Implemented Interfaces:
DataSink, DataSource, Filter, GraphElement, java.io.Serializable

public final class WakePeakFilter
extends AbstractSingleSourceFilter

This is a simple filter intended to isolate the location of wake peaks in the two types of output data that I use for ring simulations. The input should be either a spatial binned file or a particle binned file. The output will be data elements with one value for the Y location of the slice and one value for the X location of the peak. This filter supports a single input.

Author:
Mark Lewis
See Also:
Serialized Form

Nested Class Summary
private static interface WakePeakFilter.BinningStyle
           
private  class WakePeakFilter.ParticleBinStyle
           
private  class WakePeakFilter.SpaceBinStyle
           
 
Field Summary
private  WakePeakFilter.BinningStyle inputStyle
           
private static long serialVersionUID
           
private  EditableDouble threshold
           
private static java.lang.String[] valueDescription
           
private  javax.swing.JTextField valueField
           
private  DataFormula valueFormula
           
private  DataFormula xFormula
           
private  DataFormula yFormula
           
 
Fields inherited from class edu.swri.swiftvis.filters.AbstractSingleSourceFilter
bounds, changed, dataVect, input, propPanel, sinkVector
 
Constructor Summary
  WakePeakFilter()
           
private WakePeakFilter(WakePeakFilter c, java.util.List<GraphElement> l)
           
 
Method Summary
private  DataElement buildElement(double y, double x, double val)
           
 WakePeakFilter copy(java.util.List<GraphElement> l)
           
 java.lang.String getDescription()
           
 int getNumParameters()
           
 int getNumValues()
           
 java.lang.String getParameterDescription(int which)
          Tells you what a particular parameter is used for.
 java.lang.String getParameterName(int which, int paramVal)
          Tells you the text that should be used to describe a particular value of a given parameter.
static java.lang.String getTypeDescription()
           
 java.lang.String getValueDescription(int which)
          Tells you what a particular value is used for.
protected  void redoAllElements()
          For this class, this method runs through all of the input elements and for each column it locates the wake peaks above the threshold and
protected  void setupSpecificPanelProperties()
          This method should add any tabbed panes to the propPanel that are specific to the given filter.
 boolean useParameterNameString(int which)
          If this returns true then the value of a parameter for this type should be listed as the strong value returned by getParameterName.
 
Methods inherited from class edu.swri.swiftvis.filters.AbstractSingleSourceFilter
abstractRedoAllElements, addInput, addOutput, clearData, getBounds, getElement, getNumElements, getNumOutputs, getNumSources, getOutput, getOutputInfoPanel, getPaint, getPropertiesPanel, getSource, getSourceInfoPanel, relink, removeInput, removeOutput, setBounds, sourceAltered, validInput
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

valueDescription

private static final java.lang.String[] valueDescription

inputStyle

private WakePeakFilter.BinningStyle inputStyle

threshold

private EditableDouble threshold

xFormula

private DataFormula xFormula

yFormula

private DataFormula yFormula

valueFormula

private DataFormula valueFormula

valueField

private transient javax.swing.JTextField valueField

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

WakePeakFilter

public WakePeakFilter()

WakePeakFilter

private WakePeakFilter(WakePeakFilter c,
                       java.util.List<GraphElement> l)
Method Detail

getDescription

public java.lang.String getDescription()

getTypeDescription

public static java.lang.String getTypeDescription()

getParameterDescription

public java.lang.String getParameterDescription(int which)
Tells you what a particular parameter is used for.


useParameterNameString

public boolean useParameterNameString(int which)
If this returns true then the value of a parameter for this type should be listed as the strong value returned by getParameterName. Otherwise just the number should be displayed.


getParameterName

public java.lang.String getParameterName(int which,
                                         int paramVal)
Tells you the text that should be used to describe a particular value of a given parameter.


getValueDescription

public java.lang.String getValueDescription(int which)
Tells you what a particular value is used for.


getNumParameters

public int getNumParameters()

getNumValues

public int getNumValues()

copy

public WakePeakFilter copy(java.util.List<GraphElement> l)

redoAllElements

protected void redoAllElements()
For this class, this method runs through all of the input elements and for each column it locates the wake peaks above the threshold and

Specified by:
redoAllElements in class AbstractSingleSourceFilter

setupSpecificPanelProperties

protected void setupSpecificPanelProperties()
Description copied from class: AbstractSingleSourceFilter
This method should add any tabbed panes to the propPanel that are specific to the given filter. This is called when the propPanel is created. After it is called, the source and output info panels are added.

Specified by:
setupSpecificPanelProperties in class AbstractSingleSourceFilter

buildElement

private DataElement buildElement(double y,
                                 double x,
                                 double val)