MrSID Decode SDK for Raster Reference Manual  9.5.5.5244
lti_mosaicFilter.h
Go to the documentation of this file.
1 //
2 // This code is property of Celartem, Inc dba Extensis.
3 // Copyright (c) 1995-2023. All rights reserved.
4 // Use permitted only under license from Extensis.
5 //
6 /* PUBLIC */
7 
8 #ifndef LTI_MOSAIC_FILTER_H
9 #define LTI_MOSAIC_FILTER_H
10 
11 // lt_lib_mrsid_core
12 #include "lti_imageStage.h"
14 #include "lti_imageStageManager.h"
15 #include "lti_sceneBuffer.h"
16 
17 
18 
19 LT_BEGIN_LIZARDTECH_NAMESPACE
20 
21 class LTIRStarTree;
22 class LTIMemoryRStarTree;
23 class LTIEmbeddedImage;
24 class LTIPipelineBuilder;
25 
36 #ifdef SWIG
37 class LTIMosaicFilter : public LTIImageStage
38 #else
40  <LTIOverridePixelProps
41  <LTIOverrideGeoCoord
42  <LTIOverrideMagnification
43  <LTIOverrideIsSelective
44  <LTIOverrideStripHeight
45  <LTIOverrideDelegates
46  <LTIOverridePixelLookupTables
47  <LTIOverrideMetadata
48  <LTIImageStage> > > > > > > > >
49 #endif
50 {
52 public:
53  enum AlphaMode
54  {
58  };
59 
84  const LTIPixel* backgroundPixel,
85  bool useMultires,
86  bool mergeMetadata = true,
87  AlphaMode alphaMode = DoNothing);
88 
90  const LTIImage *imageProps,
91  const LTIRStarTree *rtree,
92  AlphaMode alphaMode);
93 
94 
106  bool useMultires);
107 
108  // LTIImage
110  lt_uint32 &width,
111  lt_uint32 &height) const;
112  lt_uint32 getModifications(const LTIScene &scene) const;
113 
114  // LTIImageStage
115  lt_int64 getEncodingCost(const LTIScene& scene) const;
116  bool getReaderScene(const LTIScene &decodeScene,
117  LTIScene &readerScene) const;
118  LTIMaskSource *getMask() const;
127  double fuzzyThreshold /*= LTISceneBuffer::DefaultFuzzyThreshold*/);
128 
133  double getFuzzyThreshold(void) const;
134 
139  void setResampleMethod(LTIResampleMethod resampleMethod);
140 
141  void setMagSnapThreshold(double threshold);
142 
147 
148  void setResamplePixelCenter(bool usePixelCenter);
149 
150  // for LizardTech internal use only
152  const LTIScene &decodeScene,
153  LTIScene &mosaicScene,
154  LTIScene &readerScene) const;
155  // for LizardTech internal use only
156  bool getOverviewReaderScene(const LTIScene &decodeScene,
157  LTIScene &mosaicScene,
158  LTIScene &readerScene) const;
159 
160  // for LizardTech internal use only
162  {
163  public:
164  virtual LT_STATUS found(const LTIScene &scene,
165  lt_uint32 imageNum,
166  LTIEmbeddedImage &embedded,
167  LTIImageStage &image) = 0;
168  };
169 
170  // for LizardTech internal use only
172  InSceneCallback &callback);
173 
174  // for LizardTech internal use only
175  void setDeleteImages(bool deleteImages);
176  // for LizardTech internal use only
177  bool getDeleteImages(void) const;
178 
179  // for LizardTech internal use only
181  LTIEmbeddedImage *&embedded,
182  LTIImageStage *&raw);
183  // for LizardTech internal use only
185 
186  // for LizardTech internal use only
187  // does not take ownship of pipelineBuilder
188  // don't call this function in inside a decodeBegin()/decodeStrip()/decodeEnd() loop
189  LT_STATUS setPipelineBuilder(LTIPipelineBuilder *pipelineBuilder);
190 
191  // for LizardTech internal use only
192  const LTIRStarTree &getRTree(void) const;
193  // for LizardTech internal use only
195 
196  // for LizardTech internal use only
197  bool hasOverviewImage(void) const;
198  // for LizardTech internal use only
199  double getOverviewMag(void) const;
200 
201 protected:
202  LT_STATUS decodeBegin(const LTIPixel &pixelProps,
203  const LTIScene &fullScene);
205  const LTIScene &stripScene);
207 
208 private:
209  struct TileInfo;
210 
211  LT_STATUS setupPixelProps(TileInfo *tiles, lt_uint32 numTiles,
212  const LTIPixel *background,
213  bool mergeMetadata);
214 
215  LT_STATUS setupGeoProps(LTIMemoryRStarTree *rtree,
216  TileInfo *tiles,
217  lt_uint32 numTiles,
218  bool useMultires);
219 
220  LT_STATUS setupBuffers(lt_uint32 numTiles);
221  LT_STATUS setupOverview(void);
222 
223  RC<LTIImageStageManager> m_imageStageManager;
224 
225  RC<LTIRStarTree> m_rtree;
226 
227  // open image book keeping
228  LTIImageStage **m_rImage;
229  LTIEmbeddedImage **m_fImage;
230  int *m_sImage;
231  LTIPixelFillMethod m_fillMethod;
232  double m_fuzzyThreshold;
233  AlphaMode m_alphaMode;
234  LTIResampleMethod m_resampleMethod;
235  bool m_usePixelCenter;
236  double m_magSnapThreshold;
237  bool m_deleteImages;
238 
239  LTIPipelineBuilder *m_pipelineBuilder;
240 
241  // imageInScene
242  lt_uint32 *m_inSceneList;
243 
244  RC<LTIEmbeddedImage> m_overview;
245  double m_overviewMag;
246 };
247 
248 #ifndef DOXYGEN_EXCLUDE
249 
250 class LTIPipelineBuilder
251 {
252 public:
253  virtual LT_STATUS buildPipeline(lt_uint32 imageNumber,
254  LTIImageStage *&pipeline) = 0;
255 };
256 
257 #endif
258 
259 LT_END_LIZARDTECH_NAMESPACE
260 
261 
262 #endif // LTI_MOSAIC_FILTER_H
lt_uint32 LT_STATUS
An integral status code.
Definition: lt_status.h:30
unsigned int lt_uint32
unsigned 32-bit integer
Definition: lt_types.h:44
long long int lt_int64
signed 64-bit integer
Definition: lt_types.h:57
#define LTI_REFERENCE_COUNTED_BOILERPLATE(classname)
LTIPixelFillMethod
constants representing pixel filling methods
Definition: lti_types.h:183
LTIResampleMethod
constants representing resampling methods
Definition: lti_types.h:172
LTIPipelineInfo
Definition: lti_types.h:224
create a larger frame for the image
abstract class representing an image
Definition: lti_image.h:28
abstract class for decoding from an image
abstract class for managing a list of image stages
create a single mosaicked image from a set of images
bool hasOverviewImage(void) const
LTIImageStage * getPreviousStage(void) const
void setResampleMethod(LTIResampleMethod resampleMethod)
Set resampling method.
LTIResampleMethod getResampleMethod(void) const
Get the fill method.
LT_STATUS decodeBegin(const LTIPixel &pixelProps, const LTIScene &fullScene)
LT_STATUS getDimsAtMag(double mag, lt_uint32 &width, lt_uint32 &height) const
const LTIRStarTree & getRTree(void) const
LT_STATUS setPipelineBuilder(LTIPipelineBuilder *pipelineBuilder)
double getFuzzyThreshold(void) const
LT_STATUS loadImage(lt_uint32 i, LTIEmbeddedImage *&embedded, LTIImageStage *&raw)
LTIImageStageManager & getImageStageManager(void) const
bool getOverviewReaderScene(const LTIScene &decodeScene, LTIScene &mosaicScene, LTIScene &readerScene) const
void setResamplePixelCenter(bool usePixelCenter)
bool getReaderScene(lt_uint32 child, const LTIScene &decodeScene, LTIScene &mosaicScene, LTIScene &readerScene) const
lt_uint32 getModifications(const LTIScene &scene) const
void setFillMethod(LTIPixelFillMethod method, double fuzzyThreshold)
Set the fill method which controls how noData pixels are matched.
LTIPixelFillMethod getFillMethod(void) const
Get the fill method.
static LT_STATUS checkResolutionConformance(LTIImageStageManager *imageStageManager, bool useMultires)
Check if a set of images can be mosaicked together.
LT_STATUS initialize(LTIImageStageManager *imageStageManager, const LTIImage *imageProps, const LTIRStarTree *rtree, AlphaMode alphaMode)
LT_STATUS closeImage(lt_uint32 i)
bool getReaderScene(const LTIScene &decodeScene, LTIScene &readerScene) const
lt_int64 getEncodingCost(const LTIScene &scene) const
LT_STATUS decodeEnd(void)
LT_STATUS decodeStrip(LTISceneBuffer &stripBuffer, const LTIScene &stripScene)
LTIMaskSource * getMask() const
double getOverviewMag(void) const
void setMagSnapThreshold(double threshold)
LT_STATUS initialize(LTIImageStageManager *imageStageManager, const LTIPixel *backgroundPixel, bool useMultires, bool mergeMetadata=true, AlphaMode alphaMode=DoNothing)
initializer
bool getDeleteImages(void) const
void setDeleteImages(bool deleteImages)
LT_STATUS forEachImageStageInScene(const LTIScene &scene, InSceneCallback &callback)
bool getPipelineInfo(LTIPipelineInfo info) const
virtual LT_STATUS found(const LTIScene &scene, lt_uint32 imageNum, LTIEmbeddedImage &embedded, LTIImageStage &image)=0
basic properties of a pixel
Definition: lti_pixel.h:32
representation of a scene
Definition: lti_scene.h:60
class to hold data passed between image stages

Extensis