RVC::HYPERSPECTRAL Class Reference

Manages RVC::OBJTYPE_Hyperspectral RVC objects. More...

#include <rvc/hypspect.h>

Inheritance diagram for RVC::HYPERSPECTRAL:

[legend]

Classes
class	MAKEPARMS
Public Member Functions
	HYPERSPECTRAL (const RVC::HYPERSPECTRAL &rhs)
	HYPERSPECTRAL ()
virtual	~HYPERSPECTRAL ()
INT32	GetNumPrimaryVectors () const
INT32	GetNumTileColumns () const
INT32	GetNumTileLines () const
INT32	GetNumXTiles () const
INT32	GetNumYTiles () const
INT32	GetTileSizeBytes () const
ERRVALUE	Make (RVC::OBJITEM &ObjItem, MAKEPARMS &MakeParms, const char Source=0, const CREDENTIALS Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE	Make (const RVC::OBJECT &parent, const RVC::DESCRIPTOR &Descriptor, MAKEPARMS &MakeParms, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
RVC::HYPERSPECTRAL &	operator= (const RVC::HYPERSPECTRAL &rhs)
ERRVALUE	ReadBandLossy (INT32 Band, INT32 Line, INT32 StartColumn, double *data, INT32 Length=1) const
ERRVALUE	ReadBandLossy (INT32 Band, INT32 Line, INT32 StartColumn, float *data, INT32 Length=1) const
ERRVALUE	ReadBandLossy (INT32 Band, INT32 Line, INT32 StartColumn, UINT32 *data, INT32 Length=1) const
ERRVALUE	ReadBandLossy (INT32 Band, INT32 Line, INT32 StartColumn, INT32 *data, INT32 Length=1) const
ERRVALUE	ReadBandLossy (INT32 Band, INT32 Line, INT32 StartColumn, UINT16 *data, INT32 Length=1) const
ERRVALUE	ReadBandLossy (INT32 Band, INT32 Line, INT32 StartColumn, INT16 *data, INT32 Length=1) const
ERRVALUE	ReadBandLossy (INT32 Band, INT32 Line, INT32 StartColumn, UINT8 *data, INT32 Length=1) const
ERRVALUE	ReadBandLossy (INT32 Band, INT32 Line, INT32 StartColumn, INT8 *data, INT32 Length=1) const
ERRVALUE	ReadBandLossy (INT32 Band, INT32 Line, INT32 StartColumn, void *data, INT32 Length=1, CONVMODE Convert=CONVMODE_None) const
ERRVALUE	WriteAverageLine (INT32 Line, INT32 StartColumn, const void *data, INT32 Length, CONVMODE Convert=CONVMODE_None)
ERRVALUE	WriteBandLine (INT32 Line, INT32 StartColumn, const void *data, INT32 Length, CONVMODE Convert=CONVMODE_None)
ERRVALUE	WriteClassLine (INT32 Line, INT32 StartColumn, const void *data, INT32 Length, CONVMODE Convert=CONVMODE_None)
ERRVALUE	WriteResidualLine (INT32 Band, INT32 Line, INT32 StartColumn, const void *data, INT32 Length, CONVMODE Convert=CONVMODE_None)

Detailed Description

Manages RVC::OBJTYPE_Hyperspectral RVC objects.

The interface currently wraps the MfHyperspectral functions.

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

Default RVC Object Type for this class: RVC::OBJTYPE_Hyperspectral

Valid parents for this class:

Constructor & Destructor Documentation

RVC::HYPERSPECTRAL::HYPERSPECTRAL ( )

Default constructor.

RVC::HYPERSPECTRAL::HYPERSPECTRAL ( const RVC::HYPERSPECTRAL & rhs )

Copy constructor.

virtual RVC::HYPERSPECTRAL::~HYPERSPECTRAL ( ) [virtual]

Destructor.

Member Function Documentation

INT32 RVC::HYPERSPECTRAL::GetNumPrimaryVectors ( ) const [inline]

Obtain number of primary vectors in a hyperspectral image.

Returns:: number of primary vectors in the hyperspectral image

INT32 RVC::HYPERSPECTRAL::GetNumTileColumns ( ) const [inline]

Obtain number of columns in a hyperspectral image tile.

Returns:: number of columns in the hyperspectral image tile

INT32 RVC::HYPERSPECTRAL::GetNumTileLines ( ) const [inline]

Obtain number of lines in a hyperspectral image tile.

Returns:: number of lines in the hyperspectral image tile

INT32 RVC::HYPERSPECTRAL::GetNumXTiles ( ) const [inline]

Obtain number of tiles in a raster row.

Returns:: number of row tiles

INT32 RVC::HYPERSPECTRAL::GetNumYTiles ( ) const [inline]

Obtain number of tiles in a raster column.

Returns:: number of column tiles

INT32 RVC::HYPERSPECTRAL::GetTileSizeBytes ( ) const [inline]

Obtain number of bytes in a raster tile.

Returns:: size of raster tile in bytes

ERRVALUE RVC::HYPERSPECTRAL::Make	(	RVC::OBJITEM &	ObjItem,
		MAKEPARMS &	MakeParms,
		const char *	Source = `0`,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Create a hyperspectral object.

Parameters:

	ObjItem	Parent object and DESCRIPTOR of object to create, new location RETURNED
	MakeParms	Parameters needed to create raster, cannot be changed after creation
	Source	Source of raster creation, default is GetAppName()
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

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

Create a hyperspectral object.

Parameters:

	parent	Parent object to create raster under
	MakeParms	Parameters needed to create raster, cannot be changed after creation
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

RVC::HYPERSPECTRAL& RVC::HYPERSPECTRAL::operator= ( const RVC::HYPERSPECTRAL & rhs )

Assignment.

Reimplemented from RVC::OBJECT.

ERRVALUE RVC::HYPERSPECTRAL::ReadBandLossy	(	INT32	Band,
		INT32	Line,
		INT32	StartColumn,
		double *	data,
		INT32	Length = `1`
	)			const `[inline]`

Read a line of raster cells up to a certain length, converting to 64 bit double.

Parameters:

	Band	Read a raster line, 8 byte doubles Image band number to read
	Line	Raster line to read
	StartColumn	Raster column to start reading on
	data	Buffer to read into
	Length	Number of columns to read

ERRVALUE RVC::HYPERSPECTRAL::ReadBandLossy	(	INT32	Band,
		INT32	Line,
		INT32	StartColumn,
		float *	data,
		INT32	Length = `1`
	)			const `[inline]`

Read a line of raster cells up to a certain length, converting to 32 bit float.

Parameters:

	Band	Read a raster line, 4 byte floats Image band number to read
	Line	Raster line to read
	StartColumn	Raster column to start reading on
	data	Buffer to read into
	Length	Number of columns to read

ERRVALUE RVC::HYPERSPECTRAL::ReadBandLossy	(	INT32	Band,
		INT32	Line,
		INT32	StartColumn,
		UINT32 *	data,
		INT32	Length = `1`
	)			const `[inline]`

Read a line of raster cells up to a certain length, converting to unsigned 32 bit.

Parameters:

	Band	Read a raster line, unsigned 32 bit Image band number to read
	Line	Raster line to read
	StartColumn	Raster column to start reading on
	data	Buffer to read into
	Length	Number of columns to read

ERRVALUE RVC::HYPERSPECTRAL::ReadBandLossy	(	INT32	Band,
		INT32	Line,
		INT32	StartColumn,
		INT32 *	data,
		INT32	Length = `1`
	)			const `[inline]`

Read a line of raster cells up to a certain length, converting to signed 32 bit.

Parameters:

	Band	Read a raster line, signed 32 bit Image band number to read
	Line	Raster line to read
	StartColumn	Raster column to start reading on
	data	Buffer to read into
	Length	Number of columns to read

ERRVALUE RVC::HYPERSPECTRAL::ReadBandLossy	(	INT32	Band,
		INT32	Line,
		INT32	StartColumn,
		UINT16 *	data,
		INT32	Length = `1`
	)			const `[inline]`

Read a line of raster cells up to a certain length, converting to unsigned 16 bit.

Parameters:

	Band	Read a raster line, unsigned 16 bit Image band number to read
	Line	Raster line to read
	StartColumn	Raster column to start reading on
	data	Buffer to read into
	Length	Number of columns to read

ERRVALUE RVC::HYPERSPECTRAL::ReadBandLossy	(	INT32	Band,
		INT32	Line,
		INT32	StartColumn,
		INT16 *	data,
		INT32	Length = `1`
	)			const `[inline]`

Read a line of raster cells up to a certain length, converting to signed 16 bit.

Parameters:

	Band	Read a raster line, signed 16 bit Image band number to read
	Line	Raster line to read
	StartColumn	Raster column to start reading on
	data	Buffer to read into
	Length	Number of columns to read

ERRVALUE RVC::HYPERSPECTRAL::ReadBandLossy	(	INT32	Band,
		INT32	Line,
		INT32	StartColumn,
		UINT8 *	data,
		INT32	Length = `1`
	)			const `[inline]`

Read a line of raster cells up to a certain length, converting to unsigned 8 bit.

Parameters:

	Band	Read a raster line, unsigned 8 bit Image band number to read
	Line	Raster line to read
	StartColumn	Raster column to start reading on
	data	Buffer to read into
	Length	Number of columns to read

ERRVALUE RVC::HYPERSPECTRAL::ReadBandLossy	(	INT32	Band,
		INT32	Line,
		INT32	StartColumn,
		INT8 *	data,
		INT32	Length = `1`
	)			const `[inline]`

Read a line of raster cells up to a certain length, converting to signed 8 bit.

Parameters:

	Band	Read a raster line, signed 8 bit Image band number to read
	Line	Raster line to read
	StartColumn	Raster column to start reading on
	data	Buffer to read into
	Length	Number of columns to read

ERRVALUE RVC::HYPERSPECTRAL::ReadBandLossy	(	INT32	Band,
		INT32	Line,
		INT32	StartColumn,
		void *	data,
		INT32	Length = `1`,
		CONVMODE	Convert = `CONVMODE_None`
	)			const

Read a line of raster cells up to a certain length.

Parameters:

	Line	Raster line to read
	StartColumn	Raster column to start reading on
	data	Buffer to read into
	Length	Number of columns to read
	Convert	Data conversion mode

ERRVALUE RVC::HYPERSPECTRAL::WriteAverageLine	(	INT32	Line,
		INT32	StartColumn,
		const void *	data,
		INT32	Length,
		CONVMODE	Convert = `CONVMODE_None`
	)

Parameters:

Convert

Data conversion mode

ERRVALUE RVC::HYPERSPECTRAL::WriteBandLine	(	INT32	Line,
		INT32	StartColumn,
		const void *	data,
		INT32	Length,
		CONVMODE	Convert = `CONVMODE_None`
	)

Parameters:

Convert

Data conversion mode

ERRVALUE RVC::HYPERSPECTRAL::WriteClassLine	(	INT32	Line,
		INT32	StartColumn,
		const void *	data,
		INT32	Length,
		CONVMODE	Convert = `CONVMODE_None`
	)

Parameters:

Convert

Data conversion mode

ERRVALUE RVC::HYPERSPECTRAL::WriteResidualLine	(	INT32	Band,
		INT32	Line,
		INT32	StartColumn,
		const void *	data,
		INT32	Length,
		CONVMODE	Convert = `CONVMODE_None`
	)

Parameters:

Convert

Data conversion mode

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

rvc/hypspect.h

RVC::HYPERSPECTRAL Class Reference

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation