RVC::SPECTRALLIBRARY Class Reference

Manages RVC::OBJTYPE_Spectral RVC objects. More...

#include <rvc/spectrallibrary.h>

Inheritance diagram for RVC::SPECTRALLIBRARY:

[legend]

List of all members.

Classes
struct	CHANNEL
	Spectral channel header definition. More...
struct	RECORD
	Spectral record header definition. More...
Public Member Functions
	SPECTRALLIBRARY (const RVC::SPECTRALLIBRARY &obj)
	SPECTRALLIBRARY ()
virtual	~SPECTRALLIBRARY ()
INT32	AddRecord (const RECORD &record)
ERRVALUE	DeleteRecord (INT32 RecordNum)
INT32	GetMaxNumChannels ()
double	GetMaxWavelength ()
INT32	GetMinNumChannels ()
double	GetMinWavelength ()
INT32	GetNumRecords ()
ERRVALUE	Make (RVC::OBJITEM &ObjItem, const char *Source=0, const CREDENTIALS *Credentials=0)
ERRVALUE	Make (const RVC::OBJECT &parent, const RVC::DESCRIPTOR &Descriptor, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
RVC::SPECTRALLIBRARY &	operator= (const RVC::SPECTRALLIBRARY &rhs)
ERRVALUE	ReadRecord (INT32 RecordNum, RECORD &record)
ERRVALUE	ReadRecordChannels (INT32 RecordNum, SIMPLE_ARRAY< CHANNEL > &Channels)
ERRVALUE	WriteRecord (INT32 RecordNum, RECORD &record)
ERRVALUE	WriteRecordChannels (INT32 RecordNum, const SIMPLE_ARRAY< CHANNEL > &Channels)

---

Detailed Description

Manages RVC::OBJTYPE_Spectral RVC objects.

RVC Object Types that this class supports: RVC::OBJTYPE_Spectral

Valid parents for this class: RVC::OBJTYPE_File RVC::OBJTYPE_Folder

Spectral library is a collection of hyperspectral records for number of different materials, minerals plants and etc. Hyperspectral record contains the calibrated reflectance (or measured radiance) detected at multiple wavelength channels. Each wavelength channel has a spectral definition that consists of wavelength, bandwidth and error value associated with a specific measurement. "Channel" is a USGS term for describing elementary measurement at certain wavelength.

---

Constructor & Destructor Documentation

RVC::SPECTRALLIBRARY::SPECTRALLIBRARY

(

)

Default constructor.

RVC::SPECTRALLIBRARY::SPECTRALLIBRARY

(

const RVC::SPECTRALLIBRARY &

obj

)

Copy constructor.

virtual RVC::SPECTRALLIBRARY::~SPECTRALLIBRARY

(

)

[virtual]

Destructor.

---

Member Function Documentation

INT32 RVC::SPECTRALLIBRARY::AddRecord

(

const RECORD &

record

)

Add a record to the rvc spectral library object, do not use WriteRecord() since multiple people can be trying to add a record at the same time.

Returns:

Index of new record of error if < 0

Parameters:

record

Record to add

ERRVALUE RVC::SPECTRALLIBRARY::DeleteRecord

(

INT32

RecordNum

)

Delete given record.

This method deletes a record by swapping the last record with 'ShapeNum', then it resizes the number of records by -1.

Parameters:

RecordNum

Shape number to delete

INT32 RVC::SPECTRALLIBRARY::GetMaxNumChannels

(

)

double RVC::SPECTRALLIBRARY::GetMaxWavelength

(

)

INT32 RVC::SPECTRALLIBRARY::GetMinNumChannels

(

)

double RVC::SPECTRALLIBRARY::GetMinWavelength

(

)

INT32 RVC::SPECTRALLIBRARY::GetNumRecords

(

)

Obtain the number of records in a rvc spectral library object.

Returns:

number of records

ERRVALUE RVC::SPECTRALLIBRARY::Make	(	RVC::OBJITEM &	ObjItem,
		const char *	Source = 0,
		const CREDENTIALS *	Credentials = 0
	)

Create a new rvc style object under a specified parent rvc object with name, description, and source.

Parameters:

	ObjItem	Name, Desc of object to create, Created object location RETURNED
	Source	Source of new style object, default is application name
	Credentials	User credentials passed in, NULL for default behavior

ERRVALUE RVC::SPECTRALLIBRARY::Make	(	const RVC::OBJECT &	parent,
		const RVC::DESCRIPTOR &	Descriptor,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Create a new rvc spectrallibrary object under a specified parent rvc object with name, description, and source.

Parameters:

	parent	Parent object to create style object under
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

RVC::SPECTRALLIBRARY& RVC::SPECTRALLIBRARY::operator=

(

const RVC::SPECTRALLIBRARY &

rhs

)

Assignment.

Reimplemented from RVC::OBJECT.

ERRVALUE RVC::SPECTRALLIBRARY::ReadRecord	(	INT32	RecordNum,
		RECORD &	record
	)

Read a rvc spectrallibrary object record element.

Parameters:

	RecordNum	The record index to read
	record	Record to read

ERRVALUE RVC::SPECTRALLIBRARY::ReadRecordChannels	(	INT32	RecordNum,
		SIMPLE_ARRAY< CHANNEL > &	Channels
	)

Read a rvc spectrallibrary object record channels.

Parameters:

	RecordNum	The record index to read
	Channels	Channel array RETURNED

ERRVALUE RVC::SPECTRALLIBRARY::WriteRecord	(	INT32	RecordNum,
		RECORD &	record
	)

Read a rvc spectrallibrary object record element.

Parameters:

	RecordNum	The record index to read
	record	Record to read

ERRVALUE RVC::SPECTRALLIBRARY::WriteRecordChannels	(	INT32	RecordNum,
		const SIMPLE_ARRAY< CHANNEL > &	Channels
	)

Write a rvc spectrallibrary object record channels.

Parameters:

	RecordNum	The record index to write
	Channels	Channel array to write

---

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

• rvc/spectrallibrary.h