reader for MrSID images (MG2, MG3 and MG4)
More...
#include <MrSIDImageReader.h>
List of all members.
Detailed Description
This class supports reading MrSID/MG2, MrSID/MG3, and MrSID/MG4 raster images, including MG3 and MG4 composites.
- Examples:
- DecodeMrSIDBandSelection.cpp, DecodeMrSIDToMemory.cpp, DecodeMrSIDToRaw.cpp, DecodeMrSIDToTIFF.cpp, ErrorHandling.cpp, GeoScene.cpp, ImageInfo.cpp, InterruptDelegate.cpp, MetadataDump.cpp, ProgressDelegate.cpp, and SceneBuffer.cpp.
Definition at line 35 of file MrSIDImageReader.h.
Constructor & Destructor Documentation
Member Function Documentation
- Examples:
- DecodeMrSIDBandSelection.cpp, DecodeMrSIDToMemory.cpp, DecodeMrSIDToRaw.cpp, DecodeMrSIDToTIFF.cpp, ErrorHandling.cpp, GeoScene.cpp, ImageInfo.cpp, InterruptDelegate.cpp, MetadataDump.cpp, ProgressDelegate.cpp, and SceneBuffer.cpp.
Returns the "cost" to encode this scene, for use by those image writers which have usage metering enabled. The typical cost is equal to the nominal image size (width * height * numBands * bytesPerSample), but this is overridden for special situations, e.g. the mosaic filter.
- Parameters:
-
scene | the scene to be charged for |
- Returns:
- the cost to encode the given scene
Reimplemented from LTIImageFilter.
This function gets the maximun number of worker threads that can be used during a decode request.
- See also:
- setMaxWorkerThreads() for details.
- Returns:
- the maximum number of worker threads that may be used
Implements MrSIDImageReaderInterface.
This function returns a bitfield describing what kinds of modifications have been made to the image during and since its initial encoding.
- Parameters:
-
scene | the area pertaining to this request |
- Returns:
- a bitfield itemizing the encoding modifications
Reimplemented from LTIImageFilter.
Construct a MrSID reader from the given file.
- Parameters:
-
fileSpec | file containing MrSID image |
useWorldFile | incorporate world file data when reading image |
memoryUsage | control memory resource usage |
streamUsage | control stream resource usage |
- Examples:
- DecodeMrSIDBandSelection.cpp, DecodeMrSIDToMemory.cpp, DecodeMrSIDToRaw.cpp, DecodeMrSIDToTIFF.cpp, ErrorHandling.cpp, GeoScene.cpp, ImageInfo.cpp, InterruptDelegate.cpp, MetadataDump.cpp, ProgressDelegate.cpp, and SceneBuffer.cpp.
Construct a MrSID reader from the given stream.
- Parameters:
-
stream | stream containing MrSID image (may not be NULL) |
worldFileStream | stream containing world file data (may be NULL) |
memoryUsage | control memory resource usage |
streamUsage | control stream resource usage |
Returns true iff the image is password-protected. If the image is locked, the setPasswordDelegate() or setPassword() function must be used to provide the decoder with information to decrypt the image as decode requests are processed.
- Returns:
- true, if image is password-protected
Implements MrSIDImageReaderInterface.
This function sets the maximum number of worker threads that can be used during a decode request.
- Parameters:
-
numThreads | the maximum number of threads to use, including the calling thread numThreads < 1 defaults to the number of logical cores |
- Note:
- : The internal decoder may use fewer threads. For example, MG2 does not use wroker threads.
-
: The internal decoder may limit the number of threads to the number of logical core on the system.
Implements MrSIDImageReaderInterface.
- Examples:
- DecodeMrSIDToMemory.cpp.
Member Data Documentation
The documentation for this class was generated from the following file: