Skip to content
Snippets Groups Projects
Commit 73780894 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Added docu Ymoncomp

parent bc7f6a27
No related branches found
No related tags found
No related merge requests found
@BeginModule
@NewPage
@Name = Ymoncomp
@Title = Multi-year monthly comparison
@Section = Comparison
@Class = Comparison
@Arguments = infile1 infile2 outfile
@Operators = ymoneq ymonne ymonle ymonlt ymonge ymongt
@BeginDescription
This module performs compaisons of a time series and one timestep with the same month of year.
For each field in @file{infile1} the corresponding field of the timestep in @file{infile2} with the same month of year is used.
The resulting field is a mask containing 1 if the comparison is true and 0 if not.
The type of comparison depends on the chosen operator.
The input files need to have the same structure with the same variables.
Usually @file{infile2} is generated by an operator of the module @mod{YMONSTAT}.
@EndDescription
@EndModule
@BeginOperator_ymoneq
@Title = Compare time series with Equal
@BeginDescription
Compares whether a time series is equal to a multi-year monthly time series.
@EndDescription
@EndOperator
@BeginOperator_ymonne
@Title = Compare time series with NotEqual
@BeginDescription
Compares whether a time series is not equal to a multi-year monthly time series.
@EndDescription
@EndOperator
@BeginOperator_ymonle
@Title = Compare time series with LessEqual
@BeginDescription
Compares whether a time series is less than or equal to a multi-year monthly time series.
@EndDescription
@EndOperator
@BeginOperator_ymonlt
@Title = Compares if time series with LessThan
@BeginDescription
Compares whether a time series is less than a multi-year monthly time series.
@EndDescription
@EndOperator
@BeginOperator_ymonge
@Title = Compares if time series with GreaterEqual
@BeginDescription
Compares whether a time series is greater than or equal to a multi-year monthly time series.
@EndDescription
@EndOperator
@BeginOperator_ymongt
@Title = Compares if time series with GreaterThan
@BeginDescription
Compares whether a time series is greater than a multi-year monthly time series.
@EndDescription
@EndOperator
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment