LTIRawImageWriter Class Reference

class for writing RAW files More...

#include <lti_rawImageWriter.h>

Inheritance diagram for LTIRawImageWriter:
LTIGeoFileImageWriter LTIImageWriter LTIBBBImageWriter

List of all members.

Public Member Functions

 LTIRawImageWriter (void)
virtual ~LTIRawImageWriter (void)
LT_STATUS initialize (LTIImageStage *imageStage)
 initialization function
LTILayout getLayout () const
virtual LT_STATUS writeBegin (const LTIScene &scene)
 begin an encode (write) operation
virtual LT_STATUS writeStrip (LTISceneBuffer &stripBuffer, const LTIScene &stripScene)
 encode one strip of the scene
void setLayout (LTILayout layout)
 set layout
void setByteOrder (LTIEndian byteOrder)
 set byte order

Protected Attributes

LTILayout m_layout
LTIEndian m_byteOrder

Detailed Description

This class writes an image to a stream in RAW format.

The RAW format used is simple packed BIP form.

Examples:

DecodeMrSIDToRaw.cpp, GeoScene.cpp, and Pipeline.cpp.

Definition at line 30 of file lti_rawImageWriter.h.

Constructor & Destructor Documentation

LTIRawImageWriter::LTIRawImageWriter ( void   ) 
virtual LTIRawImageWriter::~LTIRawImageWriter ( void   )  [virtual]

Member Function Documentation

LTILayout LTIRawImageWriter::getLayout (  )  const [inline]

Definition at line 47 of file lti_rawImageWriter.h.

LT_STATUS LTIRawImageWriter::initialize ( LTIImageStage *  imageStage  ) 

Note that the pointer to the input image stage may not be NULL. The writer does not take ownership of the image stage.

Parameters:
imageStage the source of image data to be written
Examples:
GeoScene.cpp.
void LTIRawImageWriter::setByteOrder ( LTIEndian  byteOrder  ) 

This function is used to determine byte ordering of the output file.

Parameters:
byteOrder the byte ordering to use
void LTIRawImageWriter::setLayout ( LTILayout  layout  ) 

This function is used to determine the layout of the output image, i.e. BIP or BIL or BSQ.

Parameters:
layout the layout to use
virtual LT_STATUS LTIRawImageWriter::writeBegin ( const LTIScene &  scene  )  [virtual]

This function implements the logic for beginning the encoding of the given scene.

The scene must be a valid scene for the underlying image pipeline.

This function is called by write(). Derived classes must implement this function.

Parameters:
scene the scene to decode and output
Returns:
status code indicating success or failure

Reimplemented from LTIGeoFileImageWriter.

Reimplemented in LTIBBBImageWriter.

virtual LT_STATUS LTIRawImageWriter::writeStrip ( LTISceneBuffer &  stripBuffer,
const LTIScene &  stripScene 
) [virtual]

This function implements the logic for actually encoding a given strip of the given scene.

This function is called by write(). Derived classes must implement this function.

Parameters:
stripBuffer the pixels for the current strip
stripScene the scene representing the strip being written
Returns:
status code indicating success or failure

Implements LTIGeoFileImageWriter.

Member Data Documentation

LTIEndian LTIRawImageWriter::m_byteOrder [protected]

Definition at line 74 of file lti_rawImageWriter.h.

LTILayout LTIRawImageWriter::m_layout [protected]

Definition at line 73 of file lti_rawImageWriter.h.

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