helikite.classes.output_schemas =============================== .. py:module:: helikite.classes.output_schemas Attributes ---------- .. autoapisummary:: helikite.classes.output_schemas.flag_pollution_cpc helikite.classes.output_schemas.flag_hovering helikite.classes.output_schemas.flag_cloud_mcda helikite.classes.output_schemas.shade_pollution_cpc helikite.classes.output_schemas.shade_pollution_cpc_ground helikite.classes.output_schemas.shade_hovering helikite.classes.output_schemas.shade_cloud_mcda helikite.classes.output_schemas.shade_filter Classes ------- .. autoapisummary:: helikite.classes.output_schemas.Level helikite.classes.output_schemas.Flag helikite.classes.output_schemas.FlightProfileVariable helikite.classes.output_schemas.FlightProfileVariableShade helikite.classes.output_schemas.OutputSchema helikite.classes.output_schemas.OutputSchemas Functions --------- .. autoapisummary:: helikite.classes.output_schemas._build_colors_defaultdict helikite.classes.output_schemas.filter_shade_condition Module Contents --------------- .. py:function:: _build_colors_defaultdict() .. py:class:: Level(*args, **kwds) Bases: :py:obj:`enum.Enum` Processing level identifiers. .. py:attribute:: LEVEL0 :value: 0 .. py:attribute:: LEVEL1 :value: 1 .. py:attribute:: LEVEL1_5 :value: 1.5 .. py:attribute:: LEVEL2 :value: 2 .. py:class:: Flag Definition of a processing flag. A flag describes a condition derived from instrument data that marks specific flight or environmental states. .. py:attribute:: flag_name :type: str Name of the flag column in output data. .. py:attribute:: column_name :type: str Source column used to compute the flag. .. py:attribute:: params :type: helikite.processing.post.fda.FDAParameters FDA parameters controlling flag detection. .. py:attribute:: y_scale :type: str :value: 'log' Plotting scale hint for visualization. .. py:method:: __str__() .. py:class:: FlightProfileVariable Configuration for plotting a flight profile variable. Defines how a variable is displayed in vertical flight profile plots. .. py:attribute:: column_name :type: str Name of the data column to plot. .. py:attribute:: shade_flags :type: list[str] :value: [] Flags for which background shading should be applied. .. py:attribute:: plot_kwargs :type: dict Matplotlib plotting arguments. .. py:attribute:: alpha_ascent :type: float :value: 1.0 Opacity for ascent segment. .. py:attribute:: alpha_descent :type: float :value: 0.5 Opacity for descent segment. .. py:attribute:: x_min :type: numbers.Number | None :value: None Lower x-axis bound. .. py:attribute:: x_max :type: numbers.Number | None :value: None Upper x-axis bound. .. py:attribute:: x_divider :type: numbers.Number | None :value: None Tick spacing hint. .. py:attribute:: x_label :type: str | None :value: None Axis label override. .. py:class:: FlightProfileVariableShade Configuration for shaded regions in flight profile and size distribution plots. .. py:attribute:: name :type: str Source column used to compute shaded regions. .. py:attribute:: condition :type: Callable[[Level, pandas.Series], pandas.Series] Predicate function that receives a column value and returns True if the corresponding row should be shaded, False otherwise. .. py:attribute:: label :type: str Legend label. .. py:attribute:: span_kwargs :type: dict Matplotlib plotting arguments for shaded spans. .. py:attribute:: line_name :type: str | None :value: None Optional column name for overlay line to plot in size distribution plot together with the shaded regions. .. py:attribute:: line_kwargs :type: dict | None :value: None Matplotlib plotting arguments for overlay line .. py:data:: flag_pollution_cpc .. py:data:: flag_hovering .. py:data:: flag_cloud_mcda .. py:data:: shade_pollution_cpc .. py:data:: shade_pollution_cpc_ground .. py:data:: shade_hovering .. py:data:: shade_cloud_mcda .. py:function:: filter_shade_condition(level: Level, values: pandas.Series) -> pandas.Series .. py:data:: shade_filter .. py:class:: OutputSchema Campaign-specific output configuration. Defines instruments, plotting styles, and metadata expectations for a campaign. .. py:attribute:: campaign :type: str | None Campaign name .. py:attribute:: instruments :type: list[helikite.instruments.Instrument] List of instruments whose columns should be present in the output dataframe. .. py:attribute:: colors :type: dict[helikite.instruments.Instrument | str, str] [Instrument|column]-to-color dictionary for the consistent across a campaign plotting. .. py:attribute:: reference_instrument_candidates :type: list[helikite.instruments.Instrument] Reference instrument candidates for the automatic instruments detection .. py:attribute:: flight_profile_variables :type: list[FlightProfileVariable] :value: [] List of flight profile variables to plot. .. py:attribute:: flight_profile_shades :type: list[FlightProfileVariableShade] .. py:attribute:: flags :type: list[Flag] List of flags which should be present in the output dataframe. .. py:class:: OutputSchemas Registry and factory for predefined output schemas. Provides access to campaign configurations and allows runtime registration of custom schemas. .. py:attribute:: _REGISTRY :type: dict[str, OutputSchema] .. py:attribute:: ORACLES_24_25 .. py:attribute:: ORACLES_25_26 .. py:attribute:: TURTMANN .. py:attribute:: ALL .. py:method:: from_name(name: str) -> OutputSchema :classmethod: Retrieve a schema by name. :param name: Schema identifier (case-insensitive). :returns: OutputSchema instance. :raises KeyError: If schema is not registered. .. py:method:: _register_builtin() :classmethod: .. py:method:: register(name: str, schema: OutputSchema, *, overwrite: bool = False) :classmethod: Register a custom output schema. :param name: Schema identifier. :param schema: Schema instance. :param overwrite: Whether to replace an existing schema in case of conflict. :raises ValueError: If schema exists and overwrite is False. .. py:method:: keys() :classmethod: List registered schema names. :returns: Iterable of schema identifiers.