Nitf::ImageSegment Class Reference

represents a image segment in an existing NITF file More...

#include <ImageSegment.h>

Inheritance diagram for Nitf::ImageSegment:

Nitf::Segment

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 LTIPixelgetPixelProps () 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_uint8getPadValue () const
lt_uint32 getBlockOffset (lt_uint32 index) const
lt_uint32 getNextBlockOffset (lt_uint32 index) const
bool isPaddedBlock (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 ImageSegmentMetadatagetImageMetadata () 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

Nitf::ImageSegment::ImageSegment ( NITFReaderManager &  ,
LTIOStreamInf ,
int  segmentNumber,
lt_int64  headerOffset,
lt_int64  headerLength,
lt_int64  dataOffset,
lt_int64  dataLength 
)

Nitf::ImageSegment::~ImageSegment (  ) 


Member Function Documentation

LT_STATUS Nitf::ImageSegment::initialize (  )  [virtual]

This function must be called immediately after the constructor.

Returns:
success or failure

Reimplemented from Nitf::Segment.

const char* Nitf::ImageSegment::getIID1 (  )  const

Format Nitf::ImageSegment::getFormat (  )  const

Layout Nitf::ImageSegment::getLayout (  )  const

bool Nitf::ImageSegment::isBlocked (  )  const

bool Nitf::ImageSegment::isMasked (  )  const

const LTIPixel& Nitf::ImageSegment::getPixelProps (  )  const

lt_uint32 Nitf::ImageSegment::getWidth (  )  const

lt_uint32 Nitf::ImageSegment::getHeight (  )  const

int Nitf::ImageSegment::getBlockWidth (  )  const

int Nitf::ImageSegment::getBlockHeight (  )  const

int Nitf::ImageSegment::getBlocksPerRow (  )  const

int Nitf::ImageSegment::getBlocksPerCol (  )  const

int Nitf::ImageSegment::getNBPP (  )  const

int Nitf::ImageSegment::getNBANDS (  )  const

int Nitf::ImageSegment::getILOCr (  )  const

int Nitf::ImageSegment::getILOCc (  )  const

const lt_uint8* Nitf::ImageSegment::getPadValue (  )  const

lt_uint32 Nitf::ImageSegment::getBlockOffset ( lt_uint32  index  )  const

lt_uint32 Nitf::ImageSegment::getNextBlockOffset ( lt_uint32  index  )  const

bool Nitf::ImageSegment::isPaddedBlock ( lt_uint32  index  )  const

LT_STATUS Nitf::ImageSegment::isSupported (  )  const

LT_STATUS Nitf::ImageSegment::addMetadataLocal ( LTIMetadataDatabase db  )  const [virtual]

Implements Nitf::Segment.

LT_STATUS Nitf::ImageSegment::createDataStream ( LTIOSubStream *&   )  const

bool Nitf::ImageSegment::hasGeoInfo ( void   )  const

LT_STATUS Nitf::ImageSegment::setGeoCoord ( LTIGeoCoord  )  const

const ImageSegmentMetadata* Nitf::ImageSegment::getImageMetadata (  )  const


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

LizardTech