Skip to content

Feature/picklable pyuda signals #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion source/wrappers/python/pyuda/_dim.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from __future__ import (division, print_function, absolute_import)

import copy

class Dim(object):

Expand All @@ -20,3 +20,18 @@ def units(self):

def __repr__(self):
return "<Dim: {0}>".format(self.label) if self.label else "<Dim>"

def __deepcopy__(self, memo):
return DataOwningDim(data=copy.deepcopy(self.data, memo),
label=copy.deepcopy(self.label, memo),
units=copy.deepcopy(self.units, memo))


class DataOwningDim:
def __init__(self, data=None, label='', units=''):
self.data = data
self.label = label
self.units = units

def __repr__(self):
return "<Dim: {0}>".format(self.label) if self.label else "<Dim>"
84 changes: 84 additions & 0 deletions source/wrappers/python/pyuda/_signal.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import json
import base64
import numpy as np
import copy

import cpyuda

Expand Down Expand Up @@ -221,3 +222,86 @@ def jsonify(self, indent=None):
def __repr__(self):
return "<Signal: {0}>".format(self.label) if self.label else "<Signal>"

def clone(self):
"""
Copy all signal data from cpyuda into a DataOwningSignal object
"""
return DataOwningSignal(data=copy.deepcopy(self.data),
errors=copy.deepcopy(self.errors),
label=copy.deepcopy(self.label),
units=copy.deepcopy(self.units),
description=copy.deepcopy(self.description),
rank=copy.deepcopy(self.rank),
dims=copy.deepcopy(self.dims),
shape=copy.deepcopy(self.shape),
time_index=copy.deepcopy(self.time_index),
meta=copy.deepcopy(self.meta))

def __deepcopy__(self, memo):
"""
Copy all signal data from cpyuda into a DataOwningSignal object
"""
return DataOwningSignal(data=copy.deepcopy(self.data, memo),
errors=copy.deepcopy(self.errors, memo),
label=copy.deepcopy(self.label, memo),
units=copy.deepcopy(self.units, memo),
description=copy.deepcopy(self.description, memo),
rank=copy.deepcopy(self.rank, memo),
dims=copy.deepcopy(self.dims, memo),
shape=copy.deepcopy(self.shape, memo),
time_index=copy.deepcopy(self.time_index, memo),
meta=copy.deepcopy(self.meta, memo))

def __reduce__(self):
"""
Overwriting __reduce__ method for pickling pyuda signal objects.
This does deep copies of all the data views held by a signal object
and constructs a data owning signal object which is picklable and can
be loaded from disk without state initialisation errors in cpyuda.
"""
return (DataOwningSignal, (copy.deepcopy(self.data),
copy.deepcopy(self.errors),
copy.deepcopy(self.label),
copy.deepcopy(self.units),
copy.deepcopy(self.description),
copy.deepcopy(self.rank),
copy.deepcopy(self.dims),
copy.deepcopy(self.shape),
copy.deepcopy(self.time_index),
copy.deepcopy(self.meta)))


class DataOwningSignal:
"""
Class to hold a copy of a pyuda Signal object where all data arrays are owned
by the object instead of being views of memory held by the uda c-library
"""

def __init__(self, data=None, errors=None, label='', units='', description='',
rank=None, dims=None, shape=None, time_index=None, meta=None):
self.data = data
self.errors = errors
self.label = label
self.units = units
self.descritpion = description
self.rank = rank
self.dims = dims
self.shape = shape
self.time_index = time_index
self.meta = meta

def plot(self):
import matplotlib.pyplot as plt

dim = self.dims[0]

plt.plot(dim.data, self.data)
plt.xlabel('{0} ({1})'.format(dim.label, dim.units))
plt.ylabel('{0} ({1})'.format(self.label, self.units))
plt.show()

def jsonify(self, indent=None):
return json.dumps(self, cls=SignalEncoder, indent=indent)

def __repr__(self):
return "<Signal: {0}>".format(self.label) if self.label else "<Signal>"
Loading