#include <ossimImageUtil.h>

Inheritance diagram for ossimImageUtil:

Public Member Functions
	ossimImageUtil ()
	default constructor More...

virtual	~ossimImageUtil ()
	virtual destructor More...

void	addOptions (ossimApplicationUsage *au)

void	addArguments (ossimArgumentParser &ap)
	Adds application arguments to the argument parser. More...

bool	initialize (ossimArgumentParser &ap)
	Initial method. More...

ossim_int32	execute ()
	Execute method. More...

virtual void	processFile (const ossimFilename &file)
	ProcessFile method. More...

void	setCreateOverviewsFlag (bool flag)
	Sets create overviews flag keyword CREATE_OVERVIEWS_KW used by processFile method. More...

bool	createOverviews () const

void	setCreateThumbnailsFlag (bool flag)
	Sets create thumbnails flag keyword CREATE_THUMBNAILS_KW used by processFile method. More...

void	setThumbnailType (const std::string &value)

void	setThumbnailStretchType (const std::string &value)

bool	createThumbnails () const

void	setRebuildOverviewsFlag (bool flag)
	Sets the rebuild overview flag keyword REBUILD_OVERVIEWS_KW used by processFile method. More...

bool	rebuildOverviews () const

void	setRebuildHistogramFlag (bool flag)
	Sets the rebuild histogram flag keyword REBUILD_HISTOGRAM_KW used by processFile method. More...

bool	rebuildHistogram () const

void	setOverviewType (const std::string &type)
	Sets key OVERVIEW_TYPE_KW. More...

void	setOverviewStopDimension (ossim_uint32 dimension)
	sets the overview stop dimension. More...

void	setOverviewStopDimension (const std::string &dimension)

void	setTileSize (ossim_uint32 tileSize)
	Sets the tile size. More...

bool	getTileSize (ossimIpt &tileSize) const
	Gets the tile size. More...

ossim_uint32	getOverviewStopDimension () const

void	setCreateHistogramFlag (bool flag)
	Sets create histogram flag keyword CREATE_HISTOGRAM_KW used by processFile method. More...

bool	createHistogram () const

void	setCreateHistogramFastFlag (bool flag)
	Sets create histogram flag keyword CREATE_HISTOGRAM_FAST_KW used by processFile method. More...

bool	createHistogramFast () const

void	setCreateHistogramR0Flag (bool flag)
	Sets create histogram "R0" flag keyword CREATE_HISTOGRAM_R0_KW used by processFile method. More...

bool	createHistogramR0 () const

bool	hasHistogramOption () const

ossimHistogramMode	getHistogramMode () const

void	setScanForMinMax (bool flag)
	Sets scan for min/max flag keyword SCAN_MIN_MAX_KW used by processFile method. More...

bool	scanForMinMax () const

void	setScanForMinMaxNull (bool flag)
	Sets scan for min/max/null flag keyword SCAN_MIN_MAX_KW used by processFile method. More...

bool	scanForMinMaxNull () const

void	setCompressionQuality (const std::string &quality)
	Sets the writer property for compression quality. More...

void	setCompressionType (const std::string &type)
	Sets the compression type to use when building overviews. More...

void	setCopyAllFlag (bool flag)
	Sets the overview builder copy all flag. More...

bool	getCopyAllFlag () const

void	setDumpFilteredImageListFlag (bool flag)
	Sets the dump filteredImageList flag. More...

bool	getDumpFilterImagesFlag () const

void	setInternalOverviewsFlag (bool flag)
	Sets the overview builder internal overviews flag. More...

bool	getInternalOverviewsFlag () const

void	setOutputDirectory (const std::string &directory)
	Sets the output directory. More...

void	setOutputFileNamesFlag (bool flag)
	Sets the output file name flag OUTPUT_FILENAMES_KW. More...

bool	getOutputFileNamesFlag () const

void	setOverrideFilteredImagesFlag (bool flag)
	Sets the override filtered images flag. More...

bool	getOverrideFilteredImagesFlag () const

void	setNumberOfThreads (ossim_uint32 threads)
	Set number of threads to use. More...

void	setNumberOfThreads (const std::string &threads)

const std::vector< std::string > &	getFilteredImages () const

std::vector< std::string > &	getFilteredImages ()
	Non const method to allow access for adding or deleting extensions from the list. More...

Public Member Functions inherited from ossimReferenced
	ossimReferenced ()

	ossimReferenced (const ossimReferenced &)

ossimReferenced &	operator= (const ossimReferenced &)

void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

int	referenceCount () const

Public Member Functions inherited from ossimFileProcessorInterface
	ossimFileProcessorInterface ()
	default constructor More...

virtual	~ossimFileProcessorInterface ()
	virtual destructor. More...

Private Member Functions
bool	keyIsTrue (const std::string &key) const

bool	isFiltered (const ossimFilename &f) const
	Convenience method to check file to see is if file should be processed. More...

void	initializeDefaultFilterList ()
	Initializes the filter list with a default set of filtered out file names. More...

void	dumpFilteredImageList () const
	Dumps filtered image list to std out. More...

void	createOverview (ossimRefPtr< ossimImageHandler > &ih, bool &consumedHistogramOptions, bool &consumedCmmOptions)

void	createOverview (ossimRefPtr< ossimImageHandler > &ih, ossimRefPtr< ossimOverviewBuilderBase > &ob, ossim_uint32 entry, bool useEntryIndex, bool &consumedHistogramOptions)

void	createThumbnail (ossimRefPtr< ossimImageHandler > &ih)

bool	hasRequiredOverview (ossimRefPtr< ossimImageHandler > &ih, ossimRefPtr< ossimOverviewBuilderBase > &ob)

bool	hasCmmOption () const

void	createHistogram (ossimRefPtr< ossimImageHandler > &ih)

void	createHistogram (ossimRefPtr< ossimImageHandler > &ih, ossim_uint32 entry, bool useEntryIndex)

void	computeMinMax (ossimRefPtr< ossimImageHandler > &ih)

void	computeMinMax (ossimRefPtr< ossimImageHandler > &ih, ossim_uint32 entry, bool useEntryIndex)

void	usage (ossimArgumentParser &ap)
	Initializes arg parser and outputs usage. More...

void	outputOverviewWriterTypes () const

bool	isDirectoryBasedImage (const ossimImageHandler *ih) const

void	getOverviewType (std::string &type) const
	Initializes type from OVERVIEW_TYPE_KW or sets to default ossim_tiff_box if not found. More...

void	setProps (ossimPropertyInterface *pi) const
	set reader or writer properties based on cast of pi. More...

ossim_uint32	getNumberOfThreads () const

ossim_uint32	getNextWriterPropIndex () const

ossim_uint32	getNextReaderPropIndex () const

ossim_uint32	getThumbnailSize () const

int	getThumbnailStretchType () const

std::string	getThumbnailType () const

std::string	getThumbnailFilename (ossimImageHandler *ih) const

void	addOption (const std::string &key, ossim_uint32 value)
	Adds option to m_kwl with mutex lock. More...

void	addOption (const std::string &key, const std::string &value)

void	setErrorStatus (ossim_int32 status)
	Sets the m_errorStatus for return on execute. More...

void	executePrepCommands () const
	run prep system commands. More...

void	executeFileCommands (const ossimFilename &file) const
	run per file system commands. More...

void	executePostCommands () const
	run post system commands. More...

void	executeCommands (const std::string &prefix, const ossimFilename &file) const
	system commands. More...

void	substituteCommandString (const ossimFilename &file, const std::string &prefix, const std::string &commandKey, ossimString &command) const
	Expands variables in a command string. More...

void	substituteFileStrings (const ossimFilename &file, ossimString &command) const
	Expands file level variables in a command string. More...

void	gsubDate (const std::string &commandPrefix, ossimString &command) const
	Expands date variables in a command string. More...

Private Attributes
ossimRefPtr< ossimKeywordlist >	m_kwl
	Holds all options passed into intialize except writer props. More...

ossimFileWalker *	m_fileWalker

std::mutex	m_mutex

ossim_int32	m_errorStatus

std::vector< std::string >	m_filteredImages
	Hold images we never want to process. More...

Additional Inherited Members
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Detailed Description

ossimImageUtil class.

Utility class for processing image recursively. This is for doing things like:

building overview, histograms, compute min/max, extract vertices.

Definition at line 44 of file ossimImageUtil.h.

Constructor & Destructor Documentation

◆ ossimImageUtil()

ossimImageUtil::ossimImageUtil ( )

default constructor

Definition at line 105 of file ossimImageUtil.cpp.

    :
    ossimReferenced(),
    ossimFileProcessorInterface(),
    m_kwl( new ossimKeywordlist() ),
    m_fileWalker(0),
    m_mutex(),
    m_errorStatus(0),
    m_filteredImages(0)
 {
 }

◆ ~ossimImageUtil()

ossimImageUtil::~ossimImageUtil ( )

virtual

virtual destructor

Definition at line 117 of file ossimImageUtil.cpp.

References m_fileWalker.

 {
    if ( m_fileWalker )
    {
       delete m_fileWalker;
       m_fileWalker = 0;
    }
 }

Member Function Documentation

◆ addArguments()

void ossimImageUtil::addArguments ( ossimArgumentParser & ap )

Adds application arguments to the argument parser.

Parameters

ap	Parser to add to.

Definition at line 189 of file ossimImageUtil.cpp.

References addOptions(), ossimArgumentParser::getApplicationName(), ossimArgumentParser::getApplicationUsage(), and ossimApplicationUsage::setCommandLineUsage().

Referenced by usage().

 {
    // Set the general usage:
    ossimApplicationUsage* au = ap.getApplicationUsage();
    ossimString usageString = ap.getApplicationName();
    usageString += " [options] <file-or-directory-to-walk>";
    au->setCommandLineUsage(usageString);
 
    addOptions(au);
  
 } // void ossimImageUtil::addArguments(ossimArgumentParser& ap)

◆ addOption() [1/2]

void ossimImageUtil::addOption	(	const std::string &	key,
		ossim_uint32	value
	)

private

Adds option to m_kwl with mutex lock.

Parameters

key
value

Definition at line 2182 of file ossimImageUtil.cpp.

References ossimString::toString().

Referenced by setCreateHistogramFastFlag(), setCreateHistogramFlag(), setCreateHistogramR0Flag(), setCreateOverviewsFlag(), setCreateThumbnailsFlag(), setNumberOfThreads(), setOverviewStopDimension(), setRebuildHistogramFlag(), setRebuildOverviewsFlag(), setScanForMinMax(), setScanForMinMaxNull(), setThumbnailStretchType(), setThumbnailType(), and setTileSize().

 {
    addOption(key, ossimString::toString(value).string());
 }

◆ addOption() [2/2]

void ossimImageUtil::addOption	(	const std::string &	key,
		const std::string &	value
	)

private

Definition at line 2187 of file ossimImageUtil.cpp.

References ossimKeywordlist::addPair(), m_kwl, m_mutex, and ossimRefPtr< T >::valid().

 {
    m_mutex.lock();
    if ( m_kwl.valid() )
    {
       if ( key.size() && value.size() )
       {
          m_kwl->addPair( key, value );
       }
    }
    m_mutex.unlock();
 }

◆ addOptions()

void ossimImageUtil::addOptions ( ossimApplicationUsage * au )

Definition at line 126 of file ossimImageUtil.cpp.

References ossimApplicationUsage::addCommandLineOption().

Referenced by addArguments().

 {
    // Set the command line options:
    au->addCommandLineOption("-a or --include-fullres", "Copy full res dataset to overview file as well as building reduced res sets. Option only valid with tiff overview builder. Requires -o option.");
  
    au->addCommandLineOption("--ch or --create-histogram", "Computes full histogram alongside overview.");
 
    au->addCommandLineOption("--chf or --create-histogram-fast", "Computes a histogram in fast mode which samples partial tiles.");
    au->addCommandLineOption("--ct or --create-thumbnail", "computes a thumbnail of the image");
    au->addCommandLineOption("--tt or --thumbnail-type", "Can be of of values png or jpeg");
    au->addCommandLineOption("--tst or --thumbnail-stretch-type", "Can be of values none,auto-minmax,auto-percentile,std-stretch-1,std-stretch-2,std-stretch-3");
 
    au->addCommandLineOption("--compression-quality", "Compression quality for TIFF JPEG takes values from 0 to 100, where 100 is best.  For J2K plugin, numerically_lossless, visually_lossless, lossy");
  
    au->addCommandLineOption("--compute-min-max", "Turns on min, max scanning when reading tiles and writes a dot omd file. This option assumes the null is known.");
  
    au->addCommandLineOption("--compute-min-max-null", "Turns on min, max, null scanning when reading tiles and write a dot omd file. This option tries to find a null value which is useful for float data.");
  
    au->addCommandLineOption("--compression-type", "Compression type can be: deflate, jpeg, lzw, none or packbits");
  
    au->addCommandLineOption("--create-histogram-r0", "Forces create-histogram code to compute a histogram using r0 instead of the starting resolution for the overview builder. Can require a separate pass of R0 layer if the base image has built in overviews.");
  
    au->addCommandLineOption("-d", "<output_directory> Write overview to output directory specified.");
  
    au->addCommandLineOption("--dump-filtered-image-list", "Outputs list of filtered images and extensions.");
  
    au->addCommandLineOption("-h", "Display this information");
  
    au->addCommandLineOption("-i or --internal-overviews", "Builds internal overviews. Requires -o option. Option only valid with tiff input image and tiff overview builder. WARNING: Modifies source image and cannot be undone!");
  
    au->addCommandLineOption("--list-entries", "Lists the entries within the image");
  
    au->addCommandLineOption("--max","Overrides max value for compute-min-max option.");
  
    au->addCommandLineOption("--min","Overrides min value for compute-min-max option.");
  
    au->addCommandLineOption("--null", "<null_value> Overrides null value for compute-min-max option.  e.g. -9999.0 for float data");
  
    au->addCommandLineOption("-o", "Creates overviews. (default=ossim_tiff_box)");
  
    au->addCommandLineOption("--of or --output-files", "Output image files we can open, exluding overviews.");
 
    au->addCommandLineOption("--options","<options.kwl>  This can be all or part of the application options. Also used for custom prep, per file and post system commands. To get a template you can turn on trace to the ossimImageUtil class by adding \"-T ossimImageUtil\" to your command.");
  
    au->addCommandLineOption("--ot", "<overview_type> Overview type. see list at bottom for valid types. (default=ossim_tiff_box)");
  
    au->addCommandLineOption("--override-filtered-images", "Allows processing of file that is in the filtered image list.");
  
    au->addCommandLineOption("-r or --rebuild-overviews", "Rebuild overviews even if they are already present.");
  
    au->addCommandLineOption("--rebuild-histogram", "Rebuild histogram even if they are already present.");
  
    au->addCommandLineOption("--reader-prop", "Adds a property to send to the reader. format is name=value");
  
    au->addCommandLineOption("-s",  "Stop dimension for overviews.  This controls how \nmany 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 by setting the keyword \"overview_stop_dimension\".");
 
    au->addCommandLineOption("--tile-size", "<size> Defines the tile size for overview builder.  Tiff option only. Must be a multiple of 16. Size will be used in both x and y directions. Note a default can be set in your ossim preferences file by setting the key \"tile_size\".");
  
    au->addCommandLineOption("--threads", "<threads> The number of threads to use. (default=1) Note a default can be set in your ossim preferences file by setting the key \"ossim_threads\".");
  
    au->addCommandLineOption("--writer-prop", "Adds a property to send to the writer. format is name=value");
 }

◆ computeMinMax() [1/2]

void ossimImageUtil::computeMinMax ( ossimRefPtr< ossimImageHandler > & ih )

private

Definition at line 1278 of file ossimImageUtil.cpp.

 {
    static const char M[] = "ossimImageUtil::computeMinMax #1";
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << M << " entered...\n";
    }
  
    if ( ih.valid() )
    {
       // Get the entry list:
       std::vector<ossim_uint32> entryList;
       ih->getEntryList(entryList);
  
       bool useEntryIndex = false;
       if ( entryList.size() )
       {
          if ( (entryList.size() > 1) || (entryList[0] != 0) ) useEntryIndex = true;
       }
  
       for(ossim_uint32 idx = 0; idx < entryList.size(); ++idx)
       {
          computeMinMax(ih, entryList[idx], useEntryIndex);
       }
    }
  
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << M << " exited...\n";
    }
  
 } // End: ossimImageUtil::computeMinMax( ih )

◆ computeMinMax() [2/2]

void ossimImageUtil::computeMinMax	(	ossimRefPtr< ossimImageHandler > &	ih,
		ossim_uint32	entry,
		bool	useEntryIndex
	)

private

Definition at line 1311 of file ossimImageUtil.cpp.

 {
    static const char M[] = "ossimImageUtil::computeMinMax #2";
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << M << " entered...\n";
    }
  
    if ( ih.valid() )
    {
       // Get any min, max, null overrides;
       double maxValue  = ossim::nan();
       double minValue  = ossim::nan();
       double nullValue = ossim::nan();
 
       ossimString value = m_kwl->findKey( CMM_MAX_KW );
       if ( value.size() )
       {
          maxValue = value.toDouble();
       }
 
       value = m_kwl->findKey( CMM_MIN_KW );
       if ( value.size() )
       {
          minValue = value.toDouble();
       }
 
       bool hasNull = false;
       value = m_kwl->findKey( CMM_NULL_KW );
       if ( value.size() )
       {
          nullValue = value.toDouble();
          if ( !ossim::isnan(nullValue) )
          {
             hasNull = true;
          }
       }
  
       // Select the entry.
       ih->setCurrentEntry( entry );
  
       // Build the .omd file name.
       ossimFilename omd_file = ih->getFilename();;
 
       // Check for output directory:
       if ( m_kwl->hasKey( OUTPUT_DIRECTORY_KW ) )
       {
          ossimFilename outputDir;
          outputDir.string() = m_kwl->findKey( OUTPUT_DIRECTORY_KW );
          
          if ( outputDir.exists() && outputDir.isDir() )
          {
             omd_file = outputDir.dirCat( omd_file.file() );
          }
       }
  
       if ( useEntryIndex )
       {
          ossim_uint32 currentEntry = ih->getCurrentEntry();
          omd_file.setExtension("");
          omd_file += "_e";
          omd_file += ossimString::toString(currentEntry);
  
          //---
          // Note:  Set extension was not used here deliberately to avoid
          // messing
          // up a MODIS file in hdf format with multiple '.'s in the file
          // name.
          //---
          omd_file += ".omd";
       }
       else
       {
          omd_file.setExtension("omd");
       }
  
       ossimRefPtr<ossimImageSourceSequencer> is = new ossimImageSourceSequencer(ih.get());
  
       //---
       // Note: getImageTileWidth/Height will return zero if the image is not
       // intenally tiles.
       //---
       ossimIpt tileWidthHeight( ih->getImageTileWidth(), ih->getImageTileHeight() );
       if (!tileWidthHeight.x)
       {
          //---
          // Make the sequencer read entire strips from the image handler
          // at a time.  This will speed up access time for strip images
          //---
          tileWidthHeight.x = ih->getBoundingRect().width();
       }
       if(!tileWidthHeight.y)
       {
          tileWidthHeight.y = ih->getTileHeight();
       }
  
       if ( traceDebug() )
       {
          ossimNotify(ossimNotifyLevel_DEBUG)
             << "Sequencer tile size: " << tileWidthHeight << endl;
       }
  
       is->setTileSize(tileWidthHeight);
  
       //---
       // Make arrays of doubles to hold the min/max values.
       // Initialize mins to default maxes and maxes to default mins to be
       // safe.
       //---
       ossim_uint32 i; // for numerous iterations...
  
       const ossimScalarType ST = ih->getOutputScalarType();
  
       const double DEFAULT_MIN = ossim::defaultMin(ST);
       const double DEFAULT_MAX = ossim::defaultMax(ST);
  
       const ossim_uint32 BANDS = ih->getNumberOfInputBands();
  
       vector<double> tmin(BANDS);
       vector<double> tmax(BANDS);
       vector<double> tnull(BANDS);
       for (i = 0; i < BANDS; ++i)
       {
          tmin[i] = DEFAULT_MAX;
          tmax[i] = DEFAULT_MIN;
  
          if ( hasNull )
          {
             // User passed in with --null option so set here.
             tnull[i] = nullValue;
          }
          else
          {
             tnull[i] = ih->getNullPixelValue(i);
          }
       }
  
       // Scan the image and compute the min and max.
       const double TOTAL_TILES = is->getNumberOfTiles();
       double tile_count = 0.0;
       ossimNotify(ossimNotifyLevel_INFO)
          << setiosflags(ios::fixed) << setprecision(0);
  
       if( (ossim::isnan(minValue) ) || (ossim::isnan(maxValue) ) )
       {
          ossimRefPtr<ossimImageData> id = is->getNextTile();
          while(id.valid())
          {
             if ( hasNull )
             {
                // Pass null to image data object so it doesn't get picked up as "min".
                id->setNullPix( nullValue );
             }
             id->computeMinMaxPix(tmin, tmax);
             id = is->getNextTile();
             ++tile_count;
             ossimNotify(ossimNotifyLevel_INFO)
                << "\r"  << setw(3)
                << (tile_count / TOTAL_TILES * 100.0) << "%"
                << flush;
          }
       }
       
       if(!ossim::isnan(minValue))
       {
          std::fill(tmin.begin(), tmin.end(), minValue);
       }
       if(!ossim::isnan(maxValue))
       {
          std::fill(tmax.begin(), tmax.end(), maxValue);
       }
       ossimNotify(ossimNotifyLevel_WARN)
          << "\r100%\nFinished..." << endl;
  
       ossimKeywordlist okwl(omd_file);
  
       for(i = 0; i < BANDS; ++i)
       {
          //---
          // Check to see if values got assigned.  If not flip to default and
          // issue a warning.
          //---
          if (tmin[i] == DEFAULT_MAX)
          {
             tmin[i] = DEFAULT_MIN;
             ossimNotify(ossimNotifyLevel_WARN)
                << "cmm scan for min failed! Using default min."
                << std::endl;
          }
          if (tmax[i] == DEFAULT_MIN)
          {
             tmax[i] = DEFAULT_MAX;
             ossimNotify(ossimNotifyLevel_WARN)
                << "cmm scan for max failed! Using default max."
                << std::endl;
          }
             
          ossimString band =
             ossimString("band")+ossimString::toString(i+1)+".";
 
          if (tmin[i] == DEFAULT_MAX)
          {
             tmin[i] = DEFAULT_MIN;
          }
          // if (tmax[i] == DEFAULT_MIN){}
             
          okwl.add(band + "min_value", tmin[i], true);
          okwl.add(band + "max_value", tmax[i], true);
          okwl.add(band + "null_value", tnull[i], true); 
          
          if( traceDebug() )
          {
             ossimNotify(ossimNotifyLevel_INFO)
                << setiosflags(ios::fixed) << setprecision(16)
                << "band" << ossimString::toString(i+1) << ".min_value: "
                << tmin[i]
                << "\nband" << ossimString::toString(i+1) << ".max_value: "
                << tmax[i]
                << "\nband" << ossimString::toString(i+1) << ".null_value: "
                << tnull[i] << endl;
          }
          
       } // End of band loop.
       
       // Add missing info (number of bands, scalar type) to the .omd file
       okwl.add("bytes_per_pixel", ossim::scalarSizeInBytes(ST), true);
       okwl.add("number_bands", BANDS, true);
       okwl.add("scalar_type", (ossimScalarTypeLut::instance()->getEntryString(ST)), true);
 
       // Write the file to disk:
       okwl.write(omd_file);
       ossimNotify(ossimNotifyLevel_INFO)
          << "wrote file:  " << omd_file << endl;
 
       ih->loadMetaData(); 
 
    } // Matches: if ( ih.valid() )
    
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << M << " exited...\n";
    }
    
 } // End: ossimImageUtil::computeMinMax( ih, entry, ... )

◆ createHistogram() [1/3]

bool ossimImageUtil::createHistogram ( ) const

Returns: true if CREATE_HISTOGRAM_KW is found and set to true.

Definition at line 1956 of file ossimImageUtil.cpp.

References keyIsTrue().

Referenced by getHistogramMode(), and hasHistogramOption().

 {
    return keyIsTrue( CREATE_HISTOGRAM_KW );
 }

◆ createHistogram() [2/3]

void ossimImageUtil::createHistogram ( ossimRefPtr< ossimImageHandler > & ih )

private

Definition at line 1145 of file ossimImageUtil.cpp.

 {
    static const char M[] = "ossimImageUtil::createHistogram #1";
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << M << " entered...\n";
    }
  
    if ( ih.valid() )
    {
       // Get the entry list:
       std::vector<ossim_uint32> entryList;
       ih->getEntryList(entryList);
  
       bool useEntryIndex = false;
       if ( entryList.size() )
       {
          if ( (entryList.size() > 1) || (entryList[0] != 0) ) useEntryIndex = true;
       }
  
       for(ossim_uint32 idx = 0; idx < entryList.size(); ++idx)
       {
          createHistogram(ih, entryList[idx], useEntryIndex);
       }
    }
  
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << M << " exited...\n";
    }
 }

◆ createHistogram() [3/3]

void ossimImageUtil::createHistogram	(	ossimRefPtr< ossimImageHandler > &	ih,
		ossim_uint32	entry,
		bool	useEntryIndex
	)

private

Definition at line 1178 of file ossimImageUtil.cpp.

 {
    static const char M[] = "ossimImageUtil::createHistogram #2";
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << M << " entered...\n";
    }
  
    if ( ih.valid() )
    {
       if (useEntryIndex)
       {
          // Set entry before deriving file name.
          ih->setCurrentEntry(entry);
          ossimNotify(ossimNotifyLevel_NOTICE) << "entry number: "<< entry << std::endl;
       }
  
       ossimFilename outputFile =
          ih->getFilenameWithThisExtension(ossimString(".his"), useEntryIndex);
 
       // Only build if needed:
       if ( (outputFile.exists() == false) || rebuildHistogram() )
       {
          ossimNotify(ossimNotifyLevel_NOTICE)
             << "Computing histogram for file: " << ih->getFilename() << std::endl;
  
          // Check handler to see if it's filtering bands.
          std::vector<ossim_uint32> originalBandList(0);
          if ( ih->isBandSelector() )
          { 
             // Capture for finalize method.
             ih->getOutputBandList( originalBandList );
  
             // Set output list to input.
             ih->setOutputToInputBandList();
          }
  
          ossimRefPtr<ossimImageHistogramSource> histoSource = new ossimImageHistogramSource;
          ossimRefPtr<ossimHistogramWriter> writer = new ossimHistogramWriter;
  
          histoSource->setMaxNumberOfRLevels(1); // Currently hard coded...
  
 #if 0 /* TODO tmp drb */
          if( !ossim::isnan(histoMin) )
          {
             histoSource->setMinValueOverride(histoMin);
          }
  
          if( !ossim::isnan(histoMax) )
          {
             histoSource->setMaxValueOverride(histoMax);
          }
  
          if(histoBins > 0)
          {
             histoSource->setNumberOfBinsOverride(histoBins);
          }
 #endif
  
          if(traceDebug())
          {
             ossimNotify(ossimNotifyLevel_DEBUG)
                << "Histogram mode: " << getHistogramMode() << "\n";
          }
  
          // Connect histogram source to image handler.
          histoSource->setComputationMode( getHistogramMode() );
          histoSource->connectMyInputTo(0, ih.get() );
          histoSource->enableSource();
  
          // Connect writer to histogram source.
          writer->connectMyInputTo(0, histoSource.get());
          writer->setFilename(outputFile);
          theStdOutProgress.setFlushStreamFlag(true);
          writer->addListener(&theStdOutProgress);
  
          // Compute...
          writer->execute();
  
          writer=0;
  
          // Reset the band list.
          if ( ih->isBandSelector() && originalBandList.size() )
          {
             ih->setOutputBandList( originalBandList );
          }
  
       } // Matches: if ( (outputFile.exists() == false) || rebuildHistogram() )
  
    } // Matches: if ( ih.valid() )
  
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << M << " exited...\n";
    }
  
 } // End: ossimImageUtil::createHistogram #2

◆ createHistogramFast()

bool ossimImageUtil::createHistogramFast ( ) const

Returns: true if CREATE_HISTOGRAM_FAST_KW is found and set to true.

Definition at line 1966 of file ossimImageUtil.cpp.

References keyIsTrue().

Referenced by getHistogramMode(), and hasHistogramOption().

 {
    return keyIsTrue( CREATE_HISTOGRAM_FAST_KW );
 }

◆ createHistogramR0()

bool ossimImageUtil::createHistogramR0 ( ) const

Returns: true if CREATE_HISTOGRAM_R0_KW is found and set to true.

Definition at line 1976 of file ossimImageUtil.cpp.

References keyIsTrue().

Referenced by getHistogramMode(), and hasHistogramOption().

 {
    return keyIsTrue( CREATE_HISTOGRAM_R0_KW );
 }

◆ createOverview() [1/2]

void ossimImageUtil::createOverview	(	ossimRefPtr< ossimImageHandler > &	ih,
		bool &	consumedHistogramOptions,
		bool &	consumedCmmOptions
	)

private

Definition at line 797 of file ossimImageUtil.cpp.

 {
    static const char M[] = "ossimImageUtil::createOverview #1";
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << M << " entered...\n";
    }
  
    if ( ih.valid() )
    {
       // Get the entry list:
       std::vector<ossim_uint32> entryList;
       ih->getEntryList(entryList);
  
       bool useEntryIndex = false;
       if ( entryList.size() )
       {
          if ( (entryList.size() > 1) || (entryList[0] != 0) ) useEntryIndex = true;
       }
 
       // Create the overview builder:
       ossimString overviewType;
       getOverviewType( overviewType.string() );
       ossimRefPtr<ossimOverviewBuilderBase> ob =
          ossimOverviewBuilderFactoryRegistry::instance()->createBuilder(overviewType);
       if ( ob.valid() )
       {
          // Set up any overview builder options that don't involve histograms.
          ossimPropertyInterface* pi = dynamic_cast<ossimPropertyInterface*>( ob.get() );
          if ( pi ) setProps(pi);
  
          ossim_uint32 stopDimension = getOverviewStopDimension();
          if ( stopDimension ) ob->setOverviewStopDimension(stopDimension);
  
          if ( ( scanForMinMax() || scanForMinMaxNull() ) && !hasCmmOption() )
          {
             //---
             // If scan is set and we don't have any min, max, null overrides let the
             // overview builder scan for min, max.
             //
             // If min, max, or null option is set, scan will be performed in
             // separate function.
             //---
             ob->setScanForMinMax( scanForMinMax() );
             ob->setScanForMinMaxNull( scanForMinMaxNull() );
             consumedCmmOptions = true;
          }
  
          for(ossim_uint32 idx = 0; idx < entryList.size(); ++idx)
          {
             createOverview(ih, ob, entryList[idx], useEntryIndex, consumedHistogramOptions);
          }
       }
       else
       {
          ossimNotify(ossimNotifyLevel_WARN)
             << "ERROR:\nCould not create builder for:  "<< overviewType << std::endl;
          outputOverviewWriterTypes();
       }
    }
  
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << M << " exited...\n";
    }
 }

◆ createOverview() [2/2]

void ossimImageUtil::createOverview	(	ossimRefPtr< ossimImageHandler > &	ih,
		ossimRefPtr< ossimOverviewBuilderBase > &	ob,
		ossim_uint32	entry,
		bool	useEntryIndex,
		bool &	consumedHistogramOptions
	)

private

Definition at line 867 of file ossimImageUtil.cpp.

 {
    static const char M[] = "ossimImageUtil::createOverview #2";
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << M << " entered...\n";
    }
  
    if ( ih.valid() && ob.valid() )
    {
       if (useEntryIndex)
       {
          // Set entry before deriving file name.
          ih->setCurrentEntry(entry);
          ossimNotify(ossimNotifyLevel_NOTICE) << "entry number: "<< entry << std::endl;
       }
  
       ossimFilename outputFile =
          ih->getFilenameWithThisExtension(ossimString(".ovr"), useEntryIndex);
  
       if ( rebuildOverviews() )
       {
          ih->closeOverview(); 
          if ( outputFile.exists() )
          {
             outputFile.remove();
          }
       }
  
       if ( getInternalOverviewsFlag() )
       {
          if ( ih->getClassName() == "ossimTiffTileSource")
          {
             //---
             // INTERNAL_OVERVIEWS_FLAG_KW is set to true:
             // Tiff reader can handle internal overviews.  Set the output file to
             // input file.  Do it after the above remove so that if there were
             // external overviews they will get removed.
             //---
             outputFile = ih->getFilename();
          }
          else 
          {
             ossimNotify(ossimNotifyLevel_NOTICE)
                << "Internal overviews not supported for reader type: "
                <<ih->getClassName()
                << "\nIgnoring option..."
                << endl;
          }
       }
  
       if ( hasRequiredOverview( ih, ob ) == false )
       {
          //---
          // Set create histogram code...
          //
          // Notes:
          // 1) Must put this logic after any removal of external overview file.
          // 
          // 2) Base file could have built in overviews, e.g. jp2 files.  So the sequensor could
          //    start at R6 even if there is no external overview file.
          //
          // 3) If user want the histogram from R0 the overview builder can do as long as
          //    ossimImageHandler::getNumberOfDecimationLevels returns 1.  If we are starting
          //    overview building at R6 then we must do the create histogram in a separate path.
          //---
          ossimHistogramMode histoMode = OSSIM_HISTO_MODE_UNKNOWN;
          if ( createHistogram() ||
               ( createHistogramR0() && ( ih->getNumberOfDecimationLevels() == 1 ) ) )
          {
             histoMode = OSSIM_HISTO_MODE_NORMAL;
          }
          else if ( createHistogramFast() )
          {
             histoMode = OSSIM_HISTO_MODE_FAST;
          }
  
          if(traceDebug())
          {
             ossimNotify(ossimNotifyLevel_DEBUG) << "Histogram mode: " << histoMode << "\n";
          }
  
          if ( histoMode != OSSIM_HISTO_MODE_UNKNOWN )
          {
             consumedHistogramOptions = true;
             ob->setHistogramMode(histoMode);
  
             ossimNotify(ossimNotifyLevel_NOTICE)
                << "Creating overviews with histogram for file: " << ih->getFilename() << std::endl;
          }
          else
          {
             if ( histoMode != OSSIM_HISTO_MODE_UNKNOWN )
             {
                consumedHistogramOptions = false;  
                ossimNotify(ossimNotifyLevel_NOTICE)
                   << "Creating overviews for file: " << ih->getFilename() << std::endl;
             }
          }
 
          //---
          // Set properties, e.g. tile size.  Must be set before the call to
          // ob->setInputSource(...)
          //---
          std::vector< ossimRefPtr<ossimProperty> > propertyList(0);
          ossimIpt tileSize;
          if ( getTileSize( tileSize ) == true )
          {
             propertyList.push_back(new ossimStringProperty(ossimKeywordNames::OUTPUT_TILE_SIZE_KW,
             tileSize.toString()));
             ob->setProperties(propertyList);
          }
 
          ob->setOutputFile(outputFile);
          ob->setInputSource(ih.get());
 
          // Create the overview for this entry in this file:
          if ( ob->execute() == false )
          {
             setErrorStatus( ossimErrorCodes::OSSIM_ERROR );
             ossimNotify(ossimNotifyLevel_WARN)
                << "Error returned creating overviews for file: " << ih->getFilename() << std::endl;
          }
       }
       else
       {
          consumedHistogramOptions = false;
          ossimNotify(ossimNotifyLevel_NOTICE)
             << "Image has required reduced resolution data sets." << std::endl;
       }
    }
  
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << M << " exited...\n";
    }
 }

◆ createOverviews()

bool ossimImageUtil::createOverviews ( ) const

Returns: true if CREATE_OVERVIEWS_KW is found and set to true.

Definition at line 1660 of file ossimImageUtil.cpp.

References keyIsTrue().

 {
    return  keyIsTrue( CREATE_OVERVIEWS_KW );
 }

◆ createThumbnail()

void ossimImageUtil::createThumbnail ( ossimRefPtr< ossimImageHandler > & ih )

private

Definition at line 1008 of file ossimImageUtil.cpp.

References ossimKeywordlist::add(), ossimKeywordNames::BANDS_KW, ossimImageSourceFactoryBase::createImageSource(), and ossimImageSourceFactoryRegistry::instance().

 {
    ossimKeywordlist bandsKeywordList;
    bandsKeywordList.add("type", "ossimBandSelector");
    bandsKeywordList.add(ossimKeywordNames::BANDS_KW, "default");
    ossimRefPtr<ossimImageSource> bs = ossimImageSourceFactoryRegistry::instance()->createImageSource(bandsKeywordList);
    if (!bs)
       return;
    ossimIrect cutRect;
    ossimRefPtr<ossimImageRenderer> renderer = new ossimImageRenderer();
    ossimRefPtr<ossimScalarRemapper> scalarRemapper = new ossimScalarRemapper();
    ossimRefPtr<ossimRectangleCutFilter> cutFilter = new ossimRectangleCutFilter();
    ossimRefPtr<ossimImageViewAffineTransform> trans = new ossimImageViewAffineTransform();
    ossimDrect bounds = ih->getBoundingRect();
    ossim_float64 maxSize = ossim::max(bounds.width(), bounds.height());
    ossim_float64 thumbnailSize = getThumbnailSize();
    ossim_float64 scale = thumbnailSize / maxSize;
    ossimFilename thumbnailFilename = getThumbnailFilename(ih.get());
    ossimHistogramRemapper::StretchMode thumbnailStretchType = static_cast<ossimHistogramRemapper::StretchMode> (getThumbnailStretchType());
    if (scale > 1.0)
    {
       scale = 1.0;
       cutRect = bounds;
    }
    else
    {
       cutRect = bounds * scale;
    }
    cutFilter->setRectangle(cutRect);
    if ((scale < .5) && (ih->getNumberOfDecimationLevels() < 2))
    {
       return;
    }
 
    trans->scale(scale, scale);
    renderer->setImageViewTransform(trans.get());
    if (!bs.valid())
       return;
    bs->connectMyInputTo(ih.get());
    bs->initialize();
    ossim_uint32 bandCount = bs->getNumberOfInputBands();
    if ((bandCount == 2) || (bandCount > 3))
    {
       ossimBandSelector *tempBs = dynamic_cast<ossimBandSelector *>(bs.get());
       if (tempBs)
       {
          tempBs->setThreeBandRgb();
       }
    }
 
    ossimRefPtr<ossimHistogramRemapper> stretch = new ossimHistogramRemapper();
    stretch->setStretchMode(thumbnailStretchType);
    ossimFilename histogramFilename = ih->createDefaultHistogramFilename();
 
    //if (!histogramFilename.empty())
    //{
    //   histogramFile = m_histogramFilename;
    // }
    stretch->connectMyInputTo(bs.get());
    stretch->openHistogram(histogramFilename);
    renderer->connectMyInputTo(stretch.get());
 
    scalarRemapper->connectMyInputTo(renderer.get());
    cutFilter->connectMyInputTo(scalarRemapper.get());
    ossimKeywordlist writerKwl;
    ossimString ext = thumbnailFilename.ext();
    ext = ext.downcase();
    writerKwl.add("type", "image/" + ext);
    writerKwl.add("filename", thumbnailFilename.c_str());
    writerKwl.add("create_external_geometry", "false");
    if (ext == "png")
    {
       writerKwl.add("add_alpha_channel", "true");
    }
    ossimRefPtr<ossimImageFileWriter> writer = ossimImageWriterFactoryRegistry::instance()->createWriter(writerKwl);
 
    if (writer)
    {
       writer->connectMyInputTo(cutFilter.get());
 
       writer->execute();
 
       writer->disconnect();
       writer = 0;
    }
    scalarRemapper->disconnect();
    scalarRemapper = 0;
    cutFilter->disconnect();
    cutFilter = 0;
    renderer->disconnect();
    renderer = 0;
    stretch->disconnect();
    stretch = 0;
    bs->disconnect();
    bs = 0;
 }

◆ createThumbnails()

bool ossimImageUtil::createThumbnails ( ) const

Returns: true if CREATE_THUMBNAILS_KW is found and set to true.

Definition at line 1669 of file ossimImageUtil.cpp.

References keyIsTrue().

 {
    return keyIsTrue(CREATE_THUMBNAILS_KW);
 }

◆ dumpFilteredImageList()

void ossimImageUtil::dumpFilteredImageList ( ) const

private

Dumps filtered image list to std out.

Definition at line 2276 of file ossimImageUtil.cpp.

References m_filteredImages, ossimNotify(), and ossimNotifyLevel_NOTICE.

 {
    ossimNotify(ossimNotifyLevel_NOTICE) << "Filtered image list:\n";
    std::vector<std::string>::const_iterator i = m_filteredImages.begin();
    while ( i != m_filteredImages.end() )
    {
       ossimNotify(ossimNotifyLevel_NOTICE) << (*i) << "\n";
       ++i;
    }
    ossimNotify(ossimNotifyLevel_NOTICE) << std::endl;
 }

◆ execute()

ossim_int32 ossimImageUtil::execute ( )

Execute method.

This launches file walking mechanism.

Returns: int, 0 = good, non-zero something happened. Because this can process multiple files a non-zero return may indicate just one file did not complete, e.g. building overviews.

Note: Throws ossimException on error.

Definition at line 584 of file ossimImageUtil.cpp.

 {
    static const char M[] = "ossimImageUtil::execute()";
  
    if ( traceDebug() )
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << M << " entered...\n";
    }
 
    // Launch any prep system commands:
    executePrepCommands();
 
    // Get the number of "file*" keywords.
    ossim_uint32 fileCount = m_kwl->numberOf("file");
  
    if ( fileCount )
    {
       if ( !m_fileWalker )
       {
          m_fileWalker = new ossimFileWalker();
       }
  
       m_fileWalker->setNumberOfThreads( getNumberOfThreads() );
  
       // Must set this so we can stop recursion on directory based images.
       m_fileWalker->setWaitOnDirFlag( true );
  
       // This links the file walker back to our "processFile" method.
       m_fileWalker->setFileProcessor( this );
  
       // Wrap in try catch block as excptions can be thrown under the hood.
       try
       {
          // Get the list of files passed to us:
          std::vector<ossimFilename> files;
          ossim_uint32 processedFiles = 0;;
          ossim_uint32 i = 0;
          while ( processedFiles < fileCount )
          {
             ossimString key = FILE_KW;
             key += ossimString::toString(i);
             std::string lookup = m_kwl->findKey( key.string() );
             if ( lookup.size() )
             {
                files.push_back( ossimFilename(lookup) );
                ++processedFiles;
             }
  
             ++i;
             if ( i > (fileCount + 100) ) break;
          }
 
          //---
          // If the file count is one and it is not a directory, we will assume
          // the caller wanted to process that file. So leave the filter list
          // blank.
          //---
          if ( (getOverrideFilteredImagesFlag() == false) && files.size() &&
               ( (files.size() > 1) || (files[0].isDir() == true) ) )
          {
             if ( m_filteredImages.empty() )
             {
                initializeDefaultFilterList();
             }
             if ( m_fileWalker->getFilteredExtensions().empty() )
             {
                m_fileWalker->initializeDefaultFilterList();
             }
          }         
 
          // Process the files:
          m_fileWalker->walk( files ); 
       }
       catch (const ossimException& e)
       {
          ossimNotify(ossimNotifyLevel_WARN)
             << "Caught exception: " << e.what() << endl;
          setErrorStatus( ossimErrorCodes::OSSIM_ERROR );
       }
  
    } // if ( fileCount )
 
    // Launch any post system commands:
    executePostCommands();
    
    if ( traceDebug() )
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << M << " exit status: " << m_errorStatus << std::endl;
    }
  
    // Zero is good, non zero is bad.
    return m_errorStatus; 
 }

◆ executeCommands()

void ossimImageUtil::executeCommands	(	const std::string &	prefix,
		const ossimFilename &	file
	)		const

private

system commands.

Definition at line 2308 of file ossimImageUtil.cpp.

References ossimString::c_str(), ossimKeywordlist::findKey(), ossimKeywordlist::getNumberOfSubstringKeys(), m_kwl, ossimNotify(), ossimNotifyLevel_NOTICE, ossimString::size(), status, ossimString::string(), substituteCommandString(), and ossimString::toString().

Referenced by executeFileCommands(), executePostCommands(), and executePrepCommands().

 {
    const std::string BASE_KEY = "command";
    
    // Get the number of test:
    const std::string REG_EXP_STR = prefix + BASE_KEY + std::string("[0-9]+");
    const ossim_uint32 NUM_COMMANDS = m_kwl->getNumberOfSubstringKeys(REG_EXP_STR);
    if ( NUM_COMMANDS )
    {
       const ossim_uint32 MAX_INDEX = NUM_COMMANDS + 1000; // for skipage...
       ossim_uint32 index = 0;
       ossim_uint32 processedIndexes = 0;
       std::string commandKey;
       ossimString command;
 
       while ( processedIndexes < MAX_INDEX )
       {
          commandKey = prefix + BASE_KEY + ossimString::toString( index++ ).string();
          command.string() = m_kwl->findKey( commandKey );
 
          if ( command.size() )
          {
             substituteCommandString( file, prefix, commandKey, command );
 
             ossimNotify( ossimNotifyLevel_NOTICE )
                << "executing_command: " << command << std::endl;
             
             // Launch the command:
             int status = system( command.c_str() );
 
             ossimNotify( ossimNotifyLevel_NOTICE )
                << "return_status: " << status << std::endl;
             
             ++processedIndexes;
 
             if ( processedIndexes == NUM_COMMANDS )
             {
                break;
             }
          }
       }
    }
 }

◆ executeFileCommands()

void ossimImageUtil::executeFileCommands ( const ossimFilename & file ) const

private

run per file system commands.

Definition at line 2295 of file ossimImageUtil.cpp.

References executeCommands().

 {
    std::string prefix = "file.";
    executeCommands( prefix, file ); 
 }

◆ executePostCommands()

void ossimImageUtil::executePostCommands ( ) const

private

run post system commands.

Definition at line 2301 of file ossimImageUtil.cpp.

References executeCommands().

 {
    std::string prefix = "post.";
    ossimFilename file = "";
    executeCommands( prefix, file );   
 }

◆ executePrepCommands()

void ossimImageUtil::executePrepCommands ( ) const

private

run prep system commands.

Definition at line 2288 of file ossimImageUtil.cpp.

References executeCommands().

 {
    std::string prefix = "prep.";
    ossimFilename file = "";
    executeCommands( prefix, file );
 }

◆ getCopyAllFlag()

bool ossimImageUtil::getCopyAllFlag ( ) const

Returns: true if COPY_ALL_FLAG_KW key is found and value is true; else, false.

Definition at line 1764 of file ossimImageUtil.cpp.

References keyIsTrue().

Referenced by hasRequiredOverview().

 {
    return keyIsTrue( COPY_ALL_FLAG_KW );
 }

◆ getDumpFilterImagesFlag()

bool ossimImageUtil::getDumpFilterImagesFlag ( ) const

Returns: true if DUMP_FILTERED_IMAGES_KW key is found and value is true; else, false.

DUMP_FILTERED_IMAGES_KW = "dump_filtered_images"

Definition at line 1776 of file ossimImageUtil.cpp.

References keyIsTrue().

 {
    return keyIsTrue( DUMP_FILTERED_IMAGES_KW );
 }

◆ getFilteredImages() [1/2]

const std::vector< std::string > & ossimImageUtil::getFilteredImages ( ) const

Returns: The list of filtered out files.

Definition at line 2254 of file ossimImageUtil.cpp.

References m_filteredImages.

 {
    return m_filteredImages;
 }

◆ getFilteredImages() [2/2]

std::vector< std::string > & ossimImageUtil::getFilteredImages ( )

Non const method to allow access for adding or deleting extensions from the list.

The list is used by the private isFiltered method to avoid trying to process unwanted files.

Definition at line 2259 of file ossimImageUtil.cpp.

References m_filteredImages.

 {
    return m_filteredImages;
 }

◆ getHistogramMode()

ossimHistogramMode ossimImageUtil::getHistogramMode ( ) const

Returns: Histogram mode or OSSIM_HISTO_MODE_UNKNOWN if not set.

Definition at line 1991 of file ossimImageUtil.cpp.

References createHistogram(), createHistogramFast(), createHistogramR0(), OSSIM_HISTO_MODE_FAST, OSSIM_HISTO_MODE_NORMAL, and OSSIM_HISTO_MODE_UNKNOWN.

 {
    ossimHistogramMode result = OSSIM_HISTO_MODE_UNKNOWN;
    if ( createHistogram() || createHistogramR0() )
    {
       result = OSSIM_HISTO_MODE_NORMAL;
    }
    else if ( createHistogramFast() )
    {
       result = OSSIM_HISTO_MODE_FAST;
    }
    return result;
 }

◆ getInternalOverviewsFlag()

bool ossimImageUtil::getInternalOverviewsFlag ( ) const

Returns: true if INTERNAL_OVERVIEWS_FLAG_KW key is found and value is true; else, false.

Definition at line 1797 of file ossimImageUtil.cpp.

References keyIsTrue().

 {
    return keyIsTrue( INTERNAL_OVERVIEWS_FLAG_KW );
 }

◆ getNextReaderPropIndex()

ossim_uint32 ossimImageUtil::getNextReaderPropIndex ( ) const

private

Returns: the next reader prop index.

Definition at line 2058 of file ossimImageUtil.cpp.

References m_kwl, and ossimKeywordlist::numberOf().

 {
    ossim_uint32 result = m_kwl->numberOf( READER_PROP_KW.c_str() );
    if ( result )
    {
       ossim_uint32 foundProps = 0;
       ossim_uint32 index = 0;
       
       //---
       // Loop until we find the last index used for WRITER_PROP_KW.
       // (result+100) is to allow for holes like reader_prop0, reader_prop2...
       //---
       while ( (foundProps < result) && (index < (result+100) ) ) 
       {
          ossimString key = READER_PROP_KW;
          key += ossimString::toString(index);
          std::string lookup = m_kwl->findKey( key.string() );
          if ( lookup.size() )
          {
             ++foundProps;
          }
          ++index;
       }
       result = index;
    }
    return result;
 }

◆ getNextWriterPropIndex()

ossim_uint32 ossimImageUtil::getNextWriterPropIndex ( ) const

private

Returns: the next writer prop index.

Definition at line 2030 of file ossimImageUtil.cpp.

References m_kwl, and ossimKeywordlist::numberOf().

 {
    ossim_uint32 result = m_kwl->numberOf( WRITER_PROP_KW.c_str() );
    if ( result )
    {
       ossim_uint32 foundProps = 0;
       ossim_uint32 index = 0;
 
       //---
       // Loop until we find the last index used for WRITER_PROP_KW.
       // (result+100) is to allow for holes like writer_prop0, writer_prop2...
       //---
       while ( (foundProps < result) && (index < (result+100) ) ) 
       {
          ossimString key = WRITER_PROP_KW;
          key += ossimString::toString(index);
          std::string lookup = m_kwl->findKey( key.string() );
          if ( lookup.size() )
          {
             ++foundProps;
          }
          ++index;
       }
       result = index;
    }
    return result;
 }

◆ getNumberOfThreads()

ossim_uint32 ossimImageUtil::getNumberOfThreads ( ) const

private

Returns: Threads to use. Defaults to 1 if THREADS_KW is not found.

Definition at line 2015 of file ossimImageUtil.cpp.

References ossimKeywordlist::findKey(), and m_kwl.

 {
    ossim_uint32 result;
    std::string lookup = m_kwl->findKey( THREADS_KW );
    if ( lookup.size() )
    {
       result = ossimString(lookup).toUInt32();
    }
    else
    {
       result = ossim::getNumberOfThreads();
    }
    return result;
 }

◆ getOutputFileNamesFlag()

bool ossimImageUtil::getOutputFileNamesFlag ( ) const

Returns: true if OUTPUT_FILENAMES_KW key is found and value is true; else, false.

Definition at line 1809 of file ossimImageUtil.cpp.

References keyIsTrue().

 {
    return keyIsTrue( OUTPUT_FILENAMES_KW );
 }

◆ getOverrideFilteredImagesFlag()

bool ossimImageUtil::getOverrideFilteredImagesFlag ( ) const

Returns: true if DUMP_FILTERED_IMAGES_KW key is found and value is true; else, false.

DUMP_FILTERED_IMAGES_KW = "dump_filtered_images"

Definition at line 1821 of file ossimImageUtil.cpp.

References keyIsTrue().

 {
    return keyIsTrue( OVERRIDE_FILTERED_IMAGES_KW );
 }

◆ getOverviewStopDimension()

ossim_uint32 ossimImageUtil::getOverviewStopDimension ( ) const

Returns: Overview stop dimension or 0 if OVERVIEW_STOP_DIM_KW is not found.

Definition at line 1940 of file ossimImageUtil.cpp.

References ossimKeywordlist::findKey(), and m_kwl.

 {
    ossim_uint32 result = 0;
    std::string lookup = m_kwl->findKey( OVERVIEW_STOP_DIM_KW );
    if ( lookup.size() )
    {
       result = ossimString(lookup).toUInt32();
    }
    return result;
 }

◆ getOverviewType()

void ossimImageUtil::getOverviewType ( std::string & type ) const

private

Initializes type from OVERVIEW_TYPE_KW or sets to default ossim_tiff_box if not found.

Definition at line 1839 of file ossimImageUtil.cpp.

References ossimKeywordlist::findKey(), and m_kwl.

 {
    std::string lookup = m_kwl->findKey(OVERVIEW_TYPE_KW);
    if ( lookup.size() )
    {
       type = lookup;
    }
    else
    {
       type = "ossim_tiff_box"; // default
    }
 }

◆ getThumbnailFilename()

std::string ossimImageUtil::getThumbnailFilename ( ossimImageHandler * ih ) const

private

Definition at line 2166 of file ossimImageUtil.cpp.

References ossimImageHandler::getFilenameWithThisExtension(), getThumbnailType(), and ossimString::string().

 {
    ossimFilename thumbnailFilename = ih->getFilenameWithThisExtension("");
    std::string thumbnailType = getThumbnailType();
    if (thumbnailType == "png")
    {
       thumbnailFilename = ossimFilename(thumbnailFilename + "thumb.png");
    }
    else
    {
       thumbnailFilename = ossimFilename(thumbnailFilename + "thumb.jpg");
    }
 
    return thumbnailFilename.string();
 }

◆ getThumbnailSize()

ossim_uint32 ossimImageUtil::getThumbnailSize ( ) const

private

Returns: the next reader prop index.

Definition at line 2085 of file ossimImageUtil.cpp.

References ossimKeywordlist::findKey(), and m_kwl.

 {
    ossim_uint32 result;
    std::string lookup = m_kwl->findKey(THUMBNAIL_SIZE_KW);
    if (lookup.size())
    {
       result = ossimString(lookup).toUInt32();
    }
    else
    {
       result = 256;
    }
    return result;
 }

◆ getThumbnailStretchType()

int ossimImageUtil::getThumbnailStretchType ( ) const

private

Definition at line 2104 of file ossimImageUtil.cpp.

References ossimKeywordlist::findKey(), ossimHistogramRemapper::LINEAR_AUTO_MIN_MAX, and m_kwl.

 {
    int result = ossimHistogramRemapper::LINEAR_AUTO_MIN_MAX;
    
    ossimString typeString = m_kwl->findKey(THUMBNAIL_STRETCH_TYPE_KW);
 
    if (typeString.empty())
    {
       typeString = "auto-minmax";
    }
 
    typeString = typeString.downcase();
 
    if ((typeString == "auto-minmax"))
    {
       result = ossimHistogramRemapper::StretchMode::LINEAR_AUTO_MIN_MAX;
    }
    else if ((typeString == "auto-percentile"))
    {
       result = ossimHistogramRemapper::StretchMode::LINEAR_AUTO_PERCENTILE;
    }
    else if ((typeString == "std-stretch-1") || (typeString == "std-stretch 1"))
    {
       result = ossimHistogramRemapper::StretchMode::LINEAR_1STD_FROM_MEAN;
    }
    else if ((typeString == "std-stretch-2") || (typeString == "std-stretch 2"))
    {
       result = ossimHistogramRemapper::StretchMode::LINEAR_2STD_FROM_MEAN;
    }
    else if ((typeString == "std-stretch-3") || (typeString == "std-stretch 3"))
    {
       result = ossimHistogramRemapper::StretchMode::LINEAR_3STD_FROM_MEAN;
    }
    else if (typeString == "auto-minmax")
    {
       result = ossimHistogramRemapper::StretchMode::STRETCH_UNKNOWN;
    }
    return result;
 }

◆ getThumbnailType()

std::string ossimImageUtil::getThumbnailType ( ) const

private

Definition at line 2149 of file ossimImageUtil.cpp.

References ossimKeywordlist::findKey(), and m_kwl.

Referenced by getThumbnailFilename().

 {
    ossimString typeString = m_kwl->findKey(THUMBNAIL_TYPE_KW);
    std::string result = "jpeg";
 
    typeString = typeString.downcase();
 
    if(typeString != "png" && typeString != "jpeg")
    {
       typeString = "jpeg";
    }
 
    result = typeString.string();
 
    return result;
 }

◆ getTileSize()

bool ossimImageUtil::getTileSize ( ossimIpt & tileSize ) const

Gets the tile size.

Parameters

tileSize Initialized by this.

Returns: true on success, false if not in options list.

Definition at line 1923 of file ossimImageUtil.cpp.

References ossimKeywordlist::findKey(), and m_kwl.

 {
    bool result = false;
    std::string lookup = m_kwl->findKey( TILE_SIZE_KW );
    if ( lookup.size() )
    {
       ossim_int32 i = ossimString(lookup).toInt32();
       if ( (i % 16) == 0 )
       {
          tileSize.x = i;
          tileSize.y = i;
          result = true;
       }  
    }
    return result;
 }

◆ gsubDate()

void ossimImageUtil::gsubDate	(	const std::string &	commandPrefix,
		ossimString &	command
	)		const

private

Expands date variables in a command string.

Definition at line 2389 of file ossimImageUtil.cpp.

References ossimString::find(), ossimKeywordlist::findKey(), ossim::getFormattedTime(), ossimString::gsub(), and m_kwl.

Referenced by substituteCommandString().

 {
    // Date:
    const std::string DATE_VARIABLE = "%{date}";
    if ( command.find( DATE_VARIABLE ) )
    {
       std::string key = ".strf_time_format";
       std::string strfTimeFormat = m_kwl->findKey( commandKey, key );
       if ( strfTimeFormat.empty() )
       {
          // yyyymmdd
          strfTimeFormat = "%Y%m%d";
       }
       
       //---
       // Get the date as a string, e.g 20150411.
       // true for gmt time.
       //---
       std::string date;
       ossim::getFormattedTime( strfTimeFormat, true, date );
       
       if ( date.size() )
       {
          // Sustitute:
          command.gsub( DATE_VARIABLE, date, true );
       }
    }
 }

◆ hasCmmOption()

bool ossimImageUtil::hasCmmOption ( ) const

private

Returns: true if any compute min, max or null options are set.

Definition at line 1986 of file ossimImageUtil.cpp.

References keyIsTrue().

 {
    return ( keyIsTrue( CMM_MAX_KW ) || keyIsTrue( CMM_MIN_KW )|| keyIsTrue( CMM_NULL_KW ) );
 }

◆ hasHistogramOption()

bool ossimImageUtil::hasHistogramOption ( ) const

Returns: true if any of the histogram options are set.

Definition at line 1981 of file ossimImageUtil.cpp.

References createHistogram(), createHistogramFast(), and createHistogramR0().

 {
    return ( createHistogram() || createHistogramFast() || createHistogramR0() );
 }

◆ hasRequiredOverview()

bool ossimImageUtil::hasRequiredOverview	(	ossimRefPtr< ossimImageHandler > &	ih,
		ossimRefPtr< ossimOverviewBuilderBase > &	ob
	)

private

Returns: true if entry has required overviews.

Definition at line 1105 of file ossimImageUtil.cpp.

References ossimObject::getClassName(), getCopyAllFlag(), ossimImageHandler::getNumberOfDecimationLevels(), ossimImageHandler::getNumberOfLines(), ossimImageHandler::getNumberOfSamples(), ossimOverviewBuilderBase::getOverviewStopDimension(), and ossimRefPtr< T >::valid().

 {
    bool result = false;
    if ( ih.valid() && ob.valid() && ( getCopyAllFlag() == false ) )
    {
       if ( ih->getClassName() == "ossimCcfTileSource" )
       {
          // CCF reader does not use external overviews.
          result = true;
       }
       else
       {
          // Note we always have one rset
          ossim_uint32 required = 1;
  
          ossim_uint32 startingResLevel      = ih->getNumberOfDecimationLevels();
          ossim_uint32 overviewStopDimension = ob->getOverviewStopDimension();
  
          ossim_uint32 largestImageDimension =
             ih->getNumberOfSamples(0) >
             ih->getNumberOfLines(0) ?
             ih->getNumberOfSamples(0) :
             ih->getNumberOfLines(0);
  
          while(largestImageDimension > overviewStopDimension)
          {
             largestImageDimension /= 2;
             ++required;
          }
  
          if ( startingResLevel >= required )
          {
             result = true;
          }
       }
    }
    return result;
 }

◆ initialize()

bool ossimImageUtil::initialize ( ossimArgumentParser & ap )

Initial method.

Typically called from application prior to execute. This parses all options and put in keyword list m_kwl.

Parameters

ap	Arg parser to initialize from.

Returns: true, indicating process should continue with execute.

Definition at line 201 of file ossimImageUtil.cpp.

 {
    static const char M[] = "ossimImageUtil::initialize(ossimArgumentParser&)";
    if ( traceDebug() )
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << M << " entered...\n";
    }
  
    bool result = true;
  
    if ( (ap.argc() == 1) || ap.read("-h") || ap.read("--help") )
    {
       usage(ap);
  
       // continue_after_init to false
       result = false;
    }
    else
    {
       // Start with clean options keyword list.
       m_kwl->clear();
 
       // Used throughout below:
       std::string ts1;
       ossimArgumentParser::ossimParameter sp1(ts1);
       std::string ts2;
       ossimArgumentParser::ossimParameter sp2(ts2);
  
       while ( 1 ) //  While forever loop...
       {
          if( ap.read("-a") || ap.read("--include-fullres") )
          {
             setCopyAllFlag( true );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          if( ap.read("--compression-quality", sp1) )
          {
             if ( ts1.size() )
             {
                setCompressionQuality( ts1 );
             }
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          if( ap.read("--compression-type", sp1) )
          {
             if ( ts1.size() )
             {
                setCompressionType( ts1 );
             }
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          if( ap.read("--ch") || ap.read("--create-histogram") )
          {
             setCreateHistogramFlag( true );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          if( ap.read("--chf") || ap.read("--create-histogram-fast") )
          {
             setCreateHistogramFastFlag( true );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
 
          if( ap.read("--compute-min-max") )
          {
             setScanForMinMax( true );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          if( ap.read("--compute-min-max-null") )
          {
             setScanForMinMaxNull( true );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          if( ap.read("--create-histogram-r0") )
          {
             setCreateHistogramR0Flag( true );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          if( ap.read("-d", sp1) )
          {
             setOutputDirectory( ts1 );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          if( ap.read("--dump-filtered-image-list") )
          {
             setDumpFilteredImageListFlag( true );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          if( ap.read("-i") || ap.read("--internal-overviews") )
          {
             setInternalOverviewsFlag( true );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          if( ap.read("--max", sp1) )
          {
             addOption( CMM_MAX_KW, ts1 );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          if( ap.read("--min", sp1) )
          {
             addOption( CMM_MIN_KW, ts1 );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          if( ap.read("--null", sp1) )
          {
             addOption( CMM_NULL_KW, ts1 );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
 
          if( ap.read("--options", sp1) )
          {
             ossimFilename optionsKwl = ts1;
             if ( optionsKwl.exists() )
             {
                if ( m_kwl->addFile(optionsKwl) == false )
                {
                   std::string errMsg = "ERROR could not open options keyword list file: ";
                   errMsg += optionsKwl.string();
                   throw ossimException(errMsg);
                }
             }
             else
             {
                std::string errMsg = "ERROR options keyword list file does not exists: ";
                errMsg += optionsKwl.string();
                throw ossimException(errMsg); 
             }
          }
          
          if( ap.read("--of") || ap.read("--output-files") )
          {
             setOutputFileNamesFlag( true );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
 
          if (ap.read("-o"))
          {
             setCreateOverviewsFlag(true);
             if (ap.argc() < 2)
             {
                break;
             }
          }
          if (ap.read("--ct"))
          {
             setCreateThumbnailsFlag(true);
             if (ap.argc() < 2)
             {
                break;
             }
          }
          if (ap.read("--tt", sp1) || ap.read("--thumbnail-type", sp1))
          {
             setThumbnailType(ts1);
             if (ap.argc() < 2)
             {
                break;
             }
          }
          if (ap.read("--tst", sp1) || ap.read("--thumbnail-stretch-type", sp1))
          {
             setThumbnailStretchType(ts1);
             if (ap.argc() < 2)
             {
                break;
             }
          }
 
          if (ap.read("--ot", sp1))
          {
             setOverviewType( ts1 );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          if( ap.read("--override-filtered-images") )
          {
             setOverrideFilteredImagesFlag( true );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          if( ap.read("-r") || ap.read("--rebuild-overviews") )
          {
             setRebuildOverviewsFlag( true );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          if( ap.read("--rebuild-histogram") )
          {
             setRebuildHistogramFlag( true );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          while(ap.read("--reader-prop", sp1))
          {
             if (ts1.size())
             {
                std::string key = READER_PROP_KW;
                key += ossimString::toString( getNextReaderPropIndex() ).string();
                addOption( key, ts1 );
             }
          }
          if ( ap.argc() < 2 )
          {
             break;
          }
  
          if( ap.read("-s", sp1) )
          {
             setOverviewStopDimension( ts1 );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          if ( ap.read("--tile-size", sp1))
          {
             setTileSize( ossimString(ts1).toInt32() );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          if( ap.read("--threads", sp1) )
          {
             m_kwl->addPair( THREADS_KW, ts1 );
             if ( ap.argc() < 2 )
             {
                break;
             }
          }
  
          while(ap.read("--writer-prop", sp1))
          {
             if (ts1.size())
             {
                std::string key = WRITER_PROP_KW;
                key += ossimString::toString( getNextWriterPropIndex() ).string();
                addOption( key, ts1 );
             }
          }
          if ( ap.argc() < 2 )
          {
             break;
          }
  
          // End of arg parsing.
          ap.reportRemainingOptionsAsUnrecognized();
          if ( ap.errors() )
          {
             ap.writeErrorMessages(ossimNotify(ossimNotifyLevel_NOTICE));
             std::string errMsg = "Unknown option...";
             throw ossimException(errMsg);
          }
  
          break; // Break from while forever.
  
       } // End while (forever) loop.
  
       if(ap.argc() > 1)
       {
          for (ossim_int32 i = 0; i < (ap.argc()-1); ++i)
          {
             ossimString kw = FILE_KW;
             kw += ossimString::toString(i);
             std::string value = ap[i+1];
             m_kwl->addPair(kw.string(), value, true);
          }
       }
       else
       {
          if ( getDumpFilterImagesFlag() )
          {
             // Caller wants to see filtered image names:
             if ( m_filteredImages.empty() )
             {
                initializeDefaultFilterList();
             }
 
             // Dump our filtered images.
             dumpFilteredImageList();
 
             if ( !m_fileWalker )
             {
                m_fileWalker = new ossimFileWalker();
                m_fileWalker->initializeDefaultFilterList();
             }
 
             // Dump the file walker's filtered extensions.
             m_fileWalker->dumpFilteredExtensionList();
          }
          else
          {
             usage(ap);
          }
  
          // continue_after_init to false
          result = false; 
  
       }
  
    } // not usage
  
    if ( traceDebug() )
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "m_kwl:\n" << *(m_kwl.get()) << "\n"
          << M << " exit result = " << (result?"true":"false")
          << "\n";
    }
  
    return result;
 }

◆ initializeDefaultFilterList()

void ossimImageUtil::initializeDefaultFilterList ( )

private

Initializes the filter list with a default set of filtered out file names.

Definition at line 2264 of file ossimImageUtil.cpp.

References m_filteredImages, and m_mutex.

 {
    m_mutex.lock();
 
    // Common images to filter out, put most common first.
    m_filteredImages.push_back(std::string("icon.jpg"));
    m_filteredImages.push_back(std::string("logo.jpg"));
    m_filteredImages.push_back(std::string("preview.jpg"));
    
    m_mutex.unlock();
 }

◆ isDirectoryBasedImage()

bool ossimImageUtil::isDirectoryBasedImage ( const ossimImageHandler * ih ) const

private

Returns: true if file is a directory based image and the stager should go on to next directory; false if stager should continue with directory.

Definition at line 1639 of file ossimImageUtil.cpp.

References ossimObject::getClassName().

 {
    bool result = false;
    if ( ih )
    {
       // Get the image handler name.
       ossimString imageHandlerName = ih->getClassName();
       if ( (imageHandlerName == "ossimAdrgTileSource") ||
            (imageHandlerName == "ossimCibCadrgTileSource") )  
       {
          result = true;
       }
    }
    return result;
 }

◆ isFiltered()

bool ossimImageUtil::isFiltered ( const ossimFilename & f ) const

private

Convenience method to check file to see is if file should be processed.

Parameters

f	File to check.

Returns: true if f is in filter list, false if not.

Definition at line 2207 of file ossimImageUtil.cpp.

References ossimFilename::file(), m_filteredImages, ossimString::size(), and ossimString::string().

 {
    bool result = false;
    if ( file.size() )
    {
       // Strip full path to base name.
       std::string baseName = file.file().string();
       if ( baseName.size() )
       {
          std::vector<std::string>::const_iterator i = m_filteredImages.begin();
          while ( i != m_filteredImages.end() )
          {
             if ( baseName == (*i) )
             {
                result = true;
                break;
             }
             ++i;
          }
       }
    }
 #if 0 /* Please leave for debug. (drb) */
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimFileWalker::isFiltered file " << (result?"filtered: ":"not filtered: ")
          << file << "\n";
    }
 #endif
    
    return result;
 }

◆ keyIsTrue()

bool ossimImageUtil::keyIsTrue ( const std::string & key ) const

private

Returns: true if key is set to true; false, if not.

Definition at line 2240 of file ossimImageUtil.cpp.

References ossimKeywordlist::findKey(), m_kwl, ossimString::toBool(), and ossimRefPtr< T >::valid().

Referenced by createHistogram(), createHistogramFast(), createHistogramR0(), createOverviews(), createThumbnails(), getCopyAllFlag(), getDumpFilterImagesFlag(), getInternalOverviewsFlag(), getOutputFileNamesFlag(), getOverrideFilteredImagesFlag(), hasCmmOption(), rebuildHistogram(), rebuildOverviews(), scanForMinMax(), and scanForMinMaxNull().

 {
    bool result = false;
    if ( m_kwl.valid() )
    {
       std::string value = m_kwl->findKey( key );
       if ( value.size() )
       {
          result = ossimString(value).toBool();
       }
    }
    return result;
 }

◆ outputOverviewWriterTypes()

void ossimImageUtil::outputOverviewWriterTypes ( ) const

private

Definition at line 1625 of file ossimImageUtil.cpp.

References ossimOverviewBuilderFactoryRegistry::getTypeNameList(), ossimOverviewBuilderFactoryRegistry::instance(), ossimNotify(), and ossimNotifyLevel_NOTICE.

Referenced by usage().

 {
    ossimNotify(ossimNotifyLevel_NOTICE)
       << "\nValid overview types: " << std::endl;
    
    std::vector<ossimString> outputType;
    
    ossimOverviewBuilderFactoryRegistry::instance()->getTypeNameList(outputType);
    std::copy(outputType.begin(),
              outputType.end(),
              std::ostream_iterator<ossimString>(ossimNotify(ossimNotifyLevel_NOTICE), "\t\n"));
 }

◆ processFile()

void ossimImageUtil::processFile ( const ossimFilename & file )

virtual

ProcessFile method.

Satisfies pure virtual ossimFileProcessorInterface::processFile.

This method is linked to the ossimFileWalker::walk method via a callback mechanism. It is called by the ossimFileWalk (caller). In turn this class (callee) calls ossimFileWalker::setRecurseFlag and ossimFileWalker::setAbortFlag to control the waking process.

Parameters

file	to process.

Implements ossimFileProcessorInterface.

Definition at line 683 of file ossimImageUtil.cpp.

 {
    static const char M[] = "ossimImageUtil::processFile";
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << M << " entered...\n" << "file: " << file << "\n";
    }
  
    bool processFileFlag = true;
    if ( !getOverrideFilteredImagesFlag() )
    {
       processFileFlag = !isFiltered( file );
    }
  
    if ( processFileFlag )
    {
       ossimNotify(ossimNotifyLevel_NOTICE) << "Processing file: " << file << std::endl;
  
       m_mutex.lock();
       ossimRefPtr<ossimImageHandler> ih =
          ossimImageHandlerRegistry::instance()->open(file, true, true);
       m_mutex.unlock();
  
       if ( ih.valid() && !ih->hasError() )
       {
          // Check for output directory:
          if ( m_kwl->hasKey( OUTPUT_DIRECTORY_KW ) )
          {
             ossimFilename outputDir;
             outputDir.string() = m_kwl->findKey( OUTPUT_DIRECTORY_KW );
 
             if ( outputDir.exists() && outputDir.isDir() )
             {
                ih->setSupplementaryDirectory( outputDir );
             }
          }
          
          if ( isDirectoryBasedImage( ih.get() ) )
          {
             // Tell the walker not to recurse this directory.
             m_mutex.lock();
             m_fileWalker->setRecurseFlag(false);
             m_mutex.unlock();
          }
 
          // Set any reader props:
          ossimPropertyInterface* pi = dynamic_cast<ossimPropertyInterface*>(ih.get());
          if ( pi ) setProps(pi);
  
          bool consumedHistogramOptions  = false;
          bool consumedCmmOptions = false;
  
          if ( getOutputFileNamesFlag() )
          {
             // Simply output the file name of any images we can open:
             ossimNotify(ossimNotifyLevel_NOTICE) << ih->getFilename().expand(); 
          }
  
          // Compute/Scan for min, max.  Note the overview sequencer may have computed for us.
          if ( ( scanForMinMax() || scanForMinMaxNull() ) && !consumedCmmOptions )
          {
             computeMinMax( ih );
          }
 
          if ( createOverviews() )
          {
             // Skip shape files...
             if ( ih->getClassName() != "ossimOgrGdalTileSource" )
             {
                createOverview(ih, consumedHistogramOptions, consumedCmmOptions);
             }
          }
          if (createThumbnails())
          {
                for (ossim_uint32 idx = 0; idx < ih->getNumberOfEntries(); ++idx)
                {
                      ih->setCurrentEntry(idx);
                      if (ih->getNumberOfDecimationLevels() <= 1)
                      {
                            ih->setState(0);
                            ih->openOverview();
                      }
                      createThumbnail(ih);
                }
          }
          // Build stand alone histogram.  Note the overview sequencer may have computed for us.
          if ( hasHistogramOption() && !consumedHistogramOptions)
          {
             createHistogram( ih );
          }
 
          // Launch any file system commands.
          executeFileCommands( file );
       }
       else
       {
          ossimNotify(ossimNotifyLevel_WARN) << M << "\nCould not open: " << file << std::endl;
       }
    }
    else // Matches: if ( processFileFlag )
    {
       ossimNotify(ossimNotifyLevel_NOTICE)
          << "Filtered file, not processing: " << file << std::endl;
    }
  
    if(traceDebug())
    {
       // Since ossimFileWalker is threaded output the file so we know which job exited.
       ossimNotify(ossimNotifyLevel_DEBUG) << M << "\nfile: " << file << "\nexited...\n";
    }
 }

◆ rebuildHistogram()

bool ossimImageUtil::rebuildHistogram ( ) const

Returns: true if REBUILD_HISTOGRAM_KW is found and set to true.

Definition at line 1697 of file ossimImageUtil.cpp.

References keyIsTrue().

 {
    return keyIsTrue( REBUILD_HISTOGRAM_KW );
 }

◆ rebuildOverviews()

bool ossimImageUtil::rebuildOverviews ( ) const

Returns: true if REBUILD_OVERVIEWS_KW is found and set to true.

Definition at line 1683 of file ossimImageUtil.cpp.

References keyIsTrue().

 {
    return keyIsTrue( REBUILD_OVERVIEWS_KW );
 }

◆ scanForMinMax()

bool ossimImageUtil::scanForMinMax ( ) const

Returns: true if SCAN_MIN_MAX_KW is found and set to true.

Definition at line 1707 of file ossimImageUtil.cpp.

References keyIsTrue().

 {
    return keyIsTrue( SCAN_MIN_MAX_KW );
 }

◆ scanForMinMaxNull()

bool ossimImageUtil::scanForMinMaxNull ( ) const

Returns: true if SCAN_MIN_MAX_NULL_KW is found and set to true.

Definition at line 1717 of file ossimImageUtil.cpp.

References keyIsTrue().

 {
    return keyIsTrue( SCAN_MIN_MAX_NULL_KW );
 }

◆ setCompressionQuality()

void ossimImageUtil::setCompressionQuality ( const std::string & quality )

Sets the writer property for compression quality.

Parameters

quality For TIFF JPEG takes values from 1 to 100, where 100 is best. For J2K plugin (if available), numerically_lossless, visually_lossless, lossy.

Definition at line 1722 of file ossimImageUtil.cpp.

 {
    if ( quality.size() )
    {
       std::string key = WRITER_PROP_KW;
       key += ossimString::toString( getNextWriterPropIndex() ).string();
       std::string value = ossimKeywordNames::COMPRESSION_QUALITY_KW;
       value += "=";
       value += quality;
       addOption( key, value );
    }
 }

◆ setCompressionType()

void ossimImageUtil::setCompressionType ( const std::string & type )

Sets the compression type to use when building overviews.

Parameters

compression_type

Current supported types:

deflate
jpeg
lzw
none
packbits

Definition at line 1735 of file ossimImageUtil.cpp.

 {
    if ( type.size() )
    {
       std::string key = WRITER_PROP_KW;
       key += ossimString::toString( getNextWriterPropIndex() ).string();
       std::string value = ossimKeywordNames::COMPRESSION_TYPE_KW;
       value += "=";
       value += type;
       addOption( key, value );
    }   
 }

◆ setCopyAllFlag()

void ossimImageUtil::setCopyAllFlag ( bool flag )

Sets the overview builder copy all flag.

Parameters

flag

Definition at line 1748 of file ossimImageUtil.cpp.

 {
    // Add this for hasRequiredOverview method.
    std::string key   = COPY_ALL_FLAG_KW;
    std::string value = ( flag ? TRUE_KW : FALSE_KW );
    addOption( key, value );
 
    // Add as a writer prop:
    key = WRITER_PROP_KW;
    key += ossimString::toString( getNextWriterPropIndex() ).string();
    value = COPY_ALL_FLAG_KW;
    value += "=";
    value += ( flag ? TRUE_KW : FALSE_KW );
    addOption( key, value );
 }

◆ setCreateHistogramFastFlag()

void ossimImageUtil::setCreateHistogramFastFlag ( bool flag )

Sets create histogram flag keyword CREATE_HISTOGRAM_FAST_KW used by processFile method.

Parameters

flag	If true a histogram will be created in fast mode.

Definition at line 1961 of file ossimImageUtil.cpp.

References addOption().

 {
    addOption( CREATE_HISTOGRAM_FAST_KW, ( flag ? TRUE_KW : FALSE_KW ) );
 }

◆ setCreateHistogramFlag()

void ossimImageUtil::setCreateHistogramFlag ( bool flag )

Sets create histogram flag keyword CREATE_HISTOGRAM_KW used by processFile method.

Parameters

flag	If true a full histogram will be created.

Definition at line 1951 of file ossimImageUtil.cpp.

References addOption().

 {
    addOption( CREATE_HISTOGRAM_KW, ( flag ? TRUE_KW : FALSE_KW ) );
 }

◆ setCreateHistogramR0Flag()

void ossimImageUtil::setCreateHistogramR0Flag ( bool flag )

Sets create histogram "R0" flag keyword CREATE_HISTOGRAM_R0_KW used by processFile method.

Parameters

flag	If true a histogram will be created from R0.

Definition at line 1971 of file ossimImageUtil.cpp.

References addOption().

 {
    addOption( CREATE_HISTOGRAM_R0_KW, ( flag ? TRUE_KW : FALSE_KW ) );
 }

◆ setCreateOverviewsFlag()

void ossimImageUtil::setCreateOverviewsFlag ( bool flag )

Sets create overviews flag keyword CREATE_OVERVIEWS_KW used by processFile method.

Parameters

flag	If true overview will be created if image does not already have the required or if the REBUILD_OVERVIEWS_KW is set.

Note: Number of required overviews is controlled by the ossim preferences keyword overview_stop_dimension.

Definition at line 1655 of file ossimImageUtil.cpp.

References addOption().

 {
    addOption( CREATE_OVERVIEWS_KW, ( flag ? TRUE_KW : FALSE_KW ) );
 }

◆ setCreateThumbnailsFlag()

void ossimImageUtil::setCreateThumbnailsFlag ( bool flag )

Sets create thumbnails flag keyword CREATE_THUMBNAILS_KW used by processFile method.

Parameters

flag	If true thumbnail will be created if image does not already.

Note: Overviews must be created before this works

Definition at line 1664 of file ossimImageUtil.cpp.

References addOption().

 {
    addOption(CREATE_THUMBNAILS_KW, (flag ? TRUE_KW : FALSE_KW));
 }

◆ setDumpFilteredImageListFlag()

void ossimImageUtil::setDumpFilteredImageListFlag ( bool flag )

Sets the dump filteredImageList flag.

Parameters

flag

Definition at line 1769 of file ossimImageUtil.cpp.

 {
    std::string key   = DUMP_FILTERED_IMAGES_KW;
    std::string value = ( flag ? TRUE_KW : FALSE_KW );
    addOption( key, value );
 }

◆ setErrorStatus()

void ossimImageUtil::setErrorStatus ( ossim_int32 status )

private

Sets the m_errorStatus for return on execute.

Definition at line 2200 of file ossimImageUtil.cpp.

References m_errorStatus, m_mutex, and status.

 {
    m_mutex.lock();
    m_errorStatus = status;
    m_mutex.unlock();
 }

◆ setInternalOverviewsFlag()

void ossimImageUtil::setInternalOverviewsFlag ( bool flag )

Sets the overview builder internal overviews flag.

Parameters

flag

Definition at line 1781 of file ossimImageUtil.cpp.

 {
    // Add this for hasRequiredOverview method.
    std::string key   = INTERNAL_OVERVIEWS_FLAG_KW;
    std::string value = ( flag ? TRUE_KW : FALSE_KW );
    addOption( key, value );
 
    // Add as a writer prop:
    key = WRITER_PROP_KW;
    key += ossimString::toString( getNextWriterPropIndex() ).string();
    value = INTERNAL_OVERVIEWS_FLAG_KW;
    value += "=";
    value += ( flag ? TRUE_KW : FALSE_KW );
    addOption( key, value );
 }

◆ setNumberOfThreads() [1/2]

void ossimImageUtil::setNumberOfThreads ( ossim_uint32 threads )

Set number of threads to use.

This is only used in execute method if a directory is given to application to walk.

Parameters

threads Defaults to 1 if THREADS_KW is not found.

Definition at line 2005 of file ossimImageUtil.cpp.

References addOption().

 {
    addOption( THREADS_KW, threads );
 }

◆ setNumberOfThreads() [2/2]

void ossimImageUtil::setNumberOfThreads ( const std::string & threads )

Definition at line 2010 of file ossimImageUtil.cpp.

References addOption().

 {
    addOption( THREADS_KW, threads );
 }

◆ setOutputDirectory()

void ossimImageUtil::setOutputDirectory ( const std::string & directory )

Sets the output directory.

Typically overviews and histograms are placed parallel to image file. This overrides.

Parameters

◆ setOutputFileNamesFlag()

void ossimImageUtil::setOutputFileNamesFlag ( bool flag )

Sets the output file name flag OUTPUT_FILENAMES_KW.

If set to true all files that we can successfully open will be output.

Parameters

flag

Definition at line 1802 of file ossimImageUtil.cpp.

 {
    std::string key   = OUTPUT_FILENAMES_KW;
    std::string value = ( flag ? TRUE_KW : FALSE_KW );
    addOption( key, value );
 }

◆ setOverrideFilteredImagesFlag()

void ossimImageUtil::setOverrideFilteredImagesFlag ( bool flag )

Sets the override filtered images flag.

Parameters

flag

Definition at line 1814 of file ossimImageUtil.cpp.

 {
    std::string key   = OVERRIDE_FILTERED_IMAGES_KW;
    std::string value = ( flag ? TRUE_KW : FALSE_KW );
    addOption( key, value );
 }

◆ setOverviewStopDimension() [1/2]

void ossimImageUtil::setOverviewStopDimension ( ossim_uint32 dimension )

sets the overview stop dimension.

The overview builder will decimate the image until both dimensions are at or below this dimension.

Parameters

dimension

Note: Recommend a power of 2 value, i.e. 8, 16, 32 and so on.

Definition at line 1898 of file ossimImageUtil.cpp.

References addOption().

 {
    addOption( OVERVIEW_STOP_DIM_KW, dimension );
 }

◆ setOverviewStopDimension() [2/2]

void ossimImageUtil::setOverviewStopDimension ( const std::string & dimension )

Definition at line 1903 of file ossimImageUtil.cpp.

References addOption().

 {
    addOption( OVERVIEW_STOP_DIM_KW, dimension );
 }

◆ setOverviewType()

void ossimImageUtil::setOverviewType ( const std::string & type )

Sets key OVERVIEW_TYPE_KW.

Available types depends on plugins. Known types: ossim_tiff_box ( defualt ) ossim_tiff_nearest ossim_kakadu_nitf_j2k ( kakadu plugin ) gdal_tiff_nearest ( gdal plugin ) gdal_tiff_average ( gdal plugin ) gdal_hfa_nearest ( gdal plugin )
gdal_hfa_average ( gdal plugin )

Parameters

type	One of the above.

Definition at line 1832 of file ossimImageUtil.cpp.

 {
    std::string key = OVERVIEW_TYPE_KW;
    addOption( key, type );
    setCreateOverviewsFlag( true ); // Assume caller wants overviews.
 }

◆ setProps()

void ossimImageUtil::setProps ( ossimPropertyInterface * pi ) const

private

set reader or writer properties based on cast of pi.

Definition at line 1852 of file ossimImageUtil.cpp.

 {
    if ( pi )
    {
       ossimString baseKey;
       if ( dynamic_cast<ossimImageHandler*>(pi) )
       {
          baseKey = READER_PROP_KW;
       }
       else
       {
          baseKey = WRITER_PROP_KW;
       }
       
       ossim_uint32 propCount = m_kwl->numberOf( baseKey.c_str() );
       if ( propCount )
       {
          ossim_uint32 foundProps = 0;
          ossim_uint32 index = 0;
          
          // (propCount+100) is to allow for holes like reader_prop0, reader_prop2...
          while ( (foundProps < propCount) && (index < (propCount+100) ) ) 
          {
             ossimString key = baseKey;
             key += ossimString::toString(index);
             std::string lookup = m_kwl->findKey( key.string() );
             if ( lookup.size() )
             {
                ossimString value = lookup;
                std::vector<ossimString> v = value.split("=");
                if (v.size() == 2)
                {
                   ossimString propertyName  = v[0];
                   ossimString propertyValue = v[1];
                   ossimRefPtr<ossimProperty> p =
                      new ossimStringProperty(propertyName, propertyValue);
                   pi->setProperty( p );
                }
                ++foundProps;
             }
             ++index;
          }
       }
    }
 }

◆ setRebuildHistogramFlag()

void ossimImageUtil::setRebuildHistogramFlag ( bool flag )

Sets the rebuild histogram flag keyword REBUILD_HISTOGRAM_KW used by processFile method.

Parameters

flag	If true forces a rebuild of histogram even if image has one already.

Definition at line 1688 of file ossimImageUtil.cpp.

References addOption().

 {
    addOption( REBUILD_HISTOGRAM_KW, ( flag ? TRUE_KW : FALSE_KW ) );
    if ( flag )
    {
       setCreateHistogramFlag( true ); // Turn on histogram building.
    }
 }

◆ setRebuildOverviewsFlag()

void ossimImageUtil::setRebuildOverviewsFlag ( bool flag )

Sets the rebuild overview flag keyword REBUILD_OVERVIEWS_KW used by processFile method.

Parameters

flag	If true forces a rebuild of overviews even if image has required number of reduced resolution data sets.

Note: Number of required overviews is controlled by the ossim preferences keyword overview_stop_dimension.

Definition at line 1674 of file ossimImageUtil.cpp.

References addOption().

 {
    addOption( REBUILD_OVERVIEWS_KW, ( flag ? TRUE_KW : FALSE_KW ) );
    if ( flag )
    {
       setCreateOverviewsFlag( true ); // Turn on overview building.
    }
 }

◆ setScanForMinMax()

void ossimImageUtil::setScanForMinMax ( bool flag )

Sets scan for min/max flag keyword SCAN_MIN_MAX_KW used by processFile method.

Parameters

flag	If true a file will be scanned for min/max and a file.omd will be written out.

Definition at line 1702 of file ossimImageUtil.cpp.

References addOption().

 {
    addOption( SCAN_MIN_MAX_KW, ( flag ? TRUE_KW : FALSE_KW ) ); 
 }

◆ setScanForMinMaxNull()

void ossimImageUtil::setScanForMinMaxNull ( bool flag )

Sets scan for min/max/null flag keyword SCAN_MIN_MAX_KW used by processFile method.

Parameters

flag	If true a file will be scanned for min/max/null and a file.omd will be written out.

Definition at line 1712 of file ossimImageUtil.cpp.

References addOption().

 {
    addOption( SCAN_MIN_MAX_NULL_KW, ( flag ? TRUE_KW : FALSE_KW ) ); 
 }

◆ setThumbnailStretchType()

void ossimImageUtil::setThumbnailStretchType ( const std::string & value )

Parameters

value can be of values none,auto-minmax,auto-percentile,std-stretch-1,std-stretch-2,std-stretch-3

Definition at line 2099 of file ossimImageUtil.cpp.

References addOption().

 {
    addOption(THUMBNAIL_STRETCH_TYPE_KW, value);
 }

◆ setThumbnailType()

void ossimImageUtil::setThumbnailType ( const std::string & value )

Parameters

value can be of values png or jpeg

Definition at line 2144 of file ossimImageUtil.cpp.

References addOption().

 {
    addOption(THUMBNAIL_TYPE_KW, value);
 }

◆ setTileSize()

void ossimImageUtil::setTileSize ( ossim_uint32 tileSize )

Sets the tile size.

Parameters

tileSize

Note: Must be a multiple of 16, i.e. 64, 128, 256 and so on.

Definition at line 1908 of file ossimImageUtil.cpp.

References addOption().

 {
    if ((tileSize % 16) == 0)
    {
       addOption( TILE_SIZE_KW, tileSize );
    }
    else
    {
       ossimNotify(ossimNotifyLevel_NOTICE)
          << "ossimImageUtil::setTileSize NOTICE:"
          << "\nTile width must be a multiple of 16!"
          << std::endl;
    }
 }

◆ substituteCommandString()

void ossimImageUtil::substituteCommandString	(	const ossimFilename &	file,
		const std::string &	prefix,
		const std::string &	commandKey,
		ossimString &	command
	)		const

private

Expands variables in a command string.

Definition at line 2353 of file ossimImageUtil.cpp.

References ossimString::expandEnvironmentVariable(), gsubDate(), and substituteFileStrings().

Referenced by executeCommands().

 {
    // Expand any environment vars, e.g. $(env_var_name):
    command.expandEnvironmentVariable();
 
    gsubDate( commandKey, command );
 
    if ( prefix == "file." )
    {
       substituteFileStrings( file, command );
    }
 }

◆ substituteFileStrings()

void ossimImageUtil::substituteFileStrings	(	const ossimFilename &	file,
		ossimString &	command
	)		const

private

Expands file level variables in a command string.

Definition at line 2370 of file ossimImageUtil.cpp.

References ossimFilename::file(), ossimString::gsub(), ossimFilename::noExtension(), ossimFilename::path(), ossimString::string(), and true.

Referenced by substituteCommandString().

 {
    const std::string BASENAME_VARIABLE = "%{basename}";
    command.gsub( BASENAME_VARIABLE, file.file().string() );
    
    const std::string BASENAME_NO_EXT_VARIABLE = "%{basename_no_ext}";
    command.gsub( BASENAME_NO_EXT_VARIABLE, file.file().string() );
 
    const std::string DIRNAME_VARIABLE = "%{dirname}";
    command.gsub( DIRNAME_VARIABLE, file.path().string() );
 
    const std::string FILE_VARIABLE = "%{file}";
    command.gsub( FILE_VARIABLE, file.string(), true );
 
    const std::string FILE_NO_EXT_VARIABLE = "%{file_no_ext}";
    command.gsub( FILE_NO_EXT_VARIABLE, file.noExtension().string(), true );
 }

◆ usage()

void ossimImageUtil::usage ( ossimArgumentParser & ap )

private

Initializes arg parser and outputs usage.

Definition at line 1558 of file ossimImageUtil.cpp.

References addArguments(), ossimInit::addOptions(), ossimArgumentParser::getApplicationName(), ossimArgumentParser::getApplicationUsage(), ossimInit::instance(), ossimNotify(), ossimNotifyLevel_INFO, outputOverviewWriterTypes(), ossimApplicationUsage::setApplicationName(), and ossimApplicationUsage::write().

 {
    // Add global usage options.
    ossimInit::instance()->addOptions(ap);
    
    // Set app name.
    ap.getApplicationUsage()->setApplicationName(ap.getApplicationName());
 
    // Add options.
    addArguments(ap);
    
    // Write usage.
    ap.getApplicationUsage()->write(ossimNotify(ossimNotifyLevel_INFO));
 
    outputOverviewWriterTypes();
    
    ossimNotify(ossimNotifyLevel_INFO)
       << "\nExample commands:\n"
 
       << "\n// A single image standard tiff overviews, histogram:\n"
       << "ossim-preproc -o --ch <file>\n"
 
       << "\n// A single image with j2k overviews(requires kakadu plugin), histogram:\n"
       << "ossim-preproc --ot ossim_kakadu_nitf_j2k --ch <file>\n"
       << "\n// j2k, histogram, 4 threads\n"
 
       << "\n// standard tiff overviews, full histogram, 4 threads:\n"
       << "ossim-preproc -r -o --ch --threads 4 <directory_to_walk>\n"
 
       << "\n// j2k, histogram (fast mode), 4 threads\n"
       << "ossim-preproc -r --ot ossim_kakadu_nitf_j2k --chf --threads 4 "
       << "<directory_to_walk>\n"
 
       << "\n// tiff, jpeg compression, histogram, 4 threads\n"
       << "ossim-preproc -r --ch --compression-quality 75 --compression-type "
       << "jpeg --threads 4 <directory_to_walk>\n"
       << "ossim-preproc -r --ch --compression-quality 75 --compression-type "
       << "jpeg --threads 4 <directory_to_walk>\n"
 
       << "\n// Process all the tiffs in a directory feeding \"prep\", \"file\", \"post\" system commands via the --options option which includes indexing file into the omar database via omar-data-mgr app:\n"
       << "ossim-preproc --options preproc-options.kwl -r -o --ch *.tif\n"
       << "\n// Contents of preproc-options.kwl used in above command:\n"
       << "prep.command0: echo start_time: %{date}\n"
       << "prep.command0.strf_time_format: %Y%m%d%H%M%S\n"
       << "prep.command1: mkdir -p %{date}\n"
       << "file.command0: mv %{file_no_ext}.* %{date}/.\n"
       << "file.command1: omar-data-mgr -u http://localhost:8080/omar add %{date}/%{basename}\n"
       << "post.command0: echo end_time: %{date}\n"
       << "post.command0.strf_time_format: %Y%m%d%H%M%S\n"
       
       << "\nNOTES:\n"
       << "\n  --ch  equals --create-histogram"
       << "\n  --chf equals --create-histogram-fast"
 
       << "\n\nExpanded command option variables:\n\n"
       << "%{basename}        = filename without path\n"
       << "%{basename_no_ext} = filename without path and without extension\n"
       << "%{date}            = Expanded to current zulu time. Default format=yyyymmdd\n"
       << "                     output format controlled by command0.strf_time_format key.\n"
       << "%{dirname}         = path of filename\n"
       << "%{file}            = filename being processed\n"
       << "%{file_no_ext}     = filename with no extension\n"
 
       << std::endl;
 }

Member Data Documentation

◆ m_errorStatus

ossim_int32 ossimImageUtil::m_errorStatus

private

Definition at line 536 of file ossimImageUtil.h.

Referenced by setErrorStatus().

◆ m_fileWalker

ossimFileWalker* ossimImageUtil::m_fileWalker

private

Definition at line 533 of file ossimImageUtil.h.

Referenced by ~ossimImageUtil().

◆ m_filteredImages

std::vector<std::string> ossimImageUtil::m_filteredImages

private

Hold images we never want to process.

Definition at line 539 of file ossimImageUtil.h.

Referenced by dumpFilteredImageList(), getFilteredImages(), initializeDefaultFilterList(), and isFiltered().

◆ m_kwl

ossimRefPtr<ossimKeywordlist> ossimImageUtil::m_kwl

private

Holds all options passed into intialize except writer props.

Definition at line 531 of file ossimImageUtil.h.

Referenced by addOption(), executeCommands(), getNextReaderPropIndex(), getNextWriterPropIndex(), getNumberOfThreads(), getOverviewStopDimension(), getOverviewType(), getThumbnailSize(), getThumbnailStretchType(), getThumbnailType(), getTileSize(), gsubDate(), and keyIsTrue().

◆ m_mutex

std::mutex ossimImageUtil::m_mutex

private

Definition at line 534 of file ossimImageUtil.h.

Referenced by addOption(), initializeDefaultFilterList(), and setErrorStatus().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimImageUtil()

◆ ~ossimImageUtil()

Member Function Documentation

◆ addArguments()

◆ addOption() [1/2]

◆ addOption() [2/2]

◆ addOptions()

◆ computeMinMax() [1/2]

◆ computeMinMax() [2/2]

◆ createHistogram() [1/3]

◆ createHistogram() [2/3]

◆ createHistogram() [3/3]

◆ createHistogramFast()

◆ createHistogramR0()

◆ createOverview() [1/2]

◆ createOverview() [2/2]

◆ createOverviews()

◆ createThumbnail()

◆ createThumbnails()

◆ dumpFilteredImageList()

◆ execute()

◆ executeCommands()

◆ executeFileCommands()

◆ executePostCommands()

◆ executePrepCommands()

◆ getCopyAllFlag()

◆ getDumpFilterImagesFlag()

◆ getFilteredImages() [1/2]

◆ getFilteredImages() [2/2]

◆ getHistogramMode()

◆ getInternalOverviewsFlag()

◆ getNextReaderPropIndex()

◆ getNextWriterPropIndex()

◆ getNumberOfThreads()

◆ getOutputFileNamesFlag()

◆ getOverrideFilteredImagesFlag()

◆ getOverviewStopDimension()

◆ getOverviewType()

◆ getThumbnailFilename()

◆ getThumbnailSize()

◆ getThumbnailStretchType()

◆ getThumbnailType()

◆ getTileSize()

◆ gsubDate()

◆ hasCmmOption()

◆ hasHistogramOption()

◆ hasRequiredOverview()

◆ initialize()

◆ initializeDefaultFilterList()

◆ isDirectoryBasedImage()

◆ isFiltered()

◆ keyIsTrue()

◆ outputOverviewWriterTypes()

◆ processFile()

◆ rebuildHistogram()

◆ rebuildOverviews()

◆ scanForMinMax()

◆ scanForMinMaxNull()

◆ setCompressionQuality()

◆ setCompressionType()

◆ setCopyAllFlag()

◆ setCreateHistogramFastFlag()

◆ setCreateHistogramFlag()

◆ setCreateHistogramR0Flag()

◆ setCreateOverviewsFlag()

◆ setCreateThumbnailsFlag()

◆ setDumpFilteredImageListFlag()

◆ setErrorStatus()

◆ setInternalOverviewsFlag()

◆ setNumberOfThreads() [1/2]

◆ setNumberOfThreads() [2/2]

◆ setOutputDirectory()

◆ setOutputFileNamesFlag()

◆ setOverrideFilteredImagesFlag()