Skip to content

vap_retriever_config

Classes:

Name Description
VapRetrieverConfig

Classes#

VapRetrieverConfig #

Bases: RetrieverConfig

Classes:

Name Description
Parameters

Attributes:

Name Type Description
parameters Optional[Parameters]

Attributes#

parameters class-attribute instance-attribute #
parameters: Optional[Parameters] = None

Classes#

Parameters #

Bases: BaseModel

Classes:

Name Description
FetchParameters
TransformationParameters

Attributes:

Name Type Description
fetch_parameters Optional[FetchParameters]
transformation_parameters Optional[TransformationParameters]
Attributes#
fetch_parameters class-attribute instance-attribute # 
fetch_parameters: Optional[FetchParameters] = None
transformation_parameters class-attribute instance-attribute # 
transformation_parameters: Optional[
    TransformationParameters
] = Field(
    default=None,
    description="Transformation parameters. See https://tsdat.readthedocs.io/en/stable/tutorials/vap_pipelines/#configuration-files-vap_gps for more information.",
)
Classes#
FetchParameters #

Bases: BaseModel

Attributes:

Name Type Description
time_padding str
Attributes#
time_padding class-attribute instance-attribute # 
time_padding: str = Field(
    regex="^[\\+|\\-]?[0-9]+[h|m|s|ms]$",
    description="The time_padding parameter in the fetch_parameters section specifies how far in time to look for data before the 'begin' timestamp (e.g., -24h), after the 'end' timestamp (e.g., +24h), or both (e.g., 24h).  Units of hours ('h'), minutes ('m'), seconds ('s', default), and milliseconds ('ms') are allowed.",
)
TransformationParameters #

Bases: BaseModel

Attributes:

Name Type Description
alignment dict[str, Literal['LEFT', 'RIGHT', 'CENTER']]
dim_range dict[str, str]
width dict[str, str]
Attributes#
alignment class-attribute instance-attribute # 
alignment: dict[str, Literal["LEFT", "RIGHT", "CENTER"]] = (
    Field(
        description="Defines the location of the window in respect to each output timestamp (LEFT, RIGHT, or CENTER)"
    )
)
dim_range class-attribute instance-attribute # 
dim_range: dict[str, str] = Field(
    ...,
    alias="range",
    regex="^[0-9]+[a-zA-Z]+$",
    description="Defines how far (in seconds) from the first/last timestamp to search for the previous/next measurement.",
)
width class-attribute instance-attribute # 
width: dict[str, str] = Field(
    ...,
    regex="^[0-9]+[a-zA-Z]+$",
    description='Defines the size of the averaging window in seconds ("600s" = 10 min).',
)