java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.data.filter.AbstractFilter<Spectrum>
      - adams.data.spectrumfilter.AmplitudeExpression

All Implemented Interfaces:

adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<adams.data.filter.Filter>, adams.core.SizeOfHandler, adams.data.filter.Filter<Spectrum>, adams.parser.GrammarSupplier, Serializable, Comparable
```
public class AmplitudeExpression
extends adams.data.filter.AbstractFilter<Spectrum>
implements adams.parser.GrammarSupplier
```
Applies the specified mathematical expression to each amplitude.
The following symbols are available:
- A: the current amplitude
- W: the current wave number
- I: the 0-based index of the wave number/amplitude
- S: the number of wave numbers in the current spectrum

The following grammar is used for the expressions:

expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;

expr ::= ( expr )

# data types
| number
| string
| boolean
| date

# constants
| true
| false
| pi
| e
| now()
| today()

# negating numeric value
| -expr

# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)

# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
| has ( variable )
| isNaN ( expr )

# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;

# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| rand () (unseeded double, 0-1)
| rand ( seed ) (seeded double, 0-1)
| randint ( bound ) (unseeded int from 0 to bound-1)
| randint ( seed, bound ) (seeded int from 0 to bound-1)
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )

# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] ) (find 'search' in 'expr', return 1-based position)
| contains ( str , find ) (checks whether 'str' string contains 'find' string)
| replace ( str , pos , len , newstr )
| replaceall ( str , regexp , replace ) (applies regular expression to 'str' and replaces all matches with 'replace')
| substitute ( str , find , replace [, occurrences] )
| str ( expr )
| str ( expr , numdecimals )
| str ( expr , decimalformat )
| ext ( file_str ) (extracts extension from file)
| replaceext ( file_str, ext_str ) (replaces the extension of the file with the new one)
;

Notes:
- Variables are either all alphanumeric and _, starting with uppercase letter (e.g., "ABc_12"),
any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]") or
enclosed by single quotes (e.g., "'Hello World'").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'.
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g. 'len("abc")' is the same as 'length("abc")'
- 'str' uses java.text.DecimalFormat when supplying a format string

A lot of the functions have been modeled after LibreOffice:
https://help.libreoffice.org/Calc/Functions_by_Category

Additional functions:
- env(String): String
   First argument is the name of the environment variable to retrieve.
   The result is the value of the environment variable.

Additional procedures:
- println(...)
   One or more arguments are printed as comma-separated list to stdout.
   If no argument is provided, a simple line feed is output.
```
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
```
```
-no-id-update <boolean> (property: dontUpdateID)
    If enabled, suppresses updating the ID of adams.data.id.IDHandler data containers.
    default: false
 
```
```
-expression <adams.parser.MathematicalExpressionText> (property: expression)
    The mathematical expression to evaluate.
    default: A
 
```
Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class adams.data.filter.AbstractFilter
  adams.data.filter.AbstractFilter.FilterJob<T extends adams.data.container.DataContainer>

Field Summary

Fields
Modifier and Type	Field	Description
`protected adams.parser.MathematicalExpressionText`	`m_Expression`	the mathematical expression to evaluate.
`static String`	`PLACEHOLDER_AMPLITUDE`	the placeholder for the amplitude.
`static String`	`PLACEHOLDER_INDEX`	the placeholder for the index.
`static String`	`PLACEHOLDER_SIZE`	the placeholder for the total number of wave numbers.
`static String`	`PLACEHOLDER_WAVENUMBER`	the placeholder for the wave number.

Fields inherited from class adams.data.filter.AbstractFilter
m_DontUpdateID

Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

AmplitudeExpression()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`defineOptions()`	Adds options to the internal list of options.
`String`	`expressionTipText()`	Returns the tip text for this property.
`adams.parser.MathematicalExpressionText`	`getExpression()`	Returns the mathematical expression to evaluate.
`String`	`getGrammar()`	Returns a string representation of the grammar.
`String`	`globalInfo()`	Returns a string describing the object.
`protected Spectrum`	`processData(Spectrum data)`	Performs the actual filtering.
`void`	`setExpression(adams.parser.MathematicalExpressionText value)`	Sets the mathematical expression to evaluate.

Methods inherited from class adams.data.filter.AbstractFilter
checkData, cleanUp, compareTo, destroy, dontUpdateIDTipText, equals, filter, forCommandLine, getDontUpdateID, reset, setDontUpdateID, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter
getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager, toCommandLine

- Field Detail
  - PLACEHOLDER_AMPLITUDE
```
public static final String PLACEHOLDER_AMPLITUDE
```
    the placeholder for the amplitude.
    
    See Also:
    
    Constant Field Values
  - PLACEHOLDER_WAVENUMBER
```
public static final String PLACEHOLDER_WAVENUMBER
```
    the placeholder for the wave number.
    
    See Also:
    
    Constant Field Values
  - PLACEHOLDER_INDEX
```
public static final String PLACEHOLDER_INDEX
```
    the placeholder for the index.
    
    See Also:
    
    Constant Field Values
  - PLACEHOLDER_SIZE
```
public static final String PLACEHOLDER_SIZE
```
    the placeholder for the total number of wave numbers.
    
    See Also:
    
    Constant Field Values
  - m_Expression
```
protected adams.parser.MathematicalExpressionText m_Expression
```
    the mathematical expression to evaluate.
- Constructor Detail
  - AmplitudeExpression
```
public AmplitudeExpression()
```
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Returns a string describing the object.
    
    Specified by:
    
    globalInfo in interface adams.core.GlobalInfoSupporter
    
    Specified by:
    
    globalInfo in class adams.core.option.AbstractOptionHandler
    
    Returns:
    
    a description suitable for displaying in the gui
  - getGrammar
```
public String getGrammar()
```
    Returns a string representation of the grammar.
    
    Specified by:
    
    getGrammar in interface adams.parser.GrammarSupplier
    
    Returns:
    
    the grammar, null if not available
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface adams.core.option.OptionHandler
    
    Overrides:
    
    defineOptions in class adams.data.filter.AbstractFilter<Spectrum>
  - setExpression
```
public void setExpression(adams.parser.MathematicalExpressionText value)
```
    Sets the mathematical expression to evaluate.
    
    Parameters:
    
    value - the expression
  - getExpression
```
public adams.parser.MathematicalExpressionText getExpression()
```
    Returns the mathematical expression to evaluate.
    
    Returns:
    
    the expression
  - expressionTipText
```
public String expressionTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - processData
```
protected Spectrum processData(Spectrum data)
```
    Performs the actual filtering.
    
    Specified by:
    
    processData in class adams.data.filter.AbstractFilter<Spectrum>
    
    Parameters:
    
    data - the data to filter
    
    Returns:
    
    the filtered data

Class AmplitudeExpression

Nested Class Summary

Nested classes/interfaces inherited from class adams.data.filter.AbstractFilter

Field Summary

Fields inherited from class adams.data.filter.AbstractFilter

Fields inherited from class adams.core.option.AbstractOptionHandler

Fields inherited from class adams.core.logging.LoggingObject

Constructor Summary

Method Summary

Methods inherited from class adams.data.filter.AbstractFilter

Methods inherited from class adams.core.option.AbstractOptionHandler

Methods inherited from class adams.core.logging.LoggingObject

Methods inherited from class java.lang.Object

Methods inherited from interface adams.core.logging.LoggingLevelHandler

Methods inherited from interface adams.core.logging.LoggingSupporter

Methods inherited from interface adams.core.option.OptionHandler

Field Detail

PLACEHOLDER_AMPLITUDE

PLACEHOLDER_WAVENUMBER

PLACEHOLDER_INDEX

PLACEHOLDER_SIZE

m_Expression

Constructor Detail

AmplitudeExpression

Method Detail

globalInfo

getGrammar

defineOptions

setExpression

getExpression

expressionTipText

processData