/usr/include/ossim/util/ossimInfo.h is in libossim-dev 1.8.16-3+b1.
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 | //----------------------------------------------------------------------------
// File: ossimInfo.h
//
// License: LGPL
//
// See LICENSE.txt file in the top level directory for more details.
//
// Author: David Burken
//
// Description: ossimInfo class declaration
//
// See class doxygen descriptions below for more.
//
//----------------------------------------------------------------------------
// $Id: ossimInfo.h 22187 2013-03-07 20:29:00Z dburken $
#ifndef ossimInfo_HEADER
#define ossimInfo_HEADER 1
#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimKeywordlist.h>
#include <ossim/base/ossimReferenced.h>
#include <ossim/base/ossimRefPtr.h>
#include <ossim/imaging/ossimImageHandler.h>
#include <ostream>
class ossimArgumentParser;
class ossimGpt;
/**
* @brief ossimInfo class.
*
* This is a utility class for getting information from the ossim library.
* This includes information from an image, general library queries, like
* loaded plugins, and just general stuff like height for point, conversions
* and so on that are easily obtained through the library.
*/
class OSSIM_DLL ossimInfo : public ossimReferenced
{
public:
/** default constructor */
ossimInfo();
/** virtual destructor */
virtual ~ossimInfo();
/**
* @brief Adds application arguments to the argument parser.
* @param ap Parser to add to.
*/
void addArguments(ossimArgumentParser& ap);
/**
* @brief Initial method.
*
* Typically called from application prior to execute. This parses
* all options and put in keyword list m_kwl.
*
* @param ap Arg parser to initialize from.
*
* @return true, indicating process should continue with execute.
*/
bool initialize(ossimArgumentParser& ap);
/**
* @brief execute method.
*
* Performs the actual dump of information. This executes any options
* set including image operations, i.e. -i -p --dno and so on.
*
* @note Throws ossimException on error.
*/
void execute();
/**
* @brief handles image options.
*
* Handles image type info opions, i.e. -i -p --dno and so on.
*
* @return Number of consumed options.
*/
ossim_uint32 executeImageOptions(const ossimFilename& file);
/**
* @brief getImageInfo Method to open image "file" and get image info
* in the form of a ossimKeywordlist.
*
* Flags turn on various pieces of info. These equate to options in
* ossim-info for image information.
*
* This method opens and closes "file" under the hood so if an image is
* open and it's not the same as "file" it will be closed by this call.
* On exite the image will be closed.
*
* @param file Image file to get information for.
* @param dumpFlag ossim-info -d
* @param dnoFlag ossim-info --dno
* @param imageGeomFlag ossim-info -p
* @param imageInfoFlag ossim-info -i
* @param metaDataFlag ossim-info -m
* @param paletteFlag ossim-info --palette
* @param kwl Initialized by this method.
*/
void getImageInfo(const ossimFilename& file,
bool dumpFlag,
bool dnoFlag,
bool imageGeomFlag,
bool imageInfoFlag,
bool metaDataFlag,
bool paletteFlag,
ossimKeywordlist& kwl);
/**
* @brief Opens image handler and stores in m_img data member.
* @param Image to open.
* @note Throws ossimException if image cannot be opened.
*/
void openImage(const ossimFilename& file);
/** @brief Closes image if open. */
void closeImage();
/**
* @return Ref pointer to the image handler. Can be null if an image is
* not open.
*/
ossimRefPtr<ossimImageHandler> getImageHandler();
/** @brief Dumps the image information from ossimInfoFactoryRegistry */
void dumpImage(const ossimFilename& file, bool dnoFlag) const;
/**
* @brief Dumps the image information from ossimInfoFactoryRegistry to
* keyword list.
* @param file Image to dump.
* @param dnoFlag Dump no overviews. If true do not dump overviews.
* @param kwl Initialized by this method.
*/
void dumpImage(const ossimFilename& file,
bool dnoFlag,
ossimKeywordlist& kwl) const;
/**
* @brief Prints factories.
* @param keywordListFlag If true the result of a saveState will be output
* for each factory.
* */
void printFactories(bool keywordListFlag) const;
/**
* @brief Populates keyword list with metadata.
* This requires open image.
*
* @param kwl Keyword list to populate.
*/
void getImageMetadata(ossimKeywordlist& kwl) const;
/**
* @brief Populates keyword list with palette data.
* This requires open image.
*
* @param kwl Keyword list to populate.
*/
void getImagePalette(ossimKeywordlist& kwl);
/**
* @brief Populates keyword list with general image information.
*
* This requires open image.
*
* @param kwl Keyword list to populate.
* @param dnoFlag If true no entries flaged as overviews will be output.
*/
void getImageInfo(ossimKeywordlist& kwl, bool dnoFlag);
/**
* @brief Populates keyword list with general image information.
*
* @param entry Entry number to select. Note this is the entry number from
* the getEntryList call not a simple zero based entry index.
*
* @param kwl Keyword list to populate.
*
* @param dnoFlag If true no entries flaged as overviews will be output.
*
* This requires open image.
*
* @return true if entry info was saved to keyword list false if not.
*/
bool getImageInfo(ossim_uint32 entry, ossimKeywordlist& kwl, bool dnoFlag);
/**
* @brief Populates keyword list with image geometry/projection information.
*
* This requires open image.
*
* @param kwl Keyword list to populate.
* @param dnoFlag If true no entries flaged as overviews will be output.
*/
void getImageGeometryInfo(ossimKeywordlist& kwl, bool dnoFlag);
/**
* @brief Populates keyword list with image geometry/projection information.
*
* @param entry Entry number to select. Note this is the entry number
* from the getEntryList call not a simple zero based entry index.
*
* @param kwl Keyword list to populate.
*
* @param dnoFlag If true no entries flaged as overviews will be output.
*
* This requires open image.
*
* @return true if entry info was saved to keyword list false if not.
*/
bool getImageGeometryInfo( ossim_uint32 entry,
ossimKeywordlist& kwl,
bool dnoFlag );
void getCenterImage(ossimKeywordlist& kwl);
void getCenterImage(ossim_uint32 entry, ossimKeywordlist& kwl);
void getCenterGround(ossimKeywordlist& kwl);
void getCenterGround(ossim_uint32 entry, ossimKeywordlist& kwl);
/**
* @brief Populates keyword list with up_is_up_rotation.
*
* @param kwl Keyword list to populate.
*
* This requires open image.
*/
void getUpIsUpAngle(ossimKeywordlist& kwl);
/**
* @brief Populates keyword list with up_is_up_rotation.
*
* @param entry Entry number to select. Note this is the entry number
* from the getEntryList call not a simple zero based entry index.
*
* @param kwl Keyword list to populate.
*
* @param dnoFlag If true no entries flaged as overviews will be output.
*
* This requires open image.
*/
void getUpIsUpAngle(ossim_uint32 entry, ossimKeywordlist& kwl);
/**
* @brief Populates keyword list with image rectangle.
*
* This requires open image.
*
* @param kwl Keyword list to populate.
*/
void getImageRect(ossimKeywordlist& kwl);
/**
* @brief Populates keyword list with image rectangle.
*
* @param entry Entry number to select. Note this is the entry number from
* the getEntryList call not a simple zero based entry index.
*
* @param kwl Keyword list to populate.
*
* This requires open image.
*/
void getImageRect(ossim_uint32 entry, ossimKeywordlist& kwl);
/**
* @return true if current open image entry is an overview.
*/
bool isImageEntryOverview() const;
/** @brief Dumps ossim preferences/configuration data. */
void printConfiguration() const;
/**
* @brief Dumps ossim preferences/configuration data.
* @param out Output to write to.
* @return stream
*/
std::ostream& printConfiguration(std::ostream& out) const;
/** @brief Dumps datum list to stdout. */
void printDatums() const;
/** @brief Dumps datum list to stream. */
std::ostream& printDatums(std::ostream& out) const;
/** @brief Converts degrees to radians and outputs to stdout. */
void deg2rad(const ossim_float64& degrees) const;
/**
* @brief Converts degrees to radians and outputs to stream.
* @param out Output to write to.
* @return stream
*/
std::ostream& deg2rad(const ossim_float64& degrees, std::ostream& out) const;
/** @brief Converts radians to degrees and outputs to stdout. */
void rad2deg(const ossim_float64& radians) const;
/**
* @brief Converts radians to degrees and outputs to stream.
* @param out Output to write to.
* @return stream
*/
std::ostream& rad2deg(const ossim_float64& radians, std::ostream& out) const;
/** @brief Converts feet to meters and outputs to stdout. */
void ft2mtrs(const ossim_float64& feet, bool us_survey) const;
/**
* @brief Converts feet to meters and outputs to stream.
* @param out Output to write to out.
* @return stream
*/
std::ostream& ft2mtrs(const ossim_float64& feet, bool us_survey, std::ostream& out) const;
/** @brief Converts meters to feet and outputs to stdout. */
void mtrs2ft(const ossim_float64& meters, bool us_survey) const;
/**
* @brief Converts meters to feet and outputs to stream.
* @param out Output to write to out.
* @return stream
*/
std::ostream& mtrs2ft(const ossim_float64& meters, bool us_survey, std::ostream& out) const;
/**
* @brief Get meters per degree for a given latitude and outputs to stdout.
* @param latitude
*/
void mtrsPerDeg(const ossim_float64& latitude) const;
/**
* @brief Get meters per degree for a given latitude and outputs to stream.
* @param latitude
* @param out Output to write to out.
* @return stream
*/
std::ostream& mtrsPerDeg(const ossim_float64& latitude, std::ostream& out) const;
/**
* @brief Gets the height for ground point (latitude, longitude). Outputs
* to stdout.
* @param gpt Ground point.
*/
void outputHeight(const ossimGpt& gpt) const;
/**
* @brief Gets the height for ground point (latitude, longitude). Outputs
* to out.
* @param out Output to write to out.
* @return stream
*/
std::ostream& outputHeight(const ossimGpt& gpt, std::ostream& out) const;
/** @brief Prints loaded plugins to stdout. */
void printPlugins() const;
/**
* @brief Prints loaded plugins to stream.
* @param out Output to write to out.
* @return stream
*/
std::ostream& printPlugins(std::ostream& out) const;
/**
* @brief Test a plugin load and outputs to stdout.
*
* @param plugin Plugin to test.
*/
void testPlugin(const ossimFilename& plugin) const;
/**
* @brief Test a plugin load outputs to stream.
*
* @param plugin Plugin to test.
* @param out Stream to write to.
* @param stream
*/
std::ostream& testPlugin(const ossimFilename& plugin, std::ostream& out) const;
/** @brief Prints overview types to stdout. */
void printOverviewTypes() const;
/** @brief Prints overview types to stream. */
std::ostream& printOverviewTypes(std::ostream& out) const;
/** @breif Prints projections to stdout. */
void printProjections() const;
/** @breif Prints projections to stream. */
std::ostream& printProjections(std::ostream& out) const;
/** @brief Prints reader properties to stdout. */
void printReaderProps() const;
/** @brief Prints reader properties to stream. */
std::ostream& printReaderProps(std::ostream& out) const;
/** @brief Prints resampler filters to stdout. */
void printResamplerFilters() const;
/** @brief Prints resampler filters to stream. */
std::ostream& printResamplerFilters(std::ostream& out) const;
/** @brief Prints list of available writers to stdout. */
void printWriters() const;
/** @brief Prints list of available writers to stream. */
std::ostream& printWriters(std::ostream& out) const;
/** @brief Prints writer properties to stdout. */
void printWriterProps() const;
/** @brief Prints writer properties to stream. */
std::ostream& printWriterProps(std::ostream& out) const;
/**
* @brief Gets the radiometry string, i.e. "8-bit" and so on, from scalar.
* @param scalar Scalar type.
* @param s String to initialize.
*/
void getRadiometry(ossimScalarType scalar, std::string& s) const;
private:
/**
* @brief Populates keyword list with metadata.
* @param ih Pointer to an image handler.
* @param kwl Keyword list to populate.
*/
void getImageMetadata( const ossimImageHandler* ih,
ossimKeywordlist& kwl ) const;
/**
* @brief Populates keyword list with palette data.
* @param ih Pointer to an image handler.
* @param kwl Keyword list to populate.
*/
void getImagePalette( ossimImageHandler* ih,
ossimKeywordlist& kwl ) const;
/**
* @brief Populates keyword list with general image information.
* @param ih Pointer to an image handler.
* @param kwl Keyword list to populate.
* @param dnoFlag If true no entries flaged as overviews will be output.
*/
void getImageInfo( ossimImageHandler* ih,
ossimKeywordlist& kwl,
bool dnoFlag ) const;
/**
* @brief Populates keyword list with general image information.
* @param ih Pointer to an image handler.
* @param entry Entry number to select. Note this is the entry number from
* the getEntryList call not a simple zero based entry index.
* @param kwl Keyword list to populate.
* @param dnoFlag If true no entries flaged as overviews will be output.
* @return true if entry info was saved to keyword list false if not.
*/
bool getImageInfo( ossimImageHandler* ih,
ossim_uint32 entry,
ossimKeywordlist& kwl,
bool dnoFlag ) const;
/**
* @brief Populates keyword list with image geometry/projection information.
* @param ih Pointer to an image handler.
* @param kwl Keyword list to populate.
* @param dnoFlag If true no entries flaged as overviews will be output.
*/
void getImageGeometryInfo( ossimImageHandler* ih,
ossimKeywordlist& kwl,
bool dnoFlag ) const;
/**
* @brief Populates keyword list with image geometry/projection information.
* @param ih Pointer to an image handler.
* @param entry Entry number to select. Note this is the entry number
* from the getEntryList call not a simple zero based entry index.
* @param kwl Keyword list to populate.
* @param dnoFlag If true no entries flaged as overviews will be output.
* @return true if entry info was saved to keyword list false if not.
*/
bool getImageGeometryInfo( ossimImageHandler* ih,
ossim_uint32 entry,
ossimKeywordlist& kwl,
bool dnoFlag ) const;
void getCenterImage( ossimImageHandler* ih,
ossimKeywordlist& kwl ) const;
void getCenterImage( ossimImageHandler* ih,
ossim_uint32 entry,
ossimKeywordlist& kwl ) const;
void getCenterGround( ossimImageHandler* ih,
ossimKeywordlist& kwl ) const;
void getCenterGround( ossimImageHandler* ih,
ossim_uint32 entry,
ossimKeywordlist& kwl ) const;
/**
* @brief Populates keyword list with up_is_up_rotation.
* @param kwl Keyword list to populate.
*/
void getUpIsUpAngle( ossimImageHandler* ih,
ossimKeywordlist& kwl ) const;
/**
* @brief Populates keyword list with up_is_up_rotation.
* @param entry Entry number to select. Note this is the entry number from
* the getEntryList call not a simple zero based entry index.
* @param kwl Keyword list to populate.
*/
void getUpIsUpAngle( ossimImageHandler* ih,
ossim_uint32 entry,
ossimKeywordlist& kwl ) const;
/**
* @brief Populates keyword list with image rectangle.
*
* @param kwl Keyword list to populate.
*/
void getImageRect( ossimImageHandler* ih,
ossimKeywordlist& kwl ) const;
/**
* @brief Populates keyword list with image rectangle.
* @param entry Entry number to select. Note this is the entry number from
* the getEntryList call not a simple zero based entry index.
* @param kwl Keyword list to populate.
*/
void getImageRect( ossimImageHandler* ih,
ossim_uint32 entry,
ossimKeywordlist& kwl ) const;
/** @return true if current open image entry is an overview. */
bool isImageEntryOverview( const ossimImageHandler* ih ) const;
/**
* @brief Opens image.
* @param Image to open.
* @return ossimRefPtr with image handler.
* @note Throws ossimException if image cannot be opened.
*/
ossimRefPtr<ossimImageHandler> openImageHandler(const ossimFilename& file) const;
/** @brief Initializes arg parser and outputs usage. */
void usage(ossimArgumentParser& ap);
/** Hold all options passed into intialize except writer props. */
ossimRefPtr<ossimKeywordlist> m_kwl;
/** Holds the open image. */
ossimRefPtr<ossimImageHandler> m_img;
};
#endif /* #ifndef ossimInfo_HEADER */
|