Class scan
for a scan of a polar volume, and its associated R base functions.
# S3 method for scan summary(object, ...) is.scan(x) # S3 method for scan dim(x)
object | Object of class |
---|---|
... | Additional arguments affecting the summary produced. |
x | Object of class |
For is.scan
: TRUE
if its argument is of
class scan
.
For dim.scan
: dimensions of the scan.
A object of class scan
is a list containing:
radar
character string with the radar identifier
datetime
nominal time of the volume to which this scan belongs (UTC)
params
a list with scan parameters
attributes
list with the scan's \what
,
\where
and \how
attributes
geo
geographic data, a list with:
lat
latitude of the radar (decimal degrees)
lon
longitude of the radar (decimal degrees)
height
height of the radar antenna (meters above sea level)
elangle
radar beam elevation (degrees)
rscale
range bin size (m)
ascale
azimuth bin size (deg)
geo
element of a scan
object is a copy of the
geo
element of its parent polar volume of class pvol
.# load example scan object data(example_scan) # verify this object is of class scan: is.scan(example_scan)#> [1] TRUE# print the scan parameters contained in the scan: example_scan$params#> $VRADH #> Polar scan parameter (class param) #> #> quantity: VRADH #> dims: 480 bins x 360 rays #> #> $DBZH #> Polar scan parameter (class param) #> #> quantity: DBZH #> dims: 480 bins x 360 rays #> #> $ZDR #> Polar scan parameter (class param) #> #> quantity: ZDR #> dims: 480 bins x 360 rays #> #> $RHOHV #> Polar scan parameter (class param) #> #> quantity: RHOHV #> dims: 480 bins x 360 rays #> #> $PHIDP #> Polar scan parameter (class param) #> #> quantity: PHIDP #> dims: 480 bins x 360 rays #># extract the VRADH scan parameter: param <- get_param(example_scan, "VRADH") # print summary info for this scan parameter: param#> Polar scan parameter (class param) #> #> quantity: VRADH #> dims: 480 bins x 360 raysis.scan("this is not a polar scan but a string") # > FALSE#> [1] FALSE