PCIDSK Namespace Reference

Namespace for all PCIDSK Library classes and functions. More...

Classes

class PCIDSKAPModelIOParams

class PCIDSKAPModelEOParams

class PCIDSKAPModelSegment

class PCIDSKChannel

Interface to one PCIDSK channel (band) or bitmap segment. More...

class EDBFile

External Database Interface class. More...

class PCIDSKException

Generic SDK Exception. More...

class PCIDSKFile

Top interface to PCIDSK (.pix) files. More...

class GCP

PCIDSK Generic GCP Structure. More...

class PCIDSKGCPSegment

Interface to PCIDSK GCP segment. More...

class PCIDSKGeoref

Interface to PCIDSK georeferencing segment. More...

class PCIDSKInterfaces

Collection of PCIDSK hookable interfaces. More...

class IOInterfaces

IO Interface class. More...

class Mutex

Mutex interface class. More...

class PCIDSK_PCT

Interface to PCIDSK pseudo-color segment. More...

class PCIDSKRPCSegment

Interface to PCIDSK RPC segment. More...

class PCIDSKSegment

Public tnterface for the PCIDSK Segment Type. More...

struct ShapeVertex

Structure for an x,y,z point. More...

class ShapeField

Attribute field value. More...

class PCIDSK_TEX

Interface to PCIDSK text segment. More...

class PCIDSKVectorSegment

Interface to PCIDSK vector segment. More...

class ShapeIterator

Iterator over shapeids in a vector segment. More...

Typedefs

typedef int32 ShapeId

Type used for shape identifier, use constant NullShapeId as a NULL value.

Enumerations

enum UnitCode { UNIT_US_FOOT = 1, UNIT_METER = 2, UNIT_DEGREE = 4, UNIT_INTL_FOOT = 5 }

enum ShapeFieldType {
  FieldTypeNone = 0, FieldTypeFloat = 1, FieldTypeDouble = 2, FieldTypeString = 3,
  FieldTypeInteger = 4, FieldTypeCountedInt = 5
}

Attribute field types.

enum eChanType {
  CHN_8U = 0, CHN_16S = 1, CHN_16U = 2, CHN_32R = 3,
  CHN_C16U = 4, CHN_C16S = 5, CHN_C32R = 6, CHN_BIT = 7,
  CHN_UNKNOWN = 99
}

Channel pixel data types. More...

enum eSegType {
  SEG_UNKNOWN = -1, SEG_BIT = 101, SEG_VEC = 116, SEG_SIG = 121,
  SEG_TEX = 140, SEG_GEO = 150, SEG_ORB = 160, SEG_LUT = 170,
  SEG_PCT = 171, SEG_BLUT = 172, SEG_BPCT = 173, SEG_BIN = 180,
  SEG_ARR = 181, SEG_SYS = 182, SEG_GCPOLD = 214, SEG_GCP2 = 215
}

Segment types.

Functions

PCIDSKFile * Open (std::string filename, std::string access, const PCIDSKInterfaces *interfaces=NULL)

PCIDSKFile * Create (std::string filename, int pixels, int lines, int channel_count, eChanType *channel_types, std::string options, const PCIDSKInterfaces *interfaces=NULL)

EDBFile * DefaultOpenEDB (std::string filename, std::string access)

void ThrowPCIDSKException (const char *fmt,...)

throw a formatted exception.

const IOInterfaces * GetDefaultIOInterfaces ()

Mutex * DefaultCreateMutex (void)

std::string ShapeFieldTypeName (ShapeFieldType type)

Translate field type into a textual description.

int DataTypeSize (eChanType)

std::string DataTypeName (eChanType)

std::string SegmentTypeName (eSegType)

eChanType GetDataTypeFromName (std::string const &type_name)

Return the segment type code based on the contents of type_name.

bool IsDataTypeComplex (eChanType type)

Return whether or not the data type is complex.

PCIDSKFile * Open (std::string filename, std::string access, const PCIDSKInterfaces *interfaces)

PCIDSKFile * Create (std::string filename, int pixels, int lines, int channel_count, eChanType *channel_types, std::string options, const PCIDSKInterfaces *interfaces)

void ThrowPCIDSKException (const char *fmt,...)

throw a formatted exception.

int DataTypeSize (eChanType chan_type)

std::string DataTypeName (eChanType chan_type)

eChanType GetDataTypeFromName (std::string const &type_name)

Return the segment type code based on the contents of type_name.

bool IsDataTypeComplex (eChanType type)

Return whether or not the data type is complex.

std::string SegmentTypeName (eSegType type)

Detailed Description

Namespace for all PCIDSK Library classes and functions.

Enumeration Type Documentation

enum PCIDSK::eChanType

Channel pixel data types.

Enumerator:

CHN_8U	8 bit unsigned byte
CHN_16S	16 bit signed integer
CHN_16U	16 bit unsigned integer
CHN_32R	32 bit ieee floating point
CHN_C16U	16-bit unsigned integer, complex
CHN_C16S	16-bit signed integer, complex
CHN_C32R	32-bit IEEE-754 Float, complex
CHN_BIT	1bit unsigned (packed bitmap)
CHN_UNKNOWN	unknown channel type

Function Documentation

PCIDSKFile* PCIDSK::Create	(	std::string	filename,
		int	pixels,
		int	lines,
		int	channel_count,
		eChanType *	channel_types,
		std::string	options,
		const PCIDSKInterfaces *	interfaces
	)

Create a PCIDSK (.pix) file.

Parameters:

	filename	the name of the PCIDSK file to create.
	pixels	the width of the new file in pixels.
	lines	the height of the new file in scanlines.
	channel_count	the number of channels to create.
	channel_types	an array of types for all the channels, or NULL for all CHN_8U channels.
	option	creation options (interleaving, etc)
	interfaces	Either NULL to use default interfaces, or a pointer to a populated interfaces object.

Returns:: a pointer to a file object for accessing the PCIDSK file.

PCIDSKFile* PCIDSK::Create	(	std::string	filename,
		int	pixels,
		int	lines,
		int	channel_count,
		eChanType *	channel_types,
		std::string	options,
		const PCIDSKInterfaces *	interfaces
	)

Create a PCIDSK (.pix) file.

Parameters:

	filename	the name of the PCIDSK file to create.
	pixels	the width of the new file in pixels.
	lines	the height of the new file in scanlines.
	channel_count	the number of channels to create.
	channel_types	an array of types for all the channels, or NULL for all CHN_8U channels.
	option	creation options (interleaving, etc)
	interfaces	Either NULL to use default interfaces, or a pointer to a populated interfaces object.

Returns:: a pointer to a file object for accessing the PCIDSK file.

std::string PCIDSK::DataTypeName ( eChanType chan_type )

Return name for the data type.

The returned values are suitable for display to people, and matches the portion of the name after the underscore (ie. "8U" for CHN_8U.

Parameters:

chan_type

the channel type enumeration value to be translated.

Returns:: a string representing the data type.

std::string PCIDSK::DataTypeName ( eChanType chan_type )

Return name for the data type.

The returned values are suitable for display to people, and matches the portion of the name after the underscore (ie. "8U" for CHN_8U.

Parameters:

chan_type

the channel type enumeration value to be translated.

Returns:: a string representing the data type.

int PCIDSK::DataTypeSize ( eChanType chan_type )

Return size of data type.

Note that type CHN_BIT exists to represent one bit backed data from bitmap segments, but because the return of this functions is measured in bytes, the size of a CHN_BIT pixel cannot be properly returned (one eighth of a byte), so "1" is returned instead.

Parameters:

chan_type

the channel type enumeration value.

Returns:: the size of the passed data type in bytes, or zero for unknown values.

int PCIDSK::DataTypeSize ( eChanType chan_type )

Return size of data type.

Parameters:

chan_type

the channel type enumeration value.

Returns:: the size of the passed data type in bytes, or zero for unknown values.

eChanType PCIDSK::GetDataTypeFromName ( std::string const & type_name )

Return the segment type code based on the contents of type_name.

Parameters:

the

type name, as a string

Returns:: the channel type code

eChanType PCIDSK::GetDataTypeFromName ( std::string const & type_name )

Return the segment type code based on the contents of type_name.

Parameters:

the

type name, as a string

Returns:: the channel type code

bool PCIDSK::IsDataTypeComplex ( eChanType type )

Return whether or not the data type is complex.

Parameters:

the

type

Returns:: true if the data type is complex, false otherwise

bool PCIDSK::IsDataTypeComplex ( eChanType type )

Return whether or not the data type is complex.

Parameters:

the

type

Returns:: true if the data type is complex, false otherwise

PCIDSKFile* PCIDSK::Open	(	std::string	filename,
		std::string	access,
		const PCIDSKInterfaces *	interfaces
	)

Open a PCIDSK (.pix) file.

This function attempts to open the named file, with the indicated access and the provided set of system interface methods.

Parameters:

	filename	the name of the PCIDSK file to access.
	access	either "r" for read-only, or "r+" for read-write access.
	interfaces	Either NULL to use default interfaces, or a pointer to a populated interfaces object.

Returns:: a pointer to a file object for accessing the PCIDSK file.

PCIDSKFile* PCIDSK::Open	(	std::string	filename,
		std::string	access,
		const PCIDSKInterfaces *	interfaces
	)

Open a PCIDSK (.pix) file.

This function attempts to open the named file, with the indicated access and the provided set of system interface methods.

Parameters:

	filename	the name of the PCIDSK file to access.
	access	either "r" for read-only, or "r+" for read-write access.
	interfaces	Either NULL to use default interfaces, or a pointer to a populated interfaces object.

Returns:: a pointer to a file object for accessing the PCIDSK file.

std::string PCIDSK::SegmentTypeName ( eSegType type )

Return name for segment type.

Returns a short name for the segment type code passed in. This is normally the portion of the enumeration name that comes after the underscore - ie. "BIT" for SEG_BIT.

Parameters:

type

the segment type code.

Returns:: the string for the segment type.

std::string PCIDSK::SegmentTypeName ( eSegType type )

Return name for segment type.

Returns a short name for the segment type code passed in. This is normally the portion of the enumeration name that comes after the underscore - ie. "BIT" for SEG_BIT.

Parameters:

type

the segment type code.

Returns:: the string for the segment type.

std::string PCIDSK::ShapeFieldTypeName ( ShapeFieldType type ) [inline]

Translate field type into a textual description.

Parameters:

type

the type enumeration value to translate.

Returns:: name for field type.

void PCIDSK::ThrowPCIDSKException	(	const char *	fmt,
			...
	)

throw a formatted exception.

This function throws a PCIDSK Exception by reference after formatting the message using the given printf style format and arguments. This function exists primarily so that throwing an exception can be done in one line of code, instead of declaring an exception and then throwing it.

Parameters:

	fmt	the printf style format (eg. "Illegal value:%d")
	...	additional arguments as required by the format string.

void PCIDSK::ThrowPCIDSKException	(	const char *	fmt,
			...
	)

throw a formatted exception.

Parameters:

	fmt	the printf style format (eg. "Illegal value:%d")
	...	additional arguments as required by the format string.

Generated on Fri Jul 16 16:01:31 2010 for libpcidsk by

1.5.1


Classes
class	PCIDSKAPModelIOParams
class	PCIDSKAPModelEOParams
class	PCIDSKAPModelSegment
class	PCIDSKChannel
	Interface to one PCIDSK channel (band) or bitmap segment. More...
class	EDBFile
	External Database Interface class. More...
class	PCIDSKException
	Generic SDK Exception. More...
class	PCIDSKFile
	Top interface to PCIDSK (.pix) files. More...
class	GCP
	PCIDSK Generic GCP Structure. More...
class	PCIDSKGCPSegment
	Interface to PCIDSK GCP segment. More...
class	PCIDSKGeoref
	Interface to PCIDSK georeferencing segment. More...
class	PCIDSKInterfaces
	Collection of PCIDSK hookable interfaces. More...
class	IOInterfaces
	IO Interface class. More...
class	Mutex
	Mutex interface class. More...
class	PCIDSK_PCT
	Interface to PCIDSK pseudo-color segment. More...
class	PCIDSKRPCSegment
	Interface to PCIDSK RPC segment. More...
class	PCIDSKSegment
	Public tnterface for the PCIDSK Segment Type. More...
struct	ShapeVertex
	Structure for an x,y,z point. More...
class	ShapeField
	Attribute field value. More...
class	PCIDSK_TEX
	Interface to PCIDSK text segment. More...
class	PCIDSKVectorSegment
	Interface to PCIDSK vector segment. More...
class	ShapeIterator
	Iterator over shapeids in a vector segment. More...
Typedefs
typedef int32	ShapeId
	Type used for shape identifier, use constant NullShapeId as a NULL value.
Enumerations
enum	UnitCode { UNIT_US_FOOT = 1, UNIT_METER = 2, UNIT_DEGREE = 4, UNIT_INTL_FOOT = 5 }
enum	ShapeFieldType { FieldTypeNone = 0, FieldTypeFloat = 1, FieldTypeDouble = 2, FieldTypeString = 3, FieldTypeInteger = 4, FieldTypeCountedInt = 5 }
	Attribute field types.
enum	eChanType { CHN_8U = 0, CHN_16S = 1, CHN_16U = 2, CHN_32R = 3, CHN_C16U = 4, CHN_C16S = 5, CHN_C32R = 6, CHN_BIT = 7, CHN_UNKNOWN = 99 }
	Channel pixel data types. More...
enum	eSegType { SEG_UNKNOWN = -1, SEG_BIT = 101, SEG_VEC = 116, SEG_SIG = 121, SEG_TEX = 140, SEG_GEO = 150, SEG_ORB = 160, SEG_LUT = 170, SEG_PCT = 171, SEG_BLUT = 172, SEG_BPCT = 173, SEG_BIN = 180, SEG_ARR = 181, SEG_SYS = 182, SEG_GCPOLD = 214, SEG_GCP2 = 215 }
	Segment types.
Functions
PCIDSKFile *	Open (std::string filename, std::string access, const PCIDSKInterfaces *interfaces=NULL)
PCIDSKFile *	Create (std::string filename, int pixels, int lines, int channel_count, eChanType channel_types, std::string options, const PCIDSKInterfaces interfaces=NULL)
EDBFile *	DefaultOpenEDB (std::string filename, std::string access)
void	ThrowPCIDSKException (const char *fmt,...)
	throw a formatted exception.
const IOInterfaces *	GetDefaultIOInterfaces ()
Mutex *	DefaultCreateMutex (void)
std::string	ShapeFieldTypeName (ShapeFieldType type)
	Translate field type into a textual description.
int	DataTypeSize (eChanType)
std::string	DataTypeName (eChanType)
std::string	SegmentTypeName (eSegType)
eChanType	GetDataTypeFromName (std::string const &type_name)
	Return the segment type code based on the contents of type_name.
bool	IsDataTypeComplex (eChanType type)
	Return whether or not the data type is complex.
PCIDSKFile *	Open (std::string filename, std::string access, const PCIDSKInterfaces *interfaces)
PCIDSKFile *	Create (std::string filename, int pixels, int lines, int channel_count, eChanType channel_types, std::string options, const PCIDSKInterfaces interfaces)
void	ThrowPCIDSKException (const char *fmt,...)
	throw a formatted exception.
int	DataTypeSize (eChanType chan_type)
std::string	DataTypeName (eChanType chan_type)
eChanType	GetDataTypeFromName (std::string const &type_name)
	Return the segment type code based on the contents of type_name.
bool	IsDataTypeComplex (eChanType type)
	Return whether or not the data type is complex.
std::string	SegmentTypeName (eSegType type)