MrSID Decode SDK for Raster Reference Manual
9.0.0.3864
|
class for reading an NITF file More...
#include <NITFReaderManager.h>
Public Member Functions | |
LT_STATUS | initialize (const LTFileSpec &fileSpec, bool useWorldFile=true) |
initialization Creates an NITFReaderManager object from the given file. | |
LT_STATUS | initialize (LTIOStreamInf *stream) |
initialization Creates an NITFReaderManager object from the given stream. | |
LT_STATUS | setTileMaskList (const lt_uint32 *tileMaskList, lt_uint32 tileMaskListLen) |
LT_STATUS | createReader (Nitf::ImageReader *&reader, lt_uint32 idx) |
creates a reader for a single segment | |
LT_STATUS | createImageStage (lt_uint32 imageNumber, LTIImageStage *&imageStage) |
create an image stage | |
void | setCompat_2500B_N2 (bool use2500B) |
COMRAT compliance control. | |
bool | getCompat_2500B_N2 () const |
COMRAT compliance setting. | |
lt_int64 | getFileSize () const |
const Nitf::FileHeader * | getFileHeader () const |
returns FileHeader metadata | |
lt_uint32 | getNumImageSegments () const |
returns number of image segments | |
const Nitf::ImageSegment * | getImageSegment (lt_uint32 num) const |
returns an image segment | |
const char * | getImageSegmentIID1 (lt_uint32 num) const |
returns the IID1 field of the given image segment | |
lt_uint32 | getNumGraphicSegments () const |
returns the number of graphic segments | |
const Nitf::GraphicSegment * | getGraphicSegment (lt_uint32 num) const |
returns a graphic segment | |
lt_uint32 | getNumLabelSegments () const |
returns the number of label segments | |
const Nitf::LabelSegment * | getLabelSegment (lt_uint32 num) const |
returns a label segment | |
lt_uint32 | getNumTextSegments () const |
returns the number of text segments | |
const Nitf::TextSegment * | getTextSegment (lt_uint32 num) const |
returns a text segment | |
lt_uint32 | getNumDataSegments () const |
returns the number of data segments | |
const Nitf::DataSegment * | getDataSegment (lt_uint32 num) const |
returns a data segment | |
lt_uint32 | getNumResSegments () const |
returns the number of RES segments | |
const Nitf::ReservedSegment * | getResSegment (lt_uint32 num) const |
returns a RES segment | |
const char * | getVersionString () const |
returns NITF version information | |
const Nitf::FileMetadata * | getFileMetadata () const |
returns the file-level metadata | |
const Nitf::SecurityMetadata * | getSecurityMetadata () const |
returns file-level security metadata | |
LTFileSpec * | getFileSpec () const |
Static Public Member Functions | |
static NITFReaderManager * | create (void) |
Protected Member Functions | |
NITFReaderManager (void) | |
virtual | ~NITFReaderManager (void) |
This class is the main entry point for reading from an NITF file. You should initially construct a NITFReaderManager, then use the functions it provides to access the segments in the image, such as getImageSegment() or getTextSegment.
To extract pixels from an image, you need to createReader() for the image segment desired. This will return an object derived from LTIImageReader which can be used for decode requests.
Definition at line 53 of file NITFReaderManager.h.
LizardTech::NITFReaderManager::NITFReaderManager | ( | void | ) | [protected] |
virtual LizardTech::NITFReaderManager::~NITFReaderManager | ( | void | ) | [protected, virtual] |
static NITFReaderManager* LizardTech::NITFReaderManager::create | ( | void | ) | [static] |
LT_STATUS LizardTech::NITFReaderManager::createImageStage | ( | lt_uint32 | imageNumber, |
LTIImageStage *& | imageStage | ||
) | [virtual] |
Note when done with the image stage call imageStage->release().
imageNumber | number of the image (zero based) |
imageStage | a pointer to the created image stage |
Reimplemented from LTIImageStageManager.
LT_STATUS LizardTech::NITFReaderManager::createReader | ( | Nitf::ImageReader *& | reader, |
lt_uint32 | idx | ||
) |
This function is used to create an ImageReader for a single given image segment, specified by number.
The reader is allocated and initialized by this function, but the caller has ownership of the object.
reader | the created segment reader |
idx | index of the image segment (one-based index) |
bool LizardTech::NITFReaderManager::getCompat_2500B_N2 | ( | ) | const |
Returns the 2500B compatability setting; see the setCompat_2500B_N2() function for details.
const Nitf::DataSegment* LizardTech::NITFReaderManager::getDataSegment | ( | lt_uint32 | num | ) | const |
This function returns an object representing a data segment.
num | the index of the segment to return (numbered starting with 1) |
const Nitf::FileHeader* LizardTech::NITFReaderManager::getFileHeader | ( | ) | const |
const Nitf::FileMetadata* LizardTech::NITFReaderManager::getFileMetadata | ( | ) | const |
lt_int64 LizardTech::NITFReaderManager::getFileSize | ( | ) | const |
const Nitf::GraphicSegment* LizardTech::NITFReaderManager::getGraphicSegment | ( | lt_uint32 | num | ) | const |
This function returns an object representing a graphic segment.
num | the index of the segment to return (numbered starting with 1) |
const Nitf::ImageSegment* LizardTech::NITFReaderManager::getImageSegment | ( | lt_uint32 | num | ) | const |
This function returns an object representing an image segment. (Note this object does not support accessing the pixel data; use createReader() for that.)
num | the index of the segment to return (numbered starting with 1) |
const char* LizardTech::NITFReaderManager::getImageSegmentIID1 | ( | lt_uint32 | num | ) | const |
const Nitf::LabelSegment* LizardTech::NITFReaderManager::getLabelSegment | ( | lt_uint32 | num | ) | const |
This function returns an object representing a label segment.
num | the index of the segment to return (numbered starting with 1) |
const Nitf::ReservedSegment* LizardTech::NITFReaderManager::getResSegment | ( | lt_uint32 | num | ) | const |
This function returns an object representing a RES segment.
num | the index of the segment to return (numbered starting with 1) |
const Nitf::SecurityMetadata* LizardTech::NITFReaderManager::getSecurityMetadata | ( | ) | const |
const Nitf::TextSegment* LizardTech::NITFReaderManager::getTextSegment | ( | lt_uint32 | num | ) | const |
This function returns an object representing a text segment.
num | the index of the segment to return (numbered starting with 1) |
const char* LizardTech::NITFReaderManager::getVersionString | ( | ) | const |
LT_STATUS LizardTech::NITFReaderManager::initialize | ( | const LTFileSpec & | fileSpec, |
bool | useWorldFile = true |
||
) |
fileSpec | the NITF file to be opened |
useWorldFile | indicates world file to be used for geo coords (applies to the first image segment only) |
stream | the NITF stream to be opened |
void LizardTech::NITFReaderManager::setCompat_2500B_N2 | ( | bool | use2500B | ) |
This function is used to control whether or not the COMRAT field is to be read. The 2500C specification requires this field be present; the 2500B Note 2 specification does not. This function is used to indicate which version of the specification this file adheres to.
The default is false, i.e. 2500C formatting.
This function must be called prior to initialize().
use2500B | set to true for 2500B/Note2 formatting |
LT_STATUS LizardTech::NITFReaderManager::setTileMaskList | ( | const lt_uint32 * | tileMaskList, |
lt_uint32 | tileMaskListLen | ||
) |