xarray.DataArray.kspace.as_configuration

DataArray.kspace.as_configuration(self, configuration)

Return a new DataArray with modified experimental configuration.

Use this method for an endstation that can acquire data in more than one physical configuration. The coordinates of the new DataArray are renamed by their physical roles to match the given configuration. The original data is not modified.

This method does not infer the acquisition geometry or repair arbitrary coordinate names from an incorrect loader implementation. The input must use the standard coordinate names for its current configuration.

Parameters:

configuration (AxesConfiguration | int) – The new configuration to apply.

Returns:

xarray.DataArray – A new array with unchanged data values, shape, dimension order, name, and dtype. Standard angle coordinates are renamed by their physical roles. A dimension is also renamed when it uses one of those coordinates. Other coordinates and attributes are retained, and the configuration attribute is updated.

Return type:

DataArray

Note

This method assumes a conversion between 4 typical setups listed in the table in Nomenclature. Any non-standard setups should be handled by the user.