check_xy_dim

artpop.util.check_xy_dim(xy_dim, force_odd=True)[source]

Check the format of xy_dim.

Parameters
xy_dimint or list-like

The dimensions of mock image in xy units. If int is given, it is assumed to be both the x and y dimensions and (xy_dim, xy_dim) will be returned. Otherwise xy_dim will be returned.

force_oddbool, optional

If True (default), force both the x and y dimensions to be odd.

Returns
xy_dimndarray

Dimensions of mock image in xy units.