xarray.CFTimeIndex

class xarray.CFTimeIndex

Custom Index for working with CF calendars and dates

All elements of a CFTimeIndex must be cftime.datetime objects.

Parameters
  • data (array or CFTimeIndex) – Sequence of cftime.datetime objects to use in index

  • name (str, default None) – Name of the resulting index

See also

cftime_range

__init__(self, /, *args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(self, /, \*args, \*\*kwargs)

Initialize self.

all(self, \*args, \*\*kwargs)

Return whether all elements are True.

any(self, \*args, \*\*kwargs)

Return whether any element is True.

append(self, other)

Append a collection of Index options together.

argmax(self[, axis, skipna])

Return an ndarray of the maximum argument indexer.

argmin(self[, axis, skipna])

Return a ndarray of the minimum argument indexer.

argsort(self, \*args, \*\*kwargs)

Return the integer indices that would sort the index.

asof(self, label)

Return the label from the index, or, if not present, the previous one.

asof_locs(self, where, mask)

Find the locations (indices) of the labels from the index for every entry in the where argument.

astype(self, dtype[, copy])

Create an Index with values cast to dtypes.

contains(self, key)

Needed for .loc based partial-string indexing

copy(self[, name, deep, dtype])

Make a copy of this object.

delete(self, loc)

Make new Index with passed location(-s) deleted.

difference(self, other[, sort])

Return a new Index with elements from the index that are not in other.

drop(self, labels[, errors])

Make new Index with passed list of labels deleted.

drop_duplicates(self[, keep])

Return Index with duplicate values removed.

droplevel(self[, level])

Return index with requested level(s) removed.

dropna(self[, how])

Return Index without NA/NaN values.

duplicated(self[, keep])

Indicate duplicate index values.

equals(self, other)

Determine if two Index objects contain the same elements.

factorize(self[, sort, na_sentinel])

Encode the object as an enumerated type or categorical variable.

fillna(self[, value, downcast])

Fill NA/NaN values with the specified value.

format(self[, name, formatter])

Render a string representation of the Index.

CFTimeIndex.get_duplicates

get_indexer(self, target[, method, limit, …])

Compute indexer and mask for new index given the current index.

get_indexer_for(self, target, \*\*kwargs)

Guaranteed return of an indexer even when non-unique.

get_indexer_non_unique(self, target)

Compute indexer and mask for new index given the current index.

get_level_values(self, level)

Return an Index of values for requested level.

get_loc(self, key[, method, tolerance])

Adapted from pandas.tseries.index.DatetimeIndex.get_loc

get_slice_bound(self, label, side, kind)

Calculate slice bound that corresponds to given label.

get_value(self, series, key)

Adapted from pandas.tseries.index.DatetimeIndex.get_value

CFTimeIndex.get_values

groupby(self, values)

Group the index labels by a given array of values.

holds_integer(self)

Whether the type is an integer type.

identical(self, other)

Similar to equals, but check that other comparable attributes are also equal.

insert(self, loc, item)

Make new Index inserting new item at location.

intersection(self, other[, sort])

Form the intersection of two Index objects.

is_(self, other)

More flexible, faster check like is but that works through views.

is_boolean(self)

is_categorical(self)

Check if the Index holds categorical data.

is_floating(self)

is_integer(self)

is_interval(self)

CFTimeIndex.is_lexsorted_for_tuple

is_mixed(self)

is_numeric(self)

is_object(self)

is_type_compatible(self, kind)

Whether the index type is compatible with the provided type.

isin(self, values[, level])

Return a boolean array where the index values are in values.

isna(self)

Detect missing values.

isnull(self)

Detect missing values.

item(self)

Return the first element of the underlying data as a python scalar.

join(self, other[, how, level, …])

Compute join_index and indexers to conform data structures to the new index.

map(self, mapper[, na_action])

Map values using input correspondence (a dict, Series, or function).

max(self[, axis, skipna])

Return the maximum value of the Index.

memory_usage(self[, deep])

Memory usage of the values.

min(self[, axis, skipna])

Return the minimum value of the Index.

notna(self)

Detect existing (non-missing) values.

notnull(self)

Detect existing (non-missing) values.

nunique(self[, dropna])

Return number of unique elements in the object.

putmask(self, mask, value)

Return a new Index of the values set with the mask.

ravel(self[, order])

Return an ndarray of the flattened values of the underlying data.

reindex(self, target[, method, level, …])

Create index with target’s values (move/add/delete values as necessary).

rename(self, name[, inplace])

Alter Index or MultiIndex name.

repeat(self, repeats[, axis])

Repeat elements of a Index.

searchsorted(self, value[, side, sorter])

Find indices where elements should be inserted to maintain order.

set_names(self, names[, level, inplace])

Set Index or MultiIndex name.

set_value(self, arr, key, value)

Fast lookup of value from 1-dimensional ndarray.

shift(self, n, freq)

Shift the CFTimeIndex a multiple of the given frequency.

slice_indexer(self[, start, end, step, kind])

For an ordered or unique index, compute the slice indexer for input labels and step.

slice_locs(self[, start, end, step, kind])

Compute slice locations for input labels.

sort(self, \*args, \*\*kwargs)

Use sort_values instead.

sort_values(self[, return_indexer, ascending])

Return a sorted copy of the index.

sortlevel(self[, level, ascending, …])

For internal compatibility with with the Index API.

strftime(self, date_format)

Return an Index of formatted strings specified by date_format, which supports the same string format as the python standard library.

CFTimeIndex.summary

symmetric_difference(self, other[, …])

Compute the symmetric difference of two Index objects.

take(self, indices[, axis, allow_fill, …])

Return a new Index of the values selected by the indices.

to_datetimeindex(self[, unsafe])

If possible, convert this index to a pandas.DatetimeIndex.

to_flat_index(self)

Identity method.

to_frame(self[, index, name])

Create a DataFrame with a column containing the Index.

to_list(self)

Return a list of the values.

to_native_types(self[, slicer])

Format specified values of self and return them.

to_numpy(self[, dtype, copy, na_value])

A NumPy ndarray representing the values in this Series or Index.

to_series(self[, index, name])

Create a Series with both index and values equal to the index keys.

tolist(self)

Return a list of the values.

transpose(self, \*args, \*\*kwargs)

Return the transpose, which is by definition self.

union(self, other[, sort])

Form the union of two Index objects.

unique(self[, level])

Return unique values in the index.

value_counts(self[, normalize, sort, …])

Return a Series containing counts of unique values.

view(self[, cls])

where(self, cond[, other])

Return an Index of same shape as self and whose corresponding entries are from self where cond is True and otherwise are from other.

Attributes

T

Return the transpose, which is by definition self.

array

The ExtensionArray of the data backing this Series or Index.

asi8

Integer representation of the values.

CFTimeIndex.base

CFTimeIndex.data

date_type

day

The days of the datetime

dayofweek

The day of week of the datetime

dayofyear

The ordinal day of year of the datetime

dtype

Return the dtype object of the underlying data.

CFTimeIndex.dtype_str

empty

CFTimeIndex.flags

has_duplicates

hasnans

Return if I have any nans; enables various perf speedups.

hour

The hours of the datetime

inferred_type

Return a string of the type inferred from the values.

is_all_dates

is_monotonic

Alias for is_monotonic_increasing.

is_monotonic_decreasing

Return if the index is monotonic decreasing (only equal or decreasing) values.

is_monotonic_increasing

Return if the index is monotonic increasing (only equal or increasing) values.

is_unique

Return if the index has unique values.

CFTimeIndex.itemsize

microsecond

The microseconds of the datetime

minute

The minutes of the datetime

month

The month of the datetime

name

names

nbytes

Return the number of bytes in the underlying data.

ndim

Number of dimensions of the underlying data, by definition 1.

nlevels

Number of levels.

second

The seconds of the datetime

shape

Return a tuple of the shape of the underlying data.

size

Return the number of elements in the underlying data.

CFTimeIndex.strides

values

Return an array representing the data in the Index.

year

The year of the datetime