scyl::data_input Class Reference

data_input is an object that allows for manual data input into the pipeline (more 'managed' than using the pipelines 'set_I()' function. More...

#include <data_input.h>

Inheritance diagram for scyl::data_input:

Public Member Functions
	data_input ()
virtual	~data_input ()
arma::fcube	I () const
	Gets I. More...
const arma::fcube *	I_ptr () const
	Gets a pointer to I. I may be unsorted unless I() has been called previously. More...
arma::fvec	illuminant () const
	Gets illuminant. More...
arma::fmat	k () const
	Gets k. More...
arma::fmat	g () const
	Gets g. More...
arma::fcube	s () const
	Gets s. More...
const arma::fcube *	s_ptr () const
	Gets a pointer to s. More...
arma::fmat	elements () const
	Gets elements. More...
arma::fcube	element_abundances () const
	Gets element_abundances. More...
arma::ucube	element_abundance_indexes () const
	Gets element_abundance_indexes. More...
arma::fmat	endmembers () const
	Gets endmembers. More...
std::vector< std::string >	endmember_labels () const
	Gets endmember_labels. More...
arma::fmat	endmember_abundances () const
	Gets endmember_element_abundances. More...
arma::umat	endmember_abundance_indexes () const
	Gets endmember_element_abundance_indexes. More...
arma::fvec	wavelengths () const
	Gets wavelengths. More...
void	set_I (const arma::fcube &in)
	Sets I for the input object. More...
void	set_illuminant (const arma::fvec &in)
	Sets illuminant for the input object. More...
void	set_k (const arma::fmat &in)
	Sets k for the input object. More...
void	set_g (const arma::fmat &in)
	Sets g for the input object. More...
void	set_s (const arma::fcube &in)
	Sets s for the input object. More...
void	set_elements (const arma::fmat &in)
	Sets elements for the input object. More...
void	set_element_abundances (const arma::fcube &in)
	Sets element_abundances for the input object. More...
void	set_element_abundance_indexes (const arma::ucube &in)
	Sets element_abundance_indexes for the input object. More...
void	set_endmembers (const arma::fmat &in)
	Sets endmembers for the input object. More...
void	set_endmember_abundances (const arma::fmat &in)
	Sets endmember_abundances for the input object. More...
void	set_endmember_abundance_indexes (const arma::umat &in)
	Sets endmember_abundance_indexes for the input object. More...
void	set_endmember_labels (const std::vector< std::string > &in)
	Sets endmember_labels for the input object. More...
void	set_wavelengths (const arma::fvec &in)
	Sets the wavelength vector for the input object. (Set I first) More...
scyl::INPUT_TYPE	type ()
	Tells you what an object is. More...
Public Member Functions inherited from scyl::input
	input ()
virtual	~input ()
virtual arma::fcube	I (const arma::uvec bands) const
	Gets I (subset of bands) More...
virtual arma::fcube	I (int r0, int c0, int r1, int c1) const
	Gets I (cropped) More...
virtual arma::fcube	I (const arma::uvec bands, int r0, int c0, int r1, int c1) const
	Gets I (subset of bands) More...
virtual GDALDataset *	gdal_dataset_ptr () const
	Gets gdal_dataset_ptr. More...
int	height () const
	Get height. More...
int	width () const
	Get width. More...
int	bands () const
	Get bands. More...

Private Attributes
arma::fcube	m_I
arma::fvec	m_illuminant
arma::fmat	m_k
arma::fmat	m_g
arma::fcube	m_s
arma::fmat	m_elements
arma::fcube	m_element_abundances
arma::ucube	m_element_abundance_indexes
arma::fmat	m_endmembers
arma::fmat	m_endmember_abundances
arma::umat	m_endmember_abundance_indexes
std::vector< std::string >	m_endmember_labels
arma::fvec	m_wavelengths

Additional Inherited Members
Protected Attributes inherited from scyl::input
unsigned int	m_height
unsigned int	m_width
unsigned int	m_bands

Detailed Description

data_input is an object that allows for manual data input into the pipeline (more 'managed' than using the pipelines 'set_I()' function.

scyl::input d_input = scyl::data_input(); d_input.set_I(image_cube); d_input.set_wavelengths(waves);

Armadillo has load/save functions that may be useful in conjunction with this class.

Only items set will return non zero values.

Constructor & Destructor Documentation

scyl::data_input::data_input

(

)

data_input Constructor Creates a data_input object.

scyl::data_input::~data_input ( )

virtual

data_input Destructor.

Member Function Documentation

arma::ucube scyl::data_input::element_abundance_indexes ( ) const

virtual

Gets element_abundance_indexes.

Returns

element_abundance_indexes

Exceptions

Exception

Data does not exist.

Reimplemented from scyl::input.

arma::fcube scyl::data_input::element_abundances ( ) const

virtual

Gets element_abundances.

Returns

element_abundances

Exceptions

Exception

Data does not exist.

Reimplemented from scyl::input.

arma::fmat scyl::data_input::elements ( ) const

virtual

Gets elements.

Returns

elements

Exceptions

Exception

Data does not exist.

Reimplemented from scyl::input.

arma::umat scyl::data_input::endmember_abundance_indexes ( ) const

virtual

Gets endmember_element_abundance_indexes.

Returns

endmember_element_abundance_indexes

Exceptions

Exception

Data does not exist.

Reimplemented from scyl::input.

arma::fmat scyl::data_input::endmember_abundances ( ) const

virtual

Gets endmember_element_abundances.

Returns

endmember_element_abundances

Exceptions

Exception

Data does not exist.

Reimplemented from scyl::input.

std::vector< std::string > scyl::data_input::endmember_labels ( ) const

virtual

Gets endmember_labels.

Returns

endmember_labels

Exceptions

Exception

Data does not exist.

Reimplemented from scyl::input.

arma::fmat scyl::data_input::endmembers ( ) const

virtual

Gets endmembers.

Returns

endmembers

Exceptions

Exception

Data does not exist.

Reimplemented from scyl::input.

arma::fmat scyl::data_input::g ( ) const

virtual

Gets g.

Returns

g

Exceptions

Exception

Data does not exist.

Reimplemented from scyl::input.

arma::fcube scyl::data_input::I ( ) const

virtual

Gets I.

Returns

I

Exceptions

Exception

Data does not exist.

Reimplemented from scyl::input.

const arma::fcube * scyl::data_input::I_ptr ( ) const

virtual

Gets a pointer to I. I may be unsorted unless I() has been called previously.

Returns

a pointer to I

Reimplemented from scyl::input.

arma::fvec scyl::data_input::illuminant ( ) const

virtual

Gets illuminant.

Returns

illuminant

Exceptions

Exception

Data does not exist.

Reimplemented from scyl::input.

arma::fmat scyl::data_input::k ( ) const

virtual

Gets k.

Returns

k

Exceptions

Exception

Data does not exist.

Reimplemented from scyl::input.

arma::fcube scyl::data_input::s ( ) const

virtual

Gets s.

Returns

s

Exceptions

Exception

Data does not exist.

Reimplemented from scyl::input.

const arma::fcube * scyl::data_input::s_ptr ( ) const

virtual

Gets a pointer to s.

Returns

a pointer to s

Exceptions

Exception

Data does not exist.

Reimplemented from scyl::input.

void scyl::data_input::set_element_abundance_indexes

(

const arma::ucube &

in

)

Sets element_abundance_indexes for the input object.

Parameters

in	element_abundance_indexes.

Exceptions

Exception

data size mismatch

void scyl::data_input::set_element_abundances

(

const arma::fcube &

in

)

Sets element_abundances for the input object.

Parameters

in	element_abundances.

Exceptions

Exception

data size mismatch

void scyl::data_input::set_elements

(

const arma::fmat &

in

)

Sets elements for the input object.

Parameters

in

elements.

Exceptions

Exception

data size mismatch

void scyl::data_input::set_endmember_abundance_indexes

(

const arma::umat &

in

)

Sets endmember_abundance_indexes for the input object.

Parameters

in	endmember_abundance_indexes.

Exceptions

Exception

data size mismatch

void scyl::data_input::set_endmember_abundances

(

const arma::fmat &

in

)

Sets endmember_abundances for the input object.

Parameters

in	endmember_abundances.

Exceptions

Exception

data size mismatch

void scyl::data_input::set_endmember_labels

(

const std::vector< std::string > &

in

)

Sets endmember_labels for the input object.

Parameters

in	endmember_labels.

Exceptions

Exception

data size mismatch

void scyl::data_input::set_endmembers

(

const arma::fmat &

in

)

Sets endmembers for the input object.

Parameters

in	endmembers.

Exceptions

Exception

data size mismatch

void scyl::data_input::set_g

(

const arma::fmat &

in

)

Sets g for the input object.

Parameters

in

g.

Exceptions

Exception

data size mismatch

void scyl::data_input::set_I

(

const arma::fcube &

in

)

Sets I for the input object.

Parameters

in	the input image cube.

Exceptions

Exception

data size mismatch

void scyl::data_input::set_illuminant

(

const arma::fvec &

in

)

Sets illuminant for the input object.

Parameters

in	the illuminant.

Exceptions

Exception

data size mismatch

void scyl::data_input::set_k

(

const arma::fmat &

in

)

Sets k for the input object.

Parameters

in

k.

Exceptions

Exception

data size mismatch

void scyl::data_input::set_s

(

const arma::fcube &

in

)

Sets s for the input object.

Parameters

in	the input reflectance cube.

Exceptions

Exception

data size mismatch

void scyl::data_input::set_wavelengths

(

const arma::fvec &

in

)

Sets the wavelength vector for the input object. (Set I first)

Bands in I will be sorted when this function is called, according to the wavelength vector (If not already sorted).

Parameters

in	the input wavelength vector.

Exceptions

Exception

data size mismatch

scyl::INPUT_TYPE scyl::data_input::type ( )

virtual

Tells you what an object is.

Returns

The type enum of this object.

Reimplemented from scyl::input.

arma::fvec scyl::data_input::wavelengths ( ) const

virtual

Gets wavelengths.

Returns

wavelengths

Exceptions

Exception

Data does not exist.

Reimplemented from scyl::input.

Member Data Documentation

arma::ucube scyl::data_input::m_element_abundance_indexes

private

arma::fcube scyl::data_input::m_element_abundances

private

arma::fmat scyl::data_input::m_elements

private

arma::umat scyl::data_input::m_endmember_abundance_indexes

private

arma::fmat scyl::data_input::m_endmember_abundances

private

std::vector<std::string> scyl::data_input::m_endmember_labels

private

arma::fmat scyl::data_input::m_endmembers

private

arma::fmat scyl::data_input::m_g

private

arma::fcube scyl::data_input::m_I

private

arma::fvec scyl::data_input::m_illuminant

private

arma::fmat scyl::data_input::m_k

private

arma::fcube scyl::data_input::m_s

private

arma::fvec scyl::data_input::m_wavelengths

private

---

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

• src/io/input/data_input.h
• src/io/input/data_input.cpp