Isis 3 Programmer Reference
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
Isis::ProcessMapMosaic Class Reference
High Level Cube I/O

Mosaic two cubs together. More...

#include <ProcessMapMosaic.h>

Inheritance diagram for Isis::ProcessMapMosaic:
Inheritance graph
Collaboration diagram for Isis::ProcessMapMosaic:
Collaboration graph

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 &parameter, 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 &parameter, 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 &parameter, 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 &parameter, UserInterface *ui=nullptr)
 Allocates a user-specified output cube whose size matches the first input cube.
 
virtual Isis::Cube * SetOutputCubeStretch (const QString &parameter, 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.
 

Private Member Functions

void BandComparison (int iss, int isl, int ins, int inl, int bandPriorityInputBandNumber, int bandPriorityOutputBandNumber, int index)
 This method compares the specified band of the input and output using the criteria (lesser or greater) to assign the pixel origin(input fileindex) to the origin band.
 
void BandPriorityWithNoTracking (int iss, int isl, int isb, int ins, int inl, int inb, int bandPriorityInputBandNumber, int bandPriorityOutputBandNumber)
 Mosaicking for Band Priority with no Tracking.
 
int GetOriginDefaultByPixelType ()
 This method returns the defaults(unassigned origin value) depending on the pixel type.
 
int GetBandIndex (bool inputFile)
 Get the Band Index in an image of type (input/output)
 
bool GetTrackStatus ()
 This method searchs the mosaic label for a table with name "InputFile".
 
void AddBandBinGroup (int origIsb)
 This method adds the BandBin group to the mosaic corresponding to the actual bands in the mosaic.
 
void AddDefaultBandBinGroup ()
 AddDefaultBandBinGroup.
 
void MatchBandBinGroup (int origIsb, int &inb)
 This method matches the input BandBin group to the mosaic BandBin Group and allows band to be replaced in mosaic if it is NA (not assigned).
 
bool ProcessAveragePriority (int piPixel, Portal &pInPortal, Portal &pOutPortal, Portal &pOrigPortal)
 Calculate DN value for a pixel for AverageImageWithMosaic priority and set the Count band portal.
 
void ResetCountBands ()
 Reset all the count bands to default at the time of mosaic creation.
 
void MatchDEMShapeModel ()
 Match the Shape Model for input and mosaic.
 

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.
 
bool m_trackingEnabled
 
Cube * m_trackingCube
 Output tracking cube. NULL unless tracking is enabled.
 
bool m_createOutputMosaic
 
int m_bandPriorityBandNumber
 
QString m_bandPriorityKeyName
 
QString m_bandPriorityKeyValue
 
bool m_bandPriorityUseMaxValue
 
int m_iss
 The starting sample within the input cube.
 
int m_isl
 The starting line within the input cube.
 
int m_isb
 The starting band within the input cube.
 
int m_ins
 The number of samples from the input cube.
 
int m_inl
 The number of lines from the input cube.
 
int m_inb
 The number of bands from the input cube.
 
int m_oss
 The starting sample within the output cube.
 
int m_osl
 The starting line within the output cube.
 
int m_osb
 The starting band within the output cube.
 
int m_onb
 The number of bands in the output cube.
 
bool m_enforceBandBinMatch
 True/False value to determine whether to enforce the input cube bandbin matches the mosaic bandbin group.
 
bool m_enforceMatchDEM
 DEM of the input and mosaic should match.
 
ImageOverlay m_imageOverlay
 
PvlObject m_imagePositions
 List of images placed on the mosaic.
 
bool m_placeHighSatPixels
 
bool m_placeLowSatPixels
 
bool m_placeNullPixels
 

Detailed Description

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.

Author
2003-04-28 Stuart Sides
History

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.

Todo
2005-02-11 Stuart Sides - add coded example and implementation example to class documentation
History

2016-08-28 Kelvin Rodriguez - Changed SetOutputCube default parameters to avoid hidden virtual function warnings in clang and the abiguous called errors. Part of porting to OS X 10.11.

2018-08-13 Summer Stapleton - Removed code that added tracking band to mosaic cube as tracking is now being stored in a separate tracking cube. This was part of a larger refactoring project to turn the tracking band of a mosaic cube into its own tracking cube containing the InputImages table to relate DN values to input images. Mosaic cube no longer holds tracking band or InputImages table, but instead has a Tracking group that points to external tracking cube.

Definition at line 97 of file ProcessMapMosaic.h.

Member Enumeration Documentation

◆ ImageOverlay

enum Isis::ProcessMosaic::ImageOverlay
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.

Constructor & Destructor Documentation

◆ ProcessMapMosaic()

Isis::ProcessMapMosaic::ProcessMapMosaic ( )

Constructs a Mosaic object.

Definition at line 30 of file ProcessMapMosaic.cpp.

References p_createMosaic.

◆ ~ProcessMapMosaic()

Isis::ProcessMapMosaic::~ProcessMapMosaic ( )
virtual

Destructor.

Definition at line 36 of file ProcessMapMosaic.cpp.

Member Function Documentation

◆ AddBandBinGroup()

void Isis::ProcessMosaic::AddBandBinGroup ( int origIsb)
privateinherited

This method adds the BandBin group to the mosaic corresponding to the actual bands in the mosaic.

returns None

Author
Sharmila Prasad (9/24/2009)
History
2011-01-12 Sharmila Prasad Added logic for Count Bands for AverageImageWithMosaic Priority

Definition at line 1154 of file ProcessMosaic.cpp.

References Isis::ProcessMosaic::AverageImageWithMosaic, Isis::Process::InputCubes, Isis::ProcessMosaic::m_osb, Isis::Process::OutputCubes, Isis::PvlKeyword::size(), and Isis::PvlObject::Traverse.

Referenced by Isis::ProcessMosaic::StartProcess().

◆ AddDefaultBandBinGroup()

void Isis::ProcessMosaic::AddDefaultBandBinGroup ( )
privateinherited

AddDefaultBandBinGroup.

This method adds a default BandBin group on Mosaic creation if the MatchBandBin Group is set to false and Tracking to set to true

Return void

Definition at line 1239 of file ProcessMosaic.cpp.

References Isis::ProcessMosaic::AverageImageWithMosaic, and Isis::Process::OutputCubes.

Referenced by Isis::ProcessMosaic::StartProcess().

◆ AddInputCube()

void Isis::Process::AddInputCube ( Cube * cube,
bool owned = true )
inherited

Definition at line 476 of file Process.cpp.

◆ AddOutputCube()

void Isis::Process::AddOutputCube ( Cube * cube,
bool owned = true )
inherited

Definition at line 482 of file Process.cpp.

◆ BandComparison()

void Isis::ProcessMosaic::BandComparison ( int iss,
int isl,
int ins,
int inl,
int bandPriorityInputBandNumber,
int bandPriorityOutputBandNumber,
int index )
privateinherited

This method compares the specified band of the input and output using the criteria (lesser or greater) to assign the pixel origin(input fileindex) to the origin band.

In the StartProcess(), input pixel is assigned to the output if the origin pixel equals the current input file index

Parameters
iss- Comparison start sample
isl- Comparison start line
ins- The number of samples to compare
inl- The number of lines to compare
bandPriorityInputBandNumber- The band in the input cube to use for comparison
bandPriorityOutputBandNumber- The band in the output cube to use for comparison
index- Tracking index for the input cube
Author
Sharmila Prasad (9/04/2009)

Definition at line 1342 of file ProcessMosaic.cpp.

References Isis::Process::InputCubes, Isis::IsHighPixel(), Isis::IsLowPixel(), Isis::IsNullPixel(), Isis::IsSpecial(), Isis::IsValidPixel(), Isis::ProcessMosaic::m_osl, Isis::ProcessMosaic::m_oss, Isis::ProcessMosaic::m_trackingCube, Isis::Process::OutputCubes, Isis::Cube::read(), and Isis::Cube::write().

Referenced by Isis::ProcessMosaic::StartProcess().

◆ BandPriorityWithNoTracking()

void Isis::ProcessMosaic::BandPriorityWithNoTracking ( int iss,
int isl,
int isb,
int ins,
int inl,
int inb,
int bandPriorityInputBandNumber,
int bandPriorityOutputBandNumber )
privateinherited

Mosaicking for Band Priority with no Tracking.

Author
Sharmila Prasad (1/4/2012)

Definition at line 1388 of file ProcessMosaic.cpp.

References Isis::Process::InputCubes, Isis::IsHighPixel(), Isis::IsLowPixel(), Isis::IsNullPixel(), Isis::IsValidPixel(), Isis::ProcessMosaic::m_onb, Isis::ProcessMosaic::m_osb, Isis::ProcessMosaic::m_osl, Isis::ProcessMosaic::m_oss, and Isis::Process::OutputCubes.

Referenced by Isis::ProcessMosaic::StartProcess().

◆ BandStatistics()

std::vector< Isis::Statistics * > Isis::Process::BandStatistics ( const unsigned index)
inlineinherited

Get the vector of Statistics objects for each band separately of a specified input cube.

Parameters
indexThe index of the input cube in InputCubes
Returns
vector<Statistics*> A list of statistics ordered by band

Definition at line 279 of file Process.h.

References Isis::Process::p_bandStats.

◆ CalculateStatistics()

void Isis::Process::CalculateStatistics ( )
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 858 of file Process.cpp.

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().

◆ CheckRequirements()

void Isis::Process::CheckRequirements ( const Cube * cube,
const int requirements )
inherited

Checks to make sure the input cube meets the inputted requirements.

Parameters
cubeCube to check
requirementsUse 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
Exceptions
Isis::iException::Message

Definition at line 513 of file Process.cpp.

References Isis::Cube::bandCount(), Isis::Cube::fileName(), Isis::Process::InputCubes, Isis::Cube::lineCount(), Isis::Cube::sampleCount(), and Isis::IException::User.

Referenced by Isis::Process::SetInputCube(), and Isis::Process::SetInputCube().

◆ ClearCubes()

void Isis::Process::ClearCubes ( )
inherited

Close owned cubes from the list and clear the list.

Definition at line 603 of file Process.cpp.

References Isis::Process::ClearInputCubes(), Isis::Process::ClearOutputCubes(), and Isis::Process::m_ownedCubes.

Referenced by Isis::Process::Finalize().

◆ ClearInputCubes()

void Isis::Process::ClearInputCubes ( )
inherited

Close owned input cubes from the list and clear the list.

Definition at line 614 of file Process.cpp.

References Isis::Process::InputCubes, and Isis::Process::m_ownedCubes.

Referenced by Isis::Process::ClearCubes(), Isis::ProcessGroundPolygons::SetStatCubes(), and StartProcess().

◆ ClearOutputCubes()

void Isis::Process::ClearOutputCubes ( )
inherited

Close owned output cubes from the list and clear the list.

Definition at line 629 of file Process.cpp.

References Isis::Process::m_ownedCubes, and Isis::Process::OutputCubes.

Referenced by Isis::Process::ClearCubes().

◆ CubeStatistics()

Isis::Statistics * Isis::Process::CubeStatistics ( const unsigned index)
inlineinherited

Get the Statistics object for all bands of a specified input cube.

Parameters
indexThe index of the input cube in InputCubes
Returns
Statistics* Collections of statistics gathered on all bands

Definition at line 293 of file Process.h.

References Isis::Process::p_cubeStats.

◆ EndProcess()

void Isis::ProcessMosaic::EndProcess ( )
virtualinherited

Cleans up by closing input, output and tracking cubes.

Reimplemented from Isis::Process.

Definition at line 523 of file ProcessMosaic.cpp.

References Isis::Cube::close(), Isis::Process::EndProcess(), and Isis::ProcessMosaic::m_trackingCube.

◆ FillNull()

void Isis::ProcessMapMosaic::FillNull ( Buffer & data)
staticprivate

Reset the buffer with NULL pixels.

Definition at line 827 of file ProcessMapMosaic.cpp.

References Isis::Null, and Isis::Buffer::size().

Referenced by RingsSetOutputCube(), RingsSetOutputCube(), SetOutputCube(), and SetOutputCube().

◆ Finalize()

void Isis::Process::Finalize ( )
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.

Definition at line 471 of file Process.cpp.

References Isis::Process::ClearCubes().

Referenced by Isis::Process::EndProcess(), Isis::ProcessByBoxcar::Finalize(), Isis::ProcessImportPds::Finalize(), and Isis::ProcessPolygons::Finalize().

◆ GetBandIndex()

int Isis::ProcessMosaic::GetBandIndex ( bool inputFile)
privateinherited

Get the Band Index in an image of type (input/output)

Definition at line 1279 of file ProcessMosaic.cpp.

References Isis::Process::InputCubes, Isis::Process::OutputCubes, Isis::PvlKeyword::size(), Isis::PvlObject::Traverse, and Isis::IException::User.

Referenced by Isis::ProcessMosaic::StartProcess().

◆ GetHighSaturationFlag()

bool Isis::ProcessMosaic::GetHighSaturationFlag ( ) const
inherited
See also
SetHighSaturationFlag()

Definition at line 831 of file ProcessMosaic.cpp.

◆ GetImageOverlay()

ProcessMosaic::ImageOverlay Isis::ProcessMosaic::GetImageOverlay ( ) const
inherited

Definition at line 839 of file ProcessMosaic.cpp.

◆ GetInputStartBandInMosaic()

int Isis::ProcessMosaic::GetInputStartBandInMosaic ( ) const
inherited

This is the band where the image was placed into the output mosaic.

Definition at line 887 of file ProcessMosaic.cpp.

References Isis::ProcessMosaic::m_osb.

◆ GetInputStartLineInMosaic()

int Isis::ProcessMosaic::GetInputStartLineInMosaic ( ) const
inherited

This is the line where the image was placed into the output mosaic.

Definition at line 871 of file ProcessMosaic.cpp.

References Isis::ProcessMosaic::m_osl.

◆ GetInputStartSampleInMosaic()

int Isis::ProcessMosaic::GetInputStartSampleInMosaic ( ) const
inherited

This is the sample where the image was placed into the output mosaic.

Definition at line 879 of file ProcessMosaic.cpp.

References Isis::ProcessMosaic::m_oss.

◆ GetLowSaturationFlag()

bool Isis::ProcessMosaic::GetLowSaturationFlag ( ) const
inherited
See also
SetLowSaturationFlag()

Definition at line 847 of file ProcessMosaic.cpp.

◆ GetNullFlag()

bool Isis::ProcessMosaic::GetNullFlag ( ) const
inherited
See also
SetNullFlag()

Definition at line 855 of file ProcessMosaic.cpp.

◆ GetOriginDefaultByPixelType()

int Isis::ProcessMosaic::GetOriginDefaultByPixelType ( )
privateinherited

This method returns the defaults(unassigned origin value) depending on the pixel type.

@No parameters

Returns
default value
Exceptions
IException::Message
Author
Sharmila Prasad (9/10/2009)

Definition at line 1480 of file ProcessMosaic.cpp.

References Isis::Process::OutputCubes, Isis::IException::Programmer, and Isis::SizeOf().

◆ GetTrackFlag()

bool Isis::ProcessMosaic::GetTrackFlag ( ) const
inherited
See also
SetTrackFlag()

Definition at line 863 of file ProcessMosaic.cpp.

◆ GetTrackStatus()

bool Isis::ProcessMosaic::GetTrackStatus ( )
privateinherited

This method searchs the mosaic label for a table with name "InputFile".

If found return true else false. Checks for the existence of the origin table

Returns
the table index of the current image
Author
Sharmila Prasad (9/22/2009)

Definition at line 1514 of file ProcessMosaic.cpp.

References Isis::Process::OutputCubes.

Referenced by Isis::ProcessMosaic::StartProcess().

◆ imagePositions()

PvlObject Isis::ProcessMosaic::imagePositions ( )
inherited

Accessor for the placed images and their locations.

Returns
The list of placed images

Definition at line 538 of file ProcessMosaic.cpp.

References Isis::ProcessMosaic::m_imagePositions.

◆ MatchBandBinGroup()

void Isis::ProcessMosaic::MatchBandBinGroup ( int origIsb,
int & inb )
privateinherited

This method matches the input BandBin group to the mosaic BandBin Group and allows band to be replaced in mosaic if it is NA (not assigned).

It expects the bands to be contiguous

returns None

Exceptions
IException::Message
Author
Sharmila Prasad (9/25/2009)

Definition at line 1083 of file ProcessMosaic.cpp.

References Isis::ProcessMosaic::AverageImageWithMosaic, Isis::Process::InputCubes, Isis::ProcessMosaic::m_osb, Isis::PvlKeyword::name(), Isis::Process::OutputCubes, Isis::PvlObject::Traverse, and Isis::IException::User.

Referenced by Isis::ProcessMosaic::StartProcess().

◆ MatchDEMShapeModel()

void Isis::ProcessMosaic::MatchDEMShapeModel ( )
privateinherited

Match the Shape Model for input and mosaic.

If creating the mosaic, copy the input ShapeModel from the input label. Store only the file name of the Shape Model

Author
Sharmila Prasad (1/24/2011)

Definition at line 955 of file ProcessMosaic.cpp.

References Isis::PvlObject::findObject(), Isis::Process::InputCubes, Isis::Process::OutputCubes, and Isis::IException::User.

Referenced by Isis::ProcessMosaic::StartProcess().

◆ MissionData()

QString Isis::Process::MissionData ( const QString & mission,
const QString & file,
bool highestVersion = false )
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.

Parameters
missionName of the mission data directory
fileName of the file to attach to the end of the directory
highestVersionIf 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 788 of file Process.cpp.

References Isis::FileName::expanded(), Isis::FileName::fileExists(), Isis::FileName::highestVersion(), Isis::IException::Io, and Isis::FileName::original().

◆ OverlayToString()

QString Isis::ProcessMosaic::OverlayToString ( ImageOverlay imageOverlay)
staticinherited

Convert an ImageOverlay to a QString.

This is used to translate between mapmos, handmos, and automos' interfaces into an ImageOverlay.

Definition at line 896 of file ProcessMosaic.cpp.

References Isis::ProcessMosaic::AverageImageWithMosaic, Isis::ProcessMosaic::PlaceImagesBeneath, Isis::ProcessMosaic::PlaceImagesOnTop, Isis::toString(), Isis::IException::Unknown, and Isis::ProcessMosaic::UseBandPlacementCriteria.

Referenced by Isis::ProcessMosaic::StringToOverlay().

◆ ProcessAveragePriority()

bool Isis::ProcessMosaic::ProcessAveragePriority ( int piPixel,
Portal & piPortal,
Portal & poPortal,
Portal & countPortal )
privateinherited

Calculate DN value for a pixel for AverageImageWithMosaic priority and set the Count band portal.

Author
Sharmila Prasad (1/13/2011)
Parameters
piPixel- Pixel index
piPortal- Input Portal
poPortal- Output Portal
countPortal- Count Portal
Returns
bool

Definition at line 1041 of file ProcessMosaic.cpp.

References Isis::IsHighPixel(), Isis::IsLowPixel(), Isis::IsNullPixel(), Isis::IsSpecial(), and Isis::IsValidPixel().

Referenced by Isis::ProcessMosaic::StartProcess().

◆ Progress()

Isis::Progress * Isis::Process::Progress ( )
inlineinherited

This method returns a pointer to a Progress object.

Returns
Progress*

Definition at line 259 of file Process.h.

References Isis::Process::p_progress.

Referenced by Isis::Equalization::applyCorrection(), and StartProcess().

◆ PropagateHistory()

void Isis::Process::PropagateHistory ( const bool prop)
inherited

This method allows the programmer to propagate history to the output cube (default is true)

Parameters
propFlag indicating if history is to be propagated to output cubes.

Definition at line 755 of file Process.cpp.

References Isis::Process::p_propagateHistory.

◆ PropagateLabels() [1/2]

void Isis::Process::PropagateLabels ( const bool prop)
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.

Parameters
propFlag indicating if labels are be propagated to output cubes.

Definition at line 652 of file Process.cpp.

References Isis::Process::p_propagateLabels.

◆ PropagateLabels() [2/2]

void Isis::Process::PropagateLabels ( const QString & cube)
inherited

This method allows the programmer to propagate labels from a specific secondary cube.

Parameters
cubeIString containing the name of the cube containing the labels to propagate.

Definition at line 664 of file Process.cpp.

References Isis::PvlObject::findObject(), and Isis::Process::OutputCubes.

◆ PropagateOriginalLabel()

void Isis::Process::PropagateOriginalLabel ( const bool prop)
inherited

This method allows the programmer to propagate original labels to the output cube (default is true)

Parameters
propFlag indicating if original labels is to be propagated to output cubes.

Definition at line 767 of file Process.cpp.

References Isis::Process::p_propagateOriginalLabel.

◆ PropagatePolygons()

void Isis::Process::PropagatePolygons ( const bool prop)
inherited

This method allows the programmer to propagate input blobs to the output cube (default is true)

Parameters
propFlag indicating if input blobs are to be propagated to output cubes.

Definition at line 744 of file Process.cpp.

References Isis::Process::p_propagatePolygons.

◆ PropagateTables() [1/2]

void Isis::Process::PropagateTables ( const bool prop)
inherited

This method allows the programmer to propagate input tables to the output cube (default is true)

Parameters
propFlag indicating if input tables are to be propagated to output cubes.

Definition at line 693 of file Process.cpp.

References Isis::Process::p_propagateTables.

◆ PropagateTables() [2/2]

void Isis::Process::PropagateTables ( const QString & fromName,
const QList< QString > & tableNames = QList<QString>() )
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.

Parameters
fromNameQString of the name of the cube containing the tables to propagate.
tableNamesList of QStrings of the names of the tables to propagate; default is empty, which indicates that all tables will be propagated.
History
2016-11-30 Ian Humphrey - Added tableNames parameter so that only specified tables will be propagated when calling this method. Note that a default of an empty QList is used to propagate all tables. References #4433.

Definition at line 714 of file Process.cpp.

References Isis::Cube::close(), Isis::Cube::label(), Isis::PvlObject::object(), Isis::Cube::open(), Isis::Process::OutputCubes, and Isis::Cube::read().

◆ ResetCountBands()

void Isis::ProcessMosaic::ResetCountBands ( )
privateinherited

Reset all the count bands to default at the time of mosaic creation.

Author
Sharmila Prasad (1/13/2011)

Definition at line 1006 of file ProcessMosaic.cpp.

References Isis::Process::OutputCubes.

Referenced by Isis::ProcessMosaic::StartProcess().

◆ RingsSetOutputCube() [1/5]

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.

Parameters
inputFileName of input file
xminMinimum x-value
xmaxMaximum x-value
yminMinimum y-value
ymaxMaximum y-value
sradStart ring radius
eradEnd ring radius
sazStart ring longitude (azimuth)
eazEnd ring longitude (azimuth)
oAttOutput attributes
mosaicFileName of the output mosaic file

Definition at line 609 of file ProcessMapMosaic.cpp.

References Isis::PvlObject::addGroup(), Isis::ProcessMosaic::AverageImageWithMosaic, FillNull(), p_createMosaic, Isis::Cube::putGroup(), Isis::ProjectionFactory::RingsCreateFromCube(), Isis::ProcessByLine::SetInputCube(), Isis::toString(), and Isis::PvlObject::Traverse.

◆ RingsSetOutputCube() [2/5]

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 731 of file ProcessMapMosaic.cpp.

References Isis::PvlObject::addGroup(), Isis::ProcessMosaic::AverageImageWithMosaic, FillNull(), Isis::Process::OutputCubes, p_createMosaic, Isis::IException::Programmer, Isis::Cube::putGroup(), Isis::ProjectionFactory::RingsCreateForCube(), and Isis::PvlObject::Traverse.

◆ RingsSetOutputCube() [3/5]

Cube * Isis::ProcessMapMosaic::RingsSetOutputCube ( const QString & mosaicFile)

Mosaic output method for Mosaic Processing Method, this will use an existing mosaic.

Definition at line 808 of file ProcessMapMosaic.cpp.

References Isis::Cube::open(), p_createMosaic, RingsSetOutputCube(), and Isis::PvlObject::Traverse.

◆ RingsSetOutputCube() [4/5]

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 274 of file ProcessMapMosaic.cpp.

References 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().

◆ RingsSetOutputCube() [5/5]

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.

Parameters
propagationCubesList of input images
sradStart ring radius
eradEnd ring radius
sazStart ring longitude (azimuth)
eazEnd ring longitude (azimuth)
oAttOutput attributes
mosaicFileName of the output mosaic file

Definition at line 436 of file ProcessMapMosaic.cpp.

References Isis::Cube::bandCount(), Isis::PvlObject::findGroup(), Isis::Cube::label(), Isis::Cube::open(), Isis::IException::Programmer, Isis::Pvl::read(), Isis::ProjectionFactory::RingsCreateForCube(), Isis::ProjectionFactory::RingsCreateFromCube(), RingsSetOutputCube(), Isis::toString(), Isis::PvlObject::Traverse, and Isis::IException::User.

◆ SetBandBinMatch()

void Isis::ProcessMosaic::SetBandBinMatch ( bool enforceBandBinMatch)
inherited

Definition at line 739 of file ProcessMosaic.cpp.

◆ SetBandKeyword()

void Isis::ProcessMosaic::SetBandKeyword ( QString bandPriorityKeyName,
QString bandPriorityKeyValue )
inherited

Set the keyword/value to use for comparing when using band priority.

Definition at line 747 of file ProcessMosaic.cpp.

◆ SetBandNumber()

void Isis::ProcessMosaic::SetBandNumber ( int bandPriorityBandNumber)
inherited

Set the band to use for priorities when using band priority.

Definition at line 756 of file ProcessMosaic.cpp.

◆ SetBandUseMaxValue()

void Isis::ProcessMosaic::SetBandUseMaxValue ( bool useMax)
inherited

Set whether to take the image with the max or min value when using band priority.

Definition at line 765 of file ProcessMosaic.cpp.

◆ SetCreateFlag()

void Isis::ProcessMosaic::SetCreateFlag ( bool createOutputMosaic)
inherited

Flag to indicate that the mosaic is being newly created Indication that the new label specific to the mosaic needs to be created.

Author
Sharmila Prasad (1/19/2011)
Parameters
createOutputMosaic- Set Create Flag True/False

Definition at line 778 of file ProcessMosaic.cpp.

Referenced by StartProcess().

◆ SetHighSaturationFlag()

void Isis::ProcessMosaic::SetHighSaturationFlag ( bool placeHighSatPixels)
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 787 of file ProcessMosaic.cpp.

◆ SetImageOverlay()

void Isis::ProcessMosaic::SetImageOverlay ( ImageOverlay placement)
inherited

Definition at line 792 of file ProcessMosaic.cpp.

◆ SetInputCube() [1/6]

Isis::Cube * Isis::ProcessMapMosaic::SetInputCube ( )
virtual

Input cube cannot be set here.

Definition at line 42 of file ProcessMapMosaic.cpp.

References Isis::IException::Programmer.

◆ SetInputCube() [2/6]

Isis::Cube * Isis::Process::SetInputCube ( const QString & fname,
const Isis::CubeAttributeInput & att,
int requirements = 0 )
virtualinherited

Opens an input cube specified by the programmer and verifies requirements are met.

Parameters
fnameProgrammer specified work file. For example, "myfile.cub".
attThe cube attributes to use when opening the input cube.
requirementsRequirements to check that the input cube meets. See CheckRequirements().
Returns
Cube*
Exceptions
Isis::iException::Message

Reimplemented from Isis::Process.

Definition at line 221 of file Process.cpp.

◆ SetInputCube() [3/6]

Cube * Isis::ProcessMosaic::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 )
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.

Returns
Cube*
Parameters
fname
att
ssThe 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
slThe 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
sbThe 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
nsThe 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
nlThe 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
nbThe 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
Exceptions
IException

Definition at line 650 of file ProcessMosaic.cpp.

References Isis::Process::InputCubes, Isis::ProcessMosaic::m_inb, Isis::ProcessMosaic::m_inl, Isis::ProcessMosaic::m_ins, Isis::ProcessMosaic::m_isb, Isis::ProcessMosaic::m_isl, Isis::ProcessMosaic::m_iss, Isis::IException::Programmer, Isis::Process::SetInputCube(), Isis::toInt(), and Isis::PvlObject::Traverse.

◆ SetInputCube() [4/6]

Isis::Cube * Isis::Process::SetInputCube ( const QString & parameter,
const int requirements = 0 )
virtualinherited

Opens an input cube specified by the user and verifies requirements are met.

Returns
Cube*
Parameters
parameterUser 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".
requirementsRequirements to check that the input cube meets. See CheckRequirements().
Exceptions
Isis::iException::Message

Reimplemented from Isis::Process.

Definition at line 219 of file Process.cpp.

◆ SetInputCube() [5/6]

Cube * Isis::ProcessMosaic::SetInputCube ( const QString & parameter,
const int ss,
const int sl,
const int sb,
const int ns,
const int nl,
const int nb )
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.

Returns
Cube*
Parameters
parameterUser 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".
ssThe 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
slThe 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
sbThe 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
nsThe 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
nlThe 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
nbThe 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
Exceptions
IException::Message

Definition at line 580 of file ProcessMosaic.cpp.

References Isis::Process::InputCubes, Isis::ProcessMosaic::m_inb, Isis::ProcessMosaic::m_inl, Isis::ProcessMosaic::m_ins, Isis::ProcessMosaic::m_isb, Isis::ProcessMosaic::m_isl, Isis::ProcessMosaic::m_iss, Isis::IException::Programmer, Isis::Process::SetInputCube(), Isis::toInt(), and Isis::PvlObject::Traverse.

Referenced by StartProcess().

◆ SetInputCube() [6/6]

void Isis::Process::SetInputCube ( Isis::Cube * inCube,
int requirements = 0 )
virtualinherited

Set the InputCube vector to an opened Cube which was dynamically allocated.

This is used if there already exists a valid opened cube

Author
Sharmila Prasad (5/7/2011)
Parameters
inCube- Pointer to input Cube
requirementsRequirements to check that the input cube meets. See CheckRequirements().

Reimplemented from Isis::Process.

Definition at line 224 of file Process.cpp.

◆ SetLowSaturationFlag()

void Isis::ProcessMosaic::SetLowSaturationFlag ( bool placeLowSatPixels)
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 801 of file ProcessMosaic.cpp.

◆ SetMatchDEM()

void Isis::ProcessMosaic::SetMatchDEM ( bool matchDEM)
inherited

Set the DEM match flag.

Parameters
matchDEMIf true, the match is enforced between Input & Mosaic

Definition at line 809 of file ProcessMosaic.cpp.

References Isis::ProcessMosaic::m_enforceMatchDEM.

◆ SetNullFlag()

void Isis::ProcessMosaic::SetNullFlag ( bool placeNullPixels)
inherited

When true, Null pixels will be considered valid data for the purposes of placing pixels in the output mosaic.

Definition at line 818 of file ProcessMosaic.cpp.

◆ SetOutputCube() [1/8]

Isis::Cube * Isis::Process::SetOutputCube ( const QString & fname,
const Isis::CubeAttributeOutput & att,
const int ns,
const int nl,
const int nb = 1 )
virtualinherited

Allocates a output cube whose name and size is specified by the programmer.

Returns
Cube*
Parameters
fnameName of the output cube to allocate
attThe cube attributes to use when creating the output cube.
nsNumber of samples to allocate
nlNumber of lines to allocate
nbNumber of bands to allocate
Exceptions
Isis::iException::Message

Definition at line 315 of file Process.cpp.

References Isis::PvlObject::addObject(), 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::Cube::setBaseMultiplier(), Isis::Cube::setByteOrder(), Isis::Cube::setDimensions(), Isis::Cube::setFormat(), Isis::Cube::setLabelsAttached(), Isis::Cube::setLabelSize(), Isis::Cube::setMinMax(), Isis::Cube::setPixelType(), Isis::IException::User, Isis::Cube::write(), and Isis::Process::WriteHistory().

◆ SetOutputCube() [2/8]

Isis::Cube * Isis::ProcessMapMosaic::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 )
virtual

Set the output cube to specified file name and specified input images and output attributes and lat,lons.

Definition at line 507 of file ProcessMapMosaic.cpp.

References Isis::PvlObject::addGroup(), Isis::PvlContainer::addKeyword(), Isis::ProcessMosaic::AverageImageWithMosaic, Isis::ProjectionFactory::CreateFromCube(), FillNull(), Isis::Displacement::Meters, p_createMosaic, Isis::Cube::putGroup(), Isis::ProcessByLine::SetInputCube(), Isis::toString(), and Isis::PvlObject::Traverse.

◆ SetOutputCube() [3/8]

Isis::Cube * Isis::ProcessMapMosaic::SetOutputCube ( const QString & inputFile,
PvlGroup mapping,
CubeAttributeOutput & oAtt,
const QString & mosaicFile )
virtual

Set the output cube to specified file name and specified input images and output attributes and lat,lons.

Definition at line 673 of file ProcessMapMosaic.cpp.

References Isis::PvlObject::addGroup(), Isis::ProcessMosaic::AverageImageWithMosaic, Isis::ProjectionFactory::CreateForCube(), FillNull(), Isis::Process::OutputCubes, p_createMosaic, Isis::IException::Programmer, Isis::Cube::putGroup(), and Isis::PvlObject::Traverse.

◆ SetOutputCube() [4/8]

Cube * Isis::ProcessMapMosaic::SetOutputCube ( const QString & mosaicFile)
virtual

Mosaic output method for Mosaic Processing Method, this will use an existing mosaic.

Reimplemented from Isis::Process.

Definition at line 788 of file ProcessMapMosaic.cpp.

References Isis::Cube::open(), p_createMosaic, SetOutputCube(), and Isis::PvlObject::Traverse.

◆ SetOutputCube() [5/8]

Isis::Cube * Isis::Process::SetOutputCube ( const QString & parameter,
const int ns,
const int nl,
const int nb = 1 )
virtualinherited

Allocates a user specified output cube whose size is specified by the programmer.

Returns
Cube*
Parameters
parameterUser 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.
nsNumber of samples to allocate
nlNumber of lines to allocate
nbNumber of bands to allocate
Exceptions
Isis::iException::Message

Definition at line 233 of file Process.cpp.

References Isis::Application::GetUserInterface(), Isis::IException::Programmer, and Isis::Process::SetOutputCube().

◆ SetOutputCube() [6/8]

Cube * Isis::ProcessMosaic::SetOutputCube ( const QString & psParameter,
UserInterface & ui )
inherited

Definition at line 703 of file ProcessMosaic.cpp.

◆ SetOutputCube() [7/8]

Isis::Cube * Isis::ProcessMapMosaic::SetOutputCube ( FileList & propagationCubes,
CubeAttributeOutput & oAtt,
const QString & mosaicFile )
virtual

Set the output cube to specified file name and specified input images and output attributes.

Definition at line 195 of file ProcessMapMosaic.cpp.

References 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().

◆ SetOutputCube() [8/8]

Isis::Cube * Isis::ProcessMapMosaic::SetOutputCube ( FileList & propagationCubes,
double slat,
double elat,
double slon,
double elon,
CubeAttributeOutput & oAtt,
const QString & mosaicFile )
virtual

Set the output cube to specified file name and specified input images and output attributes and lat,lons.

Definition at line 347 of file ProcessMapMosaic.cpp.

References Isis::Cube::bandCount(), Isis::ProjectionFactory::CreateForCube(), Isis::ProjectionFactory::CreateFromCube(), Isis::PvlObject::findGroup(), Isis::Cube::label(), Isis::Cube::open(), Isis::IException::Programmer, Isis::Pvl::read(), SetOutputCube(), Isis::toString(), Isis::PvlObject::Traverse, and Isis::IException::User.

◆ SetOutputCubeStretch() [1/2]

Isis::Cube * Isis::Process::SetOutputCubeStretch ( const QString & parameter,
const int ns,
const int nl,
const int nb = 1,
UserInterface * ui = nullptr )
virtualinherited

Allocates a user specified output cube whose size is specified by the programmer.

Returns
Cube*
Parameters
parameterUser 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.
nsNumber of samples to allocate
nlNumber of lines to allocate
nbNumber of bands to allocate
uiA user interface used to get the attributes needed. If null, the user interface will be obtained from the application.
Exceptions
Isis::iException::Message

Definition at line 275 of file Process.cpp.

References Isis::Application::GetUserInterface(), Isis::IException::Programmer, and Isis::Process::SetOutputCube().

◆ SetOutputCubeStretch() [2/2]

Isis::Cube * Isis::Process::SetOutputCubeStretch ( const QString & parameter,
UserInterface * ui = nullptr )
virtualinherited

Allocates a user-specified output cube whose size matches the first input cube.

Returns
Cube*
Parameters
parameterUser 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.
uiA user interface used to get the attributes needed for SetOutputCube.
Exceptions
Isis::iException::Message

Definition at line 196 of file Process.cpp.

References Isis::Process::InputCubes, Isis::IException::Programmer, and Isis::Process::SetOutputCubeStretch().

Referenced by Isis::Process::SetOutputCubeStretch().

◆ SetTrackFlag()

void Isis::ProcessMosaic::SetTrackFlag ( bool trackingEnabled)
inherited

Definition at line 823 of file ProcessMosaic.cpp.

◆ StartProcess() [1/3]

void Isis::ProcessMosaic::StartProcess ( const int & os,
const int & ol,
const int & ob )
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.

Parameters
osThe 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.
olThe 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.
obThe 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.
Exceptions
IException::Message
Author
Sharmila Prasad (8/25/2009)

Definition at line 106 of file ProcessMosaic.cpp.

References Isis::ProcessMosaic::AddBandBinGroup(), Isis::ProcessMosaic::AddDefaultBandBinGroup(), Isis::ProcessMosaic::AverageImageWithMosaic, Isis::ProcessMosaic::BandComparison(), Isis::ProcessMosaic::BandPriorityWithNoTracking(), Isis::Progress::CheckStatus(), Isis::Cube::close(), Isis::SerialNumber::Compose(), Isis::Cube::create(), Isis::Cube::deleteBlob(), Isis::FileName::expanded(), Isis::Cube::fileName(), Isis::ProcessMosaic::GetBandIndex(), Isis::ProcessMosaic::GetTrackStatus(), Isis::Process::InputCubes, Isis::IsHighPixel(), Isis::IsLowPixel(), Isis::IsNullPixel(), Isis::IsValidPixel(), Isis::Cube::label(), Isis::ProcessMosaic::m_enforceBandBinMatch, Isis::ProcessMosaic::m_enforceMatchDEM, Isis::ProcessMosaic::m_imagePositions, Isis::ProcessMosaic::m_inb, Isis::ProcessMosaic::m_inl, Isis::ProcessMosaic::m_ins, Isis::ProcessMosaic::m_isb, Isis::ProcessMosaic::m_isl, Isis::ProcessMosaic::m_iss, Isis::ProcessMosaic::m_onb, Isis::ProcessMosaic::m_osb, Isis::ProcessMosaic::m_osl, Isis::ProcessMosaic::m_oss, Isis::ProcessMosaic::m_trackingCube, Isis::ProcessMosaic::MatchBandBinGroup(), Isis::ProcessMosaic::MatchDEMShapeModel(), Isis::Cube::open(), Isis::Process::OutputCubes, Isis::Process::p_progress, Isis::FileName::path(), Isis::ProcessMosaic::PlaceImagesBeneath, Isis::ProcessMosaic::PlaceImagesOnTop, Isis::ProcessMosaic::ProcessAveragePriority(), Isis::IException::Programmer, Isis::Cube::read(), Isis::FileName::removeExtension(), Isis::ProcessMosaic::ResetCountBands(), Isis::Cube::setDimensions(), Isis::Progress::SetMaximumSteps(), Isis::Cube::setPixelType(), Isis::toString(), Isis::ProcessMosaic::TRACKING_TABLE_NAME, Isis::PvlObject::Traverse, Isis::IException::Unknown, Isis::ProcessMosaic::UseBandPlacementCriteria, Isis::IException::User, and Isis::Cube::write().

Referenced by StartProcess().

◆ StartProcess() [2/3]

bool Isis::ProcessMapMosaic::StartProcess ( QString inputFile)
virtual

Mosaic Processing method, returns false if the cube is not inside the mosaic.

Definition at line 52 of file ProcessMapMosaic.cpp.

References 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().

◆ StartProcess() [3/3]

virtual void Isis::Process::StartProcess ( void funct())
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.

Parameters
funct()Name of your processing function

Definition at line 213 of file Process.h.

◆ StringToOverlay()

ProcessMosaic::ImageOverlay Isis::ProcessMosaic::StringToOverlay ( QString imageOverlayString)
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 934 of file ProcessMosaic.cpp.

References Isis::ProcessMosaic::OverlayToString(), and Isis::IException::Unknown.

◆ WriteHistory()

void Isis::Process::WriteHistory ( Cube & cube)
inherited

Writes out the History blob to the cube.

Definition at line 822 of file Process.cpp.

References Isis::History::AddEntry(), Isis::Process::InputCubes, Isis::PvlObject::object(), Isis::Process::p_propagateHistory, Isis::Cube::readHistory(), and Isis::Cube::write().

Referenced by Isis::Process::SetOutputCube(), and StartProcess().

Member Data Documentation

◆ FLOAT_STORE_INT_PRECISELY_MAX_VALUE

const int Isis::ProcessMosaic::FLOAT_STORE_INT_PRECISELY_MAX_VALUE = 16777216
staticinherited

Definition at line 200 of file ProcessMosaic.h.

◆ FLOAT_STORE_INT_PRECISELY_MIN_VALUE

const int Isis::ProcessMosaic::FLOAT_STORE_INT_PRECISELY_MIN_VALUE = -16777215
staticinherited

Definition at line 201 of file ProcessMosaic.h.

◆ InputCubes

std::vector<Isis::Cube *> Isis::Process::InputCubes
protectedinherited

A vector of pointers to opened Cube objects.

The pointers are established in the SetInputCube/SetInputWorkCube methods.

Definition at line 185 of file Process.h.

Referenced by Isis::ProcessMosaic::AddBandBinGroup(), Isis::ProcessMosaic::BandComparison(), Isis::ProcessMosaic::BandPriorityWithNoTracking(), 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::ProcessMosaic::GetBandIndex(), Isis::ProcessExport::GetBuffersBIL(), Isis::ProcessExport::GetBuffersBIP(), Isis::ProcessExport::GetBuffersBSQ(), Isis::ProcessExportPds4::identificationArea(), Isis::ProcessExport::InitProcess(), Isis::ProcessExportPds::LineBytes(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::ProcessMosaic::MatchDEMShapeModel(), Isis::ProcessExportPds::OutputLabel(), Isis::ProcessByBrick::PrepProcessCube(), Isis::ProcessByBrick::PrepProcessCubeInPlace(), Isis::ProcessByBrick::PrepProcessCubes(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessByBrick::ProcessCubes(), Isis::ProcessRubberSheet::processPatchTransform(), Isis::ProcessByBrick::SetInputBrickSize(), Isis::ProcessByBrick::SetInputBrickSize(), Isis::ProcessMosaic::SetInputCube(), Isis::ProcessMosaic::SetInputCube(), 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().

◆ m_bandPriorityBandNumber

int Isis::ProcessMosaic::m_bandPriorityBandNumber
privateinherited

Definition at line 327 of file ProcessMosaic.h.

◆ m_bandPriorityKeyName

QString Isis::ProcessMosaic::m_bandPriorityKeyName
privateinherited

Definition at line 328 of file ProcessMosaic.h.

◆ m_bandPriorityKeyValue

QString Isis::ProcessMosaic::m_bandPriorityKeyValue
privateinherited

Definition at line 329 of file ProcessMosaic.h.

◆ m_bandPriorityUseMaxValue

bool Isis::ProcessMosaic::m_bandPriorityUseMaxValue
privateinherited

Definition at line 330 of file ProcessMosaic.h.

◆ m_createOutputMosaic

bool Isis::ProcessMosaic::m_createOutputMosaic
privateinherited

Definition at line 326 of file ProcessMosaic.h.

◆ m_enforceBandBinMatch

bool Isis::ProcessMosaic::m_enforceBandBinMatch
privateinherited

True/False value to determine whether to enforce the input cube bandbin matches the mosaic bandbin group.

Definition at line 345 of file ProcessMosaic.h.

Referenced by Isis::ProcessMosaic::StartProcess().

◆ m_enforceMatchDEM

bool Isis::ProcessMosaic::m_enforceMatchDEM
privateinherited

DEM of the input and mosaic should match.

Definition at line 349 of file ProcessMosaic.h.

Referenced by Isis::ProcessMosaic::ProcessMosaic(), Isis::ProcessMosaic::SetMatchDEM(), and Isis::ProcessMosaic::StartProcess().

◆ m_imageOverlay

ImageOverlay Isis::ProcessMosaic::m_imageOverlay
privateinherited

Definition at line 351 of file ProcessMosaic.h.

◆ m_imagePositions

PvlObject Isis::ProcessMosaic::m_imagePositions
privateinherited

List of images placed on the mosaic.

Definition at line 353 of file ProcessMosaic.h.

Referenced by Isis::ProcessMosaic::imagePositions(), and Isis::ProcessMosaic::StartProcess().

◆ m_inb

int Isis::ProcessMosaic::m_inb
privateinherited

The number of bands from the input cube.

Definition at line 338 of file ProcessMosaic.h.

Referenced by Isis::ProcessMosaic::ProcessMosaic(), Isis::ProcessMosaic::SetInputCube(), Isis::ProcessMosaic::SetInputCube(), and Isis::ProcessMosaic::StartProcess().

◆ m_inl

int Isis::ProcessMosaic::m_inl
privateinherited

The number of lines from the input cube.

Definition at line 337 of file ProcessMosaic.h.

Referenced by Isis::ProcessMosaic::ProcessMosaic(), Isis::ProcessMosaic::SetInputCube(), Isis::ProcessMosaic::SetInputCube(), and Isis::ProcessMosaic::StartProcess().

◆ m_ins

int Isis::ProcessMosaic::m_ins
privateinherited

The number of samples from the input cube.

Definition at line 336 of file ProcessMosaic.h.

Referenced by Isis::ProcessMosaic::ProcessMosaic(), Isis::ProcessMosaic::SetInputCube(), Isis::ProcessMosaic::SetInputCube(), and Isis::ProcessMosaic::StartProcess().

◆ m_isb

int Isis::ProcessMosaic::m_isb
privateinherited

The starting band within the input cube.

Definition at line 335 of file ProcessMosaic.h.

Referenced by Isis::ProcessMosaic::ProcessMosaic(), Isis::ProcessMosaic::SetInputCube(), Isis::ProcessMosaic::SetInputCube(), and Isis::ProcessMosaic::StartProcess().

◆ m_isl

int Isis::ProcessMosaic::m_isl
privateinherited

The starting line within the input cube.

Definition at line 334 of file ProcessMosaic.h.

Referenced by Isis::ProcessMosaic::ProcessMosaic(), Isis::ProcessMosaic::SetInputCube(), Isis::ProcessMosaic::SetInputCube(), and Isis::ProcessMosaic::StartProcess().

◆ m_iss

int Isis::ProcessMosaic::m_iss
privateinherited

The starting sample within the input cube.

Definition at line 333 of file ProcessMosaic.h.

Referenced by Isis::ProcessMosaic::ProcessMosaic(), Isis::ProcessMosaic::SetInputCube(), Isis::ProcessMosaic::SetInputCube(), and Isis::ProcessMosaic::StartProcess().

◆ m_onb

int Isis::ProcessMosaic::m_onb
privateinherited

The number of bands in the output cube.

Definition at line 343 of file ProcessMosaic.h.

Referenced by Isis::ProcessMosaic::BandPriorityWithNoTracking(), Isis::ProcessMosaic::ProcessMosaic(), and Isis::ProcessMosaic::StartProcess().

◆ m_osb

int Isis::ProcessMosaic::m_osb
privateinherited

The starting band within the output cube.

Definition at line 342 of file ProcessMosaic.h.

Referenced by Isis::ProcessMosaic::AddBandBinGroup(), Isis::ProcessMosaic::BandPriorityWithNoTracking(), Isis::ProcessMosaic::GetInputStartBandInMosaic(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::ProcessMosaic::ProcessMosaic(), and Isis::ProcessMosaic::StartProcess().

◆ m_osl

int Isis::ProcessMosaic::m_osl
privateinherited

The starting line within the output cube.

Definition at line 341 of file ProcessMosaic.h.

Referenced by Isis::ProcessMosaic::BandComparison(), Isis::ProcessMosaic::BandPriorityWithNoTracking(), Isis::ProcessMosaic::GetInputStartLineInMosaic(), Isis::ProcessMosaic::ProcessMosaic(), and Isis::ProcessMosaic::StartProcess().

◆ m_oss

int Isis::ProcessMosaic::m_oss
privateinherited

The starting sample within the output cube.

Definition at line 340 of file ProcessMosaic.h.

Referenced by Isis::ProcessMosaic::BandComparison(), Isis::ProcessMosaic::BandPriorityWithNoTracking(), Isis::ProcessMosaic::GetInputStartSampleInMosaic(), Isis::ProcessMosaic::ProcessMosaic(), and Isis::ProcessMosaic::StartProcess().

◆ m_ownedCubes

QSet<Isis::Cube *>* Isis::Process::m_ownedCubes
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.

Definition at line 199 of file Process.h.

Referenced by Isis::Process::ClearCubes(), Isis::Process::ClearInputCubes(), Isis::Process::ClearOutputCubes(), Isis::Process::Process(), and Isis::Process::~Process().

◆ m_placeHighSatPixels

bool Isis::ProcessMosaic::m_placeHighSatPixels
privateinherited

Definition at line 360 of file ProcessMosaic.h.

◆ m_placeLowSatPixels

bool Isis::ProcessMosaic::m_placeLowSatPixels
privateinherited

Definition at line 361 of file ProcessMosaic.h.

◆ m_placeNullPixels

bool Isis::ProcessMosaic::m_placeNullPixels
privateinherited

Definition at line 362 of file ProcessMosaic.h.

◆ m_trackingCube

Cube* Isis::ProcessMosaic::m_trackingCube
privateinherited

Output tracking cube. NULL unless tracking is enabled.

Definition at line 325 of file ProcessMosaic.h.

Referenced by Isis::ProcessMosaic::BandComparison(), Isis::ProcessMosaic::EndProcess(), Isis::ProcessMosaic::ProcessMosaic(), Isis::ProcessMosaic::StartProcess(), and Isis::ProcessMosaic::~ProcessMosaic().

◆ m_trackingEnabled

bool Isis::ProcessMosaic::m_trackingEnabled
privateinherited

Definition at line 324 of file ProcessMosaic.h.

◆ OutputCubes

std::vector<Isis::Cube *> Isis::Process::OutputCubes
protectedinherited

A vector of pointers to allocated Cube objects.

The pointers are established in the SetOutputCube method.

Definition at line 191 of file Process.h.

Referenced by Isis::ProcessMosaic::AddBandBinGroup(), Isis::ProcessMosaic::AddDefaultBandBinGroup(), Isis::ProcessMosaic::BandComparison(), Isis::ProcessMosaic::BandPriorityWithNoTracking(), Isis::Process::ClearOutputCubes(), Isis::ProcessPolygons::FillPolygon(), Isis::ProcessImportPds::Finalize(), Isis::ProcessMosaic::GetBandIndex(), Isis::ProcessMosaic::GetOriginDefaultByPixelType(), Isis::ProcessMosaic::GetTrackStatus(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::ProcessMosaic::MatchDEMShapeModel(), Isis::ProcessByBrick::PrepProcessCube(), Isis::ProcessByBrick::PrepProcessCubeInPlace(), Isis::ProcessByBrick::PrepProcessCubes(), 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(), Isis::ProcessMosaic::ResetCountBands(), RingsSetOutputCube(), Isis::ProcessByBrick::SetOutputBrickSize(), Isis::ProcessByBrick::SetOutputBrickSize(), 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().

◆ p_bandStats

std::vector< std::vector< Isis::Statistics * > > Isis::Process::p_bandStats
protectedinherited

Holds the calculated statistics for each band separately of every input cubei after the CalculateStatistics method is called.

Definition at line 172 of file Process.h.

Referenced by Isis::Process::BandStatistics(), and Isis::Process::CalculateStatistics().

◆ p_createMosaic

bool Isis::ProcessMapMosaic::p_createMosaic
private

Internal use; SetOutputMosaic (const QString &) sets to false to not attempt creation when using SetOutputMosaic.

Definition at line 157 of file ProcessMapMosaic.h.

Referenced by ProcessMapMosaic(), RingsSetOutputCube(), RingsSetOutputCube(), RingsSetOutputCube(), SetOutputCube(), SetOutputCube(), and SetOutputCube().

◆ p_cubeStats

std::vector< Isis::Statistics * > Isis::Process::p_cubeStats
protectedinherited

Holds the calculated statistics for every band together of every input cubei after the CalculateStatistics method is called.

Definition at line 179 of file Process.h.

Referenced by Isis::Process::CalculateStatistics(), and Isis::Process::CubeStatistics().

◆ p_progress

Isis::Progress* Isis::Process::p_progress
protectedinherited

Pointer to a Progress object.

Definition at line 145 of file Process.h.

Referenced by Isis::ProcessByBrick::BlockingReportProgress(), Isis::ProcessExport::InitProcess(), Isis::Process::Process(), Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessExport::ProcessExport(), Isis::ProcessImport::ProcessImport(), Isis::ProcessImport::ProcessJp2(), Isis::ProcessRubberSheet::processPatchTransform(), Isis::Process::Progress(), Isis::ProcessByBrick::RunProcess(), 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().

◆ p_propagateHistory

bool Isis::Process::p_propagateHistory
protectedinherited

Flag indicating if history is to be propagated to output cubes.

Definition at line 161 of file Process.h.

Referenced by Isis::Process::Process(), Isis::Process::PropagateHistory(), StartProcess(), and Isis::Process::WriteHistory().

◆ p_propagateLabels

bool Isis::Process::p_propagateLabels
protectedinherited

Flag indicating if labels are be propagated to output cubes.

Definition at line 149 of file Process.h.

Referenced by Isis::Process::Process(), Isis::Process::PropagateLabels(), and Isis::Process::SetOutputCube().

◆ p_propagateOriginalLabel

bool Isis::Process::p_propagateOriginalLabel
protectedinherited

Flag indicating if original lable is to be propagated to output cubes.

Definition at line 165 of file Process.h.

Referenced by Isis::Process::Process(), Isis::Process::PropagateOriginalLabel(), and Isis::Process::SetOutputCube().

◆ p_propagatePolygons

bool Isis::Process::p_propagatePolygons
protectedinherited

Flag indicating if blobs are be propagated to output cubes.

Definition at line 157 of file Process.h.

Referenced by Isis::Process::Process(), Isis::Process::PropagatePolygons(), and Isis::Process::SetOutputCube().

◆ p_propagateTables

bool Isis::Process::p_propagateTables
protectedinherited

Flag indicating if tables are be propagated to output cubes.

Definition at line 153 of file Process.h.

Referenced by Isis::Process::Process(), Isis::Process::PropagateTables(), and Isis::Process::SetOutputCube().

◆ TRACKING_TABLE_NAME

const char * Isis::ProcessMosaic::TRACKING_TABLE_NAME = "InputImages"
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.

Referenced by Isis::ProcessMosaic::StartProcess().

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