TIFFImageWriter Class Reference

writes an image stage to a TIFF file More...

#include <TIFFImageWriter.h>

Inheritance diagram for TIFFImageWriter:
LTIGeoFileImageWriter LTIImageWriter GeoTIFFImageWriter

List of all members.

Public Member Functions

 TIFFImageWriter (bool writeGeoTIFF=false)
 constructor
virtual ~TIFFImageWriter ()
LT_STATUS initialize (LTIImageStage *image)
void setWriteResolution (bool enable)
 Output resolution information.
void setAllowWritingBigTIFF (bool allowBigTIFF)
 Write a BigTIFF if the the scene may produce a file greater than 4GB.
void setForceWritingBigTIFF (bool forceBigTIFF)
 Write a BigTIFF.
LT_STATUS writeBegin (const LTIScene &scene)
 begin an encode (write) operation
LT_STATUS writeStrip (LTISceneBuffer &stripBuffer, const LTIScene &stripScene)
 encode one strip of the scene
LT_STATUS writeEnd ()
 complete an encode (write) operation
void setEndian (LTIEndian value)

Detailed Description

This class writes an image stage to a TIFF file.

Examples:

DecodeMrSIDToTIFF.cpp.

Definition at line 35 of file TIFFImageWriter.h.

Constructor & Destructor Documentation

TIFFImageWriter::TIFFImageWriter ( bool  writeGeoTIFF = false  ) 

Creates a writer for TIFF images.

Parameters:
writeGeoTIFF if true the writer will include GeoTIFF tags
virtual TIFFImageWriter::~TIFFImageWriter (  )  [virtual]

Member Function Documentation

LT_STATUS TIFFImageWriter::initialize ( LTIImageStage *  image  ) 
void TIFFImageWriter::setAllowWritingBigTIFF ( bool  allowBigTIFF  ) 
Parameters:
allowBigTIFF set to true to write a BigTIFF if needed
void TIFFImageWriter::setEndian ( LTIEndian  value  ) 
void TIFFImageWriter::setForceWritingBigTIFF ( bool  forceBigTIFF  ) 
Parameters:
forceBigTIFF set to true to write a BigTIFF
void TIFFImageWriter::setWriteResolution ( bool  enable  ) 

Set this to false to prevent writing normal TIFF resolution information.

The default is to write this information.

Parameters:
enable set to true to write resolution information
LT_STATUS TIFFImageWriter::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.

LT_STATUS TIFFImageWriter::writeEnd (  )  [virtual]

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

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

Returns:
status code indicating success or failure

Reimplemented from LTIGeoFileImageWriter.

LT_STATUS TIFFImageWriter::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.

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