GBDX

ENVI® Get Spectrum from Library

This task retrieves the spectrum, wavelengths, and wavelength units for a specified material from a spectral library.

GBDX Registered Name: ENVI_GetSpectrumFromLibrary
Provider: Harris Geospatial Solutions

Example Output

The output of this task is a string.

Quickstart

This is a workflow example for basic processing.

# Quickstart Example running the task name.

# Initialize the Environment.
from os.path import join, split
from gbdxtools import Interface
gbdx = Interface()

tasks = []
output_location = 'ENVI/GetSpectrumFromLibrary'


# Get a spectrum from a library
envi_spectral_library = gbdx.Task("ENVI_GetSpectrumFromLibrary")
envi_spectral_library.inputs.input_spectral_library_filename = 'veg_2grn.sli'
envi_spectral_library.inputs.spectrum_name = 'Dry Grass'
tasks += [envi_spectral_library]

workflow = gbdx.Workflow(tasks)
workflow.savedata(
    envi_spectral_library.outputs.task_meta_data, location=output_location
)

workflow.execute()

Inputs

The following table lists all ENVI_GetSpectrumFromLibrary inputs.
Mandatory (optional) settings are listed as Required = True (Required = False).

Name Required Default Valid Values Description
file_types False N/A string GBDX Option. Comma seperated list of permitted file type extensions. Use this to filter input files -- Value Type: STRING[*]
input_spectral_library False N/A See ENVISPECTRALLIBRARY input type Specify a spectral library from which to retrieve a particular spectrum. -- Value Type: ENVISPECTRALLIBRARY
input_spectral_library_filename False N/A See ENVISPECTRALLIBRARY input type Provide the file name only of the ENVI built in spectral library file. -- Value Type: STRING
spectrum_name True N/A string A string representing the material spectrum to retrieve. -- Value Type: STRING

Outputs

The following table lists all ENVI_GetSpectrumFromLibrary outputs.
Mandatory (optional) settings are listed as Required = True (Required = False).

Name Required Default Valid Values Description
task_meta_data False N/A directory GBDX Option. Output location for task meta data such as execution log and output JSON
wavelengths True N/A string A double array representing the wavelength values of the spectrum. -- Value Type: DOUBLEARRAY
reflectance_scale_factor True N/A string Scale factor to be used in converting spectra to reflectance. -- Value Type: DOUBLE
y_range True N/A string The range of the spectrum values. -- Value Type: DOUBLEARRAY
spectrum True N/A string A double array representing the spectrum that matches the input spectrum name. -- Value Type: DOUBLEARRAY
wavelength_units True N/A string A string representing the wavelength units of the spectrum. -- Value Type: STRING

Output structure

The outputs will be written to the specified S3 Customer Account Location as a json file called task_output.json

Background

For additional background information on this task please refer to the Harris Geospatial ENVI documentation and
ENVI® Get Spectrum From Library.

Contact

If you have any questions or issues with this task, please contact gbdx-support@digitalglobe.com.

ENVI® Get Spectrum from Library

This task retrieves the spectrum, wavelengths, and wavelength units for a specified material from a spectral library.

GBDX Registered Name: ENVI_GetSpectrumFromLibrary
Provider: Harris Geospatial Solutions