#!/usr/bin/env python
# -*- coding: utf-8 -*-
# #########################################################################
# Copyright (c) 2018, UChicago Argonne, LLC. All rights reserved. #
# #
# Copyright 2018. UChicago Argonne, LLC. This software was produced #
# under U.S. Government contract DE-AC02-06CH11357 for Argonne National #
# Laboratory (ANL), which is operated by UChicago Argonne, LLC for the #
# U.S. Department of Energy. The U.S. Government has rights to use, #
# reproduce, and distribute this software. NEITHER THE GOVERNMENT NOR #
# UChicago Argonne, LLC MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR #
# ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE. If software is #
# modified to produce derivative works, such modified software should #
# be clearly marked, so as not to confuse it with the version available #
# from ANL. #
# #
# Additionally, 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. #
# #
# * Neither the name of UChicago Argonne, LLC, Argonne National #
# Laboratory, ANL, the U.S. Government, nor the names of its #
# contributors may be used to endorse or promote products derived #
# from this software without specific prior written permission. #
# #
# THIS SOFTWARE IS PROVIDED BY UChicago Argonne, LLC 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 UChicago #
# Argonne, LLC 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. #
# #########################################################################
"""Define universal constants and physical relation functions."""
__author__ = "Doga Gursoy, Daniel Ching"
__copyright__ = "Copyright (c) 2018, UChicago Argonne, LLC."
__docformat__ = "restructuredtext en"
__all__ = [
"PLANCK_CONSTANT",
"SPEED_OF_LIGHT",
"wavelength",
"wavenumber",
"complex_amplitude",
"complex_intensity",
"complex_phase",
"sum_square_norm",
]
import numpy as np
PLANCK_CONSTANT = 6.58211928e-19 # [keV*s]
SPEED_OF_LIGHT = 299792458e+2 # [cm/s]
[docs]def wavelength(energy):
"""Return the wavelength [cm] for a given energy [keV]."""
return 2 * np.pi * PLANCK_CONSTANT * SPEED_OF_LIGHT / energy
[docs]def wavenumber(energy):
"""Return the wavenumber [1/cm] given energy [keV]."""
return energy / PLANCK_CONSTANT / SPEED_OF_LIGHT
[docs]def complex_amplitude(probe_grid):
"""Amplitude of the complex probe wave."""
return np.abs(probe_grid)
[docs]def complex_intensity(probe_grid):
"""Intensity of the complex wave."""
return np.square(np.abs(probe_grid))
[docs]def complex_phase(probe_grid):
"""Phase of the complex probe wave."""
return np.angle(probe_grid)
[docs]def sum_square_norm(x, N=1):
"""Return x normalized such that the sum of squares of x equals N."""
x1 = np.sqrt(np.square(x) / np.sum(np.square(x)) * N)
np.testing.assert_almost_equal(np.sum(np.square(np.abs(x1))), N, decimal=3)
return x1