sisppeo.readers package

Submodules

sisppeo.readers.GRS module

This module contains a reader for GRS products.

This reader is dedicated to extract data from S2_GRS, L4_GRS, L5_GRS, L7_GRS and L8_GRS products.

Example:

reader = GRSReader(**config)
reader.extract_bands()
reader.create_ds()
extracted_dataset = reader.dataset
class sisppeo.readers.GRS.GRSInputs(input_product, requested_bands, ROI, product_type, flags, grs_bands)

Bases: tuple

ROI

Alias for field number 2

flags

Alias for field number 4

grs_bands

Alias for field number 5

input_product

Alias for field number 0

product_type

Alias for field number 3

requested_bands

Alias for field number 1

class sisppeo.readers.GRS.GRSReader(input_product, product_type, requested_bands, geom=None, glint_corrected=True, flags=False, **_ignored)[source]

Bases: sisppeo.readers.reader.Reader

A reader dedicated to extract data from both S2_GRS, L4_GRS, L5_GRS, L7_GRS and L8_GRS products.

dataset

A dataset containing extracted data.

create_ds()[source]

See base class.

extract_bands()[source]

See base class.

sisppeo.readers.L8_USGS_L1C1 module

This module contains a reader for L8_USGS_L1C1 products.

Example:

reader = L8USGSL1C1Reader(**config)
reader.extract_bands()
reader.create_ds()
extracted_dataset = reader.dataset
class sisppeo.readers.L8_USGS_L1C1.L8USGSL1C1Reader(input_product, requested_bands, geom=None, **_ignored)[source]

Bases: sisppeo.readers.reader.Reader

A reader dedicated to extract data from L8_USGS_L1C1 products.

dataset

A dataset containing extracted data.

create_ds()[source]

See base class.

extract_bands()[source]

See base class.

sisppeo.readers.L8_USGS_L1C1.format_zippath(path)[source]

sisppeo.readers.L8_USGS_L2 module

This module contains a reader for L8_USGS_L2C1 products with hdf files.

Typical usage example:

reader = L8USGSL2C1HDFReader(**config) reader.extract_bands() reader.create_ds() extracted_dataset = reader.dataset

class sisppeo.readers.L8_USGS_L2.L8USGSL2Reader(input_product, requested_bands, geom=None, **_ignored)[source]

Bases: sisppeo.readers.reader.Reader

A reader dedicated to extract data from L8_USGS_L2C1 products (.hdf).

dataset

A dataset containing extracted data.

create_ds()[source]

See base class.

extract_bands()[source]

See base class.

sisppeo.readers.L8_USGS_L2.format_zippath(path)[source]

sisppeo.readers.S2_ESA module

This module contains a reader for S2_ESA products.

This reader is dedicated to extract data from both S2_ESA_L1C and S2_ESA_L2A.

Example:

reader = S2ESAReader(**config)
reader.extract_bands()
reader.create_ds()
extracted_dataset = reader.dataset
class sisppeo.readers.S2_ESA.S2ESAInputs(input_product, requested_bands, ROI, out_resolution)

Bases: tuple

ROI

Alias for field number 2

input_product

Alias for field number 0

out_resolution

Alias for field number 3

requested_bands

Alias for field number 1

class sisppeo.readers.S2_ESA.S2ESAReader(input_product, requested_bands, geom=None, out_resolution=None, **_ignored)[source]

Bases: sisppeo.readers.reader.Reader

A reader dedicated to extract data from both S2_ESA_L1C and S2_ESA_L2A products.

dataset

A dataset containing extracted data.

create_ds()[source]

See base class.

extract_bands()[source]

See base class.

sisppeo.readers.S2_ESA.format_zippath(path)[source]

sisppeo.readers.S2_THEIA module

This module contains a reader for S2_THEIA products.

This reader is dedicated to extract data from S2_THEIA_L2A.

Example:

reader = S2THEIAReader(**config)
reader.extract_bands()
reader.create_ds()
extracted_dataset = reader.dataset
class sisppeo.readers.S2_THEIA.S2THEIAInputs(input_product, requested_bands, ROI, out_resolution, theia_bands, theia_masks)

Bases: tuple

ROI

Alias for field number 2

input_product

Alias for field number 0

out_resolution

Alias for field number 3

requested_bands

Alias for field number 1

theia_bands

Alias for field number 4

theia_masks

Alias for field number 5

class sisppeo.readers.S2_THEIA.S2THEIAReader(input_product, requested_bands, geom=None, out_resolution=None, theia_bands='FRE', theia_masks=None, **_ignored)[source]

Bases: sisppeo.readers.reader.Reader

A reader dedicated to extract data from S2_THEIA_L2A products.

For more information about THEIA S2 L2A products, please see: https://labo.obs-mip.fr/multitemp/sentinel-2/theias-sentinel-2-l2a-product-format/

dataset

A dataset containing extracted data.

create_ds()[source]

See base class.

extract_bands()[source]

See base class.

sisppeo.readers.S2_THEIA.format_zippath(path)[source]

sisppeo.readers.reader module

This module contains the Reader class.

The Reader class is an abstract class (a blueprint) inherited by every readers. A reader is an object used to extract bands (radiometric data) and metadata from satellite products (or a subset of products). It also allows one to perform resampling operations. There is a reader for each ‘product_type’.

class sisppeo.readers.reader.Inputs(input_product, requested_bands, ROI)

Bases: tuple

ROI

Alias for field number 2

input_product

Alias for field number 0

requested_bands

Alias for field number 1

class sisppeo.readers.reader.ROI(geom, srid)

Bases: tuple

geom

Alias for field number 0

srid

Alias for field number 1

class sisppeo.readers.reader.Reader(input_product, requested_bands, geom=None, **_ignored)[source]

Bases: abc.ABC

Abstract class inherited by every specific reader.

abstract create_ds()[source]

Creates a xr.Dataset out of Reader params and extracted information.

abstract extract_bands()[source]

Opens the input product and extracts bands and metadata.

Module contents