LizardTech::NITFReaderManager Class Reference
class for reading an NITF file
More...
#include <NITFReaderManager.h>
List of all members.
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
LizardTech::NITFReaderManager::NITFReaderManager |
( |
void |
|
) |
[protected] |
virtual LizardTech::NITFReaderManager::~NITFReaderManager |
( |
void |
|
) |
[protected, virtual] |
Member Function Documentation
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:
-
| imageNumber | index of the image segment (zero-based index) |
| imageStage | the 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:
-
| reader | the created segment reader |
| idx | index of the image segment (one-based index) |
- Returns:
- status code
bool LizardTech::NITFReaderManager::getCompat_2500B_N2 |
( |
|
) |
const |
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:
-
| num | the index of the segment to return (numbered starting with 1) |
- Returns:
- the segment object
lt_int64 LizardTech::NITFReaderManager::getFileSize |
( |
|
) |
const |
LTFileSpec* LizardTech::NITFReaderManager::getFileSpec |
( |
|
) |
const |
This function returns an object representing a graphic segment.
- Parameters:
-
| num | the 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:
-
| num | the index of the segment to return (numbered starting with 1) |
- Returns:
- the segment object
const char* LizardTech::NITFReaderManager::getImageSegmentIID1 |
( |
lt_uint32 |
num |
) |
const |
This function returns an object representing a label segment.
- Parameters:
-
| num | the index of the segment to return (numbered starting with 1) |
- Returns:
- the segment object
lt_uint32 LizardTech::NITFReaderManager::getNumDataSegments |
( |
|
) |
const |
lt_uint32 LizardTech::NITFReaderManager::getNumGraphicSegments |
( |
|
) |
const |
lt_uint32 LizardTech::NITFReaderManager::getNumImageSegments |
( |
|
) |
const |
lt_uint32 LizardTech::NITFReaderManager::getNumLabelSegments |
( |
|
) |
const |
lt_uint32 LizardTech::NITFReaderManager::getNumResSegments |
( |
|
) |
const |
lt_uint32 LizardTech::NITFReaderManager::getNumTextSegments |
( |
|
) |
const |
This function returns an object representing a RES segment.
- Parameters:
-
| num | the index of the segment to return (numbered starting with 1) |
- Returns:
- the segment object
This function returns an object representing a text segment.
- Parameters:
-
| num | the index of the segment to return (numbered starting with 1) |
- Returns:
- the segment object
const char* LizardTech::NITFReaderManager::getVersionString |
( |
|
) |
const |
- Parameters:
-
| stream | the NITF stream to be opened |
- Returns:
- success or failure
LT_STATUS LizardTech::NITFReaderManager::initialize |
( |
const LTFileSpec & |
fileSpec, |
|
|
bool |
useWorldFile = true | |
|
) |
| | |
- Parameters:
-
| fileSpec | the NITF file to be opened |
| useWorldFile | indicates world file to be used for geo coords (applies to the first image segment only) |
- Returns:
- success or failure
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().
- Parameters:
-
| use2500B | set to true for 2500B/Note2 formatting |
The documentation for this class was generated from the following file: