Isis 3.0 Object Programmers' Reference |
Home |
Mosaic two cubs together. More...
#include <ProcessMapMosaic.h>
Public Types | |
enum | ImageOverlay { PlaceImagesOnTop, PlaceImagesBeneath, UseBandPlacementCriteria, AverageImageWithMosaic, NumImageOverlayOptions } |
Enumeration for different Mosaic priorities (input, mosaic, band) More... | |
Public Member Functions | |
ProcessMapMosaic () | |
Constructs a Mosaic object. | |
virtual | ~ProcessMapMosaic () |
Destructor. | |
virtual Isis::Cube * | SetOutputCube (FileList &propagationCubes, CubeAttributeOutput &oAtt, const QString &mosaicFile) |
Set the output cube to specified file name and specified input images and output attributes. | |
Isis::Cube * | RingsSetOutputCube (FileList &propagationCubes, CubeAttributeOutput &oAtt, const QString &mosaicFile) |
Set the output cube to specified file name and specified input images and output attributes. | |
virtual Isis::Cube * | SetOutputCube (FileList &propagationCubes, double slat, double elat, double slon, double elon, CubeAttributeOutput &oAtt, const QString &mosaicFile) |
Set the output cube to specified file name and specified input images and output attributes and lat,lons. | |
Isis::Cube * | RingsSetOutputCube (FileList &propagationCubes, double srad, double erad, double saz, double eaz, CubeAttributeOutput &oAtt, const QString &mosaicFile) |
Set the output cube to specified file name using the specified input images, output attributes, ring radii values and ring longitude values. | |
virtual Isis::Cube * | SetOutputCube (const QString &inputFile, double xmin, double xmax, double ymin, double ymax, double slat, double elat, double slon, double elon, int nbands, CubeAttributeOutput &oAtt, const QString &mosaicFile, bool latlonflag=true) |
Set the output cube to specified file name and specified input images and output attributes and lat,lons. | |
Isis::Cube * | RingsSetOutputCube (const QString &inputFile, double xmin, double xmax, double ymin, double ymax, double srad, double erad, double saz, double eaz, int nbands, CubeAttributeOutput &oAtt, const QString &mosaicFile) |
Set the output cube to specified file name using the specified input file name, output attributes, ring radii values and ring longitude values. | |
virtual Isis::Cube * | SetOutputCube (const QString &inputFile, PvlGroup mapping, CubeAttributeOutput &oAtt, const QString &mosaicFile) |
Set the output cube to specified file name and specified input images and output attributes and lat,lons. | |
Isis::Cube * | RingsSetOutputCube (const QString &inputFile, PvlGroup mapping, CubeAttributeOutput &oAtt, const QString &mosaicFile) |
Set the output cube to specified file name and specified input images and output attributes and lat,lons. | |
Isis::Cube * | SetOutputCube (const QString &mosaicFile) |
Mosaic output method for Mosaic Processing Method, this will use an existing mosaic. | |
Isis::Cube * | RingsSetOutputCube (const QString &mosaicFile) |
Mosaic output method for Mosaic Processing Method, this will use an existing mosaic. | |
virtual Isis::Cube * | SetInputCube () |
Input cube cannot be set here. | |
virtual bool | StartProcess (QString inputFile) |
Mosaic Processing method, returns false if the cube is not inside the mosaic. | |
virtual void | StartProcess (const int &piOutSample, const int &piOutLine, const int &piOutBand) |
This method invokes the process by mosaic operation over a single input cube and single output cube. | |
virtual void | StartProcess (void funct()) |
In the base class, this method will invoked a user-specified function exactly one time. | |
PvlObject | imagePositions () |
Accessor for the placed images and their locations. | |
virtual Isis::Cube * | SetInputCube (const QString ¶meter, const int ss=1, const int sl=1, const int sb=1, const int ns=-1, const int nl=-1, const int nb=-1) |
Opens an input cube specified by the user. | |
virtual Isis::Cube * | SetInputCube (const QString &fname, Isis::CubeAttributeInput &att, const int ss=1, const int sl=1, const int sb=1, const int ns=-1, const int nl=-1, const int nb=-1) |
Opens an input cube specified by the user. | |
virtual Isis::Cube * | SetInputCube (const QString ¶meter, const int requirements=0) |
Opens an input cube specified by the user and verifies requirements are met. | |
virtual Isis::Cube * | SetInputCube (const QString &fname, const Isis::CubeAttributeInput &att, int requirements=0) |
Opens an input cube specified by the programmer and verifies requirements are met. | |
virtual void | SetInputCube (Isis::Cube *inCube) |
Set the InputCube vector to an opened Cube which was dynamically allocated. | |
virtual Isis::Cube * | SetOutputCube (const QString ¶meter, const int nsamps, const int nlines, const int nbands=1) |
Allocates a user specified output cube whose size is specified by the programmer. | |
virtual Isis::Cube * | SetOutputCube (const QString &fname, const Isis::CubeAttributeOutput &att, const int nsamps, const int nlines, const int nbands=1) |
Allocates a output cube whose name and size is specified by the programmer. | |
void | SetBandBinMatch (bool enforceBandBinMatch) |
void | SetMosaicOrigin (int &piIndex) |
This method creates a table if not already created to hold the image file names if the track flag is true. | |
void | SetBandKeyword (QString bandPriorityKeyName, QString bandPriorityKeyValue) |
Set the keyword/value to use for comparing when using band priority. | |
void | SetBandNumber (int bandPriorityBandNumber) |
Set the band to use for priorities when using band priority. | |
void | SetBandUseMaxValue (bool useMax) |
Set whether to take the image with the max or min value when using band priority. | |
void | SetCreateFlag (bool createOutputMosaic) |
Flag to indicate that the mosaic is being newly created Indication that the new label specific to the mosaic needs to be created. | |
void | SetHighSaturationFlag (bool placeHighSatPixels) |
When true, high saturation (HRS, HIS) will be considered valid data for the purposes of placing pixels in the output mosaic. | |
void | SetImageOverlay (ImageOverlay placement) |
void | SetLowSaturationFlag (bool placeLowSatPixels) |
When true, low saturation (LRS, LIS) will be considered valid data for the purposes of placing pixels in the output mosaic. | |
void | SetMatchDEM (bool matchDEM) |
Set the DEM match flag. | |
void | SetNullFlag (bool placeNullPixels) |
When true, Null pixels will be considered valid data for the purposes of placing pixels in the output mosaic. | |
void | SetTrackFlag (bool trackingEnabled) |
bool | GetHighSaturationFlag () const |
ImageOverlay | GetImageOverlay () const |
bool | GetLowSaturationFlag () const |
bool | GetNullFlag () const |
bool | GetTrackFlag () const |
int | GetInputStartLineInMosaic () const |
This is the line where the image was placed into the output mosaic. | |
int | GetInputStartSampleInMosaic () const |
This is the sample where the image was placed into the output mosaic. | |
int | GetInputStartBandInMosaic () const |
This is the band where the image was placed into the output mosaic. | |
virtual void | EndProcess () |
End the processing sequence and cleans up by closing cubes, freeing memory, etc. | |
virtual void | Finalize () |
Cleans up by closing cubes and freeing memory for owned cubes. | |
void | AddInputCube (Cube *cube, bool owned=true) |
void | AddOutputCube (Cube *cube, bool owned=true) |
void | ClearCubes () |
Close owned cubes from the list and clear the list. | |
void | ClearInputCubes () |
Close owned input cubes from the list and clear the list. | |
void | ClearOutputCubes () |
Close owned output cubes from the list and clear the list. | |
void | PropagateLabels (const bool prop) |
This method allows the programmer to turn on/off the propagation of labels from the 1st input cube to any of the output cubes. | |
void | PropagateLabels (const QString &cube) |
This method allows the programmer to propagate labels from a specific secondary cube. | |
void | PropagateTables (const bool prop) |
This method allows the programmer to propagate input tables to the output cube (default is true) | |
void | PropagateTables (const QString &fromName) |
Propagate the tables from the cube with the given filename to the output cube. | |
void | PropagatePolygons (const bool prop) |
This method allows the programmer to propagate input blobs to the output cube (default is true) | |
void | PropagateHistory (const bool prop) |
This method allows the programmer to propagate history to the output cube (default is true) | |
void | PropagateOriginalLabel (const bool prop) |
This method allows the programmer to propagate original labels to the output cube (default is true) | |
Isis::Progress * | Progress () |
This method returns a pointer to a Progress object. | |
QString | MissionData (const QString &mission, const QString &file, bool highestVersion=false) |
This method reads the mission specific data directory from the user preference file, makes sure that mission is available in the Isis installation, and the attaches the provided input file to the directory in order to create a full file specification. | |
void | WriteHistory (Cube &cube) |
Writes out the History blob to the cube. | |
void | CalculateStatistics () |
Calculates and stores off statistics on every band of every cube added to this process via the SetInputCube method. | |
std::vector< Isis::Statistics * > | BandStatistics (const unsigned index) |
Get the vector of Statistics objects for each band separately of a specified input cube. | |
Isis::Statistics * | CubeStatistics (const unsigned index) |
Get the Statistics object for all bands of a specified input cube. | |
Static Public Member Functions | |
static QString | OverlayToString (ImageOverlay) |
Convert an ImageOverlay to a QString. | |
static ImageOverlay | StringToOverlay (QString) |
Convert a QString to an ImageOverlay (case-insensitive). | |
Static Public Attributes | |
static const char * | TRACKING_TABLE_NAME = "InputImages" |
This is the name of the table in the Cube which will contain the image file names. | |
static const int | FLOAT_STORE_INT_PRECISELY_MAX_VALUE = 16777216 |
static const int | FLOAT_STORE_INT_PRECISELY_MIN_VALUE = -16777215 |
Protected Attributes | |
Isis::Progress * | p_progress |
Pointer to a Progress object. | |
bool | p_propagateLabels |
Flag indicating if labels are be propagated to output cubes. | |
bool | p_propagateTables |
Flag indicating if tables are be propagated to output cubes. | |
bool | p_propagatePolygons |
Flag indicating if blobs are be propagated to output cubes. | |
bool | p_propagateHistory |
Flag indicating if history is to be propagated to output cubes. | |
bool | p_propagateOriginalLabel |
Flag indicating if original lable is to be propagated to output cubes. | |
std::vector< std::vector < Isis::Statistics * > > | p_bandStats |
Holds the calculated statistics for each band separately of every input cubei after the CalculateStatistics method is called. | |
std::vector< Isis::Statistics * > | p_cubeStats |
Holds the calculated statistics for every band together of every input cubei after the CalculateStatistics method is called. | |
std::vector< Isis::Cube * > | InputCubes |
A vector of pointers to opened Cube objects. | |
std::vector< Isis::Cube * > | OutputCubes |
A vector of pointers to allocated Cube objects. | |
QSet< Isis::Cube * > * | m_ownedCubes |
A list of cubes owned by this instant. | |
Static Private Member Functions | |
static void | FillNull (Buffer &data) |
Reset the buffer with NULL pixels. | |
Private Attributes | |
bool | p_createMosaic |
Internal use; SetOutputMosaic (const QString &) sets to false to not attempt creation when using SetOutputMosaic. | |
Mosaic two cubs together.
This class allows a programmer to develop a program which merges two cubes together. The application sets the position where input (child) cube will be placed in the mosaic (parent) cube and priority. The the Mosaic object will merge the overlapping area.
2003-04-28 Stuart Sides - Modified unitTest.cpp to do a better test
2003-09-04 Jeff Anderson - Added SetInputWorkCube method
2005-02-11 Elizabeth Ribelin - Modified file to support Doxygen documentation
2006-09-01 Elizabeth Miller - Added BandBinMatch option to propagate the bandbin group to the mosaic and make sure the input cube bandbin groups match the mosaics bandbin group
2006-10-20 Stuart Sides - Fixed bug BandBin group did not get copied to the output mosaic.
2008-10-03 Steven Lambright - Fixed problem where return values from SetUniversalGround were not checked
2008-11-18 Christopher Austin - Added the first cube's history to the mosaic's history along with the history object of the application which did the mosaic.
2008-12-08 Steven Lambright - Fixed one of the SetOutputCube(...) methods, a lat/lon range was specified but CreateFromCube was still being used (needed CreateFromCube because no cubes existed with the correct range).
2008-12-08 Steven Lambright - MinimumLatitude,MaximumLatitude, MinimumLongitude,MaximumLongitude keywords no longer required to exist if passed into SetOutputCube
2010-10-27 Sharmila Prasad - Read input file attributes
2011-01-18 Sharmila Prasad - Added "Average" priority feature, to double the number of mosaic bands to get Count info
2011-06-28 Jai Rideout and Steven Lambright - Now uses a different caching algorithm.
2011-09-08 Sharmila Prasad - Fixed Bug #406, Additional boundary checks similar to ProcessMosaic so that there will be no interruption for applications like automos
2012-10-05 Jeannie Backer - Fixed indentation of history entries. Added caught exception to new thrown exception. Moved method implementation to cpp. References #1169.
2013-03-27 Jeannie Backer - Added programmer comments. References #1248.
2012-01-20 Debbie A. Cook - Changed to use TProjection instead of Projection. References #775.
2013-11-14 Kimberly Oyama - Modified StartProcess() to account for a negative x or y from the projection. These x and y values are used to calculate the outline and outsample. Fixes #1736.
2013-12-27 Janet Barrett - Added additional latlonflag parameter to the SetOutputCube method so that valid lat/lon values are checked for in the input files that make up a mosaic. This change was needed to handle input files that are missing the min/max lat/lon keywords (such as those that were cropped). Fixes #1500.
2015-01-15 Sasha Brownsberger - Added virtual keyword to several functions to ensure successful inheritance between Process and its child classes. Made destructor virtual. References #2215.
Definition at line 103 of file ProcessMapMosaic.h.
|
inherited |
Enumeration for different Mosaic priorities (input, mosaic, band)
Enumerator | |
---|---|
PlaceImagesOnTop |
ontop priority |
PlaceImagesBeneath |
beneath priority |
UseBandPlacementCriteria |
band priority |
AverageImageWithMosaic |
average priority |
Definition at line 207 of file ProcessMosaic.h.
Isis::ProcessMapMosaic::ProcessMapMosaic | ( | ) |
Constructs a Mosaic object.
Definition at line 44 of file ProcessMapMosaic.cpp.
|
virtual |
Destructor.
Definition at line 50 of file ProcessMapMosaic.cpp.
|
inlineinherited |
Get the vector of Statistics objects for each band separately of a specified input cube.
index | The index of the input cube in InputCubes |
Definition at line 283 of file Process.h.
References Isis::Process::p_bandStats.
|
inherited |
Calculates and stores off statistics on every band of every cube added to this process via the SetInputCube method.
The newly calculated statistics are stored in two ways: as a vector where each entry is a single Statistics object for every band of a particular input cube, and as a vector where each entry is a vector of Statistics objects, for each band separately, of a particular input cube.
Definition at line 721 of file Process.cpp.
References Isis::Statistics::AddData(), Isis::Cube::bandCount(), Isis::Progress::CheckStatus(), Isis::Buffer::DoubleBuffer(), Isis::Cube::lineCount(), Isis::Cube::read(), Isis::LineManager::SetLine(), Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), Isis::Buffer::size(), and Isis::toString().
|
inherited |
Close owned cubes from the list and clear the list.
Definition at line 506 of file Process.cpp.
|
inherited |
Close owned input cubes from the list and clear the list.
Definition at line 516 of file Process.cpp.
Referenced by RingsSetOutputCube(), Isis::FileTool::saveAsReducedCube(), and SetOutputCube().
|
inherited |
Close owned output cubes from the list and clear the list.
Definition at line 530 of file Process.cpp.
|
inlineinherited |
Get the Statistics object for all bands of a specified input cube.
index | The index of the input cube in InputCubes |
Definition at line 297 of file Process.h.
References Isis::Process::p_cubeStats.
|
virtualinherited |
End the processing sequence and cleans up by closing cubes, freeing memory, etc.
Reimplemented in Isis::ProcessImportPds, Isis::ProcessByBrick, Isis::ProcessByBoxcar, Isis::ProcessByTile, Isis::ProcessGroundPolygons, and Isis::ProcessPolygons.
Definition at line 480 of file Process.cpp.
Referenced by Isis::ImageExporter::createWorldFile(), Isis::ProcessByBoxcar::EndProcess(), and Isis::FileTool::saveAsEnlargedCube().
|
staticprivate |
Reset the buffer with NULL pixels.
Definition at line 851 of file ProcessMapMosaic.cpp.
References Isis::Null, and Isis::Buffer::size().
|
virtualinherited |
Cleans up by closing cubes and freeing memory for owned cubes.
Clears the lists for all cubes.
Reimplemented in Isis::ProcessImportPds, Isis::ProcessByBrick, Isis::ProcessByBoxcar, Isis::ProcessByTile, Isis::ProcessGroundPolygons, and Isis::ProcessPolygons.
Definition at line 488 of file Process.cpp.
Referenced by Isis::ProcessByBoxcar::Finalize().
|
inherited |
Definition at line 891 of file ProcessMosaic.cpp.
|
inherited |
This is the band where the image was placed into the output mosaic.
Definition at line 947 of file ProcessMosaic.cpp.
|
inherited |
This is the line where the image was placed into the output mosaic.
Definition at line 931 of file ProcessMosaic.cpp.
|
inherited |
This is the sample where the image was placed into the output mosaic.
Definition at line 939 of file ProcessMosaic.cpp.
|
inherited |
Definition at line 907 of file ProcessMosaic.cpp.
|
inherited |
Definition at line 915 of file ProcessMosaic.cpp.
|
inherited |
Definition at line 923 of file ProcessMosaic.cpp.
|
inherited |
Accessor for the placed images and their locations.
Definition at line 436 of file ProcessMosaic.cpp.
|
inherited |
This method reads the mission specific data directory from the user preference file, makes sure that mission is available in the Isis installation, and the attaches the provided input file to the directory in order to create a full file specification.
mission | Name of the mission data directory |
file | Name of the file to attach to the end of the directory |
highestVersion | If set to true the method will return the highest version number of the given file. Therefore, file must contain question marks such as "file???.dat". See the FileName class for more information on versioned files. Defaults to false. |
Definition at line 666 of file Process.cpp.
References _FILEINFO_, and Isis::PvlObject::findGroup().
|
staticinherited |
Convert an ImageOverlay to a QString.
This is used to translate between mapmos, handmos, and automos' interfaces into an ImageOverlay.
Definition at line 956 of file ProcessMosaic.cpp.
References _FILEINFO_, and Isis::toString().
|
inlineinherited |
This method returns a pointer to a Progress object.
Definition at line 263 of file Process.h.
References Isis::Process::p_progress.
Referenced by Isis::Equalization::calculateStatistics(), RingsSetOutputCube(), and SetOutputCube().
|
inherited |
This method allows the programmer to propagate history to the output cube (default is true)
prop | Flag indicating if history is to be propagated to output cubes. |
Definition at line 635 of file Process.cpp.
Referenced by RingsSetOutputCube(), and SetOutputCube().
|
inherited |
This method allows the programmer to turn on/off the propagation of labels from the 1st input cube to any of the output cubes.
By default, propagation occurs automatically in the Process class when a call to either of the SetOutputCube methods is invoked. If the program * requires no propagation then utilize this method. This method can be invoked between successive calls of SetOutputCube so that some cube will have labels propagated while others will not.
prop | Flag indicating if labels are be propagated to output cubes. |
Definition at line 552 of file Process.cpp.
Referenced by RingsSetOutputCube(), and SetOutputCube().
|
inherited |
This method allows the programmer to propagate labels from a specific secondary cube.
cube | IString containing the name of the cube containing the labels to propagate. |
Definition at line 563 of file Process.cpp.
References Isis::PvlObject::addGroup(), Isis::PvlObject::addObject(), Isis::PvlObject::findObject(), Isis::PvlObject::group(), Isis::PvlObject::groups(), and Isis::PvlObject::hasObject().
|
inherited |
This method allows the programmer to propagate original labels to the output cube (default is true)
prop | Flag indicating if original labels is to be propagated to output cubes. |
Definition at line 646 of file Process.cpp.
Referenced by RingsSetOutputCube(), and SetOutputCube().
|
inherited |
This method allows the programmer to propagate input blobs to the output cube (default is true)
prop | Flag indicating if input blobs are to be propagated to output cubes. |
Definition at line 625 of file Process.cpp.
Referenced by RingsSetOutputCube(), and SetOutputCube().
|
inherited |
This method allows the programmer to propagate input tables to the output cube (default is true)
prop | Flag indicating if input tables are to be propagated to output cubes. |
Definition at line 591 of file Process.cpp.
Referenced by RingsSetOutputCube(), and SetOutputCube().
|
inherited |
Propagate the tables from the cube with the given filename to the output cube.
This is done at the time this method is called, not during normal processing.
Definition at line 600 of file Process.cpp.
References Isis::Cube::label(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Cube::open(), and Isis::Cube::read().
Isis::Cube * Isis::ProcessMapMosaic::RingsSetOutputCube | ( | FileList & | propagationCubes, |
CubeAttributeOutput & | oAtt, | ||
const QString & | mosaicFile | ||
) |
Set the output cube to specified file name and specified input images and output attributes.
Definition at line 282 of file ProcessMapMosaic.cpp.
References _FILEINFO_, Isis::Cube::bandCount(), Isis::Cube::close(), Isis::ProjectionFactory::CreateFromCube(), Isis::Cube::label(), Isis::Cube::lineCount(), Isis::Cube::open(), Isis::Cube::sampleCount(), and Isis::toString().
Isis::Cube * Isis::ProcessMapMosaic::RingsSetOutputCube | ( | FileList & | propagationCubes, |
double | srad, | ||
double | erad, | ||
double | saz, | ||
double | eaz, | ||
CubeAttributeOutput & | oAtt, | ||
const QString & | mosaicFile | ||
) |
Set the output cube to specified file name using the specified input images, output attributes, ring radii values and ring longitude values.
propagationCubes | List of input images |
srad | Start ring radius |
erad | End ring radius |
saz | Start ring longitude (azimuth) |
eaz | End ring longitude (azimuth) |
oAtt | Output attributes |
mosaicFile | Name of the output mosaic file |
Definition at line 444 of file ProcessMapMosaic.cpp.
References _FILEINFO_, Isis::PvlContainer::addKeyword(), Isis::Cube::bandCount(), Isis::PvlContainer::deleteKeyword(), Isis::PvlObject::findGroup(), Isis::PvlContainer::hasKeyword(), Isis::Cube::label(), Isis::Cube::open(), Isis::Pvl::read(), Isis::ProjectionFactory::RingsCreateForCube(), Isis::ProjectionFactory::RingsCreateFromCube(), and Isis::toString().
Isis::Cube * Isis::ProcessMapMosaic::RingsSetOutputCube | ( | const QString & | inputFile, |
double | xmin, | ||
double | xmax, | ||
double | ymin, | ||
double | ymax, | ||
double | srad, | ||
double | erad, | ||
double | saz, | ||
double | eaz, | ||
int | nbands, | ||
CubeAttributeOutput & | oAtt, | ||
const QString & | mosaicFile | ||
) |
Set the output cube to specified file name using the specified input file name, output attributes, ring radii values and ring longitude values.
inputFile | Name of input file |
xmin | Minimum x-value |
xmax | Maximum x-value |
ymin | Minimum y-value |
ymax | Maximum y-value |
srad | Start ring radius |
erad | End ring radius |
saz | Start ring longitude (azimuth) |
eaz | End ring longitude (azimuth) |
oAtt | Output attributes |
mosaicFile | Name of the output mosaic file |
Definition at line 621 of file ProcessMapMosaic.cpp.
References Isis::Cube::addCachingAlgorithm(), Isis::PvlObject::addGroup(), Isis::PvlContainer::addKeyword(), Isis::Process::ClearInputCubes(), Isis::ProcessByBrick::EndProcess(), Isis::PvlObject::findGroup(), Isis::Cube::open(), Isis::Process::Progress(), Isis::Process::PropagateHistory(), Isis::Process::PropagateLabels(), Isis::Process::PropagateOriginalLabel(), Isis::Process::PropagatePolygons(), Isis::Process::PropagateTables(), Isis::Cube::putGroup(), Isis::ProcessByLine::SetInputCube(), Isis::ProcessByBrick::SetOutputCube(), Isis::Progress::SetText(), Isis::ProcessByLine::StartProcess(), Isis::toString(), Isis::Projection::ToWorldX(), and Isis::Projection::ToWorldY().
Isis::Cube * Isis::ProcessMapMosaic::RingsSetOutputCube | ( | const QString & | inputFile, |
PvlGroup | mapping, | ||
CubeAttributeOutput & | oAtt, | ||
const QString & | mosaicFile | ||
) |
Set the output cube to specified file name and specified input images and output attributes and lat,lons.
Definition at line 751 of file ProcessMapMosaic.cpp.
References _FILEINFO_, Isis::Cube::addCachingAlgorithm(), Isis::PvlObject::addGroup(), Isis::Cube::bandCount(), Isis::Process::ClearInputCubes(), Isis::PvlContainer::deleteKeyword(), Isis::ProcessByBrick::EndProcess(), Isis::PvlObject::findGroup(), Isis::PvlContainer::hasKeyword(), Isis::Cube::open(), Isis::Process::Progress(), Isis::Process::PropagateHistory(), Isis::Process::PropagateLabels(), Isis::Cube::putGroup(), Isis::ProcessByLine::SetInputCube(), Isis::ProcessByBrick::SetOutputCube(), Isis::Progress::SetText(), and Isis::ProcessByLine::StartProcess().
Cube * Isis::ProcessMapMosaic::RingsSetOutputCube | ( | const QString & | mosaicFile | ) |
Mosaic output method for Mosaic Processing Method, this will use an existing mosaic.
Definition at line 832 of file ProcessMapMosaic.cpp.
References Isis::PvlObject::findGroup(), Isis::Cube::label(), and Isis::Cube::open().
|
inherited |
Set the keyword/value to use for comparing when using band priority.
Definition at line 807 of file ProcessMosaic.cpp.
|
inherited |
Set the band to use for priorities when using band priority.
Definition at line 816 of file ProcessMosaic.cpp.
|
inherited |
Set whether to take the image with the max or min value when using band priority.
Definition at line 825 of file ProcessMosaic.cpp.
|
inherited |
Flag to indicate that the mosaic is being newly created Indication that the new label specific to the mosaic needs to be created.
createOutputMosaic | - Set Create Flag True/False |
Definition at line 838 of file ProcessMosaic.cpp.
|
inherited |
When true, high saturation (HRS, HIS) will be considered valid data for the purposes of placing pixels in the output mosaic.
Definition at line 847 of file ProcessMosaic.cpp.
|
virtual |
Input cube cannot be set here.
Definition at line 56 of file ProcessMapMosaic.cpp.
References _FILEINFO_.
|
virtualinherited |
Opens an input cube specified by the user and verifies requirements are met.
parameter | User parameter to obtain file to open. Typically, the value is "FROM". For example, the user can specify on the command line FROM=myfile.cub and this method will attempt to open the cube "myfile.cub" if the parameter was set to "FROM". |
requirements | Use to specify requirements for the input file. The following are requirments are checked against 1) ic_base::SizeMatch checks to make sure the input cube has the same bands, samples, and lines as the first input cube open using this method, 2) ic_base::SpatialMatch checks to make sure the input cube has the same samples and lines as the first input cube, 3) ic_base::Georeferenced checks to make sure latitude/longitudes can be obtained from the input cube, 4) ic_base::FullyGeoreferenced checks to make sure latitude/longitude, phase/incidence/emission, and other geometric parameters can be obtained from the input cube, 5) ic_base::OneBand checks to make sure the input cube has exactly one band. Note, that these requirements can be logically or'ed. For example, ic_base::SpatialMatch | ic_base::georeferenced. Defaults to 0 |
Isis::iException::Message |
Reimplemented in Isis::ProcessByBrick, Isis::ProcessByLine, Isis::ProcessBySpectra, and Isis::ProcessBySample.
Definition at line 243 of file Process.cpp.
Referenced by Isis::ImageExporter::addChannel(), Isis::FileTool::saveAsEnlargedCube(), and Isis::ProcessGroundPolygons::SetStatCubes().
|
virtualinherited |
Opens an input cube specified by the programmer and verifies requirements are met.
fname | Programmer specified work file. For example, "myfile.cub". |
att | The cube attributes to use when opening the input cube. |
requirements | Same as requirements on SetInputCube. See that method for more details. Defaults to 0 |
Isis::iException::Message |
Reimplemented in Isis::ProcessByBrick.
Definition at line 82 of file Process.cpp.
References _FILEINFO_, Isis::Cube::bandCount(), Isis::CubeAttributeInput::bands(), Isis::Cube::lineCount(), Isis::Cube::open(), Isis::Cube::sampleCount(), and Isis::Cube::setVirtualBands().
|
virtualinherited |
Set the InputCube vector to an opened Cube which was dynamically allocated.
This is used if there already exists a valid opened cube
inCube | - Pointer to input Cube |
Reimplemented in Isis::ProcessByLine.
Definition at line 201 of file Process.cpp.
References _FILEINFO_, and Isis::Cube::isOpen().
|
virtualinherited |
Opens an input cube specified by the user.
This method is overloaded and adds the requirement that only one input cube can be specified.
parameter | User parameter to obtain file to open. Typically, the value is "FROM". For example, the user can specify on the command line FROM=myfile.cub and this method will attempt to open the cube "myfile.cub" if the parameter was set to "FROM". |
ss | The starting sample within the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to 1 |
sl | The starting line within the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to 1 |
sb | The starting band within the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to 1 |
ns | The number of samples from the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to number of samples in the cube |
nl | The number of lines from the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to number of lines in the cube |
nb | The number of bands from the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to number of bands in the cube |
IException::Message |
Definition at line 478 of file ProcessMosaic.cpp.
References _FILEINFO_, Isis::PvlObject::findGroup(), and Isis::toInt().
|
virtualinherited |
Opens an input cube specified by the user.
This method is overloaded and adds the requirement that only one input cube can be specified.
fname | |
att | |
ss | The starting sample within the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to 1 |
sl | The starting line within the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to 1 |
sb | The starting band within the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to 1 |
ns | The number of samples from the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to number of samples in the cube |
nl | The number of lines from the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to number of lines in the cube |
nb | The number of bands from the input cube. This allowd the application to choose a sub-area from the input cube to be place into the mosaic. Defaults to number of bands in the cube |
IException |
Definition at line 548 of file ProcessMosaic.cpp.
References _FILEINFO_, Isis::PvlObject::findGroup(), and Isis::toInt().
|
inherited |
When true, low saturation (LRS, LIS) will be considered valid data for the purposes of placing pixels in the output mosaic.
Definition at line 861 of file ProcessMosaic.cpp.
|
inherited |
Set the DEM match flag.
matchDEM | If true, the match is enforced between Input & Mosaic |
Definition at line 869 of file ProcessMosaic.cpp.
|
inherited |
This method creates a table if not already created to hold the image file names if the track flag is true.
If table exists, checks if the image already exists and if it does not, then adds the new image file name. If the field size is smaller than the new image name, then it resizes all the records to new file size. When the table is newly created,it resets the origin band to default based on pixel type.
index | - the input file index |
an | exception if the number of images exceeds the pixel size. |
iException::Message |
Definition at line 657 of file ProcessMosaic.cpp.
References _FILEINFO_, Isis::PvlObject::findGroup(), Isis::PvlObject::findKeyword(), Isis::PvlObject::hasKeyword(), Isis::PvlObject::hasObject(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Table::Records(), and Isis::toInt().
|
inherited |
When true, Null pixels will be considered valid data for the purposes of placing pixels in the output mosaic.
Definition at line 878 of file ProcessMosaic.cpp.
|
virtual |
Set the output cube to specified file name and specified input images and output attributes.
Definition at line 203 of file ProcessMapMosaic.cpp.
References _FILEINFO_, Isis::Cube::bandCount(), Isis::Cube::close(), Isis::ProjectionFactory::CreateFromCube(), Isis::Cube::label(), Isis::Cube::lineCount(), Isis::Cube::open(), Isis::Cube::sampleCount(), and Isis::toString().
|
virtual |
Set the output cube to specified file name and specified input images and output attributes and lat,lons.
Definition at line 355 of file ProcessMapMosaic.cpp.
References _FILEINFO_, Isis::PvlContainer::addKeyword(), Isis::Cube::bandCount(), Isis::ProjectionFactory::CreateForCube(), Isis::ProjectionFactory::CreateFromCube(), Isis::PvlContainer::deleteKeyword(), Isis::PvlObject::findGroup(), Isis::PvlContainer::hasKeyword(), Isis::Cube::label(), Isis::Cube::open(), Isis::Pvl::read(), and Isis::toString().
|
virtual |
Set the output cube to specified file name and specified input images and output attributes and lat,lons.
Definition at line 515 of file ProcessMapMosaic.cpp.
References Isis::Cube::addCachingAlgorithm(), Isis::PvlObject::addGroup(), Isis::PvlContainer::addKeyword(), Isis::Process::ClearInputCubes(), Isis::PvlContainer::deleteKeyword(), Isis::ProcessByBrick::EndProcess(), Isis::PvlObject::findGroup(), Isis::PvlContainer::hasKeyword(), Isis::Cube::open(), Isis::Process::Progress(), Isis::Process::PropagateHistory(), Isis::Process::PropagateLabels(), Isis::Process::PropagateOriginalLabel(), Isis::Process::PropagatePolygons(), Isis::Process::PropagateTables(), Isis::Cube::putGroup(), Isis::ProcessByLine::SetInputCube(), Isis::ProcessByBrick::SetOutputCube(), Isis::Progress::SetText(), Isis::ProcessByLine::StartProcess(), Isis::toString(), Isis::Projection::ToWorldX(), and Isis::Projection::ToWorldY().
|
virtual |
Set the output cube to specified file name and specified input images and output attributes and lat,lons.
Definition at line 689 of file ProcessMapMosaic.cpp.
References _FILEINFO_, Isis::Cube::addCachingAlgorithm(), Isis::PvlObject::addGroup(), Isis::Cube::bandCount(), Isis::Process::ClearInputCubes(), Isis::PvlContainer::deleteKeyword(), Isis::ProcessByBrick::EndProcess(), Isis::PvlObject::findGroup(), Isis::PvlContainer::hasKeyword(), Isis::Cube::open(), Isis::Process::Progress(), Isis::Process::PropagateHistory(), Isis::Process::PropagateLabels(), Isis::Cube::putGroup(), Isis::ProcessByLine::SetInputCube(), Isis::ProcessByBrick::SetOutputCube(), Isis::Progress::SetText(), and Isis::ProcessByLine::StartProcess().
|
virtual |
Mosaic output method for Mosaic Processing Method, this will use an existing mosaic.
Reimplemented from Isis::Process.
Definition at line 812 of file ProcessMapMosaic.cpp.
References Isis::PvlObject::findGroup(), Isis::Cube::label(), and Isis::Cube::open().
|
virtualinherited |
Allocates a user specified output cube whose size is specified by the programmer.
parameter | User specified output file. For example, "TO" is a popular user parameter. If the user specified TO=output.cub, then this routine would allocate the file output.cub with size specified by the first opened input cube. The output pixel type will be propagated from the first loaded input cube or will use the value in the application XML file for pixelType. |
ns | Number of samples to allocate |
nl | Number of lines to allocate |
nb | Number of bands to allocate |
Isis::iException::Message |
Definition at line 302 of file Process.cpp.
References _FILEINFO_.
|
virtualinherited |
Allocates a output cube whose name and size is specified by the programmer.
fname | Name of the output cube to allocate |
att | The cube attributes to use when creating the output cube. |
ns | Number of samples to allocate |
nl | Number of lines to allocate |
nb | Number of bands to allocate |
Isis::iException::Message |
Definition at line 334 of file Process.cpp.
References _FILEINFO_, Isis::PvlObject::addGroup(), Isis::PvlObject::addObject(), Isis::AttachedLabel, Isis::CubeAttributeOutput::byteOrder(), Isis::Cube::create(), Isis::CubeAttributeOutput::fileFormat(), Isis::PvlObject::findObject(), Isis::PvlObject::group(), Isis::PvlObject::groups(), Isis::PvlContainer::isNamed(), Isis::Cube::label(), Isis::Cube::labelSize(), Isis::CubeAttributeOutput::maximum(), Isis::CubeAttributeOutput::minimum(), Isis::PvlContainer::name(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Cube::pixelType(), Isis::CubeAttributeOutput::pixelType(), Isis::CubeAttributeOutput::propagateMinimumMaximum(), Isis::CubeAttributeOutput::propagatePixelType(), Isis::Cube::setBaseMultiplier(), Isis::Cube::setByteOrder(), Isis::Cube::setDimensions(), Isis::Cube::setFormat(), Isis::Cube::setLabelsAttached(), Isis::Cube::setLabelSize(), Isis::Cube::setMinMax(), Isis::Cube::setPixelType(), and Isis::Cube::write().
|
virtual |
Mosaic Processing method, returns false if the cube is not inside the mosaic.
Definition at line 66 of file ProcessMapMosaic.cpp.
References _FILEINFO_, Isis::Projection::IsEquatorialCylindrical(), Isis::Cube::lineCount(), Isis::Cube::projection(), Isis::Cube::sampleCount(), Isis::Progress::SetText(), Isis::Projection::SetUniversalGround(), Isis::Projection::ToProjectionX(), Isis::Projection::ToProjectionY(), Isis::Projection::ToWorldX(), Isis::Projection::ToWorldY(), and Isis::Projection::WorldX().
|
inlinevirtualinherited |
In the base class, this method will invoked a user-specified function exactly one time.
In derived classes such as ProcessByLine, the StartProcess will invoke a user-specified function for every line in a cube.
funct() | Name of your processing function |
|
virtualinherited |
This method invokes the process by mosaic operation over a single input cube and single output cube.
Unlike other Isis process objects, no application . function will be called. The processing is handled entirely within the mosaic object. The input cube must be pixel aligned with the output cube before mosaiking. If the input cube does not overlay any of the output cube, no processing takes place. There are 3 priorities input, mosaic and band. Has the ability to track the origin of the mosaic if the flag is set. Some conditions apply like tracking turned off for multiband input with input or mosaic priority.
os | The sample position of input cube starting sample relative to the output cube. The cordinate is in output cube space and may be any integer value negative or positive. |
ol | The line position of input cube starting line relative to the output cube. The cordinate is in output cube space and may be any integer value negative or positive. |
ob | The band position of input cube starting band relative to the output cube. The cordinate is in output cube space and must be a legal band number within the output cube. |
IException::Message |
Definition at line 114 of file ProcessMosaic.cpp.
References _FILEINFO_, Isis::PvlObject::findObject(), Isis::IsHighPixel(), Isis::IsLowPixel(), Isis::IsNullPixel(), Isis::IsValidPixel(), Isis::Portal::SetPosition(), Isis::Buffer::size(), and Isis::toString().
|
staticinherited |
Convert a QString to an ImageOverlay (case-insensitive).
This is used to translate between mapmos, handmos, and automos' interfaces into an ImageOverlay.
Definition at line 994 of file ProcessMosaic.cpp.
References _FILEINFO_.
|
inherited |
Writes out the History blob to the cube.
Definition at line 687 of file Process.cpp.
References Isis::History::AddEntry(), Isis::PvlContainer::isNamed(), Isis::PvlObject::object(), Isis::PvlObject::objects(), and Isis::Cube::write().
Referenced by Isis::ImageImporter::import().
|
protectedinherited |
A vector of pointers to opened Cube objects.
The pointers are established in the SetInputCube/SetInputWorkCube methods.
Definition at line 193 of file Process.h.
Referenced by Isis::ProcessExport::CreateWorldFile(), Isis::ProcessExport::GetBuffersBIL(), Isis::ProcessExport::GetBuffersBIP(), Isis::ProcessExport::GetBuffersBSQ(), Isis::ProcessExport::InitProcess(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessByBrick::ProcessCubes(), Isis::ProcessExport::SetInputRange(), Isis::ProcessByQuickFilter::StartProcess(), and Isis::ProcessExport::StartProcess().
|
protectedinherited |
|
protectedinherited |
A vector of pointers to allocated Cube objects.
The pointers are established in the SetOutputCube method.
Definition at line 199 of file Process.h.
Referenced by Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessByBrick::ProcessCubes(), Isis::ProcessImport::ProcessJp2(), and Isis::ProcessByQuickFilter::StartProcess().
|
protectedinherited |
Holds the calculated statistics for each band separately of every input cubei after the CalculateStatistics method is called.
Definition at line 180 of file Process.h.
Referenced by Isis::Process::BandStatistics().
|
private |
Internal use; SetOutputMosaic (const QString &) sets to false to not attempt creation when using SetOutputMosaic.
Definition at line 161 of file ProcessMapMosaic.h.
|
protectedinherited |
Holds the calculated statistics for every band together of every input cubei after the CalculateStatistics method is called.
Definition at line 187 of file Process.h.
Referenced by Isis::Process::CubeStatistics().
|
protectedinherited |
Pointer to a Progress object.
Definition at line 153 of file Process.h.
Referenced by Isis::ProcessExport::InitProcess(), Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessExport::ProcessExport(), Isis::ProcessImport::ProcessImport(), Isis::ProcessImport::ProcessJp2(), Isis::Process::Progress(), Isis::ProcessByBrick::RunProcess(), Isis::ProcessByQuickFilter::StartProcess(), and Isis::ProcessExport::StartProcess().
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
staticinherited |
This is the name of the table in the Cube which will contain the image file names.
Definition at line 197 of file ProcessMosaic.h.