Isis Developer Reference
|
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. | |
virtual void | EndProcess () |
Cleans up by closing input, output and tracking cubes. | |
PvlObject | imagePositions () |
Accessor for the placed images and their locations. | |
virtual Isis::Cube * | SetInputCube (const QString ¶meter, const int ss, const int sl, const int sb, const int ns, const int nl, const int nb) |
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, int requirements=0) |
Set the InputCube vector to an opened Cube which was dynamically allocated. | |
Isis::Cube * | SetOutputCube (const QString &psParameter, UserInterface &ui) |
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 | 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 | Finalize () |
Cleans up by closing cubes and freeing memory for owned cubes. | |
virtual Isis::Cube * | SetOutputCubeStretch (const QString ¶meter, UserInterface *ui=nullptr) |
Allocates a user-specified output cube whose size matches the first input cube. | |
virtual Isis::Cube * | SetOutputCubeStretch (const QString ¶meter, const int nsamps, const int nlines, const int nbands=1, UserInterface *ui=nullptr) |
Allocates a user specified output cube whose size is specified by the programmer. | |
void | AddInputCube (Cube *cube, bool owned=true) |
void | AddOutputCube (Cube *cube, bool owned=true) |
void | CheckRequirements (const Cube *cube, const int requirements) |
Checks to make sure the input cube meets the inputted requirements. | |
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, const QList< QString > &tableNames=QList< QString >()) |
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. | |
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.
|
inherited |
Isis::ProcessMapMosaic::ProcessMapMosaic | ( | ) |
Constructs a Mosaic object.
|
virtual |
Destructor.
|
inherited |
References Isis::Process::InputCubes, and Isis::Process::m_ownedCubes.
Referenced by Isis::Process::SetInputCube(), and Isis::Process::SetInputCube().
|
inherited |
|
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 |
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.
References Isis::Cube::bandCount(), Isis::Progress::CheckStatus(), Isis::Buffer::DoubleBuffer(), Isis::Process::InputCubes, Isis::Cube::lineCount(), Isis::Process::p_bandStats, Isis::Process::p_cubeStats, Isis::Cube::read(), Isis::LineManager::SetLine(), Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), Isis::Buffer::size(), and Isis::toString().
|
inherited |
Checks to make sure the input cube meets the inputted requirements.
cube | Cube to check |
requirements | Use to specify requirements for the input file. The following 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 |
References _FILEINFO_, Isis::AllMatchOrOne, Isis::Cube::bandCount(), Isis::BandMatchOrOne, Isis::Cube::fileName(), Isis::Process::InputCubes, Isis::Cube::lineCount(), Isis::OneBand, Isis::Cube::sampleCount(), Isis::SizeMatch, Isis::SpatialMatch, and Isis::IException::User.
Referenced by Isis::Process::SetInputCube(), and Isis::Process::SetInputCube().
|
inherited |
Close owned cubes from the list and clear the list.
References Isis::Process::ClearInputCubes(), Isis::Process::ClearOutputCubes(), and Isis::Process::m_ownedCubes.
Referenced by Isis::Process::Finalize().
|
inherited |
Close owned input cubes from the list and clear the list.
References Isis::Process::InputCubes, and Isis::Process::m_ownedCubes.
Referenced by Isis::Process::ClearCubes(), Isis::ProcessGroundPolygons::SetStatCubes(), and StartProcess().
|
inherited |
Close owned output cubes from the list and clear the list.
References Isis::Process::m_ownedCubes, and Isis::Process::OutputCubes.
Referenced by Isis::Process::ClearCubes().
|
inlineinherited |
Get the Statistics object for all bands of a specified input cube.
index | The index of the input cube in InputCubes |
References Isis::Process::p_cubeStats.
|
virtualinherited |
Cleans up by closing input, output and tracking cubes.
Reimplemented from Isis::Process.
References Isis::Cube::close(), and Isis::Process::EndProcess().
|
virtualinherited |
Cleans up by closing cubes and freeing memory for owned cubes.
Clears the lists for all cubes.
Reimplemented in Isis::ProcessByBoxcar, Isis::ProcessByBrick, Isis::ProcessByTile, Isis::ProcessGroundPolygons, Isis::ProcessImportPds, and Isis::ProcessPolygons.
References Isis::Process::ClearCubes().
Referenced by Isis::Process::EndProcess(), Isis::ProcessByBoxcar::Finalize(), Isis::ProcessImportPds::Finalize(), and Isis::ProcessPolygons::Finalize().
|
inherited |
|
inherited |
Referenced by RingsSetOutputCube(), RingsSetOutputCube(), SetOutputCube(), and SetOutputCube().
|
inherited |
This is the band where the image was placed into the output mosaic.
|
inherited |
This is the line where the image was placed into the output mosaic.
|
inherited |
This is the sample where the image was placed into the output mosaic.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Accessor for the placed images and their locations.
|
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. |
References _FILEINFO_, Isis::FileName::expanded(), Isis::FileName::fileExists(), Isis::FileName::highestVersion(), Isis::IException::Io, Isis::FileName::original(), and Isis::Preference::Preferences().
|
staticinherited |
Convert an ImageOverlay to a QString.
This is used to translate between mapmos, handmos, and automos' interfaces into an ImageOverlay.
References _FILEINFO_, Isis::ProcessMosaic::AverageImageWithMosaic, Isis::ProcessMosaic::NumImageOverlayOptions, Isis::ProcessMosaic::PlaceImagesBeneath, Isis::ProcessMosaic::PlaceImagesOnTop, Isis::toString(), Isis::IException::Unknown, and Isis::ProcessMosaic::UseBandPlacementCriteria.
Referenced by Isis::ProcessMosaic::StringToOverlay().
|
inlineinherited |
This method returns a pointer to a Progress object.
References Isis::Process::p_progress.
Referenced by Isis::Equalization::applyCorrection(), Isis::HiEqualization::calculateStatistics(), and StartProcess().
|
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. |
References Isis::Process::p_propagateHistory.
|
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. |
References Isis::Process::p_propagateLabels.
|
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. |
References Isis::PvlObject::findObject(), and Isis::Process::OutputCubes.
|
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. |
References Isis::Process::p_propagateOriginalLabel.
|
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. |
References Isis::Process::p_propagatePolygons.
|
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. |
References Isis::Process::p_propagateTables.
|
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. The names of the tables to propagate can be provided through the second paramter, by specifing a list of table names. Not providing any list (or providing an empty list) will propagate all tables.
fromName | QString of the name of the cube containing the tables to propagate. |
tableNames | List of QStrings of the names of the tables to propagate; default is empty, which indicates that all tables will be propagated. |
References Isis::Cube::close(), Isis::Cube::label(), Isis::PvlObject::object(), Isis::Cube::open(), Isis::Process::OutputCubes, and Isis::Cube::read().
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 |
References Isis::PvlObject::addGroup(), Isis::Process::AddOutputCube(), Isis::ProcessMosaic::AverageImageWithMosaic, Isis::ProcessMosaic::GetImageOverlay(), Isis::Cube::putGroup(), Isis::PvlContainer::Replace, Isis::ProjectionFactory::RingsCreateFromCube(), Isis::ProcessByLine::SetInputCube(), Isis::toString(), and Isis::PvlObject::Traverse.
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.
References _FILEINFO_, Isis::PvlObject::addGroup(), Isis::Process::AddOutputCube(), Isis::ProcessMosaic::AverageImageWithMosaic, Isis::ProcessMosaic::GetImageOverlay(), Isis::Process::OutputCubes, Isis::IException::Programmer, Isis::Cube::putGroup(), Isis::ProjectionFactory::RingsCreateForCube(), and Isis::PvlObject::Traverse.
Cube * Isis::ProcessMapMosaic::RingsSetOutputCube | ( | const QString & | mosaicFile | ) |
Mosaic output method for Mosaic Processing Method, this will use an existing mosaic.
References Isis::Cube::open(), RingsSetOutputCube(), and Isis::PvlObject::Traverse.
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.
References _FILEINFO_, Isis::Cube::bandCount(), Isis::Cube::close(), Isis::ProjectionFactory::CreateFromCube(), Isis::Cube::label(), Isis::Cube::lineCount(), Isis::Cube::open(), Isis::IException::Programmer, RingsSetOutputCube(), Isis::Cube::sampleCount(), Isis::toString(), and Isis::IException::User.
Referenced by RingsSetOutputCube(), RingsSetOutputCube(), and RingsSetOutputCube().
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 |
References _FILEINFO_, Isis::Cube::bandCount(), Isis::PvlObject::findGroup(), Isis::Cube::label(), Isis::Cube::open(), Isis::IException::Programmer, Isis::Pvl::read(), Isis::PvlContainer::Replace, Isis::ProjectionFactory::RingsCreateForCube(), Isis::ProjectionFactory::RingsCreateFromCube(), RingsSetOutputCube(), Isis::toString(), Isis::PvlObject::Traverse, and Isis::IException::User.
|
inherited |
Referenced by Isis::ProcessMosaic::ProcessMosaic().
|
inherited |
Set the keyword/value to use for comparing when using band priority.
|
inherited |
Set the band to use for priorities when using band priority.
|
inherited |
Set whether to take the image with the max or min value when using band priority.
|
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 |
Referenced by StartProcess().
|
inherited |
When true, high saturation (HRS, HIS) will be considered valid data for the purposes of placing pixels in the output mosaic.
|
inherited |
|
virtual |
Input cube cannot be set here.
References _FILEINFO_, and Isis::IException::Programmer.
|
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 | Requirements to check that the input cube meets. See CheckRequirements(). |
Isis::iException::Message |
Reimplemented from Isis::Process.
|
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 |
References _FILEINFO_, Isis::Process::InputCubes, Isis::IException::Programmer, Isis::Process::SetInputCube(), Isis::toInt(), and Isis::PvlObject::Traverse.
|
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 | Requirements to check that the input cube meets. See CheckRequirements(). |
Isis::iException::Message |
Reimplemented from Isis::Process.
|
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 |
References _FILEINFO_, Isis::Process::InputCubes, Isis::IException::Programmer, Isis::Process::SetInputCube(), Isis::toInt(), and Isis::PvlObject::Traverse.
Referenced by StartProcess().
|
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 |
requirements | Requirements to check that the input cube meets. See CheckRequirements(). |
Reimplemented from Isis::Process.
|
inherited |
When true, low saturation (LRS, LIS) will be considered valid data for the purposes of placing pixels in the output mosaic.
|
inherited |
Set the DEM match flag.
matchDEM | If true, the match is enforced between Input & Mosaic |
|
inherited |
When true, Null pixels will be considered valid data for the purposes of placing pixels in the output mosaic.
|
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 |
References _FILEINFO_, Isis::PvlObject::addObject(), Isis::Process::AddOutputCube(), Isis::AttachedLabel, Isis::Cube::create(), Isis::PvlObject::findObject(), Isis::Process::InputCubes, Isis::Cube::label(), Isis::Cube::labelSize(), Isis::Process::p_propagateLabels, Isis::Process::p_propagateOriginalLabel, Isis::Process::p_propagatePolygons, Isis::Process::p_propagateTables, Isis::Cube::pixelType(), Isis::IException::Programmer, Isis::Real, Isis::Cube::setBaseMultiplier(), Isis::Cube::setByteOrder(), Isis::Cube::setDimensions(), Isis::Cube::setFormat(), Isis::Cube::setLabelsAttached(), Isis::Cube::setLabelSize(), Isis::Cube::setMinMax(), Isis::Cube::setPixelType(), Isis::SignedInteger, Isis::SignedWord, Isis::UnsignedByte, Isis::UnsignedInteger, Isis::UnsignedWord, Isis::IException::User, Isis::Cube::write(), and Isis::Process::WriteHistory().
|
virtual |
Set the output cube to specified file name and specified input images and output attributes and lat,lons.
References Isis::PvlObject::addGroup(), Isis::PvlContainer::addKeyword(), Isis::Process::AddOutputCube(), Isis::ProcessMosaic::AverageImageWithMosaic, Isis::ProjectionFactory::CreateFromCube(), Isis::ProcessMosaic::GetImageOverlay(), Isis::Displacement::Meters, Isis::Cube::putGroup(), Isis::PvlContainer::Replace, Isis::ProcessByLine::SetInputCube(), Isis::toString(), and Isis::PvlObject::Traverse.
|
virtual |
Set the output cube to specified file name and specified input images and output attributes and lat,lons.
References _FILEINFO_, Isis::PvlObject::addGroup(), Isis::Process::AddOutputCube(), Isis::ProcessMosaic::AverageImageWithMosaic, Isis::ProjectionFactory::CreateForCube(), Isis::ProcessMosaic::GetImageOverlay(), Isis::Process::OutputCubes, Isis::IException::Programmer, Isis::Cube::putGroup(), and Isis::PvlObject::Traverse.
|
virtual |
Mosaic output method for Mosaic Processing Method, this will use an existing mosaic.
Reimplemented from Isis::Process.
References Isis::Cube::open(), SetOutputCube(), and Isis::PvlObject::Traverse.
|
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 |
References _FILEINFO_, Isis::Application::GetUserInterface(), Isis::IException::Programmer, and Isis::Process::SetOutputCube().
|
inherited |
|
virtual |
Set the output cube to specified file name and specified input images and output attributes.
References _FILEINFO_, Isis::Cube::bandCount(), Isis::Cube::close(), Isis::ProjectionFactory::CreateFromCube(), Isis::Cube::label(), Isis::Cube::lineCount(), Isis::Cube::open(), Isis::IException::Programmer, Isis::Cube::sampleCount(), SetOutputCube(), Isis::toString(), and Isis::IException::User.
Referenced by SetOutputCube(), SetOutputCube(), and SetOutputCube().
|
virtual |
Set the output cube to specified file name and specified input images and output attributes and lat,lons.
References _FILEINFO_, Isis::Cube::bandCount(), Isis::ProjectionFactory::CreateForCube(), Isis::ProjectionFactory::CreateFromCube(), Isis::PvlObject::findGroup(), Isis::Cube::label(), Isis::Cube::open(), Isis::IException::Programmer, Isis::Pvl::read(), Isis::PvlContainer::Replace, SetOutputCube(), Isis::toString(), Isis::PvlObject::Traverse, and Isis::IException::User.
|
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 |
ui | A user interface used to get the attributes needed. If null, the user interface will be obtained from the application. |
Isis::iException::Message |
References _FILEINFO_, Isis::Application::GetUserInterface(), Isis::IException::Programmer, and Isis::Process::SetOutputCube().
|
virtualinherited |
Allocates a user-specified output cube whose size matches the first input cube.
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. |
ui | A user interface used to get the attributes needed for SetOutputCube. |
Isis::iException::Message |
References _FILEINFO_, Isis::Process::InputCubes, Isis::IException::Programmer, and Isis::Process::SetOutputCubeStretch().
Referenced by Isis::Process::SetOutputCubeStretch().
|
inherited |
|
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 |
References _FILEINFO_, Isis::ProcessMosaic::AverageImageWithMosaic, Isis::Progress::CheckStatus(), Isis::Cube::close(), Isis::SerialNumber::Compose(), Isis::Cube::create(), Isis::Cube::deleteBlob(), Isis::FileName::expanded(), Isis::Cube::fileName(), Isis::Process::InputCubes, Isis::IsHighPixel(), Isis::IsLowPixel(), Isis::IsNullPixel(), Isis::IsValidPixel(), Isis::Cube::label(), Isis::Cube::open(), Isis::Process::OutputCubes, Isis::Process::p_progress, Isis::FileName::path(), Isis::ProcessMosaic::PlaceImagesBeneath, Isis::ProcessMosaic::PlaceImagesOnTop, Isis::IException::Programmer, Isis::Cube::read(), Isis::FileName::removeExtension(), Isis::Cube::setDimensions(), Isis::Progress::SetMaximumSteps(), Isis::Cube::setPixelType(), Isis::toString(), Isis::ProcessMosaic::TRACKING_TABLE_NAME, Isis::trackingTableName, Isis::PvlObject::Traverse, Isis::IException::Unknown, Isis::UnsignedInteger, Isis::ProcessMosaic::UseBandPlacementCriteria, Isis::IException::User, Isis::VALID_MINUI4, and Isis::Cube::write().
Referenced by StartProcess().
|
virtual |
Mosaic Processing method, returns false if the cube is not inside the mosaic.
References _FILEINFO_, Isis::Cube::addCachingAlgorithm(), Isis::Process::ClearInputCubes(), Isis::Process::InputCubes, Isis::FileName::name(), Isis::Process::OutputCubes, Isis::Process::p_propagateHistory, Isis::IException::Programmer, Isis::Process::Progress(), Isis::Cube::projection(), Isis::ProcessMosaic::SetCreateFlag(), Isis::ProcessMosaic::SetInputCube(), Isis::Progress::SetText(), Isis::ProcessMosaic::StartProcess(), Isis::IException::User, and Isis::Process::WriteHistory().
|
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 |
|
staticinherited |
Convert a QString to an ImageOverlay (case-insensitive).
This is used to translate between mapmos, handmos, and automos' interfaces into an ImageOverlay.
References _FILEINFO_, Isis::ProcessMosaic::NumImageOverlayOptions, Isis::ProcessMosaic::OverlayToString(), and Isis::IException::Unknown.
|
inherited |
Writes out the History blob to the cube.
References Isis::History::AddEntry(), Isis::iApp, Isis::Process::InputCubes, Isis::PvlObject::object(), Isis::Process::p_propagateHistory, Isis::Cube::readHistory(), and Isis::Cube::write().
Referenced by Isis::Process::SetOutputCube(), and StartProcess().
|
staticinherited |
|
staticinherited |
|
protectedinherited |
A vector of pointers to opened Cube objects.
The pointers are established in the SetInputCube/SetInputWorkCube methods.
Referenced by Isis::Process::AddInputCube(), Isis::Process::CalculateStatistics(), Isis::Process::CheckRequirements(), Isis::Process::ClearInputCubes(), Isis::ProcessExportPds4::CreateImageLabel(), Isis::ProcessExport::CreateWorldFile(), Isis::ProcessExportPds4::displaySettings(), Isis::ProcessExportPds::ExportTable(), Isis::ProcessExportPds4::fileAreaObservational(), Isis::ProcessExportPds::FixedJP2ImageRoot(), Isis::ProcessExport::GetBuffersBIL(), Isis::ProcessExport::GetBuffersBIP(), Isis::ProcessExport::GetBuffersBSQ(), Isis::ProcessExportPds4::identificationArea(), Isis::ProcessExportPds::LineBytes(), Isis::ProcessExportPds::OutputLabel(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessExport::ProcessCubes(), Isis::ProcessByBrick::ProcessCubes(), Isis::ProcessRubberSheet::processPatchTransform(), Isis::ProcessByLine::SetBricks(), Isis::ProcessByBrick::SetInputBrickSize(), Isis::ProcessByBrick::SetInputBrickSize(), Isis::ProcessMosaic::SetInputCube(), Isis::ProcessMosaic::SetInputCube(), Isis::ProcessExport::SetInputRange(), Isis::ProcessExport::SetInputRange(), Isis::ProcessExport::SetInputRange(), Isis::ProcessByBrick::SetOutputCube(), Isis::Process::SetOutputCube(), Isis::Process::SetOutputCube(), Isis::Process::SetOutputCubeStretch(), Isis::ProcessGroundPolygons::SetStatCubes(), Isis::ProcessExportPds4::StandardAllMapping(), Isis::ProcessExportPds::StandardAllMapping(), Isis::ProcessExportPds4::standardBandBin(), Isis::ProcessExportPds::StandardImageImage(), Isis::ProcessExportPds4::standardInstrument(), Isis::ProcessExportPds::StandardJP2Image(), Isis::ProcessMosaic::StartProcess(), StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessExport::StartProcess(), Isis::ProcessRubberSheet::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessExport::StartProcess(), Isis::ProcessByBoxcar::StartProcess(), Isis::ProcessByQuickFilter::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessExportPds::StreamJP2ImageRoot(), Isis::ProcessByBrick::VerifyCubes(), and Isis::Process::WriteHistory().
|
protectedinherited |
A list of cubes owned by this instant.
These cubes will be deleted on finalization. Process will not take ownership of cubes allocated outside of Process. It is the caller's responsibility to delete such cubes.
Referenced by Isis::Process::AddInputCube(), Isis::Process::AddOutputCube(), Isis::Process::ClearCubes(), Isis::Process::ClearInputCubes(), Isis::Process::ClearOutputCubes(), Isis::Process::Process(), and Isis::Process::~Process().
|
protectedinherited |
A vector of pointers to allocated Cube objects.
The pointers are established in the SetOutputCube method.
Referenced by Isis::Process::AddOutputCube(), Isis::Process::ClearOutputCubes(), Isis::ProcessImportPds::Finalize(), Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessByBrick::ProcessCubes(), Isis::ProcessImport::ProcessJp2(), Isis::ProcessRubberSheet::processPatchTransform(), Isis::Process::PropagateLabels(), Isis::Process::PropagateTables(), RingsSetOutputCube(), Isis::ProcessByLine::SetBricks(), Isis::ProcessByBrick::SetOutputBrickSize(), Isis::ProcessByBrick::SetOutputBrickSize(), SetOutputCube(), Isis::ProcessMosaic::SetOutputCube(), Isis::ProcessPolygons::SetStatCubes(), Isis::ProcessGroundPolygons::SetStatCubes(), Isis::ProcessGroundPolygons::SetStatCubes(), Isis::ProcessImportPds::StartProcess(), Isis::ProcessMosaic::StartProcess(), StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessRubberSheet::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessByBoxcar::StartProcess(), Isis::ProcessByQuickFilter::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessImportPds::TranslatePdsProjection(), and Isis::ProcessByBrick::VerifyCubes().
|
protectedinherited |
Holds the calculated statistics for each band separately of every input cubei after the CalculateStatistics method is called.
Referenced by Isis::Process::BandStatistics(), and Isis::Process::CalculateStatistics().
|
protectedinherited |
Holds the calculated statistics for every band together of every input cubei after the CalculateStatistics method is called.
Referenced by Isis::Process::CalculateStatistics(), and Isis::Process::CubeStatistics().
|
protectedinherited |
Pointer to a Progress object.
Referenced by Isis::Process::Process(), Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessExport::ProcessCubes(), Isis::ProcessExport::ProcessExport(), Isis::ProcessImport::ProcessImport(), Isis::ProcessImport::ProcessJp2(), Isis::ProcessRubberSheet::processPatchTransform(), Isis::Process::Progress(), Isis::ProcessMosaic::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessExport::StartProcess(), Isis::ProcessRubberSheet::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessExport::StartProcess(), Isis::ProcessByBoxcar::StartProcess(), Isis::ProcessByQuickFilter::StartProcess(), Isis::ProcessByBrick::StartProcess(), and Isis::Process::~Process().
|
protectedinherited |
Flag indicating if history is to be propagated to output cubes.
Referenced by Isis::Process::Process(), Isis::Process::PropagateHistory(), StartProcess(), and Isis::Process::WriteHistory().
|
protectedinherited |
Flag indicating if labels are be propagated to output cubes.
Referenced by Isis::Process::Process(), Isis::Process::PropagateLabels(), and Isis::Process::SetOutputCube().
|
protectedinherited |
Flag indicating if original lable is to be propagated to output cubes.
Referenced by Isis::Process::Process(), Isis::Process::PropagateOriginalLabel(), and Isis::Process::SetOutputCube().
|
protectedinherited |
Flag indicating if blobs are be propagated to output cubes.
Referenced by Isis::Process::Process(), Isis::Process::PropagatePolygons(), and Isis::Process::SetOutputCube().
|
protectedinherited |
Flag indicating if tables are be propagated to output cubes.
Referenced by Isis::Process::Process(), Isis::Process::PropagateTables(), and Isis::Process::SetOutputCube().
|
staticinherited |
This is the name of the table in the Cube which will contain the image file names.
Referenced by Isis::ProcessMosaic::StartProcess().