validate_and_expand_kwarg

xrayvision.imaging.validate_and_expand_kwarg(q, name='')

Expand a scalar or array of size one to size two by repeating.

Parameters:

• q (astropy.units.quantity.Quantity) – Input value

• name (str) – Name of the keyword

Examples

>>> import astropy.units as u
>>> validate_and_expand_kwarg(1*u.cm)
    <Quantity [1., 1.] cm>
>>> validate_and_expand_kwarg([1]*u.cm)
    <Quantity [1., 1.] cm>
>>> validate_and_expand_kwarg([1,1]*u.cm)
    <Quantity [1., 1.] cm>
>>> validate_and_expand_kwarg([1, 2, 3]*u.cm)  
    Traceback (most recent call last):
    ValueError:  argument must be scalar or an 1D array of size 1 or 2.