PythonAPI/diapotb.lib.internal_processing.md

+# diapotb.lib.internal_processing package
+
+## Subpackages
+
+
+* diapotb.lib.internal_processing.core package
+
+
+## Submodules
+
+## diapotb.lib.internal_processing.filtering module
+
+
+### diapotb.lib.internal_processing.filtering.create_output_geom(geom_content_in, output_file)
+Write on disk the output geom file (same as input)
+
+
+### diapotb.lib.internal_processing.filtering.filtering_on_dimension(input_file, output_file, secondary, dimension=Dimension.AZIMUT)
+Call filtering for the given Dimension
+
+
+### diapotb.lib.internal_processing.filtering.main_filtering(reference_path, secondary_path, output_dir, tmp_dir='')
+Main function to apply filtering on azimut dimension for reference only (deramp image)
+
+
+* **Parameters**
+
+    
+    * **reference_path** (*str*) – path to reference image
+
+
+    * **secondary_path** (*str*) – path to secondary image
+
+
+    * **output_dir** (*str*) – output directory
+
+
+    * **tmp_dir** (*str*) – tmp directory (empty, by default)
+
+
+
+* **Returns**
+
+    path to output file (filtered file)
+
+
+
+* **Return type**
+
+    str
+
+
+## diapotb.lib.internal_processing.resampling module
+
+
+### diapotb.lib.internal_processing.resampling.main_resampling(input_file, output_file, kwl_ref, kwl_sec, dop0, output_dir, tmp_dir='')
+Main function to apply resampling on two dimensions, if needed
+(if line_interval or Freq_sampling are different)
+
+
+* **Parameters**
+
+    
+    * **input_file** (*str*) – path to input image
+
+
+    * **output_file** (*str*) – path to output image
+
+
+    * **kwl_ref** (*dict*) – reference metadata as dictionary
+
+
+    * **kwl_sec** (*float*) – secondary metadata as dictionary
+
+
+    * **dop0** – doppler 0 (for azimut dimension, 0 otherwise)
+
+
+    * **output_dir** (*str*) – output directory
+
+
+    * **tmp_dir** (*str*) – tmp directory (empty, by default)
+
+
+
+* **Returns**
+
+    path to output file (resampled file)
+
+
+
+* **Return type**
+
+    str
+
+
+
+### diapotb.lib.internal_processing.resampling.resampling_on_dimension(input_file, output_file, kwl_ref, kwl_sec, f0, dimension=Dimension.AZIMUT)
+Call resampling for the given Dimension
+
+
+### diapotb.lib.internal_processing.resampling.retrieve_frequencies(kwl_ref, kwl_sec, dimension=Dimension.AZIMUT)
+Retrieve f_in and f_out from geom file(s)
+
+
+### diapotb.lib.internal_processing.resampling.update_and_create_output_geom(geom_content_in, output_file, resampler, dimension=Dimension.AZIMUT)
+Update some values and write on disk the output geom file
+
+## Module contents