#!/usr/bin/python
# -*- coding: utf-8 -*-

# ---------------------------------------------------------------------
# Copyright (c) 2012 Michael Hull.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
#  - Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
#  - Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in
#    the documentation and/or other materials provided with the
#    distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
#  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# ----------------------------------------------------------------------


from morphforge.traces.traceobjpluginctrl import TraceMethodCtrl, copy_trace_attrs
from morphforge.traces import TraceFixedDT, TraceVariableDT, TracePiecewise
import numpy as np

# Mean, rms, stddev, variance functions:
##############################

# For FixedDT traces, these are simple:
TraceMethodCtrl.register(TraceFixedDT, 'mean',   lambda tr: np.mean(tr.data_pts))
TraceMethodCtrl.register(TraceFixedDT, 'stddev', lambda tr: np.std(tr.data_pts))
TraceMethodCtrl.register(TraceFixedDT, 'var',    lambda tr: np.var(tr.data_pts))
TraceMethodCtrl.register(TraceFixedDT, 'rms',    lambda tr: np.sqrt(np.mean(tr.data_pts**2)))

# For VariableDT traces

[docs]def _variabledt_mean(tr):
    import scipy.integrate
    # Calculate the mean with simpsons rule:
    integral = scipy.integrate.simps(y=tr.data_pts_np, x=tr.time_pts_s)
    mean = integral / tr.get_duration().rescale('s').magnitude * tr.data_unit
    return mean


TraceMethodCtrl.register(TraceVariableDT, 'mean', _variabledt_mean)
# MISSING: VariableDT - stddev
# MISSING: VariableDT - var
# MISSING: VariableDT - rms

# For Piecewise functions:
# MISSING: Piecewise - stddev
# MISSING: Piecewise - var
# MISSING: Piecewise - rms

# PTP Functions:
################
TraceMethodCtrl.register(TraceFixedDT,    'ptp',  lambda tr: np.ptp(tr.data_pts))
TraceMethodCtrl.register(TraceVariableDT, 'ptp',  lambda tr: np.ptp(tr.data_pts))
TraceMethodCtrl.register(TracePiecewise,  'ptp',  lambda tr: tr.max[1] - tr.min[1])




# Min & Max functions:
######################
# These also return the times of min/max:

[docs]def _get_max(tr):
    ind_max = np.argmax(tr.data_pts)
    return (tr.time_pts[ind_max], tr.data_pts[ind_max])


[docs]def _get_min(tr):
    ind_min = np.argmin(tr.data_pts)
    return (tr.time_pts[ind_min], tr.data_pts[ind_min])


TraceMethodCtrl.register(TraceFixedDT, 'max', _get_max)
TraceMethodCtrl.register(TraceFixedDT, 'min', _get_min)
TraceMethodCtrl.register(TraceVariableDT, 'max', _get_max)
TraceMethodCtrl.register(TraceVariableDT, 'min', _get_min)


# MISSING: Piecewise - min
# MISSING: Piecewise - max

# Gradients:
############

[docs]def _fixeddt_gradient(self, *args):
    # assert False, 'ToCheck'
    tr_new = TraceFixedDT( 
            time = self.time_pts,
            data = np.gradient(self.data_pts_np, *args) * self.data_unit / self.get_dt_new()
            )
    copy_trace_attrs(self, tr_new, comment="+gradient")
    return tr_new
                            
    #clone_trace(tr=self, data=, comment='+ (Filtered)')

TraceMethodCtrl.register(TraceFixedDT, 'gradient', _fixeddt_gradient)
# MISSING: VariableDT - gradient
# MISSING: Piecewise - gradient

# Some aliases:
###############
TraceMethodCtrl.register(TraceFixedDT, 'Mean', lambda tr: tr.mean())
TraceMethodCtrl.register(TraceVariableDT, 'Mean', lambda tr: tr.mean())
TraceMethodCtrl.register(TracePiecewise, 'Mean', lambda tr: tr.mean())