kbdiffdi.indices.KBDI

class kbdiffdi.indices.KBDI()

A KBDI object is initialized without any parameters.

Attributes


Attribute
temp: kbdiffdi.feature.RasterCube
RasterCube object that holds temperature data
prcp: kbdiffdi.feature.RasterCube
RasterCube object that holds precipitation data
first_KBDI: numpy.ndarray
A 2D ndarray that contains the first KBDI values. This is used as an initialization for KBDI calculations
net_rainfall: numpy.ndarray
A 2D ndarray that holds net rainfall data
mean_annual_rainfall: numpy.ndarray
A 2D ndarray that holds mean annual rainfall data

Methods


Method Description
load_csv(filename) loads data from a csv into the KBDI object
fit(inittemp, initprcp, initmeanannualrainfall=None, initdroughtindex=np.array([[[[0]]]])) sets the KBDI object’s attributes and returns the KBDI

__init__()

load_csv(filename)

fit(inittemp, initprcp, initmeanannualrainfall=None, initdroughtindex=np.array([[[[0]]]]))

examples


initialize a KBDI object

from kbdiffdi import indices
my_kbdi = indices.KBDI()