MrSID Decode SDK for Raster Reference Manual  9.5.5.5244
LTIBandSelectFilter Class Reference

combine N different bands from M images into one N-banded image More...

#include <lti_bandSelectFilter.h>

Inheritance diagram for LTIBandSelectFilter:
LTIOverridePixelProps< LTIOverrideMetadata< LTIImageFilter > > LTIOverrideMetadata< BASE > LTIOverridePixelPropsData LTIOverrideMetadataData

Public Member Functions

LT_STATUS initialize (LTIImageStage *srcImages[], const int srcImageBands[], lt_uint16 numOutputBands, LTIColorSpace colorSpace)
 general initializer More...
 
LT_STATUS initialize (LTIImageStage *srcImages[], lt_uint16 numOutputBands, LTIColorSpace colorSpace)
 LTIColorCompositeFilter initializer. More...
 
LT_STATUS initialize (LTIImageStage *srcImage, const lt_uint16 srcImageBands[], lt_uint16 numOutputBands, LTIColorSpace colorSpace)
 single image initializer More...
 
lt_uint32 getStripHeight () const
 
LT_STATUS setStripHeight (lt_uint32 stripHeight)
 
lt_int64 getEncodingCost (const LTIScene &scene) const
 
virtual lt_uint32 getModifications (const LTIScene &scene) const
 
LT_STATUS remapBands (const lt_uint16 srcImageBands[])
 
LT_STATUS getBandMap (lt_uint16 srcImageBands[]) const
 
- Public Member Functions inherited from LTIOverridePixelProps< LTIOverrideMetadata< LTIImageFilter > >
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)
 
- Public Member Functions inherited from LTIOverrideMetadata< BASE >
const LTIMetadataDatabase & getMetadata () const
 
LT_STATUS overrideMetadata (const LTIMetadataDatabase &metadata)
 

Static Public Member Functions

static LTIBandSelectFilter * create (void)
 
static LT_STATUS parseString (const char *inputString, lt_int32 *&bandList, lt_uint16 &numBands)
 parse band string More...
 
static LT_STATUS push (LTIImageStage *&pipeline, const LTIPixel &pixelProps)
 
static void remapPixel (const LTIPixel &srcPixel, const lt_uint16 srcImageBands[], LTIPixel &dstPixel)
 

Protected Types

enum  SourcePixel { NodataPixel , BackgroundPixel , DRMinPixel , DRMaxPixel }
 

Protected Member Functions

 LTIBandSelectFilter (void)
 
virtual ~ LTIBandSelectFilter (void)
 
LT_STATUS decodeBegin (const LTIPixel &pixelProps, const LTIScene &fullScene)
 
LT_STATUS decodeStrip (LTISceneBuffer &stripBuffer, const LTIScene &stripScene)
 
LT_STATUS decodeEnd (void)
 
void remapPixel (LTIPixel &pixel, SourcePixel name) const
 
- Protected Member Functions inherited from LTIOverrideMetadataData
 LTIOverrideMetadataData ()
 
 ~LTIOverrideMetadataData ()
 
LT_STATUS createMetadata (const LTIMetadataDatabase *metadata)
 
LTIMetadataDatabase & getMetadata ()
 
- 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 Attributes

BandSelectMap * m_bandSelectMap
 
BandSelectMap * m_decodeMap
 
- Protected Attributes inherited from LTIOverrideMetadataData
LTIMetadataDatabase * m_metadata
 
- Protected Attributes inherited from LTIOverridePixelPropsData
LTIPixel * m_pixelProps
 
LTIPixel * m_drminPixel
 
LTIPixel * m_drmaxPixel
 
LTIPixel * m_backgroundPixel
 
LTIPixel * m_nodataPixel
 

Detailed Description

This class creates a single N-banded image which is a composition of N different bands from a set of images.

For example, an RGB image can be created from three (nominally grayscale) images which represent the red, green, and blue bands of a dataset. More generally, one can do things like construct a multispectral image from 1st and 2nd bands of one image and the 3rd and 4th bands of a second image.

Definition at line 33 of file lti_bandSelectFilter.h.

Member Enumeration Documentation

◆ SourcePixel

Enumerator
NodataPixel 
BackgroundPixel 
DRMinPixel 
DRMaxPixel 

Definition at line 166 of file lti_bandSelectFilter.h.

Constructor & Destructor Documentation

◆ LTIBandSelectFilter()

LTIBandSelectFilter::LTIBandSelectFilter ( void  )
protected

◆ ~ LTIBandSelectFilter()

virtual LTIBandSelectFilter::~ LTIBandSelectFilter ( void  )
protectedvirtual

Member Function Documentation

◆ create()

static LTIBandSelectFilter* LTIBandSelectFilter::create ( void  )
static

◆ decodeBegin()

LT_STATUS LTIBandSelectFilter::decodeBegin ( const LTIPixel &  pixelProps,
const LTIScene &  fullScene 
)
protected

◆ decodeEnd()

LT_STATUS LTIBandSelectFilter::decodeEnd ( void  )
protected

◆ decodeStrip()

LT_STATUS LTIBandSelectFilter::decodeStrip ( LTISceneBuffer &  stripBuffer,
const LTIScene &  stripScene 
)
protected

◆ getBandMap()

LT_STATUS LTIBandSelectFilter::getBandMap ( lt_uint16  srcImageBands[]) const

◆ getEncodingCost()

lt_int64 LTIBandSelectFilter::getEncodingCost ( const LTIScene &  scene) const

◆ getModifications()

virtual lt_uint32 LTIBandSelectFilter::getModifications ( const LTIScene &  scene) const
virtual

◆ getStripHeight()

lt_uint32 LTIBandSelectFilter::getStripHeight ( ) const

◆ initialize() [1/3]

LT_STATUS LTIBandSelectFilter::initialize ( LTIImageStage *  srcImage,
const lt_uint16  srcImageBands[],
lt_uint16  numOutputBands,
LTIColorSpace  colorSpace 
)

Same as the above general constructor, except that (1) a single source image is used, instead of an array of possibly different images, and (2) the output image has the same number of bands and colorspace as the input image.

(This provides compatability with the old LTISampleMapTransformer class.)

Parameters
srcImageinput image
srcImageBandsband numbers, for each output band
numOutputBandsnumber of output bands
colorSpacethe colorspace of the output image

◆ initialize() [2/3]

LT_STATUS LTIBandSelectFilter::initialize ( LTIImageStage *  srcImages[],
const int  srcImageBands[],
lt_uint16  numOutputBands,
LTIColorSpace  colorSpace 
)

Creates an image stage which composes the specified bands of the input images.

The srcImages and srcImageBands arrays each contain numOutputBands elements and serve to describe the bands of the desired output image. That is, band i of the output image will contain band srcImageBands[i] from image srcImages[i].

An element of srcImages may be nullptr. In this case, however, the corresponding srcImageBands element must be set to (int)-'Z', indicating a band of all zeros is to be used.

At least one of the srcImages elements must be non-nullptr.

Note: Data from srcImages and srcImageBands arrays are copied locally after initialize() is called.

Parameters
srcImagesinput images, for each output band
srcImageBandsband numbers, for each output band
numOutputBandsnumber of output bands
colorSpacethe colorspace of the output image

◆ initialize() [3/3]

LT_STATUS LTIBandSelectFilter::initialize ( LTIImageStage *  srcImages[],
lt_uint16  numOutputBands,
LTIColorSpace  colorSpace 
)

Same as the above general constructor, except that (1) each source image is either a one-banded image or nullptr, and (2) the srcImageBands array is constructed as the form [0,1,2...].

(This provides compatability with the old LTIColorCompositeFilter class.)

Parameters
srcImagesinput images
numOutputBandsnumber of output bands
colorSpacethe colorspace of the output image

◆ parseString()

static LT_STATUS LTIBandSelectFilter::parseString ( const char *  inputString,
lt_int32 *&  bandList,
lt_uint16 &  numBands 
)
static

Given a string such as "1,3-4,2", this function will return an array like [1,3,4,2].

The formal grammar of the input string is (ignoring whitespace): string := token? (comma token)* token := letter | number | number hyphen number letter := 'Z' number := digit+ digit := '0' | '1' | ... '9' comma := ',' hyphen := '-' Note that the range may be negative, i.e. "3-1" will be returned as [3,2,1]. A band value of Z indicates a band of all zeros should be used.

The caller takes ownership of the returned array.

Note that the caller may need to adjust the data in the returned array to be zero-based.

Parameters
inputStringthe string to parse
bandListreturned array of band numbers
numBandslength of bandList arrat
Returns
status code

◆ push()

static LT_STATUS LTIBandSelectFilter::push ( LTIImageStage *&  pipeline,
const LTIPixel &  pixelProps 
)
static

◆ remapBands()

LT_STATUS LTIBandSelectFilter::remapBands ( const lt_uint16  srcImageBands[])

◆ remapPixel() [1/2]

static void LTIBandSelectFilter::remapPixel ( const LTIPixel &  srcPixel,
const lt_uint16  srcImageBands[],
LTIPixel &  dstPixel 
)
static

◆ remapPixel() [2/2]

void LTIBandSelectFilter::remapPixel ( LTIPixel &  pixel,
SourcePixel  name 
) const
protected

◆ setStripHeight()

LT_STATUS LTIBandSelectFilter::setStripHeight ( lt_uint32  stripHeight)

Member Data Documentation

◆ m_bandSelectMap

BandSelectMap* LTIBandSelectFilter::m_bandSelectMap
protected

Definition at line 175 of file lti_bandSelectFilter.h.

◆ m_decodeMap

BandSelectMap* LTIBandSelectFilter::m_decodeMap
protected

Definition at line 176 of file lti_bandSelectFilter.h.


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

Extensis