# 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 logging
import pyspedas
from pyspedas.tplot_tools import store_data
from copy import deepcopy
from collections import OrderedDict
[docs]
def tplot_copy(old_name, new_name):
"""
This function will copy a tplot variables that is already stored in memory.
Parameters
----------
old_name : str
Old name of the Tplot Variable
new_name : str
Name of the copied Tplot Variable
Returns
-------
None
Examples
--------
>>> # Copy Variable 1 into a new Variable 2
>>> import pyspedas
>>> pyspedas.tplot_copy("Variable1", "Variable2")
"""
# if old name input is a number, convert to corresponding name
if isinstance(old_name, int):
if isinstance(pyspedas.tplot_tools.data_quants[old_name], dict):
old_name = pyspedas.tplot_tools.data_quants[old_name]['name']
else:
old_name = pyspedas.tplot_tools.data_quants[old_name].name
# check if old name is in current dictionary
if old_name not in pyspedas.tplot_tools.data_quants.keys():
logging.info("The name %s is currently not in pyspedas",old_name)
return
# Add a new data quantity with the copied data
if isinstance(pyspedas.tplot_tools.data_quants[old_name], dict):
# old variable is a non-record varying variable
store_data(new_name, data={'y': pyspedas.tplot_tools.data_quants[old_name]['data']})
else:
pyspedas.tplot_tools.data_quants[new_name] = deepcopy(pyspedas.tplot_tools.data_quants[old_name])
pyspedas.tplot_tools.data_quants[new_name].name = new_name
return