SingleMeasurementPerFileDataset

class typhon.datasets.dataset.SingleMeasurementPerFileDataset(name=None, **kwargs)[source]

Represents datasets where each file contains one measurement.

An example of this would be ACE-FTS, or some radio-occultation datasets.

filename_fields

dict with {name, dtype} for fields that should be copied from the filename (as obtained with self.re) into the header

Type

Mapping[str, dtype]

__init__(**kwargs)

Initialise a Dataset object.

All keyword arguments will be translated into attributes. Does not take positional arguments.

Note that if you create a dataset with a name that already exists, the existing object is returned, but __init__ is still called (Python does this, see https://docs.python.org/3.7/reference/datamodel.html#object.__new__).

Methods

__init__(**kwargs)

Initialise a Dataset object.

as_xarray_dataset()

combine(my_data, other_obj[, other_data, ...])

Combine with data from other dataset.

find_dir_for_time(dt)

Find the directory containing granules/measurements at (date)time

find_granules([dt_start, dt_end, ...])

Yield all granules/measurementfiles in period

find_granules_sorted([dt_start, dt_end, ...])

Yield all granules, sorted by times.

find_most_recent_granule_before(instant, ...)

Find granule covering instant

get_additional_field(M, fld)

Get additional field.

get_info_for_granule(p)

Return dict (re.fullmatch) for granule, based on re

get_mandatory_fields()

get_path_format_variables()

What extra format variables are needed in find_granules?

get_subdir_resolution()

Return the resolution for the subdir precision.

get_time_from_granule_contents(p)

Get datetime objects for beginning and end of granule

get_times_for_granule(p, **kwargs)

For granule stored in path, get start and end times.

iterate_subdirs(d_start, d_end, **extra)

Iterate through all subdirs in dataset.

read([f, fields, pseudo_fields])

Read granule in file and do some other fixes

read_period([start, end, onerror, fields, ...])

Read all granules between start and end, in bulk.

read_single(p[, fields])

Read a single measurement from a single file.

setlocal()

Set local attributes, from config or otherwise.

verify_mandatory_fields(extra)

Attributes

aliases

basedir

concat_coor

datefields

default_orbit_filters

end_date

filename_fields

granule_cache_file

granule_duration

granules_firstline_db

granules_firstline_file

mandatory_fields

maxsize

my_pseudo_fields

name

re

read_returns

refields

related

section

start_date

subdir

time_field

unique_fields

valid_field_values