OSSIM - Open Source Software Image Map
Version 1.9.0 (20180803)
|
Class used for parsing the command line *.src files. More...
#include <ossimSrcRecord.h>
Classes | |
struct | PixelFlipParams |
Public Member Functions | |
ossimSrcRecord () | |
Class used for parsing the command line *.src files. More... | |
ossimSrcRecord (const ossimKeywordlist &kwl, ossim_uint32 index=0, ossimString prefix_str="image") | |
Constructs given an in-memory KWL and record index. More... | |
bool | loadState (const ossimKeywordlist &kwl, const char *prefix=0) |
Initializes record from an in-memory KWL and prefix. More... | |
bool | valid () const |
Returns TRUE if record is valid. More... | |
const ossimFilename & | getFilename () const |
ossim_int32 | getEntryIndex () const |
const ossimFilename & | getSupportDir () const |
const ossimString & | getHistogramOp () const |
const std::vector< ossim_uint32 > & | getBands () const |
const double & | getWeight () const |
const PixelFlipParams & | getPixelFlipParams () const |
const ossimFilename & | getOverviewPath () const |
See note below on these data members. More... | |
const ossimFilename & | getHistogramPath () const |
const ossimFilename & | getMaskPath () const |
const ossimFilename & | getGeomPath () const |
void | setFilename (const ossimFilename &f) |
void | setEntryIndex (ossim_int32 i) |
void | setOverview (const ossimFilename &f) |
void | setMask (const ossimFilename &f) |
void | setHistogram (const ossimFilename &f) |
void | setHistogramOp (const ossimString &s) |
void | setGeom (const ossimFilename &f) |
void | setBands (const std::vector< ossim_uint32 > &v) |
void | setWeight (const double &weight) |
void | setRgbDataBool (bool isRgbData) |
void | setSupportDir (const ossimFilename &f) |
Sets supplementary data files dir. More... | |
bool | isVectorData () const |
Returns TRUE if the record represents a vector data set: More... | |
bool | isRgbData () const |
Returns TRUE if the record represents an rgb data set: More... | |
ossimFilename | getRgbFilename (int band) const |
ossimFilename | getRgbHistogramPath (int band) const |
ossimString | getRgbHistogramOp (int band) const |
ossimFilename | getRgbOverviewPath (int band) const |
const ossimKeywordlist & | getAttributesKwl () const |
Returns the KWL containing the desired vector representation properties. More... | |
Private Attributes | |
ossimFilename | m_filename |
ossim_int32 | m_entryIndex |
ossimFilename | m_supportDir |
std::vector< ossim_uint32 > | m_bandList |
ossimString | m_histogramOp |
double | m_weight |
ossimFilename | m_overviewPath |
The following data members are usually just a copy of m_supportDir, but are provided in order to support legacy systems where paths to OVR, thumbnails and histogram files. More... | |
ossimFilename | m_histogramPath |
ossimFilename | m_maskPath |
ossimFilename | m_geomPath |
bool | m_isVectorData |
The following data members allow users to render vector data. More... | |
ossimKeywordlist | m_attributesKwl |
std::vector< ossimString > | m_rgbFilenames |
std::vector< ossimString > | m_rgbHistogramPaths |
std::vector< ossimString > | m_rgbHistogramOps |
std::vector< ossimString > | m_rgbOverviewPaths |
bool | m_isRgbData |
PixelFlipParams | m_pixelFlipParams |
Class used for parsing the command line *.src files.
This is a scheme for providing input file information to am ossim app such as ossim-orthoigen.
The following keywords with image prefixes as shown are considered:
image0.file: <image_filename>
image0.entry: <image_index_in_multi_image_file> (unsigned integer) image0.ovr: <full/path/to/overview_file.ovr> image0.hist: <full/path/to/histogram.his> image0.hist-op: auto-minmax | std-stretch N (N=1|2|3) image0.support: <path_to_support_files> image0.rgb: R,G,B (unsigned integers starting with 1) image0.mask: <filename> image0.opacity: <double> image0.replacement_mode: <REPLACE_BAND_IF_TARGET | REPLACE_BAND_IF_PARTIAL_TARGET | REPLACE_ALL_BANDS_IF_ANY_TARGET | REPLACE_ALL_BANDS_IF_PARTIAL_TARGET | REPLACE_ONLY_FULL_TARGETS> image0.clamp.min: <double> image0.clamp.max: <double> image0.clip.min: <double> image0.clip.max: <double>
vector0.file: <image_filename>
vector0.entry: <image_index_in_multi_image_file> (unsigned integer) vector0.query: <select query>=""> vector0.line.color: <R, G, B> (255,255,255) vector0.line.width: <line width>=""> (unsigned integer) vector0.fill.color: <R, G, B> (255,0,0) vector0.fill.opacity: <opacity> (unsigned integer)
The "support" keyword can be specified in lieu of "ovr" and "hist" when the latter reside in the same external directory. This directory can also contain external image geometry files. If a support dir is provided without an ovr or hist specification, then default filenames are derived from the image filename, but with the support dir as the path.
Multiple files can be specified by incrementing the prefix image index.
Definition at line 62 of file ossimSrcRecord.h.
ossimSrcRecord::ossimSrcRecord | ( | ) |
Class used for parsing the command line *.src files.
This is a scheme for providing input file information to am ossim app such as ossim-orthoigen.
Definition at line 20 of file ossimSrcRecord.cpp.
ossimSrcRecord::ossimSrcRecord | ( | const ossimKeywordlist & | kwl, |
ossim_uint32 | index = 0 , |
||
ossimString | prefix_str = "image" |
||
) |
Constructs given an in-memory KWL and record index.
Definition at line 30 of file ossimSrcRecord.cpp.
References ossimString::chars(), loadState(), and ossimString::toString().
|
inline |
Returns the KWL containing the desired vector representation properties.
In the future we should stuff many of the members in ossimSrcRecord in a KWL (similar to what is currently done with vector properties) so that the handler is initialized via loadState() instead of individual calls to set methods. OLK 10/10
Definition at line 142 of file ossimSrcRecord.h.
Referenced by ossimSingleImageChain::addImageHandler().
|
inline |
Definition at line 101 of file ossimSrcRecord.h.
Referenced by ossimSingleImageChain::addBandSelector(), and ossimSingleImageChain::createRenderedChain().
|
inline |
Definition at line 98 of file ossimSrcRecord.h.
Referenced by ossimSingleImageChain::addImageHandler(), and ossimImageHandlerFactory::openSrcRecord().
|
inline |
Definition at line 97 of file ossimSrcRecord.h.
Referenced by ossimSingleImageChain::addImageHandler(), and ossimImageHandlerFactory::openSrcRecord().
|
inline |
Definition at line 110 of file ossimSrcRecord.h.
|
inline |
Definition at line 100 of file ossimSrcRecord.h.
Referenced by ossimSingleImageChain::addHistogramRemapper(), and ossimSingleImageChain::createRenderedChain().
|
inline |
Definition at line 108 of file ossimSrcRecord.h.
Referenced by ossimSingleImageChain::addImageHandler(), and ossimImageHandlerFactory::openSrcRecord().
|
inline |
Definition at line 109 of file ossimSrcRecord.h.
Referenced by ossimSingleImageChain::addImageHandler().
|
inline |
See note below on these data members.
Definition at line 107 of file ossimSrcRecord.h.
Referenced by ossimSingleImageChain::addImageHandler(), and ossimImageHandlerFactory::openSrcRecord().
|
inline |
Definition at line 104 of file ossimSrcRecord.h.
|
inline |
Definition at line 133 of file ossimSrcRecord.h.
|
inline |
Definition at line 135 of file ossimSrcRecord.h.
|
inline |
Definition at line 134 of file ossimSrcRecord.h.
|
inline |
Definition at line 136 of file ossimSrcRecord.h.
|
inline |
Definition at line 99 of file ossimSrcRecord.h.
Referenced by ossimSingleImageChain::addHistogramRemapper(), ossimSingleImageChain::addImageHandler(), and ossimImageHandlerFactory::openSrcRecord().
|
inline |
Definition at line 102 of file ossimSrcRecord.h.
|
inline |
Returns TRUE if the record represents an rgb data set:
Definition at line 131 of file ossimSrcRecord.h.
|
inline |
Returns TRUE if the record represents a vector data set:
Definition at line 128 of file ossimSrcRecord.h.
bool ossimSrcRecord::loadState | ( | const ossimKeywordlist & | kwl, |
const char * | prefix = 0 |
||
) |
Initializes record from an in-memory KWL and prefix.
"prefix.file" e.g. "image0.file" is required. All other data members will be cleared if their keword is not present.
kwl | Keyword list containing one or more records. |
prefix | Like "image0." |
Definition at line 45 of file ossimSrcRecord.cpp.
References ossimKeywordlist::add(), ossimKeywordNames::BRUSH_COLOR_KW, ossimString::chars(), ossimSrcRecord::PixelFlipParams::clampMax, ossimSrcRecord::PixelFlipParams::clampMin, ossimString::clear(), ossimSrcRecord::PixelFlipParams::clipMax, ossimSrcRecord::PixelFlipParams::clipMin, DIRECT_KW_MAPPING, ossimString::downcase(), ossimString::empty(), ossimKeywordNames::ENTRY_KW, ossimKeywordNames::FILENAME_KW, ossimKeywordNames::FILL_FLAG_KW, ossimKeywordlist::find(), ossimKeywordlist::getSize(), m_attributesKwl, m_bandList, m_entryIndex, m_filename, m_geomPath, m_histogramOp, m_histogramPath, m_isRgbData, m_isVectorData, m_maskPath, m_overviewPath, m_pixelFlipParams, m_rgbFilenames, m_rgbHistogramOps, m_rgbHistogramPaths, m_rgbOverviewPaths, m_supportDir, m_weight, ossimKeywordNames::PEN_COLOR_KW, ossimKeywordNames::QUERY_KW, ossimSrcRecord::PixelFlipParams::replacementMode, setGeom(), setOverview(), setSupportDir(), ossimString::split(), ossimKeywordNames::THICKNESS_KW, ossimString::toDouble(), and ossimString::toInt32().
Referenced by ossimImageHandlerFactory::openSrcRecord(), and ossimSrcRecord().
|
inline |
Definition at line 119 of file ossimSrcRecord.h.
void ossimSrcRecord::setEntryIndex | ( | ossim_int32 | i | ) |
Definition at line 300 of file ossimSrcRecord.cpp.
References ossimKeywordlist::add(), ossimKeywordNames::ENTRY_KW, m_attributesKwl, and m_entryIndex.
void ossimSrcRecord::setFilename | ( | const ossimFilename & | f | ) |
Definition at line 291 of file ossimSrcRecord.cpp.
References ossimKeywordlist::add(), ossimString::chars(), ossimKeywordNames::FILENAME_KW, m_attributesKwl, and m_filename.
void ossimSrcRecord::setGeom | ( | const ossimFilename & | f | ) |
Definition at line 317 of file ossimSrcRecord.cpp.
References ossimKeywordlist::add(), ossimString::chars(), ossimKeywordNames::GEOM_FILE_KW, m_attributesKwl, m_geomPath, and m_overviewPath.
Referenced by loadState().
|
inline |
Definition at line 116 of file ossimSrcRecord.h.
|
inline |
Definition at line 117 of file ossimSrcRecord.h.
|
inline |
Definition at line 115 of file ossimSrcRecord.h.
void ossimSrcRecord::setOverview | ( | const ossimFilename & | f | ) |
Definition at line 309 of file ossimSrcRecord.cpp.
References ossimKeywordlist::add(), ossimString::chars(), m_attributesKwl, m_overviewPath, and ossimKeywordNames::OVERVIEW_FILE_KW.
Referenced by loadState().
|
inline |
Definition at line 121 of file ossimSrcRecord.h.
void ossimSrcRecord::setSupportDir | ( | const ossimFilename & | f | ) |
Sets supplementary data files dir.
If the OVR and/or hist dirs are undefined, they are also set to this path.
Definition at line 274 of file ossimSrcRecord.cpp.
References ossimKeywordlist::add(), ossimString::c_str(), ossimString::empty(), m_attributesKwl, m_histogramPath, m_maskPath, and m_supportDir.
Referenced by loadState().
|
inline |
Definition at line 120 of file ossimSrcRecord.h.
|
inline |
|
private |
Definition at line 161 of file ossimSrcRecord.h.
Referenced by loadState(), setEntryIndex(), setFilename(), setGeom(), setOverview(), and setSupportDir().
|
private |
Definition at line 148 of file ossimSrcRecord.h.
Referenced by loadState().
|
private |
Definition at line 146 of file ossimSrcRecord.h.
Referenced by loadState(), and setEntryIndex().
|
private |
Definition at line 145 of file ossimSrcRecord.h.
Referenced by loadState(), and setFilename().
|
private |
Definition at line 157 of file ossimSrcRecord.h.
Referenced by loadState(), and setGeom().
|
private |
Definition at line 149 of file ossimSrcRecord.h.
Referenced by loadState().
|
private |
Definition at line 155 of file ossimSrcRecord.h.
Referenced by loadState(), and setSupportDir().
|
private |
Definition at line 167 of file ossimSrcRecord.h.
Referenced by loadState().
|
private |
The following data members allow users to render vector data.
Definition at line 160 of file ossimSrcRecord.h.
Referenced by loadState().
|
private |
Definition at line 156 of file ossimSrcRecord.h.
Referenced by loadState(), and setSupportDir().
|
private |
The following data members are usually just a copy of m_supportDir, but are provided in order to support legacy systems where paths to OVR, thumbnails and histogram files.
Definition at line 154 of file ossimSrcRecord.h.
Referenced by loadState(), setGeom(), and setOverview().
|
private |
Definition at line 168 of file ossimSrcRecord.h.
Referenced by loadState().
|
private |
Definition at line 163 of file ossimSrcRecord.h.
Referenced by loadState().
|
private |
Definition at line 165 of file ossimSrcRecord.h.
Referenced by loadState().
|
private |
Definition at line 164 of file ossimSrcRecord.h.
Referenced by loadState().
|
private |
Definition at line 166 of file ossimSrcRecord.h.
Referenced by loadState().
|
private |
Definition at line 147 of file ossimSrcRecord.h.
Referenced by loadState(), and setSupportDir().
|
private |
Definition at line 150 of file ossimSrcRecord.h.
Referenced by loadState().