MrSID Decode SDK for Raster Reference Manual  9.5.5.5244
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< LTIOverrideGeoCoord< LTIOverrideMagnification< LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > > > > > > LTIOverridePixelProps< BASE > LTIOverrideDimensionsData LTIOverridePixelPropsData

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 ImageSegmentMetadata * getImageMetadata () const
 returns the image segment metadata object for this segment More...
 
const SecurityMetadata * getSecurityMetadata () const
 returns the security metadata object for this segment More...
 
const ImageSegment * getImageSegment () const
 
LT_STATUS getDimsAtMag (double mag, lt_uint32 &width, lt_uint32 &height) const =0
 
- Public Member Functions inherited from LTIImageReader
LT_STATUS getDimsAtMag (double mag, lt_uint32 &width, lt_uint32 &height) const
 
lt_uint32 getModifications (const LTIScene &scene) const
 
LTIMaskSource * getMask () const
 
bool getPipelineInfo (LTIPipelineInfo info) const
 
LTIImageStage * getPreviousStage (void) const
 
lt_int64 getEncodingCost (const LTIScene &scene) const
 
bool getReaderScene (const LTIScene &decodeScene, LTIScene &readerScene) const
 
LT_STATUS readBegin (const LTIPixel &pixelProps, const LTIScene &fullScene)
 
LT_STATUS readStrip (LTISceneBuffer &buffer, const LTIScene &stripScene)
 
LT_STATUS readEnd (void)
 
- Public Member Functions inherited from LTIOverrideDimensions< LTIOverridePixelProps< LTIOverrideGeoCoord< LTIOverrideMagnification< LTIOverrideIsSelective< LTIOverrideStripHeight< LTIOverrideDelegates< LTIOverridePixelLookupTables< LTIOverrideMetadata< LTIImageStage > > > > > > > > >
lt_uint32 getWidth () const
 
lt_uint32 getHeight () const
 
- Public Member Functions inherited from LTIOverridePixelProps< BASE >
const LTIPixel & getPixelProps () const
 
const LTIPixel & getMinDynamicRange () const
 
const LTIPixel & getMaxDynamicRange () const
 
LT_STATUS overridePixelBPS (lt_uint8 bps)
 
LT_STATUS overrideColorSpace (LTIColorSpace colorspace)
 
LT_STATUS overrideDynamicRange (const LTIPixel &drmin, const LTIPixel &drmax)
 
const LTIPixel * getBackgroundPixel () const
 
const LTIPixel * getNoDataPixel () const
 
LT_STATUS overrideBackgroundPixel (const LTIPixel *backgroundPixel)
 
LT_STATUS overrideNoDataPixel (const LTIPixel *nodataPixel)
 

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=nullptr)
 
LT_STATUS loadMetadataIntoObjects (const LTIMetadataDatabase &fileMetadata, LTIPixel &pixelProps, bool updatePixelProps, bool updateGeoCoord)
 
- 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 setColorSpace (LTIColorSpace colorspace)
 
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...
 
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 LTIOverrideDimensionsData
 LTIOverrideDimensionsData ()
 
LT_STATUS setDimensions (lt_uint32 width, lt_uint32 height)
 set width and height of the image More...
 

Protected Attributes

LTIOStreamInf * m_stream
 
NITFReaderManager * m_manager
 
const ImageSegment * m_imageSegment
 
const FileHeader * m_fileHeader
 
LTReusableBuffer * m_reusableBuffer
 
LTIScene * m_activeScene
 
LTISceneBuffer * m_activeSceneBuffer
 
- Protected Attributes inherited from LTIImageReader
const bool m_supportBandSelection
 
- Protected Attributes inherited from LTIOverridePixelPropsData
LTIPixel * m_pixelProps
 
LTIPixel * m_drminPixel
 
LTIPixel * m_drmaxPixel
 
LTIPixel * m_backgroundPixel
 
LTIPixel * m_nodataPixel
 
- 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 42 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

◆ getFormat()

Format Nitf::ImageReader::getFormat ( ) const

◆ getIID1()

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

◆ getImageMetadata()

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

◆ getImageSegment()

const ImageSegment* Nitf::ImageReader::getImageSegment ( ) 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:

Extensis