MrSID Decode SDK for Raster Reference Manual  9.5.4.4709
Nitf::ImageReader Class Referenceabstract

class for representing an NITF image segment as an LTIImageReader More...

#include <ImageReader.h>

Inheritance diagram for Nitf::ImageReader:
LTIGeoImageReader LTIImageReader LTIOverrideDimensions< LTIOverridePixelProps< LTIOverrideBackgroundPixel< LTIOverrideGeoCoord< LTIOverrideMagnification< LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > > > > > > > LTIOverridePixelProps< LTIOverrideBackgroundPixel< LTIOverrideGeoCoord< LTIOverrideMagnification< LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > > > > > > LTIOverrideDimensionsData LTIOverrideBackgroundPixel< LTIOverrideGeoCoord< LTIOverrideMagnification< LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > > > > > LTIOverridePixelPropsData LTIOverrideGeoCoord< LTIOverrideMagnification< LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > > > > LTIOverrideBackgroundPixelData LTIOverrideMagnification< LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > > > LTIOverrideGeoCoordData LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > > LTIOverrideMagnificationData LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > LTIOverrideIsSelectiveData LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > LTIOverrideStripHeightData LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > LTIOverrideDelegatesData LTIOverrideMetadata< LTIImageStage > LTIOverridePixelLookupTablesData LTIImageStage LTIOverrideMetadataData LTIImage LTIReferenceCountedObject

Public Member Functions

const char * getIID1 () const
 returns the IID1 field for the segment More...
 
lt_int64 getPhysicalFileSize () const
 
NITFReaderManager & getManager () const
 
Format getFormat () const
 returns the compression format of the segment More...
 
Layout getLayout () const
 returns the pixel layout of the segment More...
 
bool isBlocked () const
 returns true iff the image segment is in blocked form More...
 
bool isMasked () const
 returns true iff block masking is used in the image segment More...
 
int getSegmentNumber () const
 returns the index of this image segment More...
 
const ImageSegmentMetadatagetImageMetadata () const
 returns the image segment metadata object for this segment More...
 
const SecurityMetadatagetSecurityMetadata () const
 returns the security metadata object for this segment More...
 
LT_STATUS getDimsAtMag (double mag, lt_uint32 &width, lt_uint32 &height) const =0
 get image width and height at given magnification More...
 
- Public Member Functions inherited from LTIImageReader
lt_uint32 getModifications (const LTIScene &scene) const
 get the modification bitfield for this image More...
 
LT_STATUS getMetadataBlob (const char *type, LTIOStreamInf *&stream) const
 extract the metadata associated with the image of the given type More...
 
LTIMaskSource * getMask () const
 
bool getPipelineInfo (LTIPipelineInfo info) const
 
lt_int64 getEncodingCost (const LTIScene &scene) const
 get the cost to encode this scene More...
 
bool getReaderScene (const LTIScene &decodeScene, LTIScene &readerScene) const
 get the underlying scene to be used More...
 
LT_STATUS readBegin (const LTIPixel &pixelProps, const LTIScene &fullScene)
 start strip-based read More...
 
LT_STATUS readStrip (LTISceneBuffer &buffer, const LTIScene &stripScene)
 read a strip from the image More...
 
LT_STATUS readEnd (void)
 finish strip-based read More...
 
- Public Member Functions inherited from LTIOverrideDimensions< LTIOverridePixelProps< LTIOverrideBackgroundPixel< LTIOverrideGeoCoord< LTIOverrideMagnification< LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > > > > > > >
lt_uint32 getWidth () const
 
lt_uint32 getHeight () const
 
- Public Member Functions inherited from LTIOverridePixelProps< LTIOverrideBackgroundPixel< LTIOverrideGeoCoord< LTIOverrideMagnification< LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > > > > > >
const LTIPixelgetPixelProps () const
 
const LTIPixelgetMinDynamicRange () const
 
const LTIPixelgetMaxDynamicRange () const
 
LT_STATUS overridePixelBPS (lt_uint8 bps)
 
LT_STATUS overrideDynamicRange (const LTIPixel &drmin, const LTIPixel &drmax)
 
- Public Member Functions inherited from LTIOverrideBackgroundPixel< LTIOverrideGeoCoord< LTIOverrideMagnification< LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > > > > >
const LTIPixelgetBackgroundPixel () const
 
const LTIPixelgetNoDataPixel () const
 
LT_STATUS overrideBackgroundPixel (const LTIPixel *backgroundPixel)
 
LT_STATUS overrideNoDataPixel (const LTIPixel *nodataPixel)
 
- Public Member Functions inherited from LTIOverrideGeoCoord< LTIOverrideMagnification< LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > > > >
const LTIGeoCoordgetGeoCoord () const
 
bool isGeoCoordImplicit () const
 
LT_STATUS overrideGeoCoord (const LTIGeoCoord &geoCoord)
 
- Public Member Functions inherited from LTIOverrideMagnification< LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > > >
double getMinMagnification () const
 
double getMaxMagnification () const
 
- Public Member Functions inherited from LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > >
bool isSelective () const
 
- Public Member Functions inherited from LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > >
lt_uint32 getStripHeight () const
 
LT_STATUS setStripHeight (lt_uint32 stripHeight)
 
- Public Member Functions inherited from LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > >
void setProgressDelegate (LTIProgressDelegate *delegate)
 
LTIProgressDelegategetProgressDelegate () const
 
void setInterruptDelegate (LTIInterruptDelegate *delegate)
 
LTIInterruptDelegategetInterruptDelegate () const
 
- Public Member Functions inherited from LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > >
const LTIPixelLookupTablegetPixelLookupTable () const
 
LT_STATUS overridePixelLookupTable (const LTIPixelLookupTable *pixelLookupTable)
 
- Public Member Functions inherited from LTIOverrideMetadata< LTIImageStage >
const LTIMetadataDatabasegetMetadata () const
 
LT_STATUS overrideMetadata (const LTIMetadataDatabase &metadata)
 
- Public Member Functions inherited from LTIImageStage
LT_STATUS read (const LTIScene &scene, LTISceneBuffer &buffer)
 read (decode) a scene from the image More...
 
lt_uint32 getNumStrips () const
 get number of strips in scene More...
 
LTIScene getStripScene (lt_uint32 stripNumber) const
 get a strip for current scene More...
 
- Public Member Functions inherited from LTIImage
lt_uint16 getNumBands () const
 get number of bands More...
 
lt_uint16 getNumBandsWithoutAlpha () const
 get number of bands without alpha More...
 
LTIColorSpace getColorSpace () const
 get colorspace More...
 
LTIDataType getDataType () const
 get data type More...
 
bool isNaturalDynamicRange () const
 check if the range is "complete" or not More...
 
lt_int64 getNominalImageSizeWithoutAlpha () const
 get the nominal size of the image, not considering the alpha band More...
 
lt_int64 getNominalImageSizeWithAlpha () const
 get the nominal size of the image, including the alpha band More...
 
void getGeoPoint (LTIPosition position, double &x, double &y) const
 get position of a named point More...
 
LTIPixelcreateBackgroundPixel () const
 return new background pixel More...
 
- Public Member Functions inherited from LTIReferenceCountedObject
virtual void retain (void) const
 increment reference counter More...
 
virtual void release (void) const
 decrement the reference counter and delete the object when the counter is zero More...
 

Protected Member Functions

 ~ImageReader (void)
 
 ImageReader (bool supportBandSelection)
 
const char * getSourceName (void) const
 
LT_STATUS init (LTIOStreamInf *stream, NITFReaderManager *manager, const ImageSegment *imageSegment, bool useWorldFile)
 
LT_STATUS addUnderlyingMetadata (const LTIImageStage &image)
 
LTIScene computeBlockedScene (const LTIScene &scene) const
 
LT_STATUS copyIntoUserBuffer (const LTIScene &dstScene, LTISceneBuffer &dstBuffer) const
 
bool activeSceneContains (const LTIScene &scene) const
 
void putBlockIntoBuffer_SEQ (LTISceneBuffer &cBuffer, lt_uint8 *buf, lt_uint32 blockRow, lt_uint32 blockCol, lt_uint32 blockBand) const
 
void putBlockIntoBuffer_BLOCK (LTISceneBuffer &cBuffer, lt_uint8 *buf, lt_uint32 blockRow, lt_uint32 blockCol) const
 
void putBlockIntoBuffer_PIXEL (LTISceneBuffer &cBuffer, lt_uint8 *buf, lt_uint32 blockRow, lt_uint32 blockCol) const
 
void putBlockIntoBuffer_ROW (LTISceneBuffer &cBuffer, lt_uint8 *buf, lt_uint32 blockRow, lt_uint32 blockCol) const
 
- Protected Member Functions inherited from LTIGeoImageReader
 LTIGeoImageReader (bool supportBandSelection)
 
LT_STATUS init (bool useWorldFile)
 
bool getUseWorldFile () const
 
LT_STATUS readWorldFile (const LTFileSpec &file, bool &changed, bool doUseWorldFileTest=true)
 
LT_STATUS readWorldFile (LTIOStreamInf &stream, bool &changed, bool doUseWorldFileTest=true)
 
- Protected Member Functions inherited from LTIImageReader
 LTIImageReader (bool supportBandSelection)
 
LT_STATUS init (const LTIImage *image=NULL)
 
LT_STATUS loadMetadataIntoObjects (const LTIMetadataDatabase &fileMetadata, LTIPixel &pixelProps, bool updatePixelProps, bool updateGeoCoord)
 
- Protected Member Functions inherited from LTIImageStage
 LTIImageStage (void)
 
virtual ~ LTIImageStage (void)
 
LT_STATUS fillBackground (const LTIScene &scene, LTISceneBuffer &buffer)
 fill the background of the scene More...
 
LT_STATUS fillBackground (const LTIScene &scene, LTISceneBuffer &buffer, const LTIPixel &color)
 fill the scene to given pixel More...
 
bool isBandSelected (const LTIPixel &pixelProps) const
 
virtual LT_STATUS decodeBegin (const LTIPixel &pixelProps, const LTIScene &fullScene)=0
 start strip-based read More...
 
virtual LT_STATUS decodeStrip (LTISceneBuffer &stripBuffer, const LTIScene &stripScene)=0
 read a strip from the image More...
 
virtual LT_STATUS decodeEnd (void)=0
 finish strip-based read More...
 
const LTIScenegetFullScene () const
 get full scene More...
 
- Protected Member Functions inherited from LTIImage
 LTIImage (void)
 
virtual ~ LTIImage (void)
 
- Protected Member Functions inherited from LTIReferenceCountedObject
 LTIReferenceCountedObject (void)
 
virtual ~ LTIReferenceCountedObject (void)
 
- Protected Member Functions inherited from LTIOverrideMetadataData
 LTIOverrideMetadataData ()
 
 ~LTIOverrideMetadataData ()
 
LT_STATUS createMetadata (const LTIMetadataDatabase *metadata)
 
LTIMetadataDatabasegetMetadata ()
 
- Protected Member Functions inherited from LTIOverridePixelLookupTablesData
 LTIOverridePixelLookupTablesData ()
 
 ~LTIOverridePixelLookupTablesData ()
 
LT_STATUS setPixelLookupTable (const LTIPixelLookupTable *pixelLookupTable)
 set the color lookup table More...
 
- Protected Member Functions inherited from LTIOverrideDelegatesData
 LTIOverrideDelegatesData ()
 
- Protected Member Functions inherited from LTIOverrideStripHeightData
 LTIOverrideStripHeightData ()
 
- Protected Member Functions inherited from LTIOverrideIsSelectiveData
 LTIOverrideIsSelectiveData ()
 
void setIsSelective (bool enable)
 set image to support "random access" More...
 
- Protected Member Functions inherited from LTIOverrideMagnificationData
 LTIOverrideMagnificationData ()
 
LT_STATUS setMagnification (double minMag, double maxMag)
 set the minimum and maximum magnifications of the image properties More...
 
- Protected Member Functions inherited from LTIOverrideGeoCoordData
 LTIOverrideGeoCoordData ()
 
 ~LTIOverrideGeoCoordData ()
 
LT_STATUS setGeoCoord (const LTIGeoCoord &geoCoord)
 set the geographic coordinates of the image More...
 
LT_STATUS setDefaultGeoCoord (const LTIImage &image)
 set the geographic coordinates of the image More...
 
- Protected Member Functions inherited from LTIOverrideBackgroundPixelData
 LTIOverrideBackgroundPixelData ()
 
 ~LTIOverrideBackgroundPixelData ()
 
LT_STATUS setBackgroundPixel (const LTIPixel *backgroundPixel)
 set the background color of the image More...
 
LT_STATUS setNoDataPixel (const LTIPixel *nodataPixel)
 set the "no data" (transparency) color of the image More...
 
- Protected Member Functions inherited from LTIOverridePixelPropsData
 LTIOverridePixelPropsData ()
 
 ~LTIOverridePixelPropsData ()
 
LT_STATUS setPixelProps (const LTIPixel &pixelProps)
 set pixel properties of the image More...
 
LT_STATUS setPixelBPS (lt_uint8 bps)
 
LT_STATUS setDynamicRange (const LTIPixel &drmin, const LTIPixel &drmax)
 set the dynamic range of the image More...
 
LT_STATUS setDefaultDynamicRange (void)
 set the dynamic range of the image More...
 
- Protected Member Functions inherited from LTIOverrideDimensionsData
 LTIOverrideDimensionsData ()
 
LT_STATUS setDimensions (lt_uint32 width, lt_uint32 height)
 set width and height of the image More...
 

Protected Attributes

LTIOStreamInfm_stream
 
NITFReaderManager * m_manager
 
const ImageSegmentm_imageSegment
 
const FileHeaderm_fileHeader
 
LTReusableBuffer * m_reusableBuffer
 
LTIScenem_activeScene
 
LTISceneBufferm_activeSceneBuffer
 
- Protected Attributes inherited from LTIImageReader
const bool m_supportBandSelection
 
- Protected Attributes inherited from LTIOverrideMetadataData
LTIMetadataDatabasem_metadata
 
- Protected Attributes inherited from LTIOverridePixelLookupTablesData
LTIPixelLookupTablem_pixelLookupTable
 
- Protected Attributes inherited from LTIOverrideDelegatesData
LTIProgressDelegatem_progressDelegate
 
LTIInterruptDelegatem_interruptDelegate
 
- Protected Attributes inherited from LTIOverrideStripHeightData
lt_uint32 m_stripHeight
 
- Protected Attributes inherited from LTIOverrideIsSelectiveData
bool m_isSelective
 
- Protected Attributes inherited from LTIOverrideMagnificationData
double m_minMag
 
double m_maxMag
 
- Protected Attributes inherited from LTIOverrideGeoCoordData
LTIGeoCoordm_geoCoord
 
bool m_geoCoordImplicit
 
- Protected Attributes inherited from LTIOverrideBackgroundPixelData
LTIPixelm_backgroundPixel
 
LTIPixelm_nodataPixel
 
- Protected Attributes inherited from LTIOverridePixelPropsData
LTIPixelm_pixelProps
 
LTIPixelm_drminPixel
 
LTIPixelm_drmaxPixel
 
- Protected Attributes inherited from LTIOverrideDimensionsData
lt_uint32 m_width
 
lt_uint32 m_height
 

Detailed Description

This class provides support for representing an NITF image segment as an LTIImageReader, from which you can extract pixel data. ImageReader objects are not to be created directly; the NITFReaderManager class contains a createReader() function for this purpose.

Definition at line 46 of file ImageReader.h.

Constructor & Destructor Documentation

§ ~ImageReader()

Nitf::ImageReader::~ImageReader ( void  )
protected

§ ImageReader()

Nitf::ImageReader::ImageReader ( bool  supportBandSelection)
protected

Member Function Documentation

§ activeSceneContains()

bool Nitf::ImageReader::activeSceneContains ( const LTIScene scene) const
protected

§ addUnderlyingMetadata()

LT_STATUS Nitf::ImageReader::addUnderlyingMetadata ( const LTIImageStage image)
protected

§ computeBlockedScene()

LTIScene Nitf::ImageReader::computeBlockedScene ( const LTIScene scene) const
protected

§ copyIntoUserBuffer()

LT_STATUS Nitf::ImageReader::copyIntoUserBuffer ( const LTIScene dstScene,
LTISceneBuffer dstBuffer 
) const
protected

§ getDimsAtMag()

LT_STATUS Nitf::ImageReader::getDimsAtMag ( double  mag,
lt_uint32 width,
lt_uint32 height 
) const
pure virtual

This function returns the width and height of the image, in pixels, relative to the given magnification.

Parameters
magmagnification to determine width at
widththe image width at the magnification
heightthe image height at the magnification
Returns
status code indicating success or failure

Reimplemented from LTIImageReader.

§ getFormat()

Format Nitf::ImageReader::getFormat ( ) const

§ getIID1()

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

§ getImageMetadata()

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

§ getLayout()

Layout Nitf::ImageReader::getLayout ( ) const

§ getManager()

NITFReaderManager& Nitf::ImageReader::getManager ( ) const

§ getPhysicalFileSize()

lt_int64 Nitf::ImageReader::getPhysicalFileSize ( ) const

§ getSecurityMetadata()

const SecurityMetadata* Nitf::ImageReader::getSecurityMetadata ( ) const

§ getSegmentNumber()

int Nitf::ImageReader::getSegmentNumber ( ) const

§ getSourceName()

const char* Nitf::ImageReader::getSourceName ( void  ) const
protectedvirtual

Implements LTIImageReader.

§ init()

LT_STATUS Nitf::ImageReader::init ( LTIOStreamInf stream,
NITFReaderManager *  manager,
const ImageSegment imageSegment,
bool  useWorldFile 
)
protected

§ isBlocked()

bool Nitf::ImageReader::isBlocked ( ) const

§ isMasked()

bool Nitf::ImageReader::isMasked ( ) const

§ putBlockIntoBuffer_BLOCK()

void Nitf::ImageReader::putBlockIntoBuffer_BLOCK ( LTISceneBuffer cBuffer,
lt_uint8 buf,
lt_uint32  blockRow,
lt_uint32  blockCol 
) const
protected

§ putBlockIntoBuffer_PIXEL()

void Nitf::ImageReader::putBlockIntoBuffer_PIXEL ( LTISceneBuffer cBuffer,
lt_uint8 buf,
lt_uint32  blockRow,
lt_uint32  blockCol 
) const
protected

§ putBlockIntoBuffer_ROW()

void Nitf::ImageReader::putBlockIntoBuffer_ROW ( LTISceneBuffer cBuffer,
lt_uint8 buf,
lt_uint32  blockRow,
lt_uint32  blockCol 
) const
protected

§ putBlockIntoBuffer_SEQ()

void Nitf::ImageReader::putBlockIntoBuffer_SEQ ( LTISceneBuffer cBuffer,
lt_uint8 buf,
lt_uint32  blockRow,
lt_uint32  blockCol,
lt_uint32  blockBand 
) const
protected

Member Data Documentation

§ m_activeScene

LTIScene* Nitf::ImageReader::m_activeScene
protected

Definition at line 145 of file ImageReader.h.

§ m_activeSceneBuffer

LTISceneBuffer* Nitf::ImageReader::m_activeSceneBuffer
protected

Definition at line 146 of file ImageReader.h.

§ m_fileHeader

const FileHeader* Nitf::ImageReader::m_fileHeader
protected

Definition at line 142 of file ImageReader.h.

§ m_imageSegment

const ImageSegment* Nitf::ImageReader::m_imageSegment
protected

Definition at line 141 of file ImageReader.h.

§ m_manager

NITFReaderManager* Nitf::ImageReader::m_manager
protected

Definition at line 139 of file ImageReader.h.

§ m_reusableBuffer

LTReusableBuffer* Nitf::ImageReader::m_reusableBuffer
protected

Definition at line 144 of file ImageReader.h.

§ m_stream

LTIOStreamInf* Nitf::ImageReader::m_stream
protected

Definition at line 138 of file ImageReader.h.


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

LizardTech