Module: sarpyx.processor.core.meta

File: sarpyx/processor/core/meta.py

No module docstring available; module purpose is inferred from implementation.

Exported Symbols (__all__)

No explicit __all__ list. Public symbols inferred from implementation.

Public Functions (0)

No public top-level functions detected.

Public Classes (1)

Handler class

" Handler class for processing metadata from a zip file containing product information. Attributes: filepath (str): Path to the zip file containing the product data. PRF (float): Pulse repetition frequency extracted from the metadata. AzimBand (float): Total azimuth bandwidth extracted from the metadata. RangeBand (float): Total range bandwidth extracted from the metadata. ChirpBand (float): Chirp bandwidth calculated from pulse length and ramp rate. AzimRes (int): Azimuth resolution (default is 5). RangeRes (int): Range resolution (default is 20). RangeSpacing (float): Range pixel spacing extracted from the metadata. AzimSpacing (float): Azimuth pixel spacing extracted from the metadata. WeightFunctRangeParams (float): Range window coefficient for weighting function. WeightFunctRange (str): Type of weighting function used for range processing (default is 'HAMMING'). WeightFunctAzimParams (float): Azimuth window coefficient for weighting function. WeightFunctAzim (str): Type of weighting function used for azimuth processing (default is 'HAMMING'). CentralFreqRange (int): Central frequency for range processing (default is 0). CentralFreqAzim (int): Central frequency for azimuth processing (default is 0). Methods: __init__(filepath): Initializes the Handler object with the path to the zip file. Chain(): Processes the metadata from the zip file, extracting relevant parameters such as PRF, bandwidths, resolutions, and spacing. The method reads the XML annotation file within the zip archive and parses the required data.

File location: sarpyx/processor/core/meta.py:5

Class Signature

class Handler

Constructor Parameters

Return Type

Handler instances.

Exceptions

Construction/runtime exceptions are inferred from implementation and method-level documentation.

Side Effects

See method-level side effects below.

Example Usage

from sarpyx.processor.core.meta import Handler

obj = Handler(...)  # inferred from implementation

Edge Cases

No class-level edge-case section is explicitly documented; rely on method-level checks and raised exceptions.

Public Methods (1)

Handler.chain method

Main method to process metadata from the .SAFE directory.

File location: sarpyx/processor/core/meta.py:47

Signature

chain(self)

Parameters

ParameterTypeRequiredDefaultDescription
--no-No explicit public parameters; behavior inferred from implementation.

Return Type

inferred from implementation

inferred from implementation.

Exceptions

  • RuntimeError

Side Effects

  • inferred from implementation

Example Usage

from sarpyx.processor.core.meta import Handler

# Constructor arguments are inferred from implementation.
obj = Handler(...)  # inferred from implementation
result = obj.chain()

Edge Cases

May raise: RuntimeError.