getWhereMeasured: Get the "where.measured" attribute

View source: R/spct.metadata.r

getWhereMeasuredR Documentation

Get the "where.measured" attribute

Description

Method to read the "where.measured" attribute of generic_spct, generic_mspct, summary_generic_spct, data.frame or a derived-class object.

Usage

getWhereMeasured(x, ...)

where_measured(x, ...)

## Default S3 method:
getWhereMeasured(x, ...)

## S3 method for class 'generic_spct'
getWhereMeasured(x, ..., simplify = FALSE)

## S3 method for class 'summary_generic_spct'
getWhereMeasured(x, ..., simplify = FALSE)

## S3 method for class 'generic_mspct'
getWhereMeasured(
  x,
  ...,
  idx = "spct.idx",
  .bind.geocodes = TRUE,
  simplify = FALSE
)

## S3 method for class 'data.frame'
getWhereMeasured(x, ...)

Arguments

x

a generic_spct object

...

Allows use of additional arguments in methods for other classes.

simplify

logical If all members share the same attribute value return one copy instead of a data.frame.

idx

character Name of the column with the names of the members of the collection of spectra.

.bind.geocodes

logical In the case of collections of spectra if .bind.geocodes = TRUE, the default, the returned value is a single geocode with one row for each member spectrum. Otherwise the individual geocode data frames are returned in a list column within a tibble.

Value

a data.frame with a single row and at least columns "lon" and "lat", unless expand is set to FALSE.

Methods (by class)

  • getWhereMeasured(default): default

  • getWhereMeasured(generic_spct): generic_spct

  • getWhereMeasured(summary_generic_spct): summary_generic_spct

  • getWhereMeasured(generic_mspct): generic_mspct

  • getWhereMeasured(data.frame): data.frame

Note

If x is not a generic_spct or an object of a derived class NA is returned.

See Also

Other measurement metadata functions: add_attr2tb(), getFilterProperties(), getHowMeasured(), getInstrDesc(), getInstrSettings(), getSoluteProperties(), getWhatMeasured(), getWhenMeasured(), get_attributes(), isValidInstrDesc(), isValidInstrSettings(), select_spct_attributes(), setFilterProperties(), setHowMeasured(), setInstrDesc(), setInstrSettings(), setSoluteProperties(), setWhatMeasured(), setWhenMeasured(), setWhereMeasured(), spct_attr2tb(), spct_metadata(), subset_attributes(), trimInstrDesc(), trimInstrSettings()

Examples

my.spct <- sun.spct
where_measured(my.spct)
where_measured(my.spct) <- data.frame(lon = 0, lat = -60)
where_measured(my.spct)
where_measured(my.spct) <- NULL
where_measured(my.spct)


photobiology documentation built on June 8, 2025, 10:14 a.m.