Source code for mr_utils.utils.sos

'''Simple root sum of squares image combination.'''

import numpy as np

def sos(im, axes=0):
    '''Root sum of squares combination along given axes.

    Parameters
    ----------
    im : array_like
        Input image.
    axes : tuple
        Dimensions to sum across.

    Returns
    -------
    array_like
        SOS combination of image.
    '''
    return np.sqrt(np.sum(np.abs(im)**2, axis=axes))

if __name__ == '__main__':
    pass