From 52fca769e214f459011453a89014b0c19ca55380 Mon Sep 17 00:00:00 2001 From: Marco Peters Date: Fri, 19 Aug 2022 11:56:13 +0200 Subject: [PATCH] [SNAP-1551] Improve binning documentation about spatial data-day --- .../main/java/org/esa/snap/binning/operator/BinningOp.java | 4 ++-- .../java/org/esa/snap/binning/support/SpatialDataPeriod.java | 5 ++++- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/snap-binning/src/main/java/org/esa/snap/binning/operator/BinningOp.java b/snap-binning/src/main/java/org/esa/snap/binning/operator/BinningOp.java index 162a2683e3f..ab070a69379 100644 --- a/snap-binning/src/main/java/org/esa/snap/binning/operator/BinningOp.java +++ b/snap-binning/src/main/java/org/esa/snap/binning/operator/BinningOp.java @@ -176,8 +176,8 @@ public enum TimeFilterMethod { @Parameter(interval = "[0,24]", description = "A sensor-dependent constant given in hours of a day (0 to 24)\n" + - "at which a sensor has a minimum number of observations at the date line (the 180 degree meridian).\n" + - "Only used if parameter 'dataDayMode' is set to 'SPATIOTEMPORAL_DATADAY'.") + "at which a sensor has a minimum number of observations at the date line (the 180 degree meridian).\n" + + "Only used if parameter 'dataDayMode' is set to 'SPATIOTEMPORAL_DATADAY'. This is usually the equator crossing time (ECT)") private Double minDataHour; @Parameter(description = "Number of rows in the (global) planetary grid. Must be even.", defaultValue = "2160") diff --git a/snap-binning/src/main/java/org/esa/snap/binning/support/SpatialDataPeriod.java b/snap-binning/src/main/java/org/esa/snap/binning/support/SpatialDataPeriod.java index d6183d07811..631751686bd 100644 --- a/snap-binning/src/main/java/org/esa/snap/binning/support/SpatialDataPeriod.java +++ b/snap-binning/src/main/java/org/esa/snap/binning/support/SpatialDataPeriod.java @@ -20,6 +20,8 @@ /** * The definition of a "spatial data-day", or more generally, a spatial data-period used for the binning. + * A detailed description of this period definition can be found in + * the GlobColour PUG in section 3.4 "The GlobColour data-day approach". * * @author Norman Fomferra */ @@ -37,7 +39,8 @@ public class SpatialDataPeriod implements DataPeriod { * @param duration The binning period's duration in days. * @param minDataHour The time in hours of a day (0 to 24) at which a given sensor has a minimum number of observations at the date line (the 180deg meridian). * This number is usually found plotting longitude-time pairs of given sensor observations and then finding - * the area where there are a minimum number of observations at the date line. + * the area where there are a minimum number of observations at the date line. This is the crossing nodal time (CNT), + * which is equal to the equator crossing time (ECT) */ public SpatialDataPeriod(double startTime, double duration, double minDataHour) { this.startTime = startTime;