#!/usr/bin/env python3
# encoding: utf-8
# Copyright (C) 2017 Space Science and Engineering Center (SSEC),
# University of Wisconsin-Madison.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# This file is part of the polar2grid software package. Polar2grid takes
# satellite observation data, remaps it, and writes it to a file format for
# input into another program.
# Documentation: http://www.ssec.wisc.edu/software/polar2grid/
#
# Written by David Hoese June 2017
# University of Wisconsin-Madison
# Space Science and Engineering Center
# 1225 West Dayton Street
# Madison, WI 53706
# david.hoese@ssec.wisc.edu
"""The CLAVR-x reader is for reading files created by the Community
Satellite Processing Package (CSPP) Clouds from AVHRR Extended
(CLAVR-x) processing system software. The CLAVR-x reader
supports CSPP CLAVR-x product files created from VIIRS, MODIS
and AVHRR imaging sensors in the native HDF4 format. For more
information on this product, please visit the CSPP LEO
website: `https://cimss.ssec.wisc.edu/cspp/`.
The reader can be specified with the ``polar2grid.sh``
command using the ``clavrx`` reader name.
The CLAVR-x reader provides the following products, which include
support for the VIIRS Day/Night Band Lunar Reflectance:
+------------------------+---------------------------------------------+
| Product Name | Description |
+========================+=============================================+
| cloud_type | Cloud Type |
+------------------------+---------------------------------------------+
| cld_height_acha | Cloud Top Height (m) |
+------------------------+---------------------------------------------+
| cld_temp_acha | Cloud Top Temperature (K) |
+------------------------+---------------------------------------------+
| cld_emiss_acha | Cloud Emissivity |
+------------------------+---------------------------------------------+
| cld_opd_dcomp | Cloud Optical Depth Daytime |
+------------------------+---------------------------------------------+
| cld_opd_nlcomp | Cloud Optical Depth Nighttime |
+------------------------+---------------------------------------------+
| cld_reff_dcomp | Cloud Effective Radius Daytime (micron) |
+------------------------+---------------------------------------------+
| cld_reff_nlomp | Cloud Effective Radius Nighttime (micron) |
+------------------------+---------------------------------------------+
| cloud_phase | Cloud Phase (5 categories) |
+------------------------+---------------------------------------------+
| rain_rate | Rain Rate (mm/hr) |
+------------------------+---------------------------------------------+
| refl_lunar_dnb_nom | Lunar Reflectance (VIIRS DNB nighttime only)|
+------------------------+---------------------------------------------+
"""
from __future__ import annotations
import os
from argparse import ArgumentParser, _ArgumentGroup
from typing import Optional
from ._base import ReaderProxyBase
# Limit the number of products shown to Polar2Grid users
# if the user uses the environment variable they can display more
ADVERTISED_DATASETS = os.environ.get("CLAVRX_AD_DATASETS", None)
if ADVERTISED_DATASETS == "all":
ADVERTISED_DATASETS = None
elif ADVERTISED_DATASETS:
ADVERTISED_DATASETS = ADVERTISED_DATASETS.split(" ")
else:
ADVERTISED_DATASETS = {
"cloud_type",
"cld_temp_acha",
"cld_height_acha",
"cloud_phase",
"cld_opd_dcomp",
"cld_opd_nlcomp",
"cld_reff_dcomp",
"cld_reff_nlcomp",
"cld_emiss_acha",
"refl_lunar_dnb_nom",
"rain_rate",
}
DEFAULT_DATASETS = [
"cloud_type",
"cld_temp_acha",
"cld_height_acha",
"cloud_phase",
"cld_opd_dcomp",
"cld_opd_nlcomp",
"cld_reff_dcomp",
"cld_reff_nlcomp",
"cld_emiss_acha",
"refl_lunar_dnb_nom",
"rain_rate",
]
FILTERS = {
"day_only": {
"name": [
"cld_opd_dcomp",
"cld_reff_dcomp",
],
},
"night_only": {
"name": [
"cld_opd_nlcomp",
"cld_reff_nlcomp",
"refl_lunar_dnb_nom",
],
},
}
[docs]
class ReaderProxy(ReaderProxyBase):
"""Provide Polar2Grid-specific information about this reader's products."""
is_geo2grid_reader = True
is_polar2grid_reader = True
[docs]
def get_all_products(self) -> list[str]:
"""Get all polar2grid products that could be loaded."""
return ADVERTISED_DATASETS
[docs]
def get_default_products(self) -> list[str]:
"""Get products to load if users hasn't specified any others."""
return DEFAULT_DATASETS
[docs]
def add_reader_argument_groups(
parser: ArgumentParser, group: Optional[_ArgumentGroup] = None
) -> tuple[Optional[_ArgumentGroup], Optional[_ArgumentGroup]]:
"""Add reader-specific command line arguments to an existing argument parser."""
if group is None:
group = parser.add_argument_group(title="CLAVR-x Reader")
return group, None
