• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    Developer toolchainFoundryTSAPI Referencefunctions.unit_conversion

    foundryts.functions.unit_conversion

    foundryts.functions.unit_conversion(from_unit, to_unit)

    Returns a function that converts all values in a single time series from the specified unit value to the specified unit.

    The unit passed can either be a value from Unit or a valid Alias from the list of available units and conversions below:

    Length

    UnitAliasNames
    mmeterMeter
    cmcentimeterCentimeter
    mmmillimeterMillimeter
    μmmicron, micrometerMicrometer
    nmnanometerNanometer
    angstromAngstrom
    kmkilometerKilometer
    ininchInch
    ftfootFoot
    ydyardYard
    mimileMile

    Temperature Units

    UnitAliasNames
    °CCelsiusCelsius
    KkelvinKelvin
    °FFahrenheitFahrenheit
    °R°Ra, rankineRankine

    Pressure Units

    UnitAliasNames
    Pan/m2, pascalPascal
    hPahectopascalHectopascal
    kPakPaa, kilopascalKilopascal
    kPagKilopascal
    gauge
    atmAtmosphere
    barbaraBar
    bargBar gauge
    fth2oFoot of
    Water Column
    inh2oInches of
    water
    inhgInch of
    Mercury
    TorrmmhgTorr (mmhg)
    mTorrMillitorr
    psipsiaPound-force
    per square
    inch
    psigPound-force
    per square
    inch gauge

    Time Units

    UnitAliasNames
    ssecondSecond
    msmillisecondMillisecond
    μsmicrosecondMicrosecond
    nsnanosecondNanosecond
    minminuteMinute
    hrhourHour

    Mass Units

    UnitAliasNames
    kgkilogramKilogram
    ggramGram
    lbpoundPound

    Contact your service administrator to access and extend the list of units and conversions for your deployment.

    • Parameters:
      • from_unit (str) – Original unit to convert values from.
      • to_unit (str) – Desired unit to convert values to.
    • Returns: A function that accepts a single time series as input and returns the time series with values converted to the specified unit.
    • Return type: (FunctionNode) -> FunctionNode

    Dataframe schema

    Column nameTypeDescription
    timestamppandas.TimestampTimestamp of the point
    valuefloatValue of the point
    Note

    This function is only applicable to numeric series.

    Examples

    Copied!
    1>>> series = F.points(
2...     (1, 8.0),
3...     (101, 4.0),
4...     (200, 2.0),
5...     (201, 1.0),
6...     (299, 35.0),
7...     (300, 16.0),
8...     (1000, 64.0),
9...     name="series",
10... )
11>>> series.to_pandas()
12                      timestamp  value
130 1970-01-01 00:00:00.000000001    8.0
141 1970-01-01 00:00:00.000000101    4.0
152 1970-01-01 00:00:00.000000200    2.0
163 1970-01-01 00:00:00.000000201    1.0
174 1970-01-01 00:00:00.000000299   35.0
185 1970-01-01 00:00:00.000000300   16.0
196 1970-01-01 00:00:00.000001000   64.0
    Copied!
    1>>> unit_converted = F.unit_conversion("m", "mm")(series)
2>>> unit_converted.to_pandas()
3                      timestamp    value
40 1970-01-01 00:00:00.000000001   8000.0
51 1970-01-01 00:00:00.000000101   4000.0
62 1970-01-01 00:00:00.000000200   2000.0
73 1970-01-01 00:00:00.000000201   1000.0
84 1970-01-01 00:00:00.000000299  35000.0
95 1970-01-01 00:00:00.000000300  16000.0
106 1970-01-01 00:00:00.000001000  64000.0