Add python package pages authored by Gaëlle USSEGLIO's avatar Gaëlle USSEGLIO
# diapotb.lib package
## Subpackages
* diapotb.lib.core package
* diapotb.lib.internal_processing package
## Submodules
## diapotb.lib.DInSAR module
DInSar chain
### class diapotb.lib.DInSAR.DInSAR(\*\*kwargs)
Bases: `diapotb.lib.core.DiapOTBProcessing.DiapOTBProcessingDualImages`
Use the module to launch DINSAR chain.
main function : execute
#### execute(\*\*kwargs)
DInSAR chain
Execute DInSAR processing following current mode (from ChainModes) thanks to an Executor.
Executor may be ExecutorDInSAROthers, ExecutorDInSARTSX or ExecutorDInSARS1IW.
* **Parameters**
**kwargs** (*dict-like*) – parameters as kwargs (used to provide additionnal input to the selected executor)
#### retrieve_output(key)
Retrieve a given output of the DInSAR chain
### class diapotb.lib.DInSAR.DInSarFilenames(value)
Bases: `diapotb.lib.core.DiapOTBEnums.FilenamesEnum`
Define key for intermediate/output filenames for DInSAR chain
3 str to speficy, a key, the extension to add and the position of the extension in order to create the file
#### FILES_AFTER_CONCATENATE( = ('interf_concatenate', 'interferogram_swath', 'exclusif'))
#### FILES_AFTER_COREGISTRATION( = ('coRe_files', '_coregistrated', 'sufix'))
#### FILES_AFTER_DERAMP( = ('coRe_deramp_files', '_coregistrated_reramp', 'sufix'))
#### FILES_AFTER_FILTERING( = ('filter_files', '_filtered', 'sufix'))
#### FILES_AFTER_FILTERING_DERAMP( = ('deramp_filter_files', '_filtered_reramp', 'sufix'))
#### FILES_AFTER_FINEGRID( = ('grid_files', 'fineDeformationGrid', 'whole'))
#### FILES_AFTER_INTERF( = ('interf_files', 'interferogram', 'whole'))
### class diapotb.lib.DInSAR.DInSarInputKeysOthers(value)
Bases: `diapotb.lib.core.DiapOTBEnums.ExtendedEnum`
Define intput keys for DINSAR chain (Others keys + the following ones)
#### CARTESIAN_ESTIMATION_REFERENCE( = 'cart_list_reference')
#### DEM( = 'dem')
#### DEMPROJ_REFERENCE( = 'dem_proj_list_reference')
#### DEMPROJ_SECONDARY( = 'dem_proj_list_secondary')
#### DOP0_SECONDARY( = 'doppler_0_list_secondary')
#### ML_REFERENCE( = 'ml_list_reference')
#### ML_SECONDARY( = 'ml_list_secondary')
### class diapotb.lib.DInSAR.DInSarOutputKeysOthers(value)
Bases: `diapotb.lib.core.DiapOTBEnums.ExtendedEnum`
Define output keys for DINSAR chain
#### COREGISTRATED_SECONDARY( = 'coregistrated_secondary')
#### GRIDS( = 'grids_list')
#### INTERFERO( = 'interferogram')
### class diapotb.lib.DInSAR.DInSarParamDefaultValueOthers(value)
Bases: `diapotb.lib.core.DiapOTBEnums.DefaultEnum`
Define some default values or redirect to other values
The following paramaters are optional (other are mandatory)
#### ADVANTAGE( = ('advantage', 'projection'))
#### MLAZI_GRID( = ('grid_ml_azi', 'ML_azi'))
#### MLRAN_GRID( = ('grid_ml_ran', 'ML_ran'))
#### ML_INTERFAZI( = ('interf_azi', 'ML_azi'))
#### ML_INTERFRAN( = ('interf_ran', 'ML_ran'))
### class diapotb.lib.DInSAR.DInSarParamDefaultValueS1IW(value)
Bases: `diapotb.lib.core.DiapOTBEnums.DefaultEnum`
Define some default values or redirect to other values
The following paramaters are optional (other are mandatory)
#### ADVANTAGE( = ('advantage', 'projection'))
#### ESD_AUTOMODE( = ('esd_AutoMode', True))
#### MLAZI_GRID( = ('grid_ml_azi', 'ML_azi'))
#### MLRAN_GRID( = ('grid_ml_ran', 'ML_ran'))
#### ML_INTERFAZI( = ('interf_azi', 'ML_azi'))
#### ML_INTERFRAN( = ('interf_ran', 'ML_ran'))
#### WITH_CONCATENATION( = ('with_concatenation', True))
#### WITH_INTERF( = ('with_interferogram', True))
### class diapotb.lib.DInSAR.DInSarParamDefaultValueTSX(value)
Bases: `diapotb.lib.core.DiapOTBEnums.DefaultEnum`
Define some default values or redirect to other values
The following paramaters are optional (other are mandatory)
#### ACTIVATE_DERAMP( = ('with_deramp', True))
#### ADVANTAGE( = ('advantage', 'projection'))
#### MLAZI_GRID( = ('grid_ml_azi', 'ML_azi'))
#### MLRAN_GRID( = ('grid_ml_ran', 'ML_ran'))
#### ML_INTERFAZI( = ('interf_azi', 'ML_azi'))
#### ML_INTERFRAN( = ('interf_ran', 'ML_ran'))
### class diapotb.lib.DInSAR.DInSarParamOthers(value)
Bases: `diapotb.lib.core.DiapOTBEnums.ExtendedEnum`
Define each required parameters for DINSAR chain
#### ADVANTAGE( = 'advantage')
#### GRID_GAP( = 'grid_gap')
#### GRID_STEP_AZI( = 'grid_step_azi')
#### GRID_STEP_RAN( = 'grid_step_ran')
#### GRID_THRESHOLD( = 'grid_treshold')
#### INTERF_GAIN( = 'interf_gain')
#### MLAZI( = 'ML_azi')
#### MLAZI_GRID( = 'grid_ml_azi')
#### MLRAN( = 'ML_ran')
#### MLRAN_GRID( = 'grid_ml_ran')
#### ML_INTERFAZI( = 'interf_azi')
#### ML_INTERFRAN( = 'interf_ran')
### class diapotb.lib.DInSAR.ExecutorDInSAROthers(param_handler, file_handler_reference, file_handler_secondary)
Bases: `diapotb.lib.core.DiapOTBProcessing.ExecutorDualImages`
Execute processing for DINSAR chain mode S1SM-CSK
#### execute()
DInSar chain for S1SM and CSK sensors
Several applications are called here : SARFineDeformationGrid, SARCoRegistration and SARRobustInterferogram.
These applications have the self._reference_image and self._secondary_image as inputs and put outputs in self._output_dir
### class diapotb.lib.DInSAR.ExecutorDInSARS1IW(param_handler, file_handler_reference, file_handler_secondary)
Bases: `diapotb.lib.core.DiapOTBProcessing.ExecutorDualImages`
Execute processing for DINSAR chain mode S1IW
#### execute()
DInSar chain for S1IW
Several applications are called here : SARFineDeformationGrid, SARCoRegistration SARDeramp, SARRobustInterferogram and SARESD.
These applications have the self._reference_image and self._secondary_image as inputs and put outputs in self._output_dir.
#### execute_one_burst(burst_dir, id_loop)
Execute DInSAR chain for each burst
### class diapotb.lib.DInSAR.ExecutorDInSARTSX(param_handler, file_handler_reference, file_handler_secondary)
Bases: `diapotb.lib.core.DiapOTBProcessing.ExecutorDualImages`
Execute processing for DINSAR chain mode TSX
#### execute()
DInSar chain for TSX/PAZ sensors
Several applications are called here : SARFineDeformationGrid, SARCoRegistration SARDeramp and SARRobustInterferogram.
These applications have the self._reference_image and self._secondary_image as inputs and put outputs in self._output_dir.
A filtering (from internal_processing package) may also be applied on reference_image
## diapotb.lib.DiapOTBProcessingFactory module
Factory to create every kind of processing
### class diapotb.lib.DiapOTBProcessingFactory.DiapOTBProcessingFactory(mode=ChainModes.OTHERS)
Bases: `object`
Factory to create all processing
#### create_processing(chain_name, \*\*kwargs)
Classmethod to create a given processing
* **Parameters**
* **chain_name** (*str*) – name of current chain from ChainNames
* **kwargs** (*dict-like*) – parameters as kwargs (several available keys : burst_id, ml_\*)
* **Raises**
**DiapOTBException** – If chain_name is not kwown as available chain
* **Returns**
instance of DiapOTBProcessing
* **Return type**
DiapOTBProcessing
#### find_class( = {'DIn_SAR': <class 'diapotb.lib.DInSAR.DInSAR'>, 'Ground': <class 'diapotb.lib.Ground.Ground'>, 'Post_Processing': <class 'diapotb.lib.PostProcessing.PostProcessing'>, 'Pre_Processing': <class 'diapotb.lib.PreProcessing.PreProcessing'>})
## diapotb.lib.Ground module
Ground chain
### class diapotb.lib.Ground.ExecutorGroundOthers(param_handler, file_handler)
Bases: `diapotb.lib.core.DiapOTBProcessing.ExecutorSingleImage`
Execute processing for ground chain mode S1SM-CSK
#### execute()
Ground chain for S1SM and CSK sensors
Two applications are called here : SARDEMProjection and SARCartesianMeanEstimation on the single input image
These applications have the self._image as input and put outputs in self._output_dir
### class diapotb.lib.Ground.ExecutorGroundS1IW(param_handler, file_handler)
Bases: `diapotb.lib.core.DiapOTBProcessing.ExecutorSingleImage`
Execute processing for ground chain mode S1SM-CSK
#### execute()
PreProcessing chain for S1SM and CSK sensors
Two applications are called here : SARDEMProjection and SARCartesianMeanEstimation on the single input image.
These applications have the self._image as input and put outputs in self._output_dir
#### execute_one_burst(deramp_in, output_dir, burst_id)
Execute ground chain for each burst
### class diapotb.lib.Ground.ExecutorGroundTSX(param_handler, file_handler)
Bases: `diapotb.lib.core.DiapOTBProcessing.ExecutorSingleImage`
Execute processing for ground chain mode TSX
#### execute()
Ground chain for TSX/PAZ sensors
Two applications are called here : SARDEMProjection and SARCartesianMeanEstimation on the single input image.
These applications have the self._image as input and put outputs in self._output_dir
### class diapotb.lib.Ground.Ground(\*\*kwargs)
Bases: `diapotb.lib.core.DiapOTBProcessing.DiapOTBProcessingSingleImage`
Use the module to launch Ground chain.
main function : execute
#### execute(\*\*kwargs)
Ground chain
Execute Ground processing following current mode (from ChainModes) thanks to an Executor.
Executor may be ExecutorGroundOthers, ExecutorGroundTSX or ExecutorGroundS1IW.
* **Parameters**
**kwargs** (*dict-like*) – parameters as kwargs (used to provide additionnal input to the selected executor)
#### retrieve_output(key)
Retrieve a given output of the Ground chain
### class diapotb.lib.Ground.GroundDefaultValue(value)
Bases: `diapotb.lib.core.DiapOTBEnums.DefaultEnum`
Define some default values or redirect to other values
The following paramaters are optional (other are mandatory)
#### CARTESIAN_ESTIMATION( = ('withcart', True))
#### NO_DATA( = ('nodata', -32768))
#### XYZ( = ('withxyz', True))
### class diapotb.lib.Ground.GroundFilenames(value)
Bases: `diapotb.lib.core.DiapOTBEnums.FilenamesEnum`
Define key for intermediate/output filenames for Ground chain
3 str to speficy, a key, the extension to add and the position of the extension in order to create the file
#### FILES_AFTER_CARTESAIN_ESTIMATION( = ('cart_files', 'cartMean_', 'prefix'))
#### FILES_AFTER_DEMPROJ( = ('dem_proj_files', 'demProj_', 'prefix'))
### class diapotb.lib.Ground.GroundInputKeysOthers(value)
Bases: `diapotb.lib.core.DiapOTBEnums.ExtendedEnum`
Define intput keys for Ground chain
#### DEM( = 'dem')
### class diapotb.lib.Ground.GroundInputKeysS1IW(value)
Bases: `diapotb.lib.core.DiapOTBEnums.ExtendedEnum`
Define intput keys for Ground chain
#### DEM( = 'dem')
#### DERAMP( = 'deramped_burst_list')
### class diapotb.lib.Ground.GroundInputKeysTSX(value)
Bases: `diapotb.lib.core.DiapOTBEnums.ExtendedEnum`
Define intput keys for Ground chain
#### DEM( = 'dem')
#### RESAMPLE_DERAMP( = 'resampled_list')
### class diapotb.lib.Ground.GroundOutputKeys(value)
Bases: `diapotb.lib.core.DiapOTBEnums.ExtendedEnum`
Define output keys for PreProcessing chain
#### CARTESIAN_ESTIMATION( = 'cart_list')
#### DEMPROJ( = 'dem_proj_list')
### class diapotb.lib.Ground.GroundParamOthers(value)
Bases: `diapotb.lib.core.DiapOTBEnums.ExtendedEnum`
Define each required parameters for Ground chain
#### CARTESIAN_ESTIMATION( = 'withcart')
#### NO_DATA( = 'nodata')
#### XYZ( = 'withxyz')
## diapotb.lib.PostProcessing module
Post Processing chain
### class diapotb.lib.PostProcessing.ExecutorPostProcessingOthers(param_handler, file_handler_reference, file_handler_secondary)
Bases: `diapotb.lib.core.DiapOTBProcessing.ExecutorDualImages`
Execute processing for PostProcessing chain mode S1SM-CSK and TSX
#### execute()
PostProcessing chain for S1SM, CSK and TSX sensors
Several applications are called here : SARTopographicPhase, SARCompensatedComplex, SARPhaseFiltering, SARAddBandInterferogram and OrthoRectification.
These applications have the self._image as input and put outputs in self._output_dir
### class diapotb.lib.PostProcessing.ExecutorPostProcessingS1IW(param_handler, file_handler_reference, file_handler_secondary)
Bases: `diapotb.lib.PostProcessing.ExecutorPostProcessingOthers`
Execute processing for PostProcessing chain mode S1IW
#### execute()
PostProcessing chain for S1IW sensors
Several applications are called here : SARPhaseFiltering, SARAddBandInterferogram and OrthoRectification.
### class diapotb.lib.PostProcessing.PostProcessing(\*\*kwargs)
Bases: `diapotb.lib.core.DiapOTBProcessing.DiapOTBProcessingDualImages`
Use the module to launch PostProcessing chain.
main function : execute
#### execute(\*\*kwargs)
PostProcessing chain
Execute post-processing following current mode (from ChainModes) thanks to an Executor.
Executor may be ExecutorPostProcessingOthers and ExecutorPostProcessingS1IW.
* **Parameters**
**kwargs** (*dict-like*) – parameters as kwargs (used to provide additionnal input to the selected executor)
#### property geoid_path()
#### retrieve_output(key)
Retrieve a given output of PostProcessing chain
### class diapotb.lib.PostProcessing.PostProcessingDefaultValue(value)
Bases: `diapotb.lib.core.DiapOTBEnums.DefaultEnum`
Define some default values or redirect to other values
The following paramaters are optional (other are mandatory)
#### ACTIVATE_FILTERING( = ('Activate_Filtering', 'yes'))
#### ACTIVATE_ORTHO( = ('Activate_Ortho', 'yes'))
#### FILT_ALPHA( = ('ml_filt_alpha', 0.7))
#### ML_FILT_AZI( = ('ml_filt_azi', 3))
#### ML_FILT_GAIN( = ('ml_filt_interf_gain', 'interf_gain'))
#### ML_FILT_RAN( = ('ml_filt_ran', 3))
#### SPACING_XY( = ('Spacingxy', 0.0001))
### class diapotb.lib.PostProcessing.PostProcessingFilenames(value)
Bases: `diapotb.lib.core.DiapOTBEnums.FilenamesEnum`
Define key for intermediate/output filenames for PostProcesssing chain
3 str to speficy, a key, the extension to add and the position of the extension in order to create the file
#### FILES_AFTER_FILTERING( = ('filtered_files', 'filtered_interferogram', 'exclusif'))
#### FILES_AFTER_ORTHO( = ('ortho_files', 'interferogram_ortho', 'exclusif'))
#### FILES_AFTER_PHASE_FILTERING( = ('phase_files', 'filfPhaCoh', 'exclusif'))
### class diapotb.lib.PostProcessing.PostProcessingInputKeysOthers(value)
Bases: `diapotb.lib.core.DiapOTBEnums.ExtendedEnum`
Define intput keys for PostProcessing chain
#### CARTESIAN_ESTIMATION_REFERENCE( = 'cart_list_reference')
#### COREGISTRATED_SECONDARY( = 'coregistrated_secondary')
#### DEM_PATH( = 'dem_path')
#### GRIDS( = 'grids_list')
#### INTERFERO( = 'interferogram')
### class diapotb.lib.PostProcessing.PostProcessingInputKeysS1IW(value)
Bases: `diapotb.lib.core.DiapOTBEnums.ExtendedEnum`
Define intput keys for PostProcessing chain
#### DEM_PATH( = 'dem_path')
#### INTERFERO( = 'interferogram')
### class diapotb.lib.PostProcessing.PostProcessingOutputKeys(value)
Bases: `diapotb.lib.core.DiapOTBEnums.ExtendedEnum`
Define output keys for PostProcessing chain
#### FILT_INTERFERO( = 'filtered_interferogram')
#### ORTHO_INTERFERO( = 'interferogram_ortho')
#### PHASE_INTERFERO( = 'filfPhaCoh')
### class diapotb.lib.PostProcessing.PostProcessingParamS1IW(value)
Bases: `diapotb.lib.core.DiapOTBEnums.ExtendedEnum`
Define each required parameters for PostProcessing chain
#### ACTIVATE_FILTERING( = 'Activate_Filtering')
#### ACTIVATE_ORTHO( = 'Activate_Ortho')
#### FILT_ALPHA( = 'ml_filt_alpha')
#### INTERF_GAIN( = 'interf_gain')
#### ML_FILT_AZI( = 'ml_filt_azi')
#### ML_FILT_GAIN( = 'ml_filt_interf_gain')
#### ML_FILT_RAN( = 'ml_filt_ran')
#### SPACING_XY( = 'Spacingxy')
## diapotb.lib.PreProcessing module
Pre-processing chain
### class diapotb.lib.PreProcessing.ExecutorPreProcessingOthers(param_handler, file_handler)
Bases: `diapotb.lib.core.DiapOTBProcessing.ExecutorSingleImage`
Execute processing for pre porcessing chain mode S1SM-CSK
#### execute()
PreProcessing chain for S1SM and CSK sensors
Two applications are called here : SARDoppler0 and SARMultiLook on the single input image.
These applications have the self._image as input and put outputs in self._output_dir
### class diapotb.lib.PreProcessing.ExecutorPreProcessingS1IW(param_handler, file_handler)
Bases: `diapotb.lib.core.DiapOTBProcessing.ExecutorSingleImage`
Execute processing for pre porcessing chain mode S1IW
#### execute()
PreProcessing chain for S1IW sensor
Four applications are called here : SARBurstExtraction, SARDeramp, SARDoppler0 and SARMultiLook
These applications processed each burst provided in param dictionary with burst_ids as key
NB : A particular case can be handle with a different burst_ids and burst_to_process.
The case rarely occurs and deals with a gap between reference/secondary burst match.
#### execute_one_burst(image, image_dir, output_dir, burst_id_in, burst_id_out)
### class diapotb.lib.PreProcessing.ExecutorPreProcessingTSX(param_handler, file_handler)
Bases: `diapotb.lib.core.DiapOTBProcessing.ExecutorSingleImage`
Execute processing for pre porcessing chain mode TSX
#### execute()
PreProcessing chain for TSX
Three applications are called here : SARDoppler0, SARMultiLook and SARDeramp on the single input image.
These applications have the self._image as input and put outputs in self._output_dir.
A resampling (from internal_processing package) may also be applied on image
### class diapotb.lib.PreProcessing.PreProcessing(\*\*kwargs)
Bases: `diapotb.lib.core.DiapOTBProcessing.DiapOTBProcessingSingleImage`
Use the module to launch Pre_Processing chain.
main function : execute
#### execute(\*\*kwargs)
PreProcessing chain
Execute pre-processing following current mode (from ChainModes) thanks to an Executor.
Executor may be ExecutorPreProcessingOthers,ExecutorPreProcessingTSX or ExecutorPreProcessingS1IW.
* **Parameters**
**kwargs** (*dict-like*) – parameters as kwargs (used to provide additionnal input to the selected executor)
#### retrieve_output(key)
Retrieve a given output of the PreProcessing chain
### class diapotb.lib.PreProcessing.PreProcessingFilenamesOthers(value)
Bases: `diapotb.lib.core.DiapOTBEnums.FilenamesEnum`
Define key for intermediate/output filenames for PreProcessing Others chain
3 str to speficy, a key, the extension to add and the position of the extension in order to create the file
#### ML( = ('ml_files', '_ml', 'sufix'))
### class diapotb.lib.PreProcessing.PreProcessingFilenamesS1IW(value)
Bases: `diapotb.lib.core.DiapOTBEnums.FilenamesEnum`
Define key for intermediate/output filenames for PreProcessing S1IW chain
3 str to speficy, a key, the extension to add and the position of the extension in order to create the file
#### BURSTEXTRACT( = ('burst_extract_files', '', 'sufix'))
#### DERAMP( = ('deramp_files', '_deramp', 'sufix'))
#### ML( = ('ml_files', '_ml', 'sufix'))
### class diapotb.lib.PreProcessing.PreProcessingFilenamesTSX(value)
Bases: `diapotb.lib.core.DiapOTBEnums.FilenamesEnum`
Define key for intermediate/output filenames for PreProcessing TSX chain
3 str to speficy, a key, the extension to add and the position of the extension in order to create the file
#### DERAMP( = ('deramp_files', '_deramp', 'sufix'))
#### ML( = ('ml_files', '_ml', 'sufix'))
#### RESAMPLED( = ('resampled_deramp_files', '', 'sufix'))
### class diapotb.lib.PreProcessing.PreProcessingOutputKeys(value)
Bases: `diapotb.lib.core.DiapOTBEnums.ExtendedEnum`
Define output keys for PreProcessing chain
#### BURSTS( = 'burst_list')
#### DERAMP( = 'deramped_burst_list')
#### DOP0( = 'doppler_0_list')
#### ML( = 'ml_list')
#### RESAMPLE( = 'resampled_list')
### class diapotb.lib.PreProcessing.PreProcessingParamDefaultValueTSX(value)
Bases: `diapotb.lib.core.DiapOTBEnums.DefaultEnum`
Define some default values or redirect to other values
The following paramaters are optional (other are mandatory)
#### ACTIVATE_DERAMP( = ('with_deramp', True))
### class diapotb.lib.PreProcessing.PreProcessingParamOthers(value)
Bases: `diapotb.lib.core.DiapOTBEnums.ExtendedEnum`
Define each required parameters for PreProcessing S1SM_CSK chain
#### DOPFILE( = 'doppler_file')
#### MLAZI( = 'ML_azi')
#### MLGAIN( = 'ML_gain')
#### MLRAN( = 'ML_ran')
## Module contents