emc2.core.Instrument

class emc2.core.Instrument(frequency=None, wavelength=None)[source]

This is the base class which holds the information needed to contain the instrument parameters for the simulator.

Attributes:
instrument_str: str

The name of the instrument.

instrument_class: str

The class of the instrument. Currently must be one of ‘radar,’ or ‘lidar’.

freq: float

The frequency of the instrument.

wavelength: float

The wavelength of the instrument

beta_p_phase_thresh: list of dicts or None

If a list, each index contains a dictionaly with class name, class integer value (mask order), LDR value bounds, and the corresponding beta_p threshold (thresholds are linearly interpolated between LDR values). In order for the method to operate properly, the list should be arranged from the lowest to highest beta_p threshold values for a given LDR, that is, beta_p[i+1 | LDR=x] >= beta_p[i | LDR=x].

ext_OD: float

The optical depth where we have full extinction of the lidar signal.

OD_from_sfc: Bool

If True (default), optical depth will be calculated from the surface. If False, optical depth will be calculated from the top of the atmosphere.

eta: float

Multiple scattering coefficient.

K_w: float

The index of refraction of water used for Ze calculation. See the ARM KAZR handbook (Widener et al. 2012)

eps_liq: float

The complex dielectric constant for liquid water.

pt: float

Transmitting power in Watts.

theta: float

3 dB beam width in degrees

gain: float

The antenna gain in linear units.

Z_min_1km: float

The minimum detectable signal at 1 km in dBZ

lr: float

Attenuation based on the the general attributes in the spectra files.

pr_noise_ge: float

Minimum detectable signal in mW.

tau_ge: float

Pulse width in mus.

tau_md: float

Pulse width in mus.

__init__(frequency=None, wavelength=None)[source]

Methods

__init__([frequency, wavelength])

read_arm_netcdf_file(filename, **kwargs)

Loads a netCDF file that corresponds to ARM standards.