PreProcessingPipeline

class glotaran.io.preprocessor.pipeline.PreProcessingPipeline(*, actions: list[typing.Annotated[glotaran.io.preprocessor.preprocessor.CorrectBaselineValue | glotaran.io.preprocessor.preprocessor.CorrectBaselineAverage, FieldInfo(default=PydanticUndefined, discriminator='action', extra={})]] = None)[source]

Bases: BaseModel

A pipeline for pre-processors.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Attributes Summary

actions

Methods Summary

`apply`	Apply all pre-processors on data.
`construct`	Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.
`copy`	Duplicate a model, optionally choose which fields to include, exclude and change.
`correct_baseline_average`	Correct a dataset by subtracting the average over a part of the data.
`correct_baseline_value`	Correct a dataset by subtracting baseline value.
`dict`	Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
`from_orm`
`json`	Generate a JSON representation of the model, include and exclude arguments as per dict().
`parse_file`
`parse_obj`
`parse_raw`
`schema`
`schema_json`
`update_forward_refs`	Try to update ForwardRefs on fields based on this Model, globalns and localns.
`validate`

Methods Documentation

Config: alias of BaseConfig

actions: list[glotaran.io.preprocessor.preprocessor.CorrectBaselineValue | glotaran.io.preprocessor.preprocessor.CorrectBaselineAverage]

apply(original: DataArray) → DataArray[source]

Apply all pre-processors on data.

Parameters:: original (xr.DataArray) – The data to process.
Return type:: xr.DataArray

classmethod construct(_fields_set: SetStr | None = None, **values: Any) → Model: Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters:

include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model

Returns:

new model instance

Correct a dataset by subtracting the average over a part of the data.

Parameters:

select (dict[str, slice | list[int] | int] | None) – The selection to average as dictionary of dimension and indexer. The indexer can be a slice, a list or an integer value.
exclude (dict[str, slice | list[int] | int] | None) – Excluded regions from the average as dictionary of dimension and indexer. The indexer can be a slice, a list or an integer value.

Return type:

PreProcessingPipeline

correct_baseline_value(value: float) → PreProcessingPipeline[source]

Correct a dataset by subtracting baseline value.

Parameters:: value (float) – The value to subtract.
Return type:: PreProcessingPipeline

dict(*, include: AbstractSetIntStr | MappingIntStrAny | None = None, exclude: AbstractSetIntStr | MappingIntStrAny | None = None, by_alias: bool = False, skip_defaults: bool | None = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny: Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

classmethod from_orm(obj: Any) → Model

json(*, include: AbstractSetIntStr | MappingIntStrAny | None = None, exclude: AbstractSetIntStr | MappingIntStrAny | None = None, by_alias: bool = False, skip_defaults: bool | None = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Callable[[Any], Any] | None = None, models_as_dict: bool = True, **dumps_kwargs: Any) → unicode

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

classmethod parse_file(path: str | Path, *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model

classmethod parse_obj(obj: Any) → Model

classmethod parse_raw(b: str | bytes, *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model

classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny

classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) → unicode

classmethod update_forward_refs(**localns: Any) → None: Try to update ForwardRefs on fields based on this Model, globalns and localns.

classmethod validate(value: Any) → Model