/usr/include/ossim/imaging/ossimOverviewBuilderBase.h is in libossim-dev 1.7.21-4.
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 | //----------------------------------------------------------------------------
//
// License: LGPL
//
// See LICENSE.txt file in the top level directory for more details.
//
// Author: David Burken
//
// Description: Base class for overview builders.
//
//----------------------------------------------------------------------------
// $Id: ossimOverviewBuilderBase.h 15366 2009-09-04 13:30:04Z dburken $
#ifndef ossimOverviewBuilderBase_HEADER
#define ossimOverviewBuilderBase_HEADER
#include <ossim/base/ossimSource.h>
#include <ossim/base/ossimProcessInterface.h>
#include <ossim/base/ossimConnectableObjectListener.h>
#include <ossim/base/ossimRtti.h>
#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimString.h>
class ossimImageHandler;
class ossimFilename;
class OSSIM_DLL ossimOverviewBuilderBase
:
public ossimSource,
public ossimProcessInterface,
public ossimConnectableObjectListener
{
public:
/** default constructor */
ossimOverviewBuilderBase();
/** virtual destructor */
virtual ~ossimOverviewBuilderBase();
/**
* @brief Sets the input to the builder. (pure virtual)
*
* @param imageSource The input to the builder.
*
* @param bool youOwnItFlag If true this object own the imageSource
* memory and will delete imageSource at destruction or change of
* imageSource.
*
* @return True on successful initializion, false on error.
*/
virtual bool setInputSource(ossimImageHandler* imageSource,
bool youOwnItFlag) = 0;
/**
* @brief Sets the output file name. (pure virtual)
* @prama file This will be the output file name like foo.ovr
*/
virtual void setOutputFile(const ossimFilename& file)=0;
/**
* @brief Gets the output file name. (pure virtual)
*
* @return The output file name or ossimFilename::NIL if it was not set
* yet and the image handle has not been initialized.
*
* @note This will return ossimFilename::NIL unless one of was called,
* setInputSource or setOutputFile.
*/
virtual ossimFilename getOutputFile() const=0;
/**
* @brief Sets the overview output type. (pure virtual)
* @param type This should be the string representing the type. This method
* will do nothing if type is not handled and return false.
* @return true if type is handled, false if not.
* @note Currently handled types are
*/
virtual bool setOverviewType(const ossimString& type)=0;
/**
* @brief Gets the overview type. (pure virtual)
* @return The overview output type as a string. */
virtual ossimString getOverviewType() const=0;
/**
* @brief Method to check if builder can handle type.
* @return true if type is handled by builder, false if not.
*/
virtual bool hasOverviewType(const ossimString& type) const;
/**
* @brief Method to populate class supported types. (pure virtual)
* Example:
* ossimTiffOverviewNearest
* ossimTiffOverviewBox
*
* @param typeList List of ossimStrings to add to.
*/
virtual void getTypeNameList(std::vector<ossimString>& typeList)const=0;
/**
* @brief Get the overview stop dimension.
* @return The overview stop dimension.
*/
virtual ossim_uint32 getOverviewStopDimension() const;
/**
* @brief Sets the overview stop dimension.
*
* This controls how many layers will be built. If set to 64 then the
* builder will stop when height and width for current level are less
* than or equal to 64. Note a default can be set in the ossim preferences
* file, setting the keyword "overview_stop_dimension".
*
* @param dim The overview stop dimension
*/
virtual void setOverviewStopDimension(ossim_uint32 dim);
/**
* @brief Builds the overviews. (pure virtual)
*
* @return true on success, false on error.
*/
virtual bool execute()=0;
static const char* OVERVIEW_STOP_DIMENSION_KW;
protected:
/**
* @brief Gets the required number of res levels.
*
* Convenience method to get the required number of reduced resolution
* data sets to get to the smallest dimension of the output tile size.
* Note that this include r0.
*
* @param ih Pointer to the image handler.
*
* @return number of res levels.
*/
ossim_uint32 getRequiredResLevels(const ossimImageHandler* ih) const;
/**
* @brief Gets the default stop dimension.
*
* Looks for overview_stop_dimension, then will use minimum default tile
* size if that is not found.
*
* @returns Returns the default stop dimension.
*/
ossim_uint32 getDefaultStopDimension() const;
ossim_uint32 theOverviewStopDimension;
/** for rtti stuff */
TYPE_DATA
};
#endif /* End of "#ifndef ossimOverviewBuilderBase_HEADER" */
|