R base functions for inspecting a time series of vertical profiles (vp
)
object.
# S3 method for vpts summary(object, ...) is.vpts(x) # S3 method for vpts dim(x)
object | A |
---|---|
... | Additional arguments affecting the summary produced. |
x | A |
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
).
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 (named dates
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. Element i
gives the
difference between profile i
and i+1
.
data
: A list of quantities, each containing a datetime
by height
matrix with the values. Use get_quantity()
to access these and see
summary.vp()
for a description of available quantities.
attributes
: List of the vertical profile's what
, where
, and how
attributes,
copied from the first profile.
regular
: Logical indicating whether the time series is regular or not.
# Load the example time series of vertical profiles vpts <- example_vpts # Verify that it is an object of class vpts is.vpts(vpts)#> [1] TRUE# Get summary info vpts # Same as summary(vpts) or print(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#> [1] 1934 25 15