The HSImage class is the base class for interacting with ENVI type hyperspectral images. More...

#include <hsimage.h>

Public Member Functions
	HSImage ()

	HSImage (std::string header_location, std::string image_location)

	HSImage (std::string header_location, std::string image_location, std::vector< std::string > &spec_location)

	HSImage (const HSImage &other)

HSImage &	operator= (const HSImage &other)

void	load (std::string header_location, std::string image_location)
	Load hyperspectral image into HSImage. More...

void	load (std::string header_location, std::string image_location, std::vector< std::string > spec_locations)
	Load hyperspectral image into HSImage. More...

void	loadSpectrometerData (std::vector< std::string > filenames)
	Load only spectrometer data for use with hyperspectral image. More...

void	addSpecDataToHeader (std::vector< std::string > filenames)
	Adds spectrometer file data to the corresponding .hdr file. More...

std::vector< u_int16_t >	getPixelSpectra (int row, int col)
	returns vector of pixel data More...

std::vector< u_int16_t >	getNormalizedPixelSpectra (int row, int col)
	Depracated. Do Not Use. More...

std::vector< double >	getPixelTransferFunction (int row, int col)
	Returns pixel "transfer function". Requires spectrometer data. More...

std::vector< cv::Mat >	getRange (const float lower_wavelength, const float upper_wavelength)
	Return a range of wavelength images as OpenCV cv::Mat objects. More...

std::vector< cv::Mat >	getSet (const std::vector< float > wavelength_set)
	Return a disparate set of wavelength images as OpenCV cv::Mat objects. More...

cv::Mat	operator[] (const float wavelength)
	Get single deisred wavelength image. More...

std::vector< u_int16_t >	getRawPixelData ()
	Get all data formatted as a row major pixel array (row*col,bands) More...

std::vector< float >	getWavelengths ()
	Return vector of imaged wavlengths. More...

std::vector< float >	getAmbientIntensities ()
	Return vector of ambient wavelength intensites. More...

std::tuple< int, int, int >	getShape ()
	Return tuple containing the shape of the HSImage data array (row,col,bands) More...

Static Public Member Functions
static bool	hasSpecFiles (std::string header_location)
	Checks if spectrometer file locations are stored as part of the ENVI .hdr file. More...

Public Attributes
std::string	acquisition_date

int	tint

int	samples

int	lines

int	bands

int	fps

int	binning [2]

std::vector< float >	wavelengths

std::vector< float >	fwhm

std::vector< float >	ambient_intensities

bool	has_spec_data

std::string	img_file

std::string	hdr_file

std::string	nir_spec_file

std::string	vis_spec_file

Detailed Description

The HSImage class is the base class for interacting with ENVI type hyperspectral images.

The HSImage class handles all the logistical operations required to support ENVI hyperspectral images in a C++ environment. The class is designed to handle ENVI type hyperspectral images as well as spectrometer files in the format of "wavelength, intensity\n" as a .txt file. The spectrometer files required to properly enable this behavior are a visible light file (400-700 nm) and a NIR file (700-1000 nm).

Definition at line 113 of file hsimage.h.

Constructor & Destructor Documentation

HSImage::HSImage ( )

Base Constructor

Definition at line 2 of file hsimage.cpp.

HSImage::HSImage	(	std::string	header_location,
		std::string	image_location
	)

Constuctor with file locations

Definition at line 7 of file hsimage.cpp.

HSImage::HSImage	(	std::string	header_location,
		std::string	image_location,
		std::vector< std::string > &	spec_location
	)

Constructor with spectrometer files

Definition at line 13 of file hsimage.cpp.

HSImage::HSImage ( const HSImage & other )

Reference Constructor

Definition at line 19 of file hsimage.cpp.

Member Function Documentation

void HSImage::addSpecDataToHeader ( std::vector< std::string > filenames )

Adds spectrometer file data to the corresponding .hdr file.

Parameters

filenames location of spectrometer files This function modifies the .hdr file of the hyperspectral image to store information about the directory locations relative to the .hdr file where the spectromteter files corresponding to the hyperspectral image are stored.

Definition at line 354 of file hsimage.cpp.

std::vector< float > HSImage::getAmbientIntensities ( )

Return vector of ambient wavelength intensites.

Returns: std::vector<float> containing the intensity of the ambient light at each wavelength imaged.

Definition at line 429 of file hsimage.cpp.

std::vector< u_int16_t > HSImage::getNormalizedPixelSpectra	(	int	row,
		int	col
	)

Depracated. Do Not Use.

Parameters

row
col

Returns

Definition at line 413 of file hsimage.cpp.

std::vector< u_int16_t > HSImage::getPixelSpectra	(	int	row,
		int	col
	)

returns vector of pixel data

Parameters

row	row of target pixel
col	column of target pixel

Returns: std::vector<u_int16_t> of intensity values for each wavelength at pixel (row,col)

Definition at line 406 of file hsimage.cpp.

std::vector< double > HSImage::getPixelTransferFunction	(	int	row,
		int	col
	)

Returns pixel "transfer function". Requires spectrometer data.

Parameters

row	row of target pixel
col	column of target pixel

Returns: std::vector<double> of transfer function values for each wavelength at pixel (row,col) The transfer function of a hyperspectral pixel requires spectrometer data and returns Y in SY = W, where S is the input from the spectrometer and W is the measured wavelength from the hyperspectral camera. This gives the function that will transform the input light into the output light observed reflecting off of the target pixel.

Definition at line 434 of file hsimage.cpp.

std::vector< cv::Mat > HSImage::getRange	(	const float	lower_wavelength,
		const float	upper_wavelength
	)

Return a range of wavelength images as OpenCV cv::Mat objects.

Parameters

lower_wavelength	Bottom wavlength of the desired range
upper_wavelength	Top wavlength of the desired range

Returns: Vector of cv::Mat objects containing the desired range of wavelength images.

Definition at line 447 of file hsimage.cpp.

std::vector< u_int16_t > HSImage::getRawPixelData ( )

Get all data formatted as a row major pixel array (row*col,bands)

Returns: std::vector<u_int16_t> Vector of pixel values

Definition at line 508 of file hsimage.cpp.

std::vector< cv::Mat > HSImage::getSet ( const std::vector< float > wavelength_set )

Return a disparate set of wavelength images as OpenCV cv::Mat objects.

Parameters

wavelength_set Vector of desired wavlengths

Returns: Vector of cv::Mat objects containing desired wavelength images.

Definition at line 467 of file hsimage.cpp.

std::tuple< int, int, int > HSImage::getShape ( )

Return tuple containing the shape of the HSImage data array (row,col,bands)

Returns: std::tuple<int,int,int> containing shape of HSImage data array

Definition at line 281 of file hsimage.cpp.

std::vector< float > HSImage::getWavelengths ( )

Return vector of imaged wavlengths.

Returns: std::vector<float> containing each wavelength that the sensor detected.

Definition at line 424 of file hsimage.cpp.

bool HSImage::hasSpecFiles ( std::string header_location )

static

Checks if spectrometer file locations are stored as part of the ENVI .hdr file.

Parameters

header_location location of .hdr file

Returns: Boolean value showing the presence of spectrometer location data in the .hdr file

Definition at line 367 of file hsimage.cpp.

void HSImage::load	(	std::string	header_location,
		std::string	image_location
	)

Load hyperspectral image into HSImage.

Parameters

header_location	location of .hdr file
image_location	location of .raw file

Definition at line 82 of file hsimage.cpp.

void HSImage::load	(	std::string	header_location,
		std::string	image_location,
		std::vector< std::string >	spec_locations
	)

Load hyperspectral image into HSImage.

Parameters

header_location	location of .hdr file
image_location	location of .raw file
spec_locations	location of the spectrometer files.

Definition at line 98 of file hsimage.cpp.

void HSImage::loadSpectrometerData ( std::vector< std::string > filenames )

Load only spectrometer data for use with hyperspectral image.

Parameters

filenames locations of the spectrometer filenames.

Definition at line 286 of file hsimage.cpp.

HSImage & HSImage::operator= ( const HSImage & other )

Copy Constructor

Definition at line 54 of file hsimage.cpp.

cv::Mat HSImage::operator[] ( const float wavelength )

Get single deisred wavelength image.

Parameters

wavelength Desired wavelength

Returns: cv::Mat object containing the desired wavelength image.

Definition at line 490 of file hsimage.cpp.

Member Data Documentation

std::string HSImage::acquisition_date

Date of image aquisition. Acquired from .hdr file.

Definition at line 224 of file hsimage.h.

std::vector<float> HSImage::ambient_intensities

Vector of ambient intensity data. Acquired from .hdr file.

Definition at line 233 of file hsimage.h.

int HSImage::bands

Number of wavelengths in image. Acquired from .hdr file.

Definition at line 228 of file hsimage.h.

int HSImage::binning[2]

Array containing the data reduction employed by the camera. Acquired from .hdr file.

Definition at line 230 of file hsimage.h.

int HSImage::fps

Number of wavelengths aquired per second. Acquired from .hdr file.

Definition at line 229 of file hsimage.h.

std::vector<float> HSImage::fwhm

Vector of individual wavelength band width. Acquired from .hdr file.

Definition at line 232 of file hsimage.h.

bool HSImage::has_spec_data

Value showing presence of spectrometer file locations. Acquired from .hdr file.

Definition at line 234 of file hsimage.h.

std::string HSImage::hdr_file

Location of .hdr hyperspectral image file

Definition at line 238 of file hsimage.h.

std::string HSImage::img_file

Location of .raw hyperspectral image file

Definition at line 237 of file hsimage.h.

int HSImage::lines

Number of rows in image. Acquired from .hdr file.

Definition at line 227 of file hsimage.h.

std::string HSImage::nir_spec_file

Location of NIR spectrometer file

Definition at line 239 of file hsimage.h.

int HSImage::samples

Number of pixels per row in image. Acquired from .hdr file.

Definition at line 226 of file hsimage.h.

int HSImage::tint

Exposure value of hyperspectral image. Acquired from .hdr file.

Definition at line 225 of file hsimage.h.

std::string HSImage::vis_spec_file

Location of VIS spectrometer file

Definition at line 240 of file hsimage.h.

std::vector<float> HSImage::wavelengths

Vector of acquired wavelength values. Acquired from .hdr file.

Definition at line 231 of file hsimage.h.

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

/media/ryan/HDD/Perception/Dissertation/Software/HSImage/src/hsimage.h
/media/ryan/HDD/Perception/Dissertation/Software/HSImage/src/hsimage.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation