5. API Reference

Warning

This chapter it generated from Python source code and not yet very useful. Also, the API described here is not yet stable.

5.1. Input / Output

5.2. Configuration

Processor configuration management.

class dedop.conf.CharacterisationFile(cst: dedop.conf.constants.ConstantsFile, filename: str = None, **kwargs)

class for loading the Characterisation File

antenna_angles

array of antenna angles

antenna_angles_spacing

spacing between antenna angles

antenna_gain_ku

antenna gain for ku-band

antenna_weights

array of antenna weights

brf_sar

burst repetition frequency

bw_ku

Ku-band bandwidth

chirp_slope_ku

the chirp slope for the Ku-band (derived parameter)

freq_ku

emitted frequency in Ku-band

mean_sat_alt

mean altitude of the satellite

n_ku_pulses_burst

number of ku-band pulses per burst

n_samples_sar

number of samples per each SAR pulse

power_tx_ant_ku

antenna SSPA RF peak transmitted power in Ku band

prf_sar

pulse repetition frequency

pulse_length

pulse length

uso_freq_nom

USO frequency nominal value

wv_length_ku

the Ku-band wavelength (derived parameter)

class dedop.conf.ConstantsFile(filename: str = None, **kwargs)

class for loading the Constants file

c

speed of light

earth_radius

radius of the earth

flat_coeff

flattening coefficient of the WGS84 ellipsoid

pi

Pi number

sec_in_day

number of seconds in a day

semi_major_axis

semi-major axis of WGS84 ellipsoid

semi_minor_axis

semi-minor axis of WGS84 ellipsoid

class dedop.conf.ConfigurationFile(filename: str = None, **kwargs)

class for loading the Configuration File

class dedop.conf.AuxiliaryFileReader(filename: str = None, **kwargs)

class for reading auxiliary files

class dedop.conf.AuxiliaryParameter(parameter_name: str, doc_string: str = None, param_type: type = None, cast_type=None, optional: bool = False, default_value=None)

this is a variable descriptor class. It exists to link internal auxiliary parameter names with those used in the JSON documents.

This also enables the code in the AuxiliaryFileReader base class to distinguish easily which members of the child classes that define parameters - this allows us to e.g: throw a warning if an input file defines an unexpected parameter

5.3. Model

5.4. Processor

5.5. Web Socket Service

5.6. Utilities

Common utilities used throughout the DeDop project.

class dedop.util.Parameter(name, default_value=None, data_type=None, description=None, value_set=None, units=None, position=0)

The Parameter class is used to describe, validate, and convert parameter values.

data_type

The parameter’s data type. Must be an instance of the type class.

default_value = None

The parameter’s default value. Default value is None.

description = None

The parameter’s description. Default value is None.

static get_parameters(clazz)

Get a dictionary that maps names to Parameter descriptors or nested Parameter dictionaries. The dictionary is collected from the given clazz’ hierarchy. Per-class parameter descriptor dictionaries are retrieved by looking up the class attribute ‘parameters’ which must be a dictionary if it exists. :param clazz: A class :return: A dictionary of possibly nested Parameter instances

is_bound_to_value_set = None

True, if the parameter value must be one of the value_set values. Default value is False.

name

The parameter’s name.

position = None

The parameter’s position which can be used for sorting if it is a positional value. Default value is 0.

units = None

The parameter value’s physical units. Default value is None.

value_set = None

The parameter’s value set. Default value is None.