R base functions for inspecting a time series of vertical profiles (vpts
)
object.
Select a vertical profile (vp
) or a time series of vertical profiles
(vpts
) by index from a vpts
.
Value
For summary.vpts()
: prints the summary of thevpts
object.
For print.vpts()
: prints the summary of the vpts
object.
For is.vpts()
: TRUE
for an object of class vpts
, otherwise
FALSE
.
For dim.vpts()
: number of datetimes, heights and quantities in a
time series of vertical profiles (vpts
).
For [.vpts
: A vpts
object containing a subset of vertical profiles (vp
) or a
vp
object when subsetting a single vertical profile (vp
).
Details
A time series of vertical profiles contains time-ordered vertical profiles
(vp)
of a single radar. This time series can be regular (vp
are
equally spaced in time) or irregular (time steps between vp
are of
unequal length), indicated in the field regular
. Irregular time series can
be projected onto a regular time grid with regularize_vpts()
. A time series
of vertical profile (vp
) object is a list containing:
radar
: Radar identifier.datetime
: Nominal times of the profiles (nameddates
in bioRad < 0.4.0) in UTC.height
: Lowest height of the height bins in the profiles in m above sea level.daterange
: Minimum and maximum nominal time of the profiles in UTC.timesteps
: Time differences between the profiles. Elementi
gives the difference between profilei
andi+1
.data
: A list of quantities, each containing adatetime
byheight
matrix with the values. Useget_quantity()
to access these and seesummary.vp()
for a description of available quantities.attributes
: List of the vertical profile'swhat
,where
, andhow
attributes, copied from the first profile.regular
: Logical indicating whether the time series is regular or not.
Conventions
NA
: Maps tonodata
in the ODIM convention: value to denote areas void of data (never radiated).NaN
: Maps toundetect
in the ODIM convention: denote areas below the measurement detection threshold (radiated but nothing detected). The value is also used when there are too few datapoints to calculate a quantity.0
: Maps to0
in the ODIM convention: denote areas where the quantity has a measured value of zero (radiated and value zero detected or inferred).
Examples
# Check if an object is of class vpts
is.vpts(example_vpts)
#> [1] TRUE
# Get summary info
example_vpts # Same as summary(example_vpts) or print(example_vpts)
#> Irregular time series of vertical profiles (class vpts)
#>
#> radar: KBGM
#> # profiles: 1934
#> time range (UTC): 2016-09-01 00:02:00 - 2016-09-10 11:56:00
#> time step (s): min: 180 max: 16320
# Get dimensions
dim(example_vpts)
#> [1] 1934 25 15
# The example vpts contains 1934 profiles (i.e. datetimes)
dim(example_vpts)
#> [1] 1934 25 15
# Subset vpts to extract 10th profile
example_vpts[10] # A vp object
#> Vertical profile (class vp)
#>
#> radar: KBGM
#> source:
#> nominal time: 2016-09-01 00:38:00
#> generated by:
# Subset vpts to extract the 20th to 100th profile
example_vpts[20:100] # A vpts object with 81 profiles
#> Irregular time series of vertical profiles (class vpts)
#>
#> radar: KBGM
#> # profiles: 81
#> time range (UTC): 2016-09-01 01:18:00 - 2016-09-01 07:36:00
#> time step (s): min: 240 max: 420
# Subset vpts to remove the first 10 profiles
example_vpts[-1:-10] # A vpts object with 10 less profiles
#> Irregular time series of vertical profiles (class vpts)
#>
#> radar: KBGM
#> # profiles: 1924
#> time range (UTC): 2016-09-01 00:42:00 - 2016-09-10 11:56:00
#> time step (s): min: 180 max: 16320