MrSID Decode SDK for Raster Reference Manual
9.0.0.3864
|
class for reading RAW files More...
#include <lti_rawImageReader.h>
Public Member Functions | |
LT_STATUS | initialize (LTIOStreamInf *stream, const LTIPixel &pixelProps, lt_uint32 width, lt_uint32 height, bool useWorldFile=true) |
initialize (stream) | |
LT_STATUS | initialize (const LTFileSpec &fileSpec, const LTIPixel &pixelProps, lt_uint32 width, lt_uint32 height, bool useWorldFile=true) |
initialize (FileSpec) | |
LT_STATUS | initialize (const char *file, const LTIPixel &pixelProps, lt_uint32 width, lt_uint32 height, bool useWorldFile=true) |
initialize (char*) | |
Properties of the RAW image | |
These must be called prior to calling initialize(), unlike most other SDK objects. | |
void | setStreamOwnership (bool takeOwnership) |
set stream ownership | |
void | setRowBytes (lt_uint32 rowBytes) |
sets the number of bytes in each row | |
void | setLayout (LTILayout layout) |
sets the layout or organization of the raw data | |
void | setSkipBytes (lt_int64 leadingBytes, lt_int64 trailingBytes=0) |
sets the number of bytes to skip at the beginning and end of the file | |
void | setByteOrder (LTIEndian byteOrder) |
sets endianness of input file | |
Static Public Member Functions | |
static LTIRawImageReader * | create (void) |
Protected Member Functions | |
LTIRawImageReader (void) | |
virtual | ~LTIRawImageReader (void) |
LT_STATUS | decodeBegin (const LTIPixel &pixelProps, const LTIScene &fullScene) |
start strip-based read | |
LT_STATUS | decodeStrip (LTISceneBuffer &stripBuffer, const LTIScene &stripScene) |
read a strip from the image | |
LT_STATUS | decodeEnd (void) |
finish strip-based read | |
const char * | getSourceName (void) const |
Protected Attributes | |
LTFileSpec * | m_fileSpec |
This class reads a RAW image.
The RAW format used is simple packed BIP form.
Definition at line 30 of file lti_rawImageReader.h.
LTIRawImageReader::LTIRawImageReader | ( | void | ) | [protected] |
virtual LTIRawImageReader::~LTIRawImageReader | ( | void | ) | [protected, virtual] |
static LTIRawImageReader* LTIRawImageReader::create | ( | void | ) | [static] |
Reimplemented in LTIBBBImageReader.
LT_STATUS LTIRawImageReader::decodeBegin | ( | const LTIPixel & | pixelProps, |
const LTIScene & | fullScene | ||
) | [protected, virtual] |
This function is called by readBegin() to start the actual class-specific work for decoding a scene.
Derived classes must implement this function.
This function should never be called directly.
pixelProps | the band selection |
fullScene | the full scene to be read |
Implements LTIImageStage.
LT_STATUS LTIRawImageReader::decodeEnd | ( | void | ) | [protected, virtual] |
This function is called by readEnd() to complete the actual class-specific work for decoding a scene.
Derived classes must implement this function.
This function should never be called directly.
Implements LTIImageStage.
LT_STATUS LTIRawImageReader::decodeStrip | ( | LTISceneBuffer & | stripBuffer, |
const LTIScene & | stripScene | ||
) | [protected, virtual] |
This function is called by readStrip() to implement the actual class-specific work for decoding a strip of the scene.
Derived classes must implement this function.
This function should never be called directly.
stripBuffer | the buffer to read the pixels into |
stripScene | the scene for this strip being decoded |
Implements LTIImageStage.
const char* LTIRawImageReader::getSourceName | ( | void | ) | const [protected, virtual] |
Implements LTIImageReader.
LT_STATUS LTIRawImageReader::initialize | ( | LTIOStreamInf * | stream, |
const LTIPixel & | pixelProps, | ||
lt_uint32 | width, | ||
lt_uint32 | height, | ||
bool | useWorldFile = true |
||
) |
This function constructs an LTIImageReader using the data in the stream with the image properties specified. The input taken from a stream.
stream | stream containing the RAW image data (may not be NULL) |
pixelProps | the pixel properties of the image (colorspace, datatype, etc) |
width | the width of the image |
height | the height of the image |
useWorldFile | use world file information if available |
LT_STATUS LTIRawImageReader::initialize | ( | const LTFileSpec & | fileSpec, |
const LTIPixel & | pixelProps, | ||
lt_uint32 | width, | ||
lt_uint32 | height, | ||
bool | useWorldFile = true |
||
) |
This function constructs an LTIImageReader using the data in the stream with the image properties specified. The input taken from a stream, and the background and nodata pixels may be specified.
fileSpec | file containing the RAW image data |
pixelProps | the pixel properties of the image (colorspace, datatype, etc) |
width | the width of the image |
height | the height of the image |
useWorldFile | use world file information if available |
LT_STATUS LTIRawImageReader::initialize | ( | const char * | file, |
const LTIPixel & | pixelProps, | ||
lt_uint32 | width, | ||
lt_uint32 | height, | ||
bool | useWorldFile = true |
||
) |
This function constructs an LTIImageReader using the data in the stream with the image properties specified. The input taken from a stream, and the background and nodata pixels may be specified.
file | file containing the RAW image data (may not be NULL) |
pixelProps | the pixel properties of the image (colorspace, datatype, etc) |
width | the width of the image |
height | the height of the image |
useWorldFile | use world file information if available |
void LTIRawImageReader::setByteOrder | ( | LTIEndian | byteOrder | ) |
Sets the byte order or endianness of the input file.
byteOrder | the endian setting to use |
void LTIRawImageReader::setLayout | ( | LTILayout | layout | ) |
Sets the layout or organization of the raw data.
If not set, the default is BIP format.
layout | the layout of the raw data |
void LTIRawImageReader::setRowBytes | ( | lt_uint32 | rowBytes | ) |
Sets the number of bytes in each row.
If not set, the bytes per row is simply the number of data items per row times the size of a data item. (Note that a "data item" in this case may be either a pixel or a sample, depending on the layout being used.)
rowBytes | the number of bytes per row |
void LTIRawImageReader::setSkipBytes | ( | lt_int64 | leadingBytes, |
lt_int64 | trailingBytes = 0 |
||
) |
Sets the number of bytes to skip at the beginning of the file and the end of the file. (The "ending skip bytes" property is sometimes required because LTIRawImageReader::initialize() does a sanity check to make sure the number of data bytes in the file is equal to the number of bytes needed for the given width, height, etc.
leadingBytes | the number of bytes to skip at the top |
trailingBytes | the number of bytes to skip at the bottom |
void LTIRawImageReader::setStreamOwnership | ( | bool | takeOwnership | ) |
Sets the ownership of the stream, to indicate responsibility for deleting the stream when done. This only pertains to objects which were passed a stream in the ctor.
If not set, the default is for the object to not take ownership of the stream.
takeOwnership | set to true to have the reader delete the stream |
LTFileSpec* LTIRawImageReader::m_fileSpec [protected] |
Definition at line 184 of file lti_rawImageReader.h.