###
# Copyright 2011 Diamond Light Source Ltd.
# 
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# 
#   http://www.apache.org/licenses/LICENSE-2.0
# 
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
###

'''
Signal processing package
'''

import org.eclipse.dawnsci.analysis.dataset.impl.Signal as _signal

from jycore import _wrap
from jycore import asfarray as _asf

@_wrap
def correlate(f, g=None, mode='valid', axes=None):
    '''Perform a cross (or auto if g is None) correlation along given axes'''

    f = _asf(f)._jdataset()
    if g is None:
        g = f
    else:
        g = _asf(g)._jdataset()

    if mode == 'same':
        return _signal.correlateToSameShape(f, g, axes)
    elif mode == 'valid':
        return _signal.correlateForOverlap(f, g, axes)
    elif mode == 'full':
        return _signal.correlate(f, g, axes)
    raise ValueError, "mode keyword has unrecognised value"

@_wrap
def phasecorrelate(f, g, axes=None, includeinv=False):
    '''Perform a phase cross correlation along given axes (can include inverse of cross-power spectrum)'''
    ans = _signal.phaseCorrelate(_asf(f)._jdataset(), _asf(g)._jdataset(), axes, includeinv)
    if includeinv:
        return ans[0], ans[1]
    else:
        return ans[0]

@_wrap
def convolve(f, g, mode='full', axes=None):
    '''Perform a convolution along given axes'''
    if mode == 'same':
        return _signal.convolveToSameShape(_asf(f)._jdataset(), _asf(g)._jdataset(), axes)
    elif mode == 'valid':
        return _signal.convolveForOverlap(_asf(f)._jdataset(), _asf(g)._jdataset(), axes)
    elif mode == 'full':
        return _signal.convolve(_asf(f)._jdataset(), _asf(g)._jdataset(), axes)
    raise ValueError, "mode keyword has unrecognised value"