Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow skipping unit conversion in NinJoTIFF #2025

Merged
merged 2 commits into from Feb 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 13 additions & 0 deletions satpy/tests/writer_tests/test_ninjotiff.py
Expand Up @@ -67,6 +67,19 @@ def test_dataset(self, iwsd):
uconv.assert_called_once_with(dataset, 'K', 'CELSIUS')
self.assertEqual(iwsd.call_count, 1)

@mock.patch('satpy.writers.ninjotiff.ImageWriter.save_dataset')
@mock.patch('satpy.writers.ninjotiff.nt', pyninjotiff_mock.ninjotiff)
def test_dataset_skip_unit_conversion(self, iwsd):
"""Test saving a dataset without unit conversion."""
from satpy.writers.ninjotiff import NinjoTIFFWriter
ntw = NinjoTIFFWriter()
dataset = xr.DataArray([1, 2, 3], attrs={'units': 'K'})
with mock.patch('satpy.writers.ninjotiff.convert_units') as uconv:
ntw.save_dataset(dataset, physic_unit='CELSIUS',
convert_temperature_units=False)
uconv.assert_not_called()
self.assertEqual(iwsd.call_count, 1)

@mock.patch('satpy.writers.ninjotiff.NinjoTIFFWriter.save_dataset')
@mock.patch('satpy.writers.ninjotiff.ImageWriter.save_image')
@mock.patch('satpy.writers.ninjotiff.nt', pyninjotiff_mock.ninjotiff)
Expand Down
12 changes: 9 additions & 3 deletions satpy/writers/ninjotiff.py
Expand Up @@ -116,6 +116,7 @@ def convert_units(dataset, in_unit, out_unit):
return dataset

if in_unit.lower() in {"k", "kelvin"} and out_unit.lower() in {"c", "celsius"}:
logger.debug("Converting temperature units from K to °C")
with xr.set_options(keep_attrs=True):
new_dataset = dataset - 273.15
new_dataset.attrs["units"] = out_unit
Expand Down Expand Up @@ -177,12 +178,14 @@ def save_image(self, img, filename=None, compute=True, **kwargs): # floating_po
return nt.save(img, filename, data_is_scaled_01=True, compute=compute, **kwargs)

def save_dataset(
self, dataset, filename=None, fill_value=None, compute=True, **kwargs
self, dataset, filename=None, fill_value=None, compute=True,
convert_temperature_units=True, **kwargs
):
"""Save a dataset to ninjotiff format.

This calls `save_image` in turn, but first preforms some unit conversion
if necessary.
if necessary and desired. Unit conversion can be suppressed by passing
``convert_temperature_units=False``.
"""
nunits = kwargs.get("physic_unit", None)
if nunits is None:
Expand All @@ -201,7 +204,10 @@ def save_dataset(
"Saving to physical ninjo file without units defined in dataset!"
)
else:
dataset = convert_units(dataset, units, nunits)
if convert_temperature_units:
dataset = convert_units(dataset, units, nunits)
else:
logger.debug("Omitting unit conversion")
return super(NinjoTIFFWriter, self).save_dataset(
dataset, filename=filename, compute=compute, fill_value=fill_value, **kwargs
)