HSI.hsimage Class Reference

This class provides an interface for unlabeled ENVI-BIL hyperspectral images. More...

Public Member Functions
def	__init__
	Constructor Default Constructor to create empty hsimage instance.
def	__init__
	Constructor Constructor for loading with header (.hdr), image (.raw) and spectrometer files (.txt) More...
def	__init__
	Constructor. More...
def	load
	Load. More...
def	load
	Load. More...
def	loadSpectrometerData
	loadSpectrometerData More...
def	hasSpecFiles
	hasSpecFiles More...
def	getPixelSpectra
	getPixelSpectra More...
def	getWavelengths
	getWavelengths More...
def	getAmbientIntensities
	getAmbientIntensities More...
def	getPixelTransferFunction
	getPixelTransferFunction More...
def	getPixelArray
	getPixelArray More...
def	getRange
	getRange More...
def	getSet
	getSet More...
def	getBand
	getBand More...
def	getShape
	getShape More...

Detailed Description

This class provides an interface for unlabeled ENVI-BIL hyperspectral images.

This class provides an interface to an unlabeled hyperspectral image. It requires a header (.hdr) file and an image (.raw) file for basic operation, and two spectrometer files (.txt) for full operation.

Definition at line 10 of file HSI.dxy.

Constructor & Destructor Documentation

def HSI.hsimage.__init__	(		header_loc,
			image_loc,
			spec_locations
	)

Constructor Constructor for loading with header (.hdr), image (.raw) and spectrometer files (.txt)

Parameters

header_loc	Location of header file
image_loc	Location of image file
spec_locations	List of strings of spectrometer location files

Returns

hsimage hsimage instance

Definition at line 29 of file HSI.dxy.

def HSI.hsimage.__init__

(

hsimage_instance

)

Constructor.

Copy constructor

Parameters

hsimage_instance

Instance to copy from

Returns

hsimage hsimage instance

Definition at line 36 of file HSI.dxy.

Member Function Documentation

def HSI.hsimage.getAmbientIntensities

(

)

getAmbientIntensities

Get ambient intensities at wavelengths given by getWavelengths() if spectrometer data has been loaded into hsimage instance

Returns

List[float] Returns a list of ambient (spectrometer) intensities at the measured wavelengths

Definition at line 83 of file HSI.dxy.

def HSI.hsimage.getBand

(

wavelength

)

getBand

Returns a numpy array useable with OpenCV of the intensities at every pixel of one wavelength

Parameters

wavelength

Wavelength image to return

Returns

np.array OpenCV compatible numpy array wavelength image

Definition at line 120 of file HSI.dxy.

def HSI.hsimage.getPixelArray

(

)

getPixelArray

Get the entire pixel array, in row major order. Array returned is of size (rows*cols, bands)

Returns

List(uint)

Definition at line 97 of file HSI.dxy.

def HSI.hsimage.getPixelSpectra	(		row,
			col
	)

getPixelSpectra

Get wavelength vector at a single pixel (row,col) location

Parameters

row	Row of pixel to retrieve
col	Column of pixel to retrieve

Returns

List[float] Returns a wavelength intensity vector of the specified pixel

Definition at line 71 of file HSI.dxy.

def HSI.hsimage.getPixelTransferFunction	(		row,
			col
	)

getPixelTransferFunction

Get pixel transfer function, or pixel reflectance, at a specific row, col location. Only enabled if spectrometer data has been loaded into hsimage instance

Parameters

row	Row of pixel to retrieve
col	Column of pixel to retrieve

Returns

List[float]

Definition at line 91 of file HSI.dxy.

def HSI.hsimage.getRange	(		low_wavelength,
			high_wavelength
	)

getRange

Get range of wavelength arrays from a minimum wavelength to a maximum wavelength, inclusive

Parameters

low_wavelength	Lower wavelength
high_wavelength	Higher wavelength

Returns

List[List[float]] Returns a nested list of wavelength spectra

Definition at line 106 of file HSI.dxy.

def HSI.hsimage.getSet

(

wavelengths

)

getSet

Get set of wavelength arrays from list of wavelengths passed into function

Parameters

wavelengths

List of wavelengths to return

Returns

List[List[float]] Returns a nested list of wavelength spectra

Definition at line 113 of file HSI.dxy.

def HSI.hsimage.getShape

(

)

getShape

Returns a tuple of (row,col,bands) that give the size of the underlying hyperspectral data

Returns

tuple (row,col,bands)

Definition at line 126 of file HSI.dxy.

def HSI.hsimage.getWavelengths

(

)

getWavelengths

Get wavelengths detected by camera

Returns

List[float] Returns a list of detected wavelengths

Definition at line 77 of file HSI.dxy.

def HSI.hsimage.hasSpecFiles

(

)

hasSpecFiles

Check if instance of hsimage has associated spectrometer files

Returns

Boolean Returns True if spectrometer file locations stored in header (.hdr) file, otherwise returns False

Definition at line 63 of file HSI.dxy.

def HSI.hsimage.load	(		header_loc,
			image_loc
	)

Load.

Load function

Parameters

header_loc	Location of header file
image_loc	Location of image file

Definition at line 43 of file HSI.dxy.

def HSI.hsimage.load	(		header_loc,
			image_loc,
			spec_locations
	)

Load.

Load function

Parameters

header_loc	Location of header file
image_loc	Location of image file
spec_locations	List of spectrometer file location strings

Definition at line 51 of file HSI.dxy.

def HSI.hsimage.loadSpectrometerData

(

spec_locations

)

loadSpectrometerData

Load spectrometer data into existing hsimage instance

Parameters

spec_locations

List of spectrometer file location strings

Definition at line 57 of file HSI.dxy.

---

The documentation for this class was generated from the following file:

• /media/ryan/HDD/Perception/Dissertation/Software/HSImage/src/HSI.dxy