spedas / pyspedas / 16972251084

coverage: 89.527% (+0.01%) from 89.515%
16972251084

push

github

jameswilburlewis 
Tweaked wording and formatting for readthedocs

40100 of 44791 relevant lines covered (89.53%)

0.9 hits per line

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

72.73
/pyspedas/pytplot/tplot_math/divide.py
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.pytplot 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✔





40



        logging.info("divide: The new_tvar parameter is deprecated. Please use newname instead.")




×







41



        newname = new_tvar




×







42












43



    # interpolate tvars










44



    tv2 = tinterp(tvar1, tvar2)




1✔





45



    # separate and divide data










46



    data1 = pyspedas.pytplot.data_quants[tvar1].values




1✔





47



    data2 = pyspedas.pytplot.data_quants[tv2].values




1✔





48



    data = data1 / data2




1✔





49



    # store divided data










50



    if newname is None:




1✔





51



        pyspedas.pytplot.data_quants[tvar1].values = data




×







52



        return tvar1




×







53



    if 'spec_bins' in pyspedas.pytplot.data_quants[tvar1].coords:




1✔





54



        store_data(newname, data={'x': pyspedas.pytplot.data_quants[tvar1].coords['time'].values, 'y': data,




×







55



                                           'v': pyspedas.pytplot.data_quants[tvar1].coords['spec_bins'].values})










56



        pyspedas.pytplot.data_quants[newname].attrs = copy.deepcopy(pyspedas.pytplot.data_quants[tvar1].attrs)




×







57



    else:










58



       store_data(newname, data={'x':pyspedas.pytplot.data_quants[tvar1].coords['time'].values, 'y': data})




1✔





59



       pyspedas.pytplot.data_quants[newname].attrs = copy.deepcopy(pyspedas.pytplot.data_quants[tvar1].attrs)




1✔





60












61



    return new_tvar




1✔



















    

  • 

    •