4.1.1.3. pamtra2.instruments

4.1.1.3.1. Submodules

4.1.1.3.2. Package Contents

4.1.1.3.2.1. Classes

instrument

Base instrument simulator class

microwaveInstrument

Base instrument simulator class
class instrument(parent=None, frequencies='all', name='instrument', **settings)[source]

Bases: object

Base instrument simulator class

This is the base class for all instrument simulators providing the most important data structures.

Parameters

  • parent ({pamtra2 class}) – Calling parent object

  • frequencies ({list} or {'all'}, optional) – Use this instrument for the frequencies indicated in the list or ‘all’ frequencies (the default is ‘all’, which means all frequencies)

  • **settings ({dict}) – Additional settings for the instrument

frequencies

List of used frequencies

Type

{list}

settings

Instrument specific settings

Type

{dict}

parent

Calling parent object

Type

{pamtra2 class}

profile

Calling parent’s profile

Type

{xr.Dataset}

hydrometeorProfiles

Calling parent’s hydrometeor profiles

Type

{pamtra2.helpers.AttrDict}

results

Instrument simulator results

Type

{xr.Dataset}

to_netcdf(self, fname, resultVariables='all', profileVariables=['height'], **kwargs)

Store result as netcdf file

Parameters

  • fname (str) – filename

  • resultVariables ('all' or list of str, optional) – variales to store in result (default ‘all’)

  • profileVariables ('all' or list of str, optional) – profile variables to include in file (default [‘height’])

  • **kwargs (kwargs to pass to xarray's to_netcdf function.) –

class microwaveInstrument(parent=None, frequencies='all', gaseousAttenuationModel='Rosenkranz98', **settings)[source]

Bases: instrument

Base instrument simulator class

This is the base class for all instrument simulators providing the most important data structures.

Parameters

  • parent ({pamtra2 class}) – Calling parent object

  • frequencies ({list} or {'all'}, optional) – Use this instrument for the frequencies indicated in the list or ‘all’ frequencies (the default is ‘all’, which means all frequencies)

  • **settings ({dict}) – Additional settings for the instrument

frequencies

List of used frequencies

Type

{list}

settings

Instrument specific settings

Type

{dict}

parent

Calling parent object

Type

{pamtra2 class}

profile

Calling parent’s profile

Type

{xr.Dataset}

hydrometeorProfiles

Calling parent’s hydrometeor profiles

Type

{pamtra2.helpers.AttrDict}

results

Instrument simulator results

Type

{xr.Dataset}

_calcHydrometeorAbsorption(self)

Calculate hydrometeor absorption

Returns

absorption coefficient

Return type

xr.DataArray

_calcGaseousAbsorption(self)

Calculate gaseous absorption

Returns

absorption coefficient

Return type

xr.DataArray