Scyllarus: C++ Hyperspectral Processing Library
Hyperspectral Image Processing Pipeline
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | Protected Attributes | List of all members
scyl::input Class Reference

Input is a base class from which input classes for the pipeline are derived.. More...

#include <input.h>

Inheritance diagram for scyl::input:
scyl::component_input scyl::data_input scyl::hdr_input scyl::hsz_input scyl::tif_input

Public Member Functions

 input ()
 
virtual ~input ()
 
virtual arma::fcube I () const
 Gets I. More...
 
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 const arma::fcube * I_ptr () const
 Gets a pointer to I. More...
 
virtual arma::fvec illuminant () const
 Gets illuminant. More...
 
virtual arma::fmat k () const
 Gets k. More...
 
virtual arma::fmat g () const
 Gets g. More...
 
virtual arma::fcube s () const
 Gets s. More...
 
virtual const arma::fcube * s_ptr () const
 Gets a pointer to s. More...
 
virtual arma::fmat elements () const
 Gets elements. More...
 
virtual arma::fmat endmembers () const
 Gets endmembers. More...
 
virtual std::vector< std::string > endmember_labels () const
 Gets endmember_labels. More...
 
virtual arma::fcube element_abundances () const
 Gets element_abundances. More...
 
virtual arma::ucube element_abundance_indexes () const
 Gets element_abundance_indexes. More...
 
virtual arma::fmat endmember_abundances () const
 Gets endmember_abundances. More...
 
virtual arma::umat endmember_abundance_indexes () const
 Gets endmember_abundance_indexes. More...
 
virtual arma::fvec wavelengths () const
 Gets wavelengths. More...
 
virtual GDALDataset * gdal_dataset_ptr () const
 Gets gdal_dataset_ptr. More...
 
virtual scyl::INPUT_TYPE type ()
 Tells you what an object is..... (Why isn't this already a thing?) More...
 
int height () const
 Get height. More...
 
int width () const
 Get width. More...
 
int bands () const
 Get bands. More...
 

Protected Attributes

unsigned int m_height
 
unsigned int m_width
 
unsigned int m_bands
 

Detailed Description

Input is a base class from which input classes for the pipeline are derived..

At the most basic level, the input can be used as follows (eg for HDR):

scyl::input * input = scyl::hdr_input("string/filename/path.hdr");

The input class itself is a class from which other input types will derive. All the methods in the class return exceptions, with the intention that they be over-ridden by derived implementations.

Constructor & Destructor Documentation

scyl::input::input ( )

Input Constructor

scyl::input::~input ( )
virtual

Input Destructor

Member Function Documentation

int scyl::input::bands ( ) const

Get bands.

Returns
bands
arma::ucube scyl::input::element_abundance_indexes ( ) const
virtual

Gets element_abundance_indexes.

Returns
element_abundance_indexes
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::component_input, scyl::hsz_input, and scyl::data_input.

arma::fcube scyl::input::element_abundances ( ) const
virtual

Gets element_abundances.

Returns
element_abundances
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::component_input, scyl::hsz_input, and scyl::data_input.

arma::fmat scyl::input::elements ( ) const
virtual

Gets elements.

Returns
elements
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::component_input, scyl::data_input, and scyl::hsz_input.

arma::umat scyl::input::endmember_abundance_indexes ( ) const
virtual

Gets endmember_abundance_indexes.

Returns
endmember_abundance_indexes
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::component_input, scyl::data_input, and scyl::hsz_input.

arma::fmat scyl::input::endmember_abundances ( ) const
virtual

Gets endmember_abundances.

Returns
endmember_abundances
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::component_input, scyl::data_input, and scyl::hsz_input.

std::vector< std::string > scyl::input::endmember_labels ( ) const
virtual

Gets endmember_labels.

Returns
endmember_labels
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::component_input, scyl::data_input, and scyl::hsz_input.

arma::fmat scyl::input::endmembers ( ) const
virtual

Gets endmembers.

Returns
endmembers
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::component_input, scyl::data_input, and scyl::hsz_input.

arma::fmat scyl::input::g ( ) const
virtual

Gets g.

Returns
g
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::component_input, scyl::hsz_input, and scyl::data_input.

GDALDataset * scyl::input::gdal_dataset_ptr ( ) const
virtual

Gets gdal_dataset_ptr.

Returns
gdal_dataset_ptr
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::hdr_input, and scyl::tif_input.

int scyl::input::height ( ) const

Get height.

Returns
height
arma::fcube scyl::input::I ( ) const
virtual

Gets I.

Returns
I
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::component_input, scyl::hdr_input, scyl::tif_input, scyl::data_input, and scyl::hsz_input.

arma::fcube scyl::input::I ( const arma::uvec  bands) const
virtual

Gets I (subset of bands)

Parameters
bandsa list of the indices of the desired bands
Returns
I
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::hdr_input.

arma::fcube scyl::input::I ( int  r0,
int  c0,
int  r1,
int  c1 
) const
virtual

Gets I (cropped)

Parameters
r0beginning row
c0beginning col
r1ending row
c1ending col
Returns
I
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::hdr_input.

arma::fcube scyl::input::I ( const arma::uvec  bands,
int  r0,
int  c0,
int  r1,
int  c1 
) const
virtual

Gets I (subset of bands)

Parameters
bandsa list of the indices of the desired bands
r0beginning row
c0beginning col
r1ending row
c1ending col
Returns
I
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::hdr_input.

const arma::fcube * scyl::input::I_ptr ( ) const
virtual

Gets a pointer to I.

Returns
Pointer to I
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::component_input, scyl::hdr_input, scyl::tif_input, scyl::data_input, and scyl::hsz_input.

arma::fvec scyl::input::illuminant ( ) const
virtual

Gets illuminant.

Returns
illuminant
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::component_input, scyl::data_input, and scyl::hsz_input.

arma::fmat scyl::input::k ( ) const
virtual

Gets k.

Returns
k
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::component_input, scyl::data_input, and scyl::hsz_input.

arma::fcube scyl::input::s ( ) const
virtual

Gets s.

Returns
s
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::component_input, scyl::hdr_input, scyl::data_input, and scyl::hsz_input.

const arma::fcube * scyl::input::s_ptr ( ) const
virtual

Gets a pointer to s.

Returns
Pointer to s
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::component_input, scyl::hdr_input, scyl::data_input, and scyl::hsz_input.

scyl::INPUT_TYPE scyl::input::type ( )
virtual

Tells you what an object is..... (Why isn't this already a thing?)

Returns
The type enum of this object.

Reimplemented in scyl::component_input, scyl::data_input, scyl::hsz_input, scyl::hdr_input, and scyl::tif_input.

arma::fvec scyl::input::wavelengths ( ) const
virtual

Gets wavelengths.

Returns
wavelengths
Exceptions
ExceptionData does not exist.

Reimplemented in scyl::component_input, scyl::data_input, scyl::hsz_input, scyl::hdr_input, and scyl::tif_input.

int scyl::input::width ( ) const

Get width.

Returns
width

Member Data Documentation

unsigned int scyl::input::m_bands
protected
unsigned int scyl::input::m_height
protected
unsigned int scyl::input::m_width
protected

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