Typhon
0.10.0
  • Reference
    • ARTS
    • Cloud mask
    • Collocations
      • Collocations
        • collapse
        • Collocator
        • Collocations
        • expand
    • Configuration and Environment
    • Constants
    • Datasets
    • Filesets and handlers
    • Geodesy and Geography
    • Mathematics
    • Physics
    • Physics (Unit-aware via pint)
    • Plotting
    • Retrieval
    • Spectroscopy
    • Topography
    • Miscellaneous
    • Indices and tables
  • Developer documentation
  • FAQ
  • Tutorials
Typhon
  • Reference
  • Collocations
  • Collocations
  • search
  • View page source

search

Collocations.search(filesets, collocator=None, **kwargs)[source]

Find all collocations between two filesets and store them in files

Collocations are two or more data points that are located close to each other in space and/or time.

This takes all files from the filesets between two dates, find collocations of their data points and store them in output files.

Each collocation output file provides these standard fields:

  • fileset_name/lat - Latitudes of the collocations.

  • fileset_name/lon - Longitude of the collocations.

  • fileset_name/time - Timestamp of the collocations.

  • fileset_name/__index - Indices of the collocation data in

    the original files.

  • fileset_name/__file_start - Start time of the original file.

  • fileset_name/__file_end - End time of the original file.

  • collocations/pairs - Tells you which data points are collocated

    with each other by giving their indices.

And all additional fields that were loaded from the original files (you can control which fields should be loaded by the read_args parameter from the FileSet objects in filesets). Note that subgroups in the original data will be flattened by replacing / with _ since xarray is not yet able to handle grouped data properly.

Parameters:
  • filesets – A list of FileSet objects.

  • collocator – If you want to use your own collocator, you can pass it here. It must behave like Collocator.

  • **kwargs – Additional keyword arguments that are allowed for collocate_filesets().

Examples:

Previous Next

© Copyright The Typhon Developers.

Built with Sphinx using a theme provided by Read the Docs.