Obstype

Parent class defenition for observation types.

Constructor for Obstype

Obstype(obsname, std_unit[, description, ...])

Object with all info and methods for a specific observation type.

General methods and attributes for Obstype

Obstype.set_description(desc)	Set the description of the observation type.
Obstype.set_original_name(columnname)	Set the original name of the observation type.
Obstype.set_original_unit(original_unit)	Set the original unit of the observation type.
Obstype.add_unit(unit_name[, conversion])	Add a new unit to an observation type.
Obstype.get_orig_name()	Return the original name of the observation type.
Obstype.get_description()	Return the descrition of the observation type.
Obstype.get_all_units()	Return a list with all the known unit (in standard naming).
Obstype.get_standard_unit()	Return the standard unit of the observation type.
Obstype.get_info()	Print out detailed information of the observation type.

Developers methods and attributes for Obstype

Obstype.get_plot_y_label([mapname])	Return a string to represent the vertical axes of a plot.
Obstype.convert_to_standard_units(...)	Convert data from a knonw unit to the standard unit.
Obstype.test_if_unit_is_known(unit_name)	Test is the unit is known.

ModelObstype

A child of Obstype that adds info on how this observationtype is represented in modeloutput. All methods of Obstype() are inhereted.

Constructor for ModelObstype

ModelObstype(obstype[, model_equivalent_dict])

Extension of the Obstype class specific for the obstypes of Modeldata.

General methods and attributes for ModelObstype

ModelObstype.get_mapped_datasets()	Return all gee datasets with a representing band for this obstype.
ModelObstype.get_bandname(mapname)	Return the representing bandname of the obstype from a given gee dataset.
ModelObstype.get_modelunit(mapname)	Return the units of the representing bandname of the obstype from a given gee dataset.
ModelObstype.add_new_band(mapname, bandname, ...)	Add a new representing dataset/bandname to the obstype.

Developers methods and attributes for ModelObstype

ModelObstype.get_bandname_mapper(mapname)	Return the representing bandname with tlk standard name as a dict.
ModelObstype.has_mapped_band(mapname)	Test is a gee dataset has a representing band.

ModelObstype_Vectorfield

A child of Obstype, similar to ModelObstype, that adds info on how this handle 2D vectorfields in the modeloutput. A vectorfield in the modeloutput is defined by its components.

All methods of Obstype() are inhereted.

Constructor for ModelObstype_Vectorfield

ModelObstype_Vectorfield(obstype[, ...])

General methods and attributes for ModelObstype_Vectorfield

ModelObstype_Vectorfield.get_mapped_datasets()	Return all gee datasets with a representing band for this obstype.
ModelObstype_Vectorfield.get_modelunit(mapname)	Return the units of the representing bandname of the obstype from a given gee dataset.
ModelObstype_Vectorfield.add_new_band(...[, ...])	Add a new representing dataset/bandname to the obstype.

Developers methods and attributes

ModelObstype_Vectorfield.get_bandname_mapper(mapname)	Return the representing bandname with tlk standard name as a dict.
ModelObstype_Vectorfield.has_mapped_band(mapname)	Test is a gee dataset has a representing band.

Developers vectorfield conversion functions

These functions are used by the ModelObstype_Vectorfield to convert components to amplitudes and angles.

obstype_modeldata.compute_amplitude(...)	Compute amplitude of 2D vectorfield components.
obstype_modeldata.compute_angle(...)	Compute vector direction of 2D vectorfield components.