17001196665

Committed 15 Aug 2025 11:12PM UTC coverage: 89.516% (+0.7%) from 88.849%

Build # 17001196665

Build Type

push

github

Committed by

web-flow

Commit Message

Merge branch 'pyspedas_2_0_dev' into master

Run Details

5072 of 6199 new or added lines in 413 files covered. (81.82%)

8 existing lines in 2 files now uncovered.

40061 of 44753 relevant lines covered (89.52%)

0.9 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

72.73

/pyspedas/tplot_tools/tplot_math/divide.py

# Copyright 2020 Regents of the University of Colorado. All Rights Reserved.
# Released under the MIT license.
# This software was developed at the University of Colorado's Laboratory for Atmospheric and Space Physics.
# Verify current version before use at: https://github.com/MAVENSDC/Pytplot

import pyspedas
from pyspedas.tplot_tools import store_data, tinterp
import numpy as np
import copy
import logging

def divide(tvar1,tvar2,newname=None, new_tvar=None):
    """
    Divides two tplot variables.  Will interpolate if the two are not on the same time cadence.

    Parameters
    ----------
        tvar1 : str
            Name of first tplot variable.
        tvar2 : int/float
            Name of second tplot variable
        new_tvar : str (Deprecated)
            Name of new tvar for divided data.  If not set, then the data in tvar1 is replaced.
        newname : str
            Name of new tvar for divided data.  If not set, then the data in tvar1 is replaced.

    Returns
    -------
        None

    Examples
    --------

        >>> pyspedas.store_data('a', data={'x':[0,4,8,12,16], 'y':[1,2,3,4,5]})
        >>> pyspedas.store_data('c', data={'x':[0,4,8,12,16,19,21], 'y':[1,4,1,7,1,9,1]})
        >>> pyspedas.divide('a','c','a_over_c')
        """
    # new_tvar is deprecated in favor of newname
    if new_tvar is not None:
        logging.info("divide: The new_tvar parameter is deprecated. Please use newname instead.")
        newname = new_tvar

    # interpolate tvars
    tv2 = tinterp(tvar1, tvar2)
    # separate and divide data
    data1 = pyspedas.tplot_tools.data_quants[tvar1].values
    data2 = pyspedas.tplot_tools.data_quants[tv2].values
    data = data1 / data2
    # store divided data
    if newname is None:
        pyspedas.tplot_tools.data_quants[tvar1].values = data
        return tvar1
    if 'spec_bins' in pyspedas.tplot_tools.data_quants[tvar1].coords:
        store_data(newname, data={'x': pyspedas.tplot_tools.data_quants[tvar1].coords['time'].values, 'y': data,
                                           'v': pyspedas.tplot_tools.data_quants[tvar1].coords['spec_bins'].values})
        pyspedas.tplot_tools.data_quants[newname].attrs = copy.deepcopy(pyspedas.tplot_tools.data_quants[tvar1].attrs)
    else:
       store_data(newname, data={'x':pyspedas.tplot_tools.data_quants[tvar1].coords['time'].values, 'y': data})
       pyspedas.tplot_tools.data_quants[newname].attrs = copy.deepcopy(pyspedas.tplot_tools.data_quants[tvar1].attrs)

    return new_tvar

1	# Copyright 2020 Regents of the University of Colorado. All Rights Reserved.
2	# Released under the MIT license.
3	# This software was developed at the University of Colorado's Laboratory for Atmospheric and Space Physics.
4	# Verify current version before use at: https://github.com/MAVENSDC/Pytplot
5
6	import pyspedas	1✔
7	from pyspedas.tplot_tools import store_data, tinterp	1✔
8	import numpy as np	1✔
9	import copy	1✔
10	import logging	1✔
11
12	def divide(tvar1,tvar2,newname=None, new_tvar=None):	1✔
13	"""
14	Divides two tplot variables. Will interpolate if the two are not on the same time cadence.
15
16	Parameters
17	----------
18	tvar1 : str
19	Name of first tplot variable.
20	tvar2 : int/float
21	Name of second tplot variable
22	new_tvar : str (Deprecated)
23	Name of new tvar for divided data. If not set, then the data in tvar1 is replaced.
24	newname : str
25	Name of new tvar for divided data. If not set, then the data in tvar1 is replaced.
26
27	Returns
28	-------
29	None
30
31	Examples
32	--------
33
34	>>> pyspedas.store_data('a', data={'x':[0,4,8,12,16], 'y':[1,2,3,4,5]})
35	>>> pyspedas.store_data('c', data={'x':[0,4,8,12,16,19,21], 'y':[1,4,1,7,1,9,1]})
36	>>> pyspedas.divide('a','c','a_over_c')
37	"""
38	# new_tvar is deprecated in favor of newname
39	if new_tvar is not None:	1✔
NEW 40	logging.info("divide: The new_tvar parameter is deprecated. Please use newname instead.")	×
NEW 41	newname = new_tvar	×
42
43	# interpolate tvars
44	tv2 = tinterp(tvar1, tvar2)	1✔
45	# separate and divide data
46	data1 = pyspedas.tplot_tools.data_quants[tvar1].values	1✔
47	data2 = pyspedas.tplot_tools.data_quants[tv2].values	1✔
48	data = data1 / data2	1✔
49	# store divided data
50	if newname is None:	1✔
NEW 51	pyspedas.tplot_tools.data_quants[tvar1].values = data	×
NEW 52	return tvar1	×
53	if 'spec_bins' in pyspedas.tplot_tools.data_quants[tvar1].coords:	1✔
NEW 54	store_data(newname, data={'x': pyspedas.tplot_tools.data_quants[tvar1].coords['time'].values, 'y': data,	×
55	'v': pyspedas.tplot_tools.data_quants[tvar1].coords['spec_bins'].values})
NEW 56	pyspedas.tplot_tools.data_quants[newname].attrs = copy.deepcopy(pyspedas.tplot_tools.data_quants[tvar1].attrs)	×
57	else:
58	store_data(newname, data={'x':pyspedas.tplot_tools.data_quants[tvar1].coords['time'].values, 'y': data})	1✔
59	pyspedas.tplot_tools.data_quants[newname].attrs = copy.deepcopy(pyspedas.tplot_tools.data_quants[tvar1].attrs)	1✔
60
61	return new_tvar	1✔

spedas / pyspedas / 17001196665

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous