Skip to content

Commit 94dc15f

Browse files
committed
pr comments and logger statements
1 parent 6898445 commit 94dc15f

3 files changed

Lines changed: 35 additions & 8 deletions

File tree

imap_processing/cdf/config/imap_ultra_l1b_variable_attrs.yaml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -553,9 +553,10 @@ quality_statistics:
553553
LABLAXIS: quality_statistics
554554
# TODO: come back to format
555555
UNITS: " "
556+
DEPEND_0: spin_number
556557

557558
energy_range_edges:
558-
CATDESC: Energy range edges used for culling data at l1b.
559+
CATDESC: Energy range edges used for culling data.
559560
DISPLAY_TYPE: no_plot
560561
FIELDNAM: Energy Range Edges
561562
FILLVAL: -1.0e+31
@@ -565,9 +566,10 @@ energy_range_edges:
565566
VALIDMIN: 0.0
566567
VALIDMAX: 5000
567568
VAR_TYPE: support_data
569+
DEPEND_0: energy_range_edges_dim
568570

569571
energy_range_flags:
570-
CATDESC: Bit flags describing culling energy ranges applied at l1b.
572+
CATDESC: Bit flags describing culling energy ranges.
571573
DISPLAY_TYPE: no_plot
572574
FIELDNAM: Energy Range Flags
573575
FILLVAL: 0
@@ -576,4 +578,5 @@ energy_range_flags:
576578
UNITS: " "
577579
VALIDMIN: 1
578580
VALIDMAX: 65534
579-
VAR_TYPE: support_data
581+
VAR_TYPE: support_data
582+
DEPEND_0: energy_range_flags_dim

imap_processing/ultra/l1b/ultra_l1b_culling.py

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -674,7 +674,11 @@ def flag_low_voltage(
674674
# For each low voltage ind, flag the corresponding flag
675675
quality_flags[lv_spin_inds] = True
676676

677-
# TODO add log summary.
677+
num_culled: int = np.sum(quality_flags)
678+
logger.info(
679+
f"High energy culling removed {num_culled} spin bins across all energy "
680+
f"channels. Voltage threshold: {voltage_threshold} V."
681+
)
678682

679683
return quality_flags
680684

@@ -752,7 +756,12 @@ def flag_high_energy(
752756
quality_flags[:, ~mask] = flagged[:, ~mask]
753757
else:
754758
quality_flags = flagged
755-
# TODO add log summary. E.g Tim's hi goodtimes code
759+
760+
num_culled: int = np.sum(quality_flags)
761+
logger.info(
762+
f"High energy culling removed {num_culled} spin bins across {n_energy_bins} "
763+
f"energy channels. Energy thresholds: {energy_thresholds.flatten()}, "
764+
)
756765

757766
return quality_flags
758767

@@ -889,7 +898,7 @@ def flag_statistical_outliers(
889898
convergence[e_idx] = True
890899

891900
num_culled: int = np.sum(quality_stats)
892-
logger.debug(
901+
logger.info(
893902
f"Statistical culling removed {num_culled} spin bins across {n_energy_bins}"
894903
f" energy channels. Convergence: {convergence} after "
895904
f"{iterations} iterations."

imap_processing/ultra/utils/ultra_l1_utils.py

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
"""Create dataset."""
22

3+
import numpy as np
34
import xarray as xr
45

56
from imap_processing.cdf.imap_cdf_manager import ImapCdfAttributes
@@ -186,15 +187,29 @@ def create_dataset( # noqa: PLR0912
186187
attrs=cdf_manager.get_variable_attributes(key, check_schema=False),
187188
)
188189
elif key in {"energy_range_edges"}:
190+
dataset["energy_range_edges_dim"] = xr.DataArray(
191+
np.arange(len(data)),
192+
dims=["energy_range_edges_dim"],
193+
attrs=cdf_manager.get_variable_attributes(
194+
"energy_range_edges_dim", check_schema=False
195+
),
196+
)
189197
dataset[key] = xr.DataArray(
190198
data,
191-
dims=["energy_range_edges"],
199+
dims=["energy_range_edges_dim"],
192200
attrs=cdf_manager.get_variable_attributes(key, check_schema=False),
193201
)
194202
elif key in {"energy_range_flags"}:
203+
dataset["energy_range_flags_dim"] = xr.DataArray(
204+
np.arange(len(data)),
205+
dims=["energy_range_flags_dim"],
206+
attrs=cdf_manager.get_variable_attributes(
207+
"energy_range_flags_dim", check_schema=False
208+
),
209+
)
195210
dataset[key] = xr.DataArray(
196211
data,
197-
dims=["energy_range_flags"],
212+
dims=["energy_range_flags_dim"],
198213
attrs=cdf_manager.get_variable_attributes(key, check_schema=False),
199214
)
200215
else:

0 commit comments

Comments
 (0)