Changeset 1020

Timestamp:

08/02/12 12:54:01 (10 months ago)

Author:

jjr8

Message:

Started work on #551: Climatology tools should allow production of climatologies for ENSO phases

Location:

MGET/Branches/Jason/PythonPackage/src/GeoEco/DataProducts

Files:

• Aviso.py (modified) (4 diffs)
• HYCOM.py (modified) (4 diffs)
• NASA/OceanColor.py (modified) (4 diffs)
• NASA/PODAAC.py (modified) (4 diffs)
• NOAA/NODC.py (modified) (4 diffs)
• NOAA/OSCAR.py (modified) (4 diffs)
• UMaineOMG.py (modified) (4 diffs)

MGET/Branches/Jason/PythonPackage/src/GeoEco/DataProducts/Aviso.py

@@ -1274 +1274 @@
 
 AddArgumentMetadata(AvisoGriddedSSH.CreateClimatologicalArcGISRasters, u'binType',
-    typeMetadata=UnicodeStringTypeMetadata(allowedValues=[u'Daily', u'Monthly', u'Cumulative'], makeLowercase=True),
+    typeMetadata=UnicodeStringTypeMetadata(allowedValues=[u'Daily', u'Monthly', u'Cumulative', u'ENSO Daily', u'ENSO Monthly', u'ENSO Cumulative'], makeLowercase=True),
     description=_(
 u"""Climatology bins to use, one of:
@@ -1309 +1309 @@
   from the entire dataset. The Bin Duration parameter is ignored.
 
+* ENSO Daily, ENSO Monthly, ENSO Cumulative - the same as above,
+  except each of the bins above will be split into three, based on the
+  phase of the `El Nino Southern Oscillation (ENSO) <http://en.wikipedia.org/wiki/ENSO>`_,
+  as determined by the Oceanic Nino Index (ONI) calculated by the
+  `NOAA NCEP Climate Prediction Center <http://www.cpc.ncep.noaa.gov/products/analysis_monitoring/ensostuff/ensoyears.shtml>`_.
+  The ONI classifies each month into one of three phases: neutral, El
+  Nino, or La Nina. This tool first classifies input images according
+  to their dates into ENSO phases (it downloads ONI data from the
+  `NOAA Earth System Research Laboratory <http://www.esrl.noaa.gov/psd/data/climateindices/list/>`_),
+  then produces a climatology bin for each phase. For example, if you
+  request ENSO Cumulative bins, three bins will be produced: one for
+  all images occurring in neutral months, one for all in El Nino
+  months, and one for all in La Nina months. If you request ENSO
+  Monthly bins, 36 bins will be produced: one for each combination of
+  the 12 months and the three ENSO phases.
+
 For Daily and Monthly, to adjust when the bins start (e.g. to center a
 4-bin seasonal climatology on solstices and equinoxes), use the Start
@@ -1386 +1402 @@
   if 1-day bins, "Xday" if multi-day bins (X is replaced by the
   duration), "Monthly" if 1-month bins, "Xmonth" if multi-month bins,
-  or "Cumulative".
+  or "Cumulative". If an ENSO bin type is used, "ENSO_" will be
+  prepended to those strings (e.g. "ENSO_Daily", "ENSO_Monthly").
 
 * %(ClimatologyBinName)s - name of the climatology bin corresponding
@@ -1394 +1411 @@
   replaced by the last day), "monthXX" for 1-month bins (XX is
   replaced by the month), "monthXXtoYY" (XX is replaced by the first
-  month of the bin, YY by the last month), or "cumulative".
+  month of the bin, YY by the last month), or "cumulative". If an ENSO
+  bin type is used, "neutral_", "ElNino_", and "LaNina_" will be
+  prepended to those strings for each of the three ENSO phased rasters
+  (e.g. "neutral_cumulative", "ElNino_cumulative", and
+  "LaNina_cumulative" when "ENSO Cumulative" bins are requested).
 
 * %(Statistic)s - statistic that was calculated, in lowercase and with

MGET/Branches/Jason/PythonPackage/src/GeoEco/DataProducts/HYCOM.py

@@ -2385 +2385 @@
 
 AddArgumentMetadata(HYCOMGOMl0043D.CreateClimatologicalArcGISRasters, u'binType',
-    typeMetadata=UnicodeStringTypeMetadata(allowedValues=[u'Daily', u'Monthly', u'Cumulative'], makeLowercase=True),
+    typeMetadata=UnicodeStringTypeMetadata(allowedValues=[u'Daily', u'Monthly', u'Cumulative', u'ENSO Daily', u'ENSO Monthly', u'ENSO Cumulative'], makeLowercase=True),
     description=_(
 u"""Climatology bins to use, one of:
@@ -2420 +2420 @@
   from the entire dataset. The Bin Duration parameter is ignored.
 
+* ENSO Daily, ENSO Monthly, ENSO Cumulative - the same as above,
+  except each of the bins above will be split into three, based on the
+  phase of the `El Nino Southern Oscillation (ENSO) <http://en.wikipedia.org/wiki/ENSO>`_,
+  as determined by the Oceanic Nino Index (ONI) calculated by the
+  `NOAA NCEP Climate Prediction Center <http://www.cpc.ncep.noaa.gov/products/analysis_monitoring/ensostuff/ensoyears.shtml>`_.
+  The ONI classifies each month into one of three phases: neutral, El
+  Nino, or La Nina. This tool first classifies input images according
+  to their dates into ENSO phases (it downloads ONI data from the
+  `NOAA Earth System Research Laboratory <http://www.esrl.noaa.gov/psd/data/climateindices/list/>`_),
+  then produces a climatology bin for each phase. For example, if you
+  request ENSO Cumulative bins, three bins will be produced: one for
+  all images occurring in neutral months, one for all in El Nino
+  months, and one for all in La Nina months. If you request ENSO
+  Monthly bins, 36 bins will be produced: one for each combination of
+  the 12 months and the three ENSO phases.
+
 For Daily and Monthly, to adjust when the bins start (e.g. to center a
 4-bin seasonal climatology on solstices and equinoxes), use the Start
@@ -2474 +2490 @@
   if 1-day bins, "Xday" if multi-day bins (X is replaced by the
   duration), "Monthly" if 1-month bins, "Xmonth" if multi-month bins,
-  or "Cumulative".
+  or "Cumulative". If an ENSO bin type is used, "ENSO_" will be
+  prepended to those strings (e.g. "ENSO_Daily", "ENSO_Monthly").
 
 * %(ClimatologyBinName)s - name of the climatology bin corresponding
@@ -2482 +2499 @@
   replaced by the last day), "monthXX" for 1-month bins (XX is
   replaced by the month), "monthXXtoYY" (XX is replaced by the first
-  month of the bin, YY by the last month), or "cumulative".
+  month of the bin, YY by the last month), or "cumulative". If an ENSO
+  bin type is used, "neutral_", "ElNino_", and "LaNina_" will be
+  prepended to those strings for each of the three ENSO phased rasters
+  (e.g. "neutral_cumulative", "ElNino_cumulative", and
+  "LaNina_cumulative" when "ENSO Cumulative" bins are requested).
 
 * %(Statistic)s - statistic that was calculated, in lowercase and with

MGET/Branches/Jason/PythonPackage/src/GeoEco/DataProducts/NASA/OceanColor.py

@@ -1385 +1385 @@
 
 AddArgumentMetadata(OceanColorLevel3SMITimeSeries.CreateClimatologicalArcGISRasters, u'binType',
-    typeMetadata=UnicodeStringTypeMetadata(allowedValues=[u'Daily', u'Monthly', u'Cumulative'], makeLowercase=True),
+    typeMetadata=UnicodeStringTypeMetadata(allowedValues=[u'Daily', u'Monthly', u'Cumulative', u'ENSO Daily', u'ENSO Monthly', u'ENSO Cumulative'], makeLowercase=True),
     description=_(
 u"""Climatology bins to use, one of:
@@ -1420 +1420 @@
   from the entire dataset. The Bin Duration parameter is ignored.
 
+* ENSO Daily, ENSO Monthly, ENSO Cumulative - the same as above,
+  except each of the bins above will be split into three, based on the
+  phase of the `El Nino Southern Oscillation (ENSO) <http://en.wikipedia.org/wiki/ENSO>`_,
+  as determined by the Oceanic Nino Index (ONI) calculated by the
+  `NOAA NCEP Climate Prediction Center <http://www.cpc.ncep.noaa.gov/products/analysis_monitoring/ensostuff/ensoyears.shtml>`_.
+  The ONI classifies each month into one of three phases: neutral, El
+  Nino, or La Nina. This tool first classifies input images according
+  to their dates into ENSO phases (it downloads ONI data from the
+  `NOAA Earth System Research Laboratory <http://www.esrl.noaa.gov/psd/data/climateindices/list/>`_),
+  then produces a climatology bin for each phase. For example, if you
+  request ENSO Cumulative bins, three bins will be produced: one for
+  all images occurring in neutral months, one for all in El Nino
+  months, and one for all in La Nina months. If you request ENSO
+  Monthly bins, 36 bins will be produced: one for each combination of
+  the 12 months and the three ENSO phases.
+
 For Daily and Monthly, to adjust when the bins start (e.g. to center a
 4-bin seasonal climatology on solstices and equinoxes), use the Start
@@ -1493 +1509 @@
   if 1-day bins, "Xday" if multi-day bins (X is replaced by the
   duration), "Monthly" if 1-month bins, "Xmonth" if multi-month bins,
-  or "Cumulative".
+  or "Cumulative". If an ENSO bin type is used, "ENSO_" will be
+  prepended to those strings (e.g. "ENSO_Daily", "ENSO_Monthly").
 
 * %(ClimatologyBinName)s - name of the climatology bin corresponding
@@ -1501 +1518 @@
   replaced by the last day), "monthXX" for 1-month bins (XX is
   replaced by the month), "monthXXtoYY" (XX is replaced by the first
-  month of the bin, YY by the last month), or "cumulative".
+  month of the bin, YY by the last month), or "cumulative". If an ENSO
+  bin type is used, "neutral_", "ElNino_", and "LaNina_" will be
+  prepended to those strings for each of the three ENSO phased rasters
+  (e.g. "neutral_cumulative", "ElNino_cumulative", and
+  "LaNina_cumulative" when "ENSO Cumulative" bins are requested).
 
 * %(Statistic)s - statistic that was calculated, in lowercase and with

MGET/Branches/Jason/PythonPackage/src/GeoEco/DataProducts/NASA/PODAAC.py

@@ -1492 +1492 @@
 
 AddArgumentMetadata(MODISL3SSTTimeSeries.CreateClimatologicalArcGISRasters, u'binType',
-    typeMetadata=UnicodeStringTypeMetadata(allowedValues=[u'Daily', u'Monthly', u'Cumulative'], makeLowercase=True),
+    typeMetadata=UnicodeStringTypeMetadata(allowedValues=[u'Daily', u'Monthly', u'Cumulative', u'ENSO Daily', u'ENSO Monthly', u'ENSO Cumulative'], makeLowercase=True),
     description=_(
 u"""Climatology bins to use, one of:
@@ -1527 +1527 @@
   from the entire dataset. The Bin Duration parameter is ignored.
 
+* ENSO Daily, ENSO Monthly, ENSO Cumulative - the same as above,
+  except each of the bins above will be split into three, based on the
+  phase of the `El Nino Southern Oscillation (ENSO) <http://en.wikipedia.org/wiki/ENSO>`_,
+  as determined by the Oceanic Nino Index (ONI) calculated by the
+  `NOAA NCEP Climate Prediction Center <http://www.cpc.ncep.noaa.gov/products/analysis_monitoring/ensostuff/ensoyears.shtml>`_.
+  The ONI classifies each month into one of three phases: neutral, El
+  Nino, or La Nina. This tool first classifies input images according
+  to their dates into ENSO phases (it downloads ONI data from the
+  `NOAA Earth System Research Laboratory <http://www.esrl.noaa.gov/psd/data/climateindices/list/>`_),
+  then produces a climatology bin for each phase. For example, if you
+  request ENSO Cumulative bins, three bins will be produced: one for
+  all images occurring in neutral months, one for all in El Nino
+  months, and one for all in La Nina months. If you request ENSO
+  Monthly bins, 36 bins will be produced: one for each combination of
+  the 12 months and the three ENSO phases.
+
 For Daily and Monthly, to adjust when the bins start (e.g. to center a
 4-bin seasonal climatology on solstices and equinoxes), use the Start
@@ -1615 +1631 @@
   if 1-day bins, "Xday" if multi-day bins (X is replaced by the
   duration), "Monthly" if 1-month bins, "Xmonth" if multi-month bins,
-  or "Cumulative".
+  or "Cumulative". If an ENSO bin type is used, "ENSO_" will be
+  prepended to those strings (e.g. "ENSO_Daily", "ENSO_Monthly").
 
 * %(ClimatologyBinName)s - name of the climatology bin corresponding
@@ -1623 +1640 @@
   replaced by the last day), "monthXX" for 1-month bins (XX is
   replaced by the month), "monthXXtoYY" (XX is replaced by the first
-  month of the bin, YY by the last month), or "cumulative".
+  month of the bin, YY by the last month), or "cumulative". If an ENSO
+  bin type is used, "neutral_", "ElNino_", and "LaNina_" will be
+  prepended to those strings for each of the three ENSO phased rasters
+  (e.g. "neutral_cumulative", "ElNino_cumulative", and
+  "LaNina_cumulative" when "ENSO Cumulative" bins are requested).
 
 * %(Statistic)s - statistic that was calculated, in lowercase and with

MGET/Branches/Jason/PythonPackage/src/GeoEco/DataProducts/NOAA/NODC.py

@@ -2512 +2512 @@
 
 AddArgumentMetadata(AVHRRPathfinderSSTTimeSeries.CreateClimatologicalArcGISRasters, u'binType',
-    typeMetadata=UnicodeStringTypeMetadata(allowedValues=[u'Daily', u'Monthly', u'Cumulative'], makeLowercase=True),
+    typeMetadata=UnicodeStringTypeMetadata(allowedValues=[u'Daily', u'Monthly', u'Cumulative', u'ENSO Daily', u'ENSO Monthly', u'ENSO Cumulative'], makeLowercase=True),
     description=_(
 u"""Climatology bins to use, one of:
@@ -2547 +2547 @@
   from the entire dataset. The Bin Duration parameter is ignored.
 
+* ENSO Daily, ENSO Monthly, ENSO Cumulative - the same as above,
+  except each of the bins above will be split into three, based on the
+  phase of the `El Nino Southern Oscillation (ENSO) <http://en.wikipedia.org/wiki/ENSO>`_,
+  as determined by the Oceanic Nino Index (ONI) calculated by the
+  `NOAA NCEP Climate Prediction Center <http://www.cpc.ncep.noaa.gov/products/analysis_monitoring/ensostuff/ensoyears.shtml>`_.
+  The ONI classifies each month into one of three phases: neutral, El
+  Nino, or La Nina. This tool first classifies input images according
+  to their dates into ENSO phases (it downloads ONI data from the
+  `NOAA Earth System Research Laboratory <http://www.esrl.noaa.gov/psd/data/climateindices/list/>`_),
+  then produces a climatology bin for each phase. For example, if you
+  request ENSO Cumulative bins, three bins will be produced: one for
+  all images occurring in neutral months, one for all in El Nino
+  months, and one for all in La Nina months. If you request ENSO
+  Monthly bins, 36 bins will be produced: one for each combination of
+  the 12 months and the three ENSO phases.
+
 For Daily and Monthly, to adjust when the bins start (e.g. to center a
 4-bin seasonal climatology on solstices and equinoxes), use the Start
@@ -2609 +2625 @@
   if 1-day bins, "Xday" if multi-day bins (X is replaced by the
   duration), "Monthly" if 1-month bins, "Xmonth" if multi-month bins,
-  or "Cumulative".
+  or "Cumulative". If an ENSO bin type is used, "ENSO_" will be
+  prepended to those strings (e.g. "ENSO_Daily", "ENSO_Monthly").
 
 * %(ClimatologyBinName)s - name of the climatology bin corresponding
@@ -2617 +2634 @@
   replaced by the last day), "monthXX" for 1-month bins (XX is
   replaced by the month), "monthXXtoYY" (XX is replaced by the first
-  month of the bin, YY by the last month), or "cumulative".
+  month of the bin, YY by the last month), or "cumulative". If an ENSO
+  bin type is used, "neutral_", "ElNino_", and "LaNina_" will be
+  prepended to those strings for each of the three ENSO phased rasters
+  (e.g. "neutral_cumulative", "ElNino_cumulative", and
+  "LaNina_cumulative" when "ENSO Cumulative" bins are requested).
 
 * %(Statistic)s - statistic that was calculated, in lowercase and with

MGET/Branches/Jason/PythonPackage/src/GeoEco/DataProducts/NOAA/OSCAR.py

@@ -806 +806 @@
 
 AddArgumentMetadata(OSCAR5DayThirdDegreeCurrents.CreateClimatologicalArcGISRasters, u'binType',
-    typeMetadata=UnicodeStringTypeMetadata(allowedValues=[u'Daily', u'Monthly', u'Cumulative'], makeLowercase=True),
+    typeMetadata=UnicodeStringTypeMetadata(allowedValues=[u'Daily', u'Monthly', u'Cumulative', u'ENSO Daily', u'ENSO Monthly', u'ENSO Cumulative'], makeLowercase=True),
     description=_(
 u"""Climatology bins to use, one of:
@@ -841 +841 @@
   from the entire dataset. The Bin Duration parameter is ignored.
 
+* ENSO Daily, ENSO Monthly, ENSO Cumulative - the same as above,
+  except each of the bins above will be split into three, based on the
+  phase of the `El Nino Southern Oscillation (ENSO) <http://en.wikipedia.org/wiki/ENSO>`_,
+  as determined by the Oceanic Nino Index (ONI) calculated by the
+  `NOAA NCEP Climate Prediction Center <http://www.cpc.ncep.noaa.gov/products/analysis_monitoring/ensostuff/ensoyears.shtml>`_.
+  The ONI classifies each month into one of three phases: neutral, El
+  Nino, or La Nina. This tool first classifies input images according
+  to their dates into ENSO phases (it downloads ONI data from the
+  `NOAA Earth System Research Laboratory <http://www.esrl.noaa.gov/psd/data/climateindices/list/>`_),
+  then produces a climatology bin for each phase. For example, if you
+  request ENSO Cumulative bins, three bins will be produced: one for
+  all images occurring in neutral months, one for all in El Nino
+  months, and one for all in La Nina months. If you request ENSO
+  Monthly bins, 36 bins will be produced: one for each combination of
+  the 12 months and the three ENSO phases.
+
 For Daily and Monthly, to adjust when the bins start (e.g. to center a
 4-bin seasonal climatology on solstices and equinoxes), use the Start
@@ -897 +913 @@
   if 1-day bins, "Xday" if multi-day bins (X is replaced by the
   duration), "Monthly" if 1-month bins, "Xmonth" if multi-month bins,
-  or "Cumulative".
+  or "Cumulative". If an ENSO bin type is used, "ENSO_" will be
+  prepended to those strings (e.g. "ENSO_Daily", "ENSO_Monthly").
 
 * %(ClimatologyBinName)s - name of the climatology bin corresponding
@@ -905 +922 @@
   replaced by the last day), "monthXX" for 1-month bins (XX is
   replaced by the month), "monthXXtoYY" (XX is replaced by the first
-  month of the bin, YY by the last month), or "cumulative".
+  month of the bin, YY by the last month), or "cumulative". If an ENSO
+  bin type is used, "neutral_", "ElNino_", and "LaNina_" will be
+  prepended to those strings for each of the three ENSO phased rasters
+  (e.g. "neutral_cumulative", "ElNino_cumulative", and
+  "LaNina_cumulative" when "ENSO Cumulative" bins are requested).
 
 * %(Statistic)s - statistic that was calculated, in lowercase and with

MGET/Branches/Jason/PythonPackage/src/GeoEco/DataProducts/UMaineOMG.py

@@ -1750 +1750 @@
 
 AddArgumentMetadata(ROMSCoSiNE3D.CreateClimatologicalArcGISRasters, u'binType',
-    typeMetadata=UnicodeStringTypeMetadata(allowedValues=[u'Daily', u'Monthly', u'Cumulative'], makeLowercase=True),
+    typeMetadata=UnicodeStringTypeMetadata(allowedValues=[u'Daily', u'Monthly', u'Cumulative', u'ENSO Daily', u'ENSO Monthly', u'ENSO Cumulative'], makeLowercase=True),
     description=_(
 u"""Climatology bins to use, one of:
@@ -1785 +1785 @@
   from the entire dataset. The Bin Duration parameter is ignored.
 
+* ENSO Daily, ENSO Monthly, ENSO Cumulative - the same as above,
+  except each of the bins above will be split into three, based on the
+  phase of the `El Nino Southern Oscillation (ENSO) <http://en.wikipedia.org/wiki/ENSO>`_,
+  as determined by the Oceanic Nino Index (ONI) calculated by the
+  `NOAA NCEP Climate Prediction Center <http://www.cpc.ncep.noaa.gov/products/analysis_monitoring/ensostuff/ensoyears.shtml>`_.
+  The ONI classifies each month into one of three phases: neutral, El
+  Nino, or La Nina. This tool first classifies input images according
+  to their dates into ENSO phases (it downloads ONI data from the
+  `NOAA Earth System Research Laboratory <http://www.esrl.noaa.gov/psd/data/climateindices/list/>`_),
+  then produces a climatology bin for each phase. For example, if you
+  request ENSO Cumulative bins, three bins will be produced: one for
+  all images occurring in neutral months, one for all in El Nino
+  months, and one for all in La Nina months. If you request ENSO
+  Monthly bins, 36 bins will be produced: one for each combination of
+  the 12 months and the three ENSO phases.
+
 For Daily and Monthly, to adjust when the bins start (e.g. to center a
 4-bin seasonal climatology on solstices and equinoxes), use the Start
@@ -1839 +1855 @@
   if 1-day bins, "Xday" if multi-day bins (X is replaced by the
   duration), "Monthly" if 1-month bins, "Xmonth" if multi-month bins,
-  or "Cumulative".
+  or "Cumulative". If an ENSO bin type is used, "ENSO_" will be
+  prepended to those strings (e.g. "ENSO_Daily", "ENSO_Monthly").
 
 * %(ClimatologyBinName)s - name of the climatology bin corresponding
@@ -1847 +1864 @@
   replaced by the last day), "monthXX" for 1-month bins (XX is
   replaced by the month), "monthXXtoYY" (XX is replaced by the first
-  month of the bin, YY by the last month), or "cumulative".
+  month of the bin, YY by the last month), or "cumulative". If an ENSO
+  bin type is used, "neutral_", "ElNino_", and "LaNina_" will be
+  prepended to those strings for each of the three ENSO phased rasters
+  (e.g. "neutral_cumulative", "ElNino_cumulative", and
+  "LaNina_cumulative" when "ENSO Cumulative" bins are requested).
 
 * %(Statistic)s - statistic that was calculated, in lowercase and with