MrSID Decode SDK for Raster Reference Manual  9.5.4.4709
LizardTech::NITFReaderManager Class Reference

class for reading an NITF file More...

#include <NITFReaderManager.h>

Inheritance diagram for LizardTech::NITFReaderManager:
LTIImageStageManager LTIReferenceCountedObject

List of all members.

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 createReader (Nitf::ImageReader *&reader, lt_uint32 idx)
 creates a reader for a single segment
LT_STATUS createImageStage (lt_uint32 imageNumber, LTIImageStage *&imageStage)
 creates a reader for a single element, band mapped according to irep
void setCompat_2500B_N2 (bool use2500B)
 COMRAT compliance control.
bool getCompat_2500B_N2 () const
 COMRAT compliance setting.
lt_int64 getFileSize () const
const Nitf::FileHeadergetFileHeader () const
 returns FileHeader metadata
lt_uint32 getNumImageSegments () const
 returns number of image segments
const Nitf::ImageSegmentgetImageSegment (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::GraphicSegmentgetGraphicSegment (lt_uint32 num) const
 returns a graphic segment
lt_uint32 getNumLabelSegments () const
 returns the number of label segments
const Nitf::LabelSegmentgetLabelSegment (lt_uint32 num) const
 returns a label segment
lt_uint32 getNumTextSegments () const
 returns the number of text segments
const Nitf::TextSegmentgetTextSegment (lt_uint32 num) const
 returns a text segment
lt_uint32 getNumDataSegments () const
 returns the number of data segments
const Nitf::DataSegmentgetDataSegment (lt_uint32 num) const
 returns a data segment
lt_uint32 getNumResSegments () const
 returns the number of RES segments
const Nitf::ReservedSegmentgetResSegment (lt_uint32 num) const
 returns a RES segment
const char * getVersionString () const
 returns NITF version information
const Nitf::FileMetadatagetFileMetadata () const
 returns the file-level metadata
const Nitf::SecurityMetadatagetSecurityMetadata () const
 returns file-level security metadata
LTFileSpecgetFileSpec () const

Static Public Member Functions

static NITFReaderManagercreate (void)

Protected Member Functions

 NITFReaderManager (void)
virtual ~NITFReaderManager (void)

Detailed Description

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.


Constructor & Destructor Documentation

virtual LizardTech::NITFReaderManager::~NITFReaderManager ( void  ) [protected, virtual]

Member Function Documentation

LT_STATUS LizardTech::NITFReaderManager::createImageStage ( lt_uint32  imageNumber,
LTIImageStage *&  imageStage 
) [virtual]

This function is used to create an LTIImageStage pipeline including the reader itself fronted by a bandmap filter accommodating images that are not in RGB band order.

Note: the index used is zero-based for consistency with this virtual method, in contrast to the createReader() method which uses a one-based segment index.

Parameters:
imageNumberindex of the image segment (zero-based index)
imageStagethe created band-mapped reader pipeline
Returns:
status code

Reimplemented from LTIImageStageManager.

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.

Parameters:
readerthe created segment reader
idxindex of the image segment (one-based index)
Returns:
status code

Returns the 2500B compatability setting; see the setCompat_2500B_N2() function for details.

Returns:
true iff 200B / Note 2 formatting is being used

This function returns an object representing a data segment.

Parameters:
numthe index of the segment to return (numbered starting with 1)
Returns:
the segment object

This function returns an object representing a graphic segment.

Parameters:
numthe index of the segment to return (numbered starting with 1)
Returns:
the segment object

This function returns an object representing an image segment. (Note this object does not support accessing the pixel data; use createReader() for that.)

Parameters:
numthe index of the segment to return (numbered starting with 1)
Returns:
the segment object

This function returns an object representing a label segment.

Parameters:
numthe index of the segment to return (numbered starting with 1)
Returns:
the segment object

This function returns an object representing a RES segment.

Parameters:
numthe index of the segment to return (numbered starting with 1)
Returns:
the segment object

This function returns an object representing a text segment.

Parameters:
numthe index of the segment to return (numbered starting with 1)
Returns:
the segment object
LT_STATUS LizardTech::NITFReaderManager::initialize ( const LTFileSpec fileSpec,
bool  useWorldFile = true 
)
Parameters:
fileSpecthe NITF file to be opened
useWorldFileindicates world file to be used for geo coords (applies to the first image segment only)
Returns:
success or failure
Parameters:
streamthe NITF stream to be opened
Returns:
success or failure

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().

Parameters:
use2500Bset to true for 2500B/Note2 formatting

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