Create structured hyperspectral metadata

Usage

hsi_create_metadata(
  name,
  sensor_type = NULL,
  manufacturer = NULL,
  lens = NULL,
  calibration_pack = NULL,
  session_id = NULL,
  operator = NULL,
  campaign_prefix = NULL,
  dataset_name = NULL,
  nrow = NULL,
  ncol = NULL,
  nlyr = NULL,
  xres = NULL,
  yres = NULL,
  spectral_resolution_nm = NULL,
  frame_rate_hz = NULL,
  et_target_ms = NULL,
  et_white_ms = NULL,
  target_start_mm = NULL,
  target_stop_mm = NULL,
  fov_mm = NULL,
  camera_position_mm = NULL,
  stage_position_mm = NULL,
  scanning_speed_mm_s = NULL,
  aspect_ratio = NULL,
  spectral_binning = NULL,
  spatial_binning = NULL,
  dropped_frames = NULL,
  gcp_count = NULL,
  wavelengths = NULL,
  fwhm = NULL
)

Arguments

name: Character. Capture name. A single non-empty string.
sensor_type: Character. Sensor type. Default NULL.
manufacturer: Character. Sensor manufacturer. Default NULL.
lens: Character. Lens description, e.g. focal length. Default NULL.
calibration_pack: Character. Calibration pack name or path. Default NULL.
session_id: Character. Session identifier grouping scans that share a white reference. Default NULL.
operator: Character. Operator full name. Default NULL.
campaign_prefix: Character. Campaign prefix as set in the acquisition software. Default NULL.
dataset_name: Character. Dataset name as entered in the acquisition software. Default NULL.
nrow: Positive integer. Number of raster rows. Default NULL.
ncol: Positive integer. Number of raster columns. Default NULL.
nlyr: Positive integer. Number of raster layers. Default NULL.
xres: Positive number. Pixel resolution in the x direction. Default NULL.
yres: Positive number. Pixel resolution in the y direction. Default NULL.
spectral_resolution_nm: Positive number. Spectral resolution in nm. Default NULL.
frame_rate_hz: Positive number. Frame rate in Hz. Default NULL.
et_target_ms: Positive number. Target integration time in ms. Default NULL.
et_white_ms: Positive number. White reference integration time in ms. Default NULL.
target_start_mm: Positive number. Motor position at scan start in mm. Default NULL.
target_stop_mm: Positive number. Motor position at scan end in mm. Default NULL.
fov_mm: Numeric. Across-track field of view in mm. Default NULL.
camera_position_mm: Numeric. Camera position reading in mm. Default NULL.
stage_position_mm: Numeric. Stage or focus-table position reading in mm. Default NULL.
scanning_speed_mm_s: Numeric. Along-track scanning speed in mm/s. Default NULL.
aspect_ratio: Positive number. Measured pixel aspect ratio (along-track / across-track). Default NULL.
spectral_binning: Positive integer. Spectral binning factor. Default NULL.
spatial_binning: Positive integer. Spatial binning factor. Default NULL.
dropped_frames: Numeric. Number of dropped frames reported by the acquisition software. Default NULL.
gcp_count: Numeric. Number of ground control points placed for co-registration. Default NULL.
wavelengths: Positive numeric vector. Band centre wavelengths in nm, one value per layer. Default NULL.
fwhm: Positive numeric vector. Band full width at half maximum in nm, one value per layer. Default NULL.

Value

An object of class hsi_metadata: a validated list of capture metadata fields with an internally stamped schema_version.

Examples

if (FALSE) { # \dontrun{
# Minimal: name only
x_metadata <- hsi_create_metadata(name = "capture_01")

# With sensor identity, dimensions, and spectral axis
x_metadata <- hsi_create_metadata(
  name = "capture_01",
  sensor_type = "VNIR",
  manufacturer = "Specim",
  nlyr = 224,
  wavelengths = seq(400, 1000, length.out = 224)
)
} # }

Create structured hyperspectral metadata

Usage

Arguments

Value

See also

Examples