Process data to the observation vector (toobsvect / std)

Yaml arguments

The following arguments are used to configure the plugin. pyCIF will return an exception at the initialization if mandatory arguments are not specified, or if any argument does not fit accepted values or type:

Optional arguments

parameter: (optional)

Parameter name on which the transform works on

accepted type: str

component: (optional)

Component name on which the transform works on

accepted type: str

orig_parameter_plg: (optional)

Plugin object on which the transform works on

accepted type: Plugin

orig_component_plg: (optional)

Corresponding component object on which the transform works on

accepted type: Plugin

successor: (optional)

Name of the successor transform

accepted type: str

precursor: (optional)

Name of the precursor transform

accepted type: str

split_freq: (optional)

Frequency at which to split the processing of observations. The expected frequency should follow Pandas syntax

accepted type: str

Requirements

The current plugin requires the present plugins to run properly:

Requirement name	Requirement type	Explicit definition	Any valid	Default name	Default version
obsvect	ObsVect	True	True	standard	std
controlvect	ControlVect	True	True	standard	std

Yaml template

Please find below a template for a Yaml configuration:

transform:
  plugin:
    name: toobsvect
    version: std
    type: transform

  # Optional arguments
  parameter: XXXXX  # str
  component: XXXXX  # str
  orig_parameter_plg: XXXXX  # Plugin
  orig_component_plg: XXXXX  # Plugin
  successor: XXXXX  # str
  precursor: XXXXX  # str
  split_freq: XXXXX  # str