/usr/include/ossim/util/ossimChipperUtil.h is in libossim-dev 1.8.16-4ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 | //----------------------------------------------------------------------------
//
// File: ossimChipperUtil.h
//
// License: LGPL
//
// See LICENSE.txt file in the top level directory for more details.
//
// Author: David Burken
//
// Description:
//
// Utility class to for chipping out images. , orthorectifying imagery with an added slant
// toward doing digital elevation model(DEM) operations.
//
//----------------------------------------------------------------------------
// $Id: ossimChipperUtil.h 22257 2013-05-01 19:21:35Z dburken $
#ifndef ossimChipperUtil_HEADER
#define ossimChipperUtil_HEADER 1
#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimReferenced.h>
#include <ossim/base/ossimRefPtr.h>
#include <ossim/imaging/ossimImageSource.h>
#include <ossim/imaging/ossimSingleImageChain.h>
#include <ossim/projection/ossimMapProjection.h>
#include <map>
#include <vector>
// Forward class declarations:
class ossimArgumentParser;
class ossimDpt;
class ossimFilename;
class ossimGpt;
class ossimImageFileWriter;
class ossimImageGeometry;
class ossimImageViewAffineTransform;
class ossimIrect;
class ossimKeywordlist;
/**
* @brief ossimChipperUtil class.
*
* This is a utility class to orthorectify imagery with an added slant toward
* doing digital elevation model(DEM) operations.
*
* See the ossim-dem application for a code usage example.
*
* @note Almost all methods use throw for stack unwinding. This is not in
* method declarations to alleviate build errors on windows. Sorry...
*
* @note "bumpshade" and "hillshade" intermixed throughout. The class to do
* a hillshade is the ossimBumpShadeTileSource.
*/
class OSSIM_DLL ossimChipperUtil : public ossimReferenced
{
public:
/** emumerated operations */
enum ossimChipperOperation
{
OSSIM_CHIPPER_OP_UNKNOWN = 0,
OSSIM_CHIPPER_OP_HILL_SHADE = 1,
OSSIM_CHIPPER_OP_COLOR_RELIEF = 2,
OSSIM_CHIPPER_OP_ORTHO = 3,
OSSIM_CHIPPER_OP_2CMV = 4, // two color multiview
OSSIM_CHIPPER_OP_CHIP = 5 // image space
};
/** emumerated output projections */
enum ossimChipperOutputProjection
{
OSSIM_CHIPPER_PROJ_UNKNOWN = 0,
OSSIM_CHIPPER_PROJ_GEO = 1,
OSSIM_CHIPPER_PROJ_GEO_SCALED = 2,
OSSIM_CHIPPER_PROJ_INPUT = 3,
OSSIM_CHIPPER_PROJ_UTM = 4
};
/** default constructor */
ossimChipperUtil();
/** virtual destructor */
virtual ~ossimChipperUtil();
/**
* @brief Initial method to be ran prior to execute.
* @param ap Arg parser to initialize from.
* @note Throws ossimException on error.
* @note A throw with an error message of "usage" is used to get out when
* a usage is printed.
*/
bool initialize(ossimArgumentParser& ap);
/**
* @brief Initial method to be ran prior to execute.
*
* This was separated out from initialize(ossimArgumentParser& ap) because
* you could make an initialize(const ossimKeywordlist& kwl) and then call
* initialize().
*
* @note Throws ossimException on error.
*/
void initialize();
/**
* @brief execute method. Performs the actual product write.
* @note Throws ossimException on error.
*/
void execute();
/**
* @brief Gets the output file name.
* @param f Initialized by this with the filename.
*/
void getOutputFilename(ossimFilename& f) const;
private:
/**
* @brief Initializes the output projection and propagates to image chains.
* @note Throws ossimException on error.
*/
void initializeOutputProjection();
/** @brief Create chains for all dems. */
void addDemSources();
/** @brief Method to create a chain and add to dem layers from file. */
void addDemSource(const ossimFilename& file);
/**
* @brief Method to create a chain and add to dem layers from a
* ossimSrcRecord.
*/
void addDemSource(const ossimSrcRecord& rec);
/** @brief Creates chains for all images. */
void addImgSources();
/** @brief Method to create a chain and add to img layers from file. */
void addImgSource(const ossimFilename& file);
/**
* @brief Method to create a chain and add to img layers from a
* ossimSrcRecord.
*/
void addImgSource(const ossimSrcRecord& rec);
/**
* @brief Creates a ossimSingleImageChain from file.
* @param file File to open.
* @return Ref pointer to ossimSingleImageChain.
* @note Throws ossimException on error.
*/
ossimRefPtr<ossimSingleImageChain> createChain(const ossimFilename& file) const;
/**
* @brief Creates a ossimSingleImageChain from ossimSrcRecord.
* @param src Record.
* @return Ref pointer to ossimSingleImageChain.
* @note Throws ossimException on error.
*/
ossimRefPtr<ossimSingleImageChain> createChain(const ossimSrcRecord& rec) const;
/**
* @brief Creates the output or view projection.
* @note All chains should be constructed prior to calling this.
*/
void createOutputProjection();
/**
* @brief Sets the single image chain for identity operations view to
* a ossimImageViewAffineTransform. This will have a rotation if
* up is up is selected. Also set m_outputProjection to the input's
* for area of interest.
*/
void createIdentityProjection();
/**
* @brief Gets the first input projection.
*
* This gets the output projection of the first dem layer if present;
* if not, the first image layer.
*
* @return ref ptr to projection, could be null.
*/
ossimRefPtr<ossimMapProjection> getFirstInputProjection();
/**
* @brief Convenience method to get geographic projection.
* @return new ossimEquDistCylProjection.
*/
ossimRefPtr<ossimMapProjection> getNewGeoProjection();
/**
* @brief Convenience method to get geographic projection.
*
* This method sets the origin to the center of the scene bounding rect
* of all layers.
* @return new ossimEquDistCylProjection.
*/
ossimRefPtr<ossimMapProjection> getNewGeoScaledProjection();
/**
* @brief Convenience method to get a projection from an srs code.
* @return new ossimMapProjection.
*/
ossimRefPtr<ossimMapProjection> getNewProjectionFromSrsCode(const ossimString& code);
/**
* @brief Convenience method to get a utm projection.
* @return new ossimUtmProjection.
*/
ossimRefPtr<ossimMapProjection> getNewUtmProjection();
/**
* @brief Convenience method to get a pointer to the output map
* projection.
*
* Callers should check for valid() as the pointer could be
* 0 if not initialized.
*
* @returns The ossimMapProjection* from the m_outputGeometry as a ref
* pointer.
*/
ossimRefPtr<ossimMapProjection> getMapProjection();
/**
* @brief Sets the projection tie point to the scene bounding rect corner.
* @note Throws ossimException on error.
*/
void intiailizeProjectionTiePoint();
/**
* @brief Initializes the projection gsd.
*
* This loops through all chains to find the best resolution gsd.
*
* @note Throws ossimException on error.
*/
void initializeProjectionGsd();
/**
* @brief Initializes the image view transform(IVT) scale.
*
* Chip mode only. Sets IVT scale to output / input.
*
* @note Throws ossimException on error.
*/
void initializeIvtScale();
/**
* @brief Loops through all layers to get the upper left tie point.
* @param tie Point to initialize.
*/
void getTiePoint(ossimGpt& tie);
/**
* @brief Gets the upper left tie point from a chain.
* @param chain The chain to get tie point from.
* @param tie Point to initialize.
* @note Throws ossimException on error.
*/
void getTiePoint(ossimSingleImageChain* chain, ossimGpt& tie);
/**
* @brief Loops through all layers to get the upper left tie point.
* @param tie Point to initialize.
*/
void getTiePoint(ossimDpt& tie);
/**
* @brief Gets the upper left tie point from a chain.
* @param chain The chain to get tie point from.
* @param tie Point to initialize.
* @note Throws ossimException on error.
*/
void getTiePoint(ossimSingleImageChain* chain, ossimDpt& tie);
/**
* @brief Loops through all layers to get the best gsd.
* @param gsd Point to initialize.
*/
void getMetersPerPixel(ossimDpt& gsd);
/**
* @brief Gets the gsd from a chain.
* @param chain The chain to get gsd from.
* @param gsd Point to initialize.
* @note Throws ossimException on error.
*/
void getMetersPerPixel(ossimSingleImageChain* chain, ossimDpt& gsd);
/**
* @brief Gets value of key "central_meridan" if set, nan if not.
*
* @return Value as a double or nan if keyord is not set.
*
* @note Throws ossimException on range error.
*/
ossim_float64 getCentralMeridian() const;
/**
* @brief Gets value of key "origin_latitude" if set, nan if not.
*
* @return Value as a double or nan if keyord is not set.
*
* @note Throws ossimException on range error.
*/
ossim_float64 getOriginLatitude() const;
/**
* @brief Loops through all layers to get the scene center ground point.
* @param gpt Point to initialize.
* @note Throws ossimException on error.
*/
void getSceneCenter(ossimGpt& gpt);
/**
* @brief Gets the scene center from a chain.
* @param chain The chain to get scene center from.
* @param gpt Point to initialize.
* @note Throws ossimException on error.
*/
void getSceneCenter(ossimSingleImageChain* chain, ossimGpt& gpt);
/**
* @brief Creates a new writer.
*
* This will use the writer option (-w or --writer), if present; else,
* it will be derived from the output file extention.
*
* This will also set any writer properties passed in.
*
* @return new ossimImageFileWriter.
* @note Throws ossimException on error.
*/
ossimRefPtr<ossimImageFileWriter> createNewWriter() const;
/**
* @brief loops through all chains and sets the output projection.
* @note Throws ossimException on error.
*/
void propagateOutputProjectionToChains();
/**
* @brief Combines all layers into an ossimImageMosaic.
* @return ossimRefPtr with pointer to ossimImageSource. Can be null.
*/
ossimRefPtr<ossimImageSource> combineLayers(
std::vector< ossimRefPtr<ossimSingleImageChain> >& layers) const;
/** @brief Combines dems(m_demLayer) and images(m_imgLayer). */
ossimRefPtr<ossimImageSource> combineLayers();
/** @brief Combines two images into a two color multi view chain.
* @return ossimRefPtr with pointer to ossimImageSource. Can be null.
*/
ossimRefPtr<ossimImageSource> combine2CmvLayers();
/**
* @brief Creates ossimIndexToRgbLutFilter and connects to source.
* @param Source to connect to.
* @return End of chain with lut filter on it.
* @note Throws ossimException on error.
*/
ossimRefPtr<ossimImageSource> addIndexToRgbLutFilter(
ossimRefPtr<ossimImageSource> &source) const;
/**
* @brief Creates ossimScalarRemapper and connects to source.
* @param Source to connect to.
* @param scalar Scalar type.
* @return End of chain with remapper on it.
* @note Throws ossimException on error.
*/
ossimRefPtr<ossimImageSource> addScalarRemapper(
ossimRefPtr<ossimImageSource> &source,
ossimScalarType scalar) const;
/**
* @brief Set up ossimHistogramRemapper for a chain.
* @param chain Chain to set up.
* @return true on success, false on error.
*/
bool setupChainHistogram( ossimRefPtr<ossimSingleImageChain>& chain) const;
/**
* @brief Sets entry for a chain.
* @param chain Chain to set up.
* @param entryIndex Zero based index.
* @return true on success, false on error.
*/
bool setChainEntry( ossimRefPtr<ossimSingleImageChain>& chain,
ossim_uint32 entryIndex ) const;
/**
* @brief Initializes "rect" with the output area of interest.
*
* Initialization will either come from user defined cut options or the
* source bounding rect with user options taking precidence.
*
* @param source Should be the end of the processing chain.
* @param rect Rectangle to initialize. This is in output (view) space.
*
* @note Throws ossimException on error.
*/
void getAreaOfInterest( ossimImageSource* source, ossimIrect& rect ) const;
/**
* @brief Method to calculate and initialize scale and area of interest
* for making a thumbnail.
*
* Sets the scale of the output projection so that the adjusted rectangle
* meets the cut rect and demension requirements set in options.
*
* @param originalRect Original scene area of interest.
* @param adjustedRect New rect for thumbnail.
*
* @note Throws ossimException on error.
*/
void initializeThumbnailProjection(const ossimIrect& originalRect,
ossimIrect& adjustedRect);
/** @return true if BANDS keyword is set; false, if not. */
bool hasBandSelection() const;
/**
* @brief Gets the band list if BANDS keyword is set.
*
* NOTE: BANDS keyword values are ONE based. bandList values are
* ZERO based.
*
* @param bandList List initialized by this.
*/
void getBandList( std::vector<ossim_uint32>& bandList ) const;
/** @return true if color table (lut) is set; false, if not. */
bool hasLutFile() const;
/**
* @return true if any bump share options have been set by user; false,
* if not.
*/
bool hasBumpShadeArg() const;
/** @return true if thumbnail option is set; false, if not. */
bool hasThumbnailResolution() const;
bool hasHistogramOperation() const;
/** @return true if file extension is "hgt", "dem" or contains "dtN" (dted). */
bool isDemFile(const ossimFilename& file) const;
/** @return true if file extension is "src" */
bool isSrcFile(const ossimFilename& file) const;
/** @brief Initializes m_srcKwl if option was set. */
void initializeSrcKwl();
/**
* @return The number of DEM_KW and IMG_KW found in the m_kwl and m_srcKwl
* keyword list.
*/
ossim_uint32 getNumberOfInputs() const;
/**
* @brief Gets the emumerated output projection type.
*
* This looks in m_kwl for ossimKeywordNames::PROJECTION_KW.
* @return The enumerated output projection type.
* @note This does not cover SRS keyword which could be any type of projection.
*/
ossimChipperOutputProjection getOutputProjectionType() const;
/**
* @brief Returns the scalar type from OUTPUT_RADIOMETRY_KW keyword if
* present. Deprecated SCALE_2_8_BIT_KW is also checked.
*
* @return ossimScalarType Note this can be OSSIM_SCALAR_UNKNOWN if the
* keywords are not present.
*/
ossimScalarType getOutputScalarType() const;
/** @return true if scale to eight bit option is set; false, if not. */
bool scaleToEightBit() const;
/** @return true if snap tie to origin option is set; false, if not. */
bool snapTieToOrigin() const;
/**
* @brief Gets rotation.
*
* @return Rotation in decimal degrees if ROTATION_KW option is set;
* ossim::nan, if not.
*
* @note Throws ossimException on range error.
*/
ossim_float64 getRotation() const;
/** @return true if ROTATION_KW option is set; false, if not. */
bool hasRotation() const;
/** @return true if UP_IS_UP_KW option is set; false, if not. */
bool upIsUp() const;
/** @return true if NORTH_UP_KW option is set; false, if not. */
bool northUp() const;
/** @return true if operation is "chip" or identity; false, if not. */
bool isIdentity() const;
/** @return true if key is set to true; false, if not. */
bool keyIsTrue( const std::string& key ) const;
/**
* @return The entry number if set. Zero if ossimKeywordNames::ENTRY_KW not
* found.
*/
ossim_uint32 getEntryNumber() const;
/**
* @return True if any input has a sensor model input, false if all input
* projections are map projections.
*/
bool hasSensorModelInput() const;
/**
* @brief Adds application arguments to the argument parser.
* @param ap Parser to add to.
*/
void addArguments(ossimArgumentParser& ap);
/** @brief Initializes arg parser and outputs usage. */
void usage(ossimArgumentParser& ap);
/** Enumerated operation to perform. */
ossimChipperOperation m_operation;
/** Hold all options passed into intialize except writer props. */
ossimRefPtr<ossimKeywordlist> m_kwl;
/** Hold contents of src file if --src is used. */
ossimRefPtr<ossimKeywordlist> m_srcKwl;
/**
* The image geometry. In chip mode this will be from the input image. So
* this may or may not have a map projection. In any other mode it
* will the view or output geometry which will be a map projection.
*/
ossimRefPtr<ossimImageGeometry> m_geom;
/**
* Image view transform(IVT). Only set/used in "chip"(identity) operation as
* the IVT for the resampler(ossimImageRenderer).
*/
ossimRefPtr<ossimImageViewAffineTransform> m_ivt;
/** Array of dem chains. */
std::vector< ossimRefPtr<ossimSingleImageChain> > m_demLayer;
/** Array of image source chains. */
std::vector< ossimRefPtr<ossimSingleImageChain> > m_imgLayer;
};
#endif /* #ifndef ossimChipperUtil_HEADER */
|