Function List

Contents

Scyllarus

Scyllarus is the main function in the toolbox. It provides a means to compute a hyperspectral data structure (HSZ) which contains photometric parameters and material information. It also provides a varied set of processing options and spectra representations. For convenience, the toolbox also includes the function RGB2FLA (see General Purpose Functions below).

Whenever this function is used for research purposes, please cite:

Spectra Representation Functions

eval_gaussian_mixture: Evaluates spectra represented as a Gaussian mixture.

eval_nurbs: Evaluates spectra represented as a spline (NURBS). Whenever this function is used for research purposes, please cite

get_gaussian_mixture: Represents raw spectra using a Gaussian mixture model.

get_nurbs: Computes the B-spline (NURBS) representation of the input spectra. When using this function, please cite:

Input-Output Functions

FLAread: Reads a flat (FLA) file from disk.

FLAwrite: Writes a flat file (FLA) to disk.

HSZread: Loads a hyperspectral zipped file (HSZ) from disk.

HSZwrite: Writes a hyperspectral zipped file (HSZ) to disk.

SLZread: Reads a Scyllarus spectral library file (SLZ) from disk.

SLZwrite: Writes a spectral library file (SLZ) to disk.

Photogrammetry Functions

recover_dichromatic_parameters: Computes the dichromatic photometric parameters for an input hyperspectral image. Whenever this function is used for research purposes, please cite:

recover_global_illuminant: Recovers the global illuminant in the scene. Whenever this function is used for research purposes, please cite:

recover_materials: Recovers the scene materials and their abundances per pixel. Whenever this function is used for research purposes, please cite:

recover_multi_illuminant: Computes the power spectrum of the illuminants in the scene. Whenever this function is used for research purposes, please cite:

General Purpose Functions

encode_HSZ: Encodes a Scyllarus data structure using spectral descriptors such as NURBS or Gaussian mixtures.

eval_HSZ: Evaluates a Scyllarus data structure which has been encoded using spectral descriptors such as NURBS or Gaussian mixtures so as to obtain a RAW HSZ.

L2_unmixing: Performs spectral unmixing using a regularised L2 norm. Whenever this function is used for research purposes, please cite:

mix_spectra: Computes the mixed spectra from a matrix of end members and abundances.

reconstruct_illuminant: Illuminant evaluation routine for HSZ data structures

reconstruct_image: Computes flat image (FLA) from an HSZ data structure.

reconstruct_reflectance: Reflectance evaluation routine for HSZ data structures.

reconstruct_specularity: Evaluates the image highlights as represented on a HSZ data structure.

recover_RGBImage: Computes a pseudo-colour image from either an HSZ or flat data structure using camera sensitivity functions.

resize_I: Resizes a hyperspectral image cube.

crop_I: Crops a hyperspectral image cube.

resize_image: Resizes a hyperspectral flat image (FLA) or HSZ data structure.

crop_image: Crops a hyperspectral image (FLA) or HSZ data structure.

RGB2FLA: Converts a trichromatic or monochrome image into a flat data structure (FLA). This function has been provided for the sake of convenience so as to allow Scyllarus to process trichromatic imagery in if required.

translate_HSZ: Re-evaluation routine for HSZ data structures.

translate_spectra: Re-evaluation routine for spectral data.

unmix_illuminant: Unmixes the illuminants in an HSZ data structure with respect to a library of canonical illuminants.

unmix_reflectance: Unmixes the reflectancde in an HSZ data structure with respect to a library of end members.

wavelength_subset: Returns the indices and values for the subset of wavelengths that are common to the input spectral data

HSZ2SLZ: Creates a spectral library (SLZ) data structure from an HSZ data structure.