#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright (c) 2017 Satpy developers
#
# This file is part of satpy.
#
# satpy 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.
#
# satpy 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
# satpy. If not, see <http://www.gnu.org/licenses/>.
"""The abi_l1b reader tests package."""
import unittest
from unittest import mock
import numpy as np
import pytest
import xarray as xr
from satpy.tests.utils import make_dataid
[docs]class Test_NC_ABI_L1B_Base(unittest.TestCase):
"""Common setup for NC_ABI_L1B tests."""
[docs] @mock.patch('satpy.readers.abi_base.xr')
def setUp(self, xr_, rad=None):
"""Create a fake dataset using the given radiance data."""
from satpy.readers.abi_l1b import NC_ABI_L1B
x_image = xr.DataArray(0.)
y_image = xr.DataArray(0.)
time = xr.DataArray(0.)
if rad is None:
rad_data = (np.arange(10.).reshape((2, 5)) + 1.) * 50.
rad_data = (rad_data + 1.) / 0.5
rad_data = rad_data.astype(np.int16)
rad = xr.DataArray(
rad_data,
dims=('y', 'x'),
attrs={
'scale_factor': 0.5,
'add_offset': -1.,
'_FillValue': 1002,
'units': 'W m-2 um-1 sr-1',
'valid_range': (0, 4095),
}
)
rad.coords['t'] = time
rad.coords['x_image'] = x_image
rad.coords['y_image'] = y_image
x__ = xr.DataArray(
range(5),
attrs={'scale_factor': 2., 'add_offset': -1.},
dims=('x',)
)
y__ = xr.DataArray(
range(2),
attrs={'scale_factor': -2., 'add_offset': 1.},
dims=('y',)
)
proj = xr.DataArray(
[],
attrs={
'semi_major_axis': 1.,
'semi_minor_axis': 1.,
'perspective_point_height': 1.,
'longitude_of_projection_origin': -90.,
'latitude_of_projection_origin': 0.,
'sweep_angle_axis': u'x'
}
)
fake_dataset = xr.Dataset(
data_vars={
'Rad': rad,
'band_id': np.array(8),
# 'x': x__,
# 'y': y__,
'x_image': x_image,
'y_image': y_image,
'goes_imager_projection': proj,
'yaw_flip_flag': np.array([1]),
"planck_fk1": np.array(13432.1),
"planck_fk2": np.array(1497.61),
"planck_bc1": np.array(0.09102),
"planck_bc2": np.array(0.99971),
"esun": np.array(2017),
"nominal_satellite_subpoint_lat": np.array(0.0),
"nominal_satellite_subpoint_lon": np.array(-89.5),
"nominal_satellite_height": np.array(35786.02),
"earth_sun_distance_anomaly_in_AU": np.array(0.99)
},
coords={
't': rad.coords['t'],
'x': x__,
'y': y__,
},
attrs={
"time_coverage_start": "2017-09-20T17:30:40.8Z",
"time_coverage_end": "2017-09-20T17:41:17.5Z",
},
)
xr_.open_dataset.return_value = fake_dataset
self.reader = NC_ABI_L1B('filename',
{'platform_shortname': 'G16', 'observation_type': 'Rad',
'suffix': 'custom',
'scene_abbr': 'C', 'scan_mode': 'M3'},
{'filetype': 'info'})
[docs]class TestABIYAML:
"""Tests for the ABI L1b reader's YAML configuration."""
[docs] @pytest.mark.parametrize(['channel', 'suffix'],
[("C{:02d}".format(num), suffix)
for num in range(1, 17)
for suffix in ('', '_test_suffix')])
def test_file_patterns_match(self, channel, suffix):
"""Test that the configured file patterns work."""
from satpy.readers import configs_for_reader, load_reader
reader_configs = list(configs_for_reader('abi_l1b'))[0]
reader = load_reader(reader_configs)
fn1 = ("OR_ABI-L1b-RadM1-M3{}_G16_s20182541300210_e20182541300267"
"_c20182541300308{}.nc").format(channel, suffix)
loadables = reader.select_files_from_pathnames([fn1])
assert len(loadables) == 1
if not suffix and channel in ["C01", "C02", "C03", "C05"]:
fn2 = ("OR_ABI-L1b-RadM1-M3{}_G16_s20182541300210_e20182541300267"
"_c20182541300308-000000_0.nc").format(channel)
loadables = reader.select_files_from_pathnames([fn2])
assert len(loadables) == 1
[docs]class Test_NC_ABI_L1B(Test_NC_ABI_L1B_Base):
"""Test the NC_ABI_L1B reader."""
[docs] def test_basic_attributes(self):
"""Test getting basic file attributes."""
from datetime import datetime
self.assertEqual(self.reader.start_time,
datetime(2017, 9, 20, 17, 30, 40, 800000))
self.assertEqual(self.reader.end_time,
datetime(2017, 9, 20, 17, 41, 17, 500000))
[docs] def test_get_dataset(self):
"""Test the get_dataset method."""
key = make_dataid(name='Rad', calibration='radiance')
res = self.reader.get_dataset(key, {'info': 'info'})
exp = {'calibration': 'radiance',
'instrument_ID': None,
'modifiers': (),
'name': 'Rad',
'observation_type': 'Rad',
'orbital_parameters': {'projection_altitude': 1.0,
'projection_latitude': 0.0,
'projection_longitude': -90.0,
'satellite_nominal_altitude': 35786020.,
'satellite_nominal_latitude': 0.0,
'satellite_nominal_longitude': -89.5,
'yaw_flip': True},
'orbital_slot': None,
'platform_name': 'GOES-16',
'platform_shortname': 'G16',
'production_site': None,
'scan_mode': 'M3',
'scene_abbr': 'C',
'scene_id': None,
'sensor': 'abi',
'timeline_ID': None,
'suffix': 'custom',
'units': 'W m-2 um-1 sr-1'}
self.assertDictEqual(res.attrs, exp)
# we remove any time dimension information
self.assertNotIn('t', res.coords)
self.assertNotIn('t', res.dims)
self.assertNotIn('time', res.coords)
self.assertNotIn('time', res.dims)
[docs] @mock.patch('satpy.readers.abi_base.geometry.AreaDefinition')
def test_get_area_def(self, adef):
"""Test the area generation."""
self.reader.get_area_def(None)
self.assertEqual(adef.call_count, 1)
call_args = tuple(adef.call_args)[0]
self.assertDictEqual(call_args[3], {'a': 1.0, 'b': 1.0, 'h': 1.0, 'lon_0': -90.0, 'proj': 'geos',
'sweep': 'x', 'units': 'm'})
self.assertEqual(call_args[4], self.reader.ncols)
self.assertEqual(call_args[5], self.reader.nlines)
np.testing.assert_allclose(call_args[6], (-2, -2, 8, 2))
[docs]class Test_NC_ABI_L1B_ir_cal(Test_NC_ABI_L1B_Base):
"""Test the NC_ABI_L1B reader's IR calibration."""
[docs] def setUp(self):
"""Create fake data for the tests."""
rad_data = (np.arange(10.).reshape((2, 5)) + 1.) * 50.
rad_data = (rad_data + 1.) / 0.5
rad_data = rad_data.astype(np.int16)
rad = xr.DataArray(
rad_data,
dims=('y', 'x'),
attrs={
'scale_factor': 0.5,
'add_offset': -1.,
'_FillValue': 1002,
}
)
super(Test_NC_ABI_L1B_ir_cal, self).setUp(rad=rad)
[docs] def test_ir_calibrate(self):
"""Test IR calibration."""
res = self.reader.get_dataset(
make_dataid(name='C05', calibration='brightness_temperature'), {})
expected = np.array([[267.55572248, 305.15576503, 332.37383249, 354.73895301, 374.19710115],
[391.68679226, 407.74064808, 422.69329105, 436.77021913, np.nan]])
self.assertTrue(np.allclose(res.data, expected, equal_nan=True))
# make sure the attributes from the file are in the data array
self.assertNotIn('scale_factor', res.attrs)
self.assertNotIn('_FillValue', res.attrs)
self.assertEqual(res.attrs['standard_name'],
'toa_brightness_temperature')
self.assertEqual(res.attrs['long_name'], 'Brightness Temperature')
[docs]class Test_NC_ABI_L1B_vis_cal(Test_NC_ABI_L1B_Base):
"""Test the NC_ABI_L1B reader."""
[docs] def setUp(self):
"""Create fake data for the tests."""
rad_data = (np.arange(10.).reshape((2, 5)) + 1.)
rad_data = (rad_data + 1.) / 0.5
rad_data = rad_data.astype(np.int16)
rad = xr.DataArray(
rad_data,
dims=('y', 'x'),
attrs={
'scale_factor': 0.5,
'add_offset': -1.,
'_FillValue': 20,
}
)
super(Test_NC_ABI_L1B_vis_cal, self).setUp(rad=rad)
[docs] def test_vis_calibrate(self):
"""Test VIS calibration."""
res = self.reader.get_dataset(
make_dataid(name='C05', calibration='reflectance'), {})
expected = np.array([[0.15265617, 0.30531234, 0.45796851, 0.61062468, 0.76328085],
[0.91593702, 1.06859319, 1.22124936, np.nan, 1.52656171]])
self.assertTrue(np.allclose(res.data, expected, equal_nan=True))
self.assertNotIn('scale_factor', res.attrs)
self.assertNotIn('_FillValue', res.attrs)
self.assertEqual(res.attrs['standard_name'],
'toa_bidirectional_reflectance')
self.assertEqual(res.attrs['long_name'],
'Bidirectional Reflectance')
[docs]class Test_NC_ABI_L1B_raw_cal(Test_NC_ABI_L1B_Base):
"""Test the NC_ABI_L1B reader raw calibration."""
[docs] def setUp(self):
"""Create fake data for the tests."""
rad_data = (np.arange(10.).reshape((2, 5)) + 1.)
rad_data = (rad_data + 1.) / 0.5
rad_data = rad_data.astype(np.int16)
rad = xr.DataArray(
rad_data,
dims=('y', 'x'),
attrs={
'scale_factor': 0.5,
'add_offset': -1.,
'_FillValue': 20,
}
)
super(Test_NC_ABI_L1B_raw_cal, self).setUp(rad=rad)
[docs] def test_raw_calibrate(self):
"""Test RAW calibration."""
res = self.reader.get_dataset(
make_dataid(name='C05', calibration='counts'), {})
# We expect the raw data to be unchanged
expected = res.data
self.assertTrue(np.allclose(res.data, expected, equal_nan=True))
# check for the presence of typical attributes
self.assertIn('scale_factor', res.attrs)
self.assertIn('add_offset', res.attrs)
self.assertIn('_FillValue', res.attrs)
self.assertIn('orbital_parameters', res.attrs)
self.assertIn('platform_shortname', res.attrs)
self.assertIn('scene_id', res.attrs)
# determine if things match their expected values/types.
self.assertEqual(res.data.dtype, np.int16, "int16 data type expected")
self.assertEqual(res.attrs['standard_name'],
'counts')
self.assertEqual(res.attrs['long_name'],
'Raw Counts')
[docs]class Test_NC_ABI_L1B_invalid_cal(Test_NC_ABI_L1B_Base):
"""Test the NC_ABI_L1B reader with invalid calibration."""
[docs] def test_invalid_calibration(self):
"""Test detection of invalid calibration values."""
# Need to use a custom DataID class because the real DataID class is
# smart enough to detect the invalid calibration before the ABI L1B
# get_dataset method gets a chance to run.
class FakeDataID(dict):
def to_dict(self):
return self
with self.assertRaises(ValueError, msg='Did not detect invalid cal'):
did = FakeDataID(name='C05', calibration='invalid', modifiers=())
self.reader.get_dataset(did, {})
[docs]class Test_NC_ABI_File(unittest.TestCase):
"""Test file opening."""
[docs] @mock.patch('satpy.readers.abi_base.xr')
def test_open_dataset(self, _):
"""Test openning a dataset."""
from satpy.readers.abi_l1b import NC_ABI_L1B
openable_thing = mock.MagicMock()
NC_ABI_L1B(openable_thing, {'platform_shortname': 'g16'}, None)
openable_thing.open.assert_called()
[docs]class Test_NC_ABI_L1B_H5netcdf(Test_NC_ABI_L1B):
"""Allow h5netcdf peculiarities."""
[docs] def setUp(self):
"""Create fake data for the tests."""
rad_data = np.int16(50)
rad = xr.DataArray(
rad_data,
attrs={
'scale_factor': 0.5,
'add_offset': -1.,
'_FillValue': np.array([1002]),
'units': 'W m-2 um-1 sr-1',
'valid_range': (0, 4095),
}
)
super(Test_NC_ABI_L1B_H5netcdf, self).setUp(rad=rad)