xarray.IndexVariable.astype#
- IndexVariable.astype(dtype, *, order=None, casting=None, subok=None, copy=None, keep_attrs=True)[source]#
Copy of the Variable object, with data cast to a specified type.
- Parameters:
dtype (
str
ordtype
) – Typecode or data-type to which the array is cast.order (
{'C', 'F', 'A', 'K'}
, optional) – Controls the memory layout order of the result. ‘C’ means C order, ‘F’ means Fortran order, ‘A’ means ‘F’ order if all the arrays are Fortran contiguous, ‘C’ order otherwise, and ‘K’ means as close to the order the array elements appear in memory as possible.casting (
{'no', 'equiv', 'safe', 'same_kind', 'unsafe'}
, optional) – Controls what kind of data casting may occur.‘no’ means the data types should not be cast at all.
‘equiv’ means only byte-order changes are allowed.
‘safe’ means only casts which can preserve values are allowed.
‘same_kind’ means only safe casts or casts within a kind, like float64 to float32, are allowed.
‘unsafe’ means any data conversions may be done.
subok (
bool
, optional) – If True, then sub-classes will be passed-through, otherwise the returned array will be forced to be a base-class array.copy (
bool
, optional) – By default, astype always returns a newly allocated array. If this is set to False and the dtype requirement is satisfied, the input array is returned instead of a copy.keep_attrs (
bool
, optional) – By default, astype keeps attributes. Set to False to remove attributes in the returned object.
- Returns:
out (
same as object
) – New object with data cast to the specified type.
Notes
The
order
,casting
,subok
andcopy
arguments are only passed through to theastype
method of the underlying array when a value different thanNone
is supplied. Make sure to only supply these arguments if the underlying array class supports them.