darfix.core.dimension.AcquisitionDims

class darfix.core.dimension.AcquisitionDims

Bases: dict

Define the view of the data which has to be made

add_dim(axis, dim)

Parameters:

• axis (int) –

• dim (Dimension | dict) –

clear() → None.  Remove all items from D.

copy() → a shallow copy of D

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(axis, default=None)

Get Dimension at certain axis.

Parameters:

• axis (int) – axis of the dimension.

• axis –

Return type:

Dimension | None

Returns:

the requested dimension if exists.

get_names()

Get list with all the names of the dimensions.

Returns:

array_like of strings

items() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D's keys

property ndim: int

pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

remove_dim(axis)

Parameters:

axis (int) –

set_size(axis, size)

Recreated new dimension with new size and same name and kind.

Parameters:

• axis (int) – axis of the dimension

• size (int) – new size for the dimension

• axis –

• size –

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

property shape: tuple[int, ...]

Shape order is reversed from the axis so the data is correctly reshaped so that the dimensions which motors move first are at the last axis of the data. This is done to mantain the axes order as they are used to in the beamlines.

Returns:

shape of the currently defined dims

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values