cubevis 0.5.14__py3-none-any.whl → 0.5.15__py3-none-any.whl

cubevis/plot/ms_plot/_raster_plot_inputs.py

@@ -1,116 +0,0 @@
-'''
-Check inputs to MsRaster plot() or its GUI
-'''
-
-from cubevis.plot.ms_plot._ms_plot_constants import VIS_AXIS_OPTIONS, AGGREGATOR_OPTIONS
-
-def check_inputs(inputs):
-    ''' Check plot input types, and axis input values. '''
-    _set_baseline_antenna_axis(inputs)
-    _check_axis_inputs(inputs)
-    _check_selection_input(inputs)
-    _check_agg_inputs(inputs)
-    _check_color_inputs(inputs)
-    _check_other_inputs(inputs)
-
-def _set_baseline_antenna_axis(inputs):
-    ''' Set baseline axis to dimension in data_dims '''
-    if 'data_dims' not in inputs:
-        return
-
-    data_dims = inputs['data_dims']
-    baseline_dim = 'antenna_name' if 'antenna_name' in data_dims else 'baseline'
-
-    # Convert baseline axis to existing baseline dimension
-    baseline_dims = ['baseline', 'antenna_name']
-    for axis in ['x_axis', 'y_axis', 'iter_axis', 'agg_axis']:
-        if inputs[axis] in baseline_dims:
-            inputs[axis] = baseline_dim
-
-def _check_axis_inputs(inputs):
-    ''' Check x_axis, y_axis, vis_axis, and iter_axis inputs. '''
-    x_axis = inputs['x_axis']
-    y_axis = inputs['y_axis']
-    if x_axis == y_axis:
-        raise ValueError(f"Invalid parameter values: x_axis {x_axis} cannot be same as y_axis {y_axis}.")
-
-    iter_axis = inputs['iter_axis']
-    if iter_axis and iter_axis in (x_axis, y_axis):
-        raise ValueError(f"Invalid parameter value: iter_axis {iter_axis} cannot be x_axis ({x_axis}) or y_axis ({y_axis}).")
-
-    data_dims = inputs['data_dims'] if 'data_dims' in inputs else None
-    if data_dims:
-        if x_axis not in data_dims or y_axis not in data_dims:
-            raise ValueError(f"Invalid parameter value: x and y axis must be a data dimension in {data_dims}.")
-        if iter_axis and iter_axis not in data_dims:
-            raise ValueError(f"Invalid parameter value: iter_axis {iter_axis} must be a data dimension in {data_dims}.")
-
-    vis_axis = inputs['vis_axis']
-    if vis_axis not in VIS_AXIS_OPTIONS:
-        raise ValueError(f"Invalid parameter value: vis_axis {vis_axis} must be one of {VIS_AXIS_OPTIONS}")
-
-def _check_selection_input(inputs):
-    ''' Check selection type and data_group selection.  Make copy of user selection. '''
-    if 'selection' in inputs:
-        user_selection = inputs['selection']
-        if user_selection:
-            if not isinstance(user_selection, dict):
-                raise TypeError("Invalid parameter type: selection must be dictionary.")
-
-def _check_agg_inputs(inputs):
-    ''' Check aggregator and agg_axis. Set agg_axis if not set. '''
-    aggregator = inputs['aggregator']
-    agg_axis = inputs['agg_axis']
-
-    x_axis = inputs['x_axis']
-    y_axis = inputs['y_axis']
-    data_dims = inputs['data_dims'] if 'data_dims' in inputs else None
-
-    if aggregator and aggregator not in AGGREGATOR_OPTIONS:
-        raise ValueError(f"Invalid parameter value: aggregator {aggregator} must be None or one of {AGGREGATOR_OPTIONS}.")
-
-    if agg_axis:
-        if not isinstance(agg_axis, str) and not isinstance(agg_axis, list):
-            raise TypeError(f"Invalid parameter type: agg_axis {agg_axis} must be str or list.")
-
-        # Make agg_axis a list
-        if isinstance(agg_axis, str):
-            agg_axis = [agg_axis]
-
-        for axis in agg_axis:
-            if axis in (x_axis, y_axis):
-                raise ValueError(f"Invalid parameter value: agg_axis {agg_axis} cannot be x_axis ({x_axis}) or y_axis ({y_axis}).")
-            if data_dims and axis not in data_dims:
-                raise ValueError(f"Invalid parameter value: agg_axis {axis} must be a data dimension in {data_dims}.")
-    elif aggregator and data_dims:
-        # Set agg_axis to non-plotted dim axes
-        agg_axis = data_dims.copy()
-        agg_axis.remove(x_axis)
-        agg_axis.remove(y_axis)
-        if 'iter_axis' in inputs and inputs['iter_axis']:
-            agg_axis.remove(inputs['iter_axis'])
-    inputs['agg_axis'] = agg_axis
-
-def _check_color_inputs(inputs):
-    if inputs['color_mode']:
-        color_mode = inputs['color_mode'].lower()
-        valid_color_modes = ['auto', 'manual']
-        if color_mode not  in valid_color_modes:
-            raise ValueError(f"Invalid parameter value: color_mode {color_mode} must be None or one of {valid_color_modes}.")
-        inputs['color_mode'] = color_mode
-
-    if inputs['color_range']:
-        if not (isinstance(inputs['color_range'], tuple) and len(inputs['color_range']) == 2):
-            raise ValueError("Invalid parameter type: color_range must be None or a tuple of (min, max).")
-
-def _check_other_inputs(inputs):
-    if inputs['iter_range']:
-        if not (isinstance(inputs['iter_range'], tuple) and len(inputs['iter_range']) == 2):
-            raise ValueError("Invalid parameter type: iter_range must be None or a tuple of (start, end).")
-
-    if inputs['subplots']:
-        if not (isinstance(inputs['subplots'], tuple) and len(inputs['subplots']) == 2):
-            raise ValueError("Invalid parameter type: subplots must be None or a tuple of (rows, columns).")
-
-    if inputs['title'] and not isinstance(inputs['title'], str):
-        raise TypeError("Invalid parameter type: title must be None or a string.")

cubevis/plot/ms_plot/_xds_plot_axes.py

@@ -1,110 +0,0 @@
-'''
-Functions for plot axes labels
-'''
-
-# pylint: disable=inconsistent-return-statements
-def get_coordinate_labels(xds, coordinate):
-    ''' Return coordinate values as string or list of strings, or None if numeric '''
-    if coordinate == 'time':
-        return _get_time_labels(xds.time)
-    if coordinate == 'baseline':
-        return _get_baseline_antenna_labels(xds.baseline)
-    if coordinate == 'antenna_name':
-        return _get_baseline_antenna_labels(xds.antenna_name)
-    if coordinate == 'frequency':
-        return _get_frequency_labels(xds.frequency)
-    if coordinate == 'polarization':
-        return _get_polarization_labels(xds.polarization)
-# pylint: enable=inconsistent-return-statements
-
-def get_axis_labels(xds, axis):
-    ''' Return axis name, label and ticks, reindex for regular axis '''
-    labels = get_coordinate_labels(xds, axis)
-    ticks = list(enumerate(labels)) if labels is not None and isinstance(labels, list) else None
-
-    if axis == "time":
-        start_date, _ = _get_date_range(xds.time)
-        label =  f"Time {xds.time.attrs['scale'].upper()} ({start_date})"
-    elif axis == "baseline":
-        label = "Baseline Antenna1"
-        ticks = _get_baseline_ant1_ticks(ticks)
-    elif axis == "antenna_name":
-        label = "Antenna"
-    elif axis == "frequency":
-        label = f"Frequency ({xds.frequency.attrs['units']}) {xds.frequency.attrs['observer'].upper()}"
-    elif axis == "polarization":
-        label =  "Polarization"
-    else:
-        label = None
-    return (axis, label, ticks)
-
-def get_vis_axis_labels(xds, data_group, correlated_data, vis_axis, include_unit=True):
-    ''' Get vis axis label for colorbar. Returns (axis, label, ticks) '''
-    label = vis_axis.capitalize()
-    if data_group != 'base':
-        label += f":{data_group.capitalize()}"
-
-    if include_unit:
-        units = None
-        if vis_axis in xds.data_vars and 'units' in xds[vis_axis].attrs:
-            units = xds[vis_axis].units
-        else:
-            if 'units' in xds[correlated_data].attrs:
-                units = xds[correlated_data].units
-        if units:
-            label += f" ({units})"
-
-    return (vis_axis, label)
-
-def _get_time_labels(time_xda):
-    ''' Return time as formatted string, or None to autogenerate ticks '''
-    if time_xda.size == 1:
-        time = time_xda.values.astype('datetime64[s]').item().strftime("%d-%b-%Y %H:%M:%S")
-        time += " " + time_xda.attrs['scale'].upper()
-        return time
-    return None # auto ticks from time values
-
-def _get_baseline_antenna_labels(baseline_antenna_xda):
-    ''' Return baseline pairs as string or list of strings '''
-    if baseline_antenna_xda.size == 1:
-        return baseline_antenna_xda.values
-    return baseline_antenna_xda.values.ravel().tolist()
-
-def _get_polarization_labels(polarization_xda):
-    ''' Return polarization as single string or list of strings '''
-    if polarization_xda.size == 1: # string
-        return polarization_xda.values
-    return list(polarization_xda.values) # array of strings
-
-def _get_frequency_labels(frequency_xda):
-    ''' Return frequency as formatted string, or None to autogenerate ticks '''
-    if frequency_xda.size == 1:
-        return f"{frequency_xda.item():.4f} {frequency_xda.attrs['units']} {frequency_xda.attrs['observer'].upper()}"
-    return None # auto ticks from frequency values
-
-def _get_date_range(time_xda):
-    ''' Return date as dd-Mon-yyyy e.g. 23-Aug-2010 '''
-    if time_xda.size == 1:
-        date = time_xda.values.astype('datetime64[s]').item().strftime("%d-%b-%Y")
-        return (date, date)
-    start_date = time_xda.values[0].astype('datetime64[s]').item().strftime("%d-%b-%Y")
-    end_date = time_xda.values[time_xda.size - 1].astype('datetime64[s]').item().strftime("%d-%b-%Y")
-    return (start_date, end_date)
-
-def _get_baseline_ant1_ticks(baseline_ticks):
-    ''' Return labels for each new ant1 name in baselines '''
-    ant1_ticks = []
-    last_ant1 = None
-    last_idx = None
-
-    # space by minimum increment to avoid overlapping tick labels
-    min_increment = max(int(len(baseline_ticks) / 50), 1)
-
-    for idx, tick in baseline_ticks:
-        ant1_name = tick.split(' & ')[0]
-        if ant1_name != last_ant1:
-            last_ant1 = ant1_name
-            if last_idx is None or ((idx - last_idx) >= min_increment):
-                ant1_ticks.append((idx, ant1_name))
-                last_idx = idx
-    return ant1_ticks