datasets

Modules in this package contain classes to handle datasets.

That includes the overall framework to handle datasets in the dataset module, as well as concrete datasets for specific sensors etc., including reading routines.

To implement a new reading routine, subclass one of the datasets here.

datasets.dataset

Module containing classes abstracting datasets

DataFileError	Superclass for any datafile problems
Dataset([name])	Represents a dataset.
DatasetDeque(ds, window, init_time, *args, ...)	A deque-like object sliding through a dataset.
GranuleLocatorError	Problem locating granules.
HomemadeDataset([name])	For any dataset created by typhon or its dependencies.
HyperSpectral([name])	Superclass for any hyperspectral instrument
InvalidDataError	Raised when data is not how it should be.
InvalidFileError	Raised when the requested information cannot be obtained from the file
MiB	int([x]) -> integer int(x, base=10) -> integer
MultiFileDataset([name])	Represents a dataset where measurements are spread over multiple files.
MultiSatelliteDataset()
NetCDFDataset()	Mixin for any dataset where the contents are in NetCDF.
SingleFileDataset([name])	Represents a dataset where all measurements are in one file.
SingleMeasurementPerFileDataset([name])	Represents datasets where each file contains one measurement.

datasets.filters

Collection of classes related to filtering

FilterError	For any errors related to filtering.
OutlierFilter()
MEDMAD(cutoff[, fallback_min_std])	Outlier filter based on Median Absolute Deviation
OrbitFilter()	Generic, abstract class for any kind of filtering.
TimeMaskFilter(ds)	Throw out bad (masked) times.
HIRSTimeSequenceDuplicateFilter()	Force scanlines to be in the proper sequence without duplicates
HIRSFlagger(ds[, max_flagged])	Apply HIRS flags and raise error in case of failure
HIRSCalibCountFilter(ds, filter_calibcounts)	Apply masking based on calibration count filter for HIRS
HIRSPRTTempFilter(ds, filter_prttemps)	Apply masking to PRT counts when they are outliers
OverlapFilter()	Implementations to feed into firstline filtering
FirstlineDBFilter(ds, granules_firstline_file)
NullLineFilter()	Do not filter firstlines at all
HIRSBestLineFilter(ds[, warn_overlap])	Choose best between overlaps.

datasets.model

Datasets for models

ERAInterim([name])

datasets.tovs

Datasets for TOVS/ATOVS

This module imports typhon.physics.units and therefore has a soft dependency on the pint units library. Import this module only if you can accept such a dependency.

ATOVS()	Functionality in common with all ATOVS.
HIASI([name])	"HIRS-IASI collocations
HIRS([name])	High-resolution Infra-Red Sounder.
HIRS2([name])	Sole implementation of HIRSPOD
HIRS2I([name])
HIRS3([name])
HIRS4([name])
HIRSHIRS([name])	HIRS-HIRS collocations from Brockmann Consult
HIRSKLM([name])
HIRSPOD([name])	Read early HIRS such as documented in POD guide.
IASIEPS([name])	Read IASI from EUMETSAT EPS L1C
IASISub([name])
MHSL1C([name])
Radiometer()
TOVSCollocatedDataset()	Mixin for any TOVS collocated dataset.