API
dafmit_aeromag.Dataset
Query a fixed, reproducible release of the open flight data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
release
|
str
|
Bundled catalog release. Version |
'v3'
|
data_dir
|
str | Path | None
|
Directory for downloaded HDF5 files. By default Pooch's user cache is used. |
None
|
progress
|
bool
|
Show download progress bars when a file is fetched. |
True
|
offline
|
bool
|
Refuse downloads and use only already verified local files. |
False
|
flights(collection=None)
Return the release's flight/file catalog as a DataFrame.
fields(flight=None, *, collection=None, group=None)
Return field names, units, descriptions, and collection coverage.
field_groups(group=None, *, flight=None, collection=None)
Return fields organized by stable convenience groups.
Groups are a navigation aid only; the name column remains the
original HDF5 field name.
field_names(group, *, flight=None, collection=None)
Return original HDF5 field names in a convenience group.
sensors(collection=None)
Return documented magnetometer and fluxgate sensor positions.
segments(flights=None, *, split=None, flight=None)
Return documented flight segments, including holdout metadata.
fetch(flights)
Ensure files are local and return {flight: path}.
read(selections, *, columns, split='train', raw=False, missing='raise')
Read one or more selections into a single DataFrame.
Selection order is preserved, followed by source row order. The
normalized output always starts with flight, line, year, doy, tt,
time. By default only catalogued training intervals are returned;
pass split='holdout' or split='all' to choose another view.
raw=True returns only the requested source sample fields.
to_xarray(frame)
Convert a DataFrame returned by :meth:read to an xarray Dataset.
dafmit_aeromag.Selection
dataclass
A flight-scoped sample selection.
lines accepts canonical decimal strings. time and tt are
half-open slices, and are intentionally mutually exclusive because tt
is the native time coordinate stored by the source files.
all(flight)
classmethod
Select every sample in flight before the read split is applied.
dafmit_aeromag.DatasetError
Bases: Exception
Base class for all expected library errors.