fields.buffers.core.HDF5Buffer.to#

HDF5Buffer.to(units, *args, equivalence=None, buffer_class=None, buffer_registry=None, as_array: bool = False, **kwargs)#

Return a new buffer (or array) with values cast to the specified units.

This is a shorthand for .in_units(…), and fully equivalent in functionality.

Parameters:

units (str or unyt.Unit) – Desired output units.
equivalence (str, optional) – Optional equivalence name for converting between dimensionally different types.
buffer_class (type, optional) – Explicit buffer type for re-wrapping.
buffer_registry (BufferRegistry, optional) – Optional registry to use for resolution.
as_array (bool, default False) – If True, return raw unyt_array instead of a buffer.
*args – Forwarded to .in_units.
**kwargs – Forwarded to .in_units.

Returns:

Buffer (or array) in the new units.

Return type:

BufferBase or unyt_array