LizardTech::Nitf::ImageSegment Class Reference
represents a image segment in an existing NITF file
More...
#include <ImageSegment.h>
List of all members.
Public Member Functions |
| ImageSegment (NITFReaderManager &, LTIOStreamInf &, int segmentNumber, lt_int64 headerOffset, lt_int64 headerLength, lt_int64 dataOffset, lt_int64 dataLength) |
| ~ImageSegment () |
LT_STATUS | initialize () |
| initializer
|
const char * | getIID1 () const |
| returns the IID1 field of the image
|
Format | getFormat () const |
| returns the format (JPEG, RAW, JP2, etc) of the image
|
Layout | getLayout () const |
| returns the layout (interleaved, blocked, etc) of the image
|
bool | isBlocked () const |
| returns true iff the image is blocked
|
bool | isMasked () const |
| returns true iff the image is masked
|
const LTIPixel & | getPixelProps () const |
| returns the pixel type of the image
|
lt_uint32 | getWidth () const |
| returns the width of the image, in pixels
|
lt_uint32 | getHeight () const |
| returns the height of the image, in pixels
|
int | getBlockWidth () const |
| returns the width of a block, in pixels (corresponds to the NPPBH field)
|
int | getBlockHeight () const |
| returns the height of a block, in pixels (corresponds to the NPPBV field)
|
int | getBlocksPerRow () const |
| returns the number of blocks per row in the image (corresponds to the NBPR field)
|
int | getBlocksPerCol () const |
| returns the number of blocks per row in the image (corresponds to the NBPC field)
|
int | getNBPP () const |
| returns the number of bits per pixel used in the image (corresponds to the NBPP field)
|
int | getNBANDS () const |
| returns the number of bands in the image (corresponds to the NBANDS field)
|
int | getILOCr () const |
int | getILOCc () const |
const lt_uint8 * | getPadValue () const |
lt_uint64 | getBlockOffset (lt_uint32 index) const |
lt_uint64 | getNextBlockOffset (lt_uint32 index) const |
bool | isMaskedBlock (lt_uint32 index) const |
LT_STATUS | isSupported () const |
LT_STATUS | addMetadataLocal (LTIMetadataDatabase &db) const |
LT_STATUS | createDataStream (LTIOSubStream *&) const |
bool | hasGeoInfo (void) const |
LT_STATUS | setGeoCoord (LTIGeoCoord &) const |
const ImageSegmentMetadata * | getImageMetadata () const |
| returns the metadata object associated with the image
|
Detailed Description
This class represents an image segment in an NITF file. To access the image segment of a file, retrieve the ImageSegment from the NITFReaderManager class.
This class exposes some basic properties of the image in the segment.
This class does not implement the renderable image, however. Use the createImage() function of the NITFReaderManager to access an ImageReader (which is an LTIImageReader).
Definition at line 44 of file ImageSegment.h.
Constructor & Destructor Documentation
LizardTech::Nitf::ImageSegment::ImageSegment |
( |
NITFReaderManager & |
, |
|
|
LTIOStreamInf & |
, |
|
|
int |
segmentNumber, |
|
|
lt_int64 |
headerOffset, |
|
|
lt_int64 |
headerLength, |
|
|
lt_int64 |
dataOffset, |
|
|
lt_int64 |
dataLength | |
|
) |
| | |
LizardTech::Nitf::ImageSegment::~ImageSegment |
( |
|
) |
|
Member Function Documentation
int LizardTech::Nitf::ImageSegment::getBlockHeight |
( |
|
) |
const |
lt_uint64 LizardTech::Nitf::ImageSegment::getBlockOffset |
( |
lt_uint32 |
index |
) |
const |
int LizardTech::Nitf::ImageSegment::getBlocksPerCol |
( |
|
) |
const |
int LizardTech::Nitf::ImageSegment::getBlocksPerRow |
( |
|
) |
const |
int LizardTech::Nitf::ImageSegment::getBlockWidth |
( |
|
) |
const |
Format LizardTech::Nitf::ImageSegment::getFormat |
( |
|
) |
const |
lt_uint32 LizardTech::Nitf::ImageSegment::getHeight |
( |
|
) |
const |
const char* LizardTech::Nitf::ImageSegment::getIID1 |
( |
|
) |
const |
int LizardTech::Nitf::ImageSegment::getILOCc |
( |
|
) |
const |
int LizardTech::Nitf::ImageSegment::getILOCr |
( |
|
) |
const |
Layout LizardTech::Nitf::ImageSegment::getLayout |
( |
|
) |
const |
int LizardTech::Nitf::ImageSegment::getNBANDS |
( |
|
) |
const |
int LizardTech::Nitf::ImageSegment::getNBPP |
( |
|
) |
const |
lt_uint64 LizardTech::Nitf::ImageSegment::getNextBlockOffset |
( |
lt_uint32 |
index |
) |
const |
const lt_uint8* LizardTech::Nitf::ImageSegment::getPadValue |
( |
|
) |
const |
const LTIPixel& LizardTech::Nitf::ImageSegment::getPixelProps |
( |
|
) |
const |
lt_uint32 LizardTech::Nitf::ImageSegment::getWidth |
( |
|
) |
const |
bool LizardTech::Nitf::ImageSegment::hasGeoInfo |
( |
void |
|
) |
const |
LT_STATUS LizardTech::Nitf::ImageSegment::initialize |
( |
|
) |
[virtual] |
This function must be called immediately after the constructor.
- Returns:
- success or failure
Reimplemented from LizardTech::Nitf::Segment.
bool LizardTech::Nitf::ImageSegment::isBlocked |
( |
|
) |
const |
bool LizardTech::Nitf::ImageSegment::isMasked |
( |
|
) |
const |
bool LizardTech::Nitf::ImageSegment::isMaskedBlock |
( |
lt_uint32 |
index |
) |
const |
LT_STATUS LizardTech::Nitf::ImageSegment::isSupported |
( |
|
) |
const |
The documentation for this class was generated from the following file: