opera.pge.dswx_ni package

Submodules

opera.pge.dswx_ni.dswx_ni_pge module

dswx_ni_pge.py

Module defining the implementation for the Dynamic Surface Water Extent (DSWX) from NISAR (NI) PGE.

class opera.pge.dswx_ni.dswx_ni_pge.DSWxNIExecutor(pge_name, runconfig_path, **kwargs)

Bases: DSWxNIPreProcessorMixin, DSWxNIPostProcessorMixin, PgeExecutor

Main class for execution of the DSWx-NI PGE, including the SAS layer. This class essentially rolls up the DSWx-specific pre- and post-processor functionality, while inheriting all other functionality for setup and execution of the SAS from the base PgeExecutor class.

LEVEL = 'L3'

Processing Level for DSWx-NI Products

NAME = 'DSWx-NI'

Short name for the DSWx-NI PGE

SAS_VERSION = '0.2'

Version of the SAS wrapped by this PGE, should be updated as needed

class opera.pge.dswx_ni.dswx_ni_pge.DSWxNIPostProcessorMixin

Bases: DSWxS1PostProcessorMixin

Mixin class responsible for handling all post-processing steps for the DSWx-NI PGE. The post-processing phase is defined as all steps required after SAS execution has completed, prior to handover of output products to PCM. In addition to the base functionality inherited from PostProcessorMixin, this mixin adds an output validation step inherited from DSWxS1PostProcessorMixin to ensure that the output file(s) defined by the RunConfig exist and are valid.

run_postprocessor(**kwargs)

Executes the post-processing steps for the DSWx-NI PGE. The DSWxNIPostProcessorMixin version of this method performs the same steps as the base PostProcessorMixin, but inserts a step to perform output product validation (inherited from DSWxS1PostProcessorMixin) prior to staging and renaming of the output files (partially developed).

Parameters:

**kwargs (dict) – Any keyword arguments needed by the post-processor

class opera.pge.dswx_ni.dswx_ni_pge.DSWxNIPreProcessorMixin

Bases: DSWxS1PreProcessorMixin

Mixin class responsible for handling all pre-processing steps for the DSWX-NI PGE. The pre-processing phase is defined as all steps necessary prior to SAS execution.

This particular pre-processor inherits its functionality from the DSWx-S1 pre-processor class, as both PGE’s share a similar interface.

run_preprocessor(**kwargs)

Executes the pre-processing steps for DSWx-NI PGE initialization. The DSWxNIPreProcessorMixin version of this class performs all actions of the DSWxS1PreProcessorMixin class. Parameterization of the validation functions is handled via specialized class attributes (i.e. _valid_input_extensions)

Parameters:

**kwargs (dict) – Any keyword arguments needed by the pre-processor

Module contents