Collocator

class typhon.collocations.Collocator(threads=None, name=None)[source]

__init__(threads=None, name=None)[source]

Initialize a collocator object that can find collocations

Parameters:

threads – Finding collocations can be parallelized in threads. Give here the maximum number of threads that you want to use. Which number of threads is the best, may be machine-dependent. So this is a parameter that you can use to fine-tune the performance. Note: Not yet implemented due to GIL usage of sklearn BallTree.
name – The name of this collocator, will be used in log statements.

Methods

`__init__`([threads, name])	Initialize a collocator object that can find collocations
`collocate`(primary, secondary[, ...])	Find collocations between two xarray.Dataset objects
`collocate_filesets`(filesets[, start, end, ...])	Find collocation between the data of two filesets
`get_meta_group`()
`spatial_search`(lat1, lon1, lat2, lon2, ...)
`spatial_search_with_temporal_binning`(...)
`temporal_search`(primary, secondary, max_interval)

Attributes