USGS

Isis 3.0 Object Programmers' Reference

Home

Isis::ProcessMosaic Class Reference

Mosaic two cubes together. More...

#include <ProcessMosaic.h>

Inheritance diagram for Isis::ProcessMosaic:
Inheritance graph
Collaboration diagram for Isis::ProcessMosaic:
Collaboration graph

Public Types

enum  ImageOverlay {
  PlaceImagesOnTop, PlaceImagesBeneath, UseBandPlacementCriteria, AverageImageWithMosaic,
  NumImageOverlayOptions
}
 Enumeration for different Mosaic priorities (input, mosaic, band) More...
 

Public Member Functions

 ProcessMosaic ()
 ProcessMosaic Contructor.
 
virtual ~ProcessMosaic ()
 Destroys the Mosaic object. It will close all opened cubes.
 
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.
 
PvlObject imagePositions ()
 Accessor for the placed images and their locations.
 
virtual Isis::CubeSetInputCube (const QString &parameter, 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::CubeSetInputCube (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.
 
Isis::CubeSetOutputCube (const QString &psParameter)
 Opens an output cube specified by the user.
 
void SetBandBinMatch (bool enforceBandBinMatch)
 
void SetMosaicOrigin (int &piIndex)
 This method creates a table if not already created to hold the image file names if the track flag is true.
 
void SetBandKeyword (QString bandPriorityKeyName, QString bandPriorityKeyValue)
 Set the keyword/value to use for comparing when using band priority.
 
void SetBandNumber (int bandPriorityBandNumber)
 Set the band to use for priorities when using band priority.
 
void SetBandUseMaxValue (bool useMax)
 Set whether to take the image with the max or min value when using band priority.
 
void SetCreateFlag (bool createOutputMosaic)
 Flag to indicate that the mosaic is being newly created Indication that the new label specific to the mosaic needs to be created.
 
void SetHighSaturationFlag (bool placeHighSatPixels)
 When true, high saturation (HRS, HIS) will be considered valid data for the purposes of placing pixels in the output mosaic.
 
void SetImageOverlay (ImageOverlay placement)
 
void SetLowSaturationFlag (bool placeLowSatPixels)
 When true, low saturation (LRS, LIS) will be considered valid data for the purposes of placing pixels in the output mosaic.
 
void SetMatchDEM (bool matchDEM)
 Set the DEM match flag.
 
void SetNullFlag (bool placeNullPixels)
 When true, Null pixels will be considered valid data for the purposes of placing pixels in the output mosaic.
 
void SetTrackFlag (bool trackingEnabled)
 
bool GetHighSaturationFlag () const
 
ImageOverlay GetImageOverlay () const
 
bool GetLowSaturationFlag () const
 
bool GetNullFlag () const
 
bool GetTrackFlag () const
 
int GetInputStartLineInMosaic () const
 This is the line where the image was placed into the output mosaic.
 
int GetInputStartSampleInMosaic () const
 This is the sample where the image was placed into the output mosaic.
 
int GetInputStartBandInMosaic () const
 This is the band where the image was placed into the output mosaic.
 
virtual void StartProcess (void funct())
 In the base class, this method will invoked a user-specified function exactly one time.
 
virtual void EndProcess ()
 End the processing sequence and cleans up by closing cubes, freeing memory, etc.
 
virtual void Finalize ()
 Cleans up by closing cubes and freeing memory for owned cubes.
 
virtual Isis::CubeSetInputCube (const QString &parameter, const int requirements=0)
 Opens an input cube specified by the user and verifies requirements are met.
 
virtual Isis::CubeSetInputCube (const QString &fname, const Isis::CubeAttributeInput &att, int requirements=0)
 Opens an input cube specified by the programmer and verifies requirements are met.
 
virtual void SetInputCube (Isis::Cube *inCube)
 Set the InputCube vector to an opened Cube which was dynamically allocated.
 
virtual Isis::CubeSetOutputCube (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::CubeSetOutputCube (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 AddInputCube (Cube *cube, bool owned=true)
 
void AddOutputCube (Cube *cube, bool owned=true)
 
void ClearCubes ()
 Close owned cubes from the list and clear the list.
 
void ClearInputCubes ()
 Close owned input cubes from the list and clear the list.
 
void ClearOutputCubes ()
 Close owned output cubes from the list and clear the list.
 
void PropagateLabels (const bool prop)
 This method allows the programmer to turn on/off the propagation of labels from the 1st input cube to any of the output cubes.
 
void PropagateLabels (const QString &cube)
 This method allows the programmer to propagate labels from a specific secondary cube.
 
void PropagateTables (const bool prop)
 This method allows the programmer to propagate input tables to the output cube (default is true)
 
void PropagateTables (const QString &fromName)
 Propagate the tables from the cube with the given filename to the output cube.
 
void PropagatePolygons (const bool prop)
 This method allows the programmer to propagate input blobs to the output cube (default is true)
 
void PropagateHistory (const bool prop)
 This method allows the programmer to propagate history to the output cube (default is true)
 
void PropagateOriginalLabel (const bool prop)
 This method allows the programmer to propagate original labels to the output cube (default is true)
 
Isis::ProgressProgress ()
 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::StatisticsCubeStatistics (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::Progressp_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

int GetIndexOffsetByPixelType ()
 This method returns the start value depending on the pixel type 8,16,32 bit.
 
void BandComparison (int iss, int isl, int isb, int ins, int inl, int inb, 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 ResetOriginBand ()
 This method sets the origin band to defaults(unassigned value) depending on the pixel type.
 
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.
 

Private Attributes

bool m_trackingEnabled
 
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 cubes 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 Mosaic object will merge the overlapping area.

The process has four priorities (input, mosaic, band, average) for how the input image has to be placed on the mosaic. Priority "input" will place the input image on top of the mosaic. Priority "mosaic" will place the input image beneath the mosaic. Priority "band" will place the input image on the mosaic based on the "Lessser" or "Greater" criteria between user defined band in the input and the mosaic images. Priority Average will average of valid pixels in the input and mosaic images. Choosing this priority will cause the mosaic to have twice the number of bands of the input image,with a count band for each band. The count band keeps track of number of images involved in the dn value of the mosaic. In case of special pixels and the special pixel flags being enabled, the details for each priority is described below.

This class also has the ability to track the origin of the pixel by storing the input image names in a table and assigning an index to each unique image in the order they were placed on the mosaic. If the priority is input or mosaic then tracking is done only for single band input image. Band priority can track the origin for multiple bands based on a specified band based on the criteria (Lesser or Greater). The specified band can be a number or any keyword in the label.

There are also options to copy High and Low Saturation both for Instrument and Representation and Null DN values from the input to the mosaic. These options are valid for only input(top) and band priorities.

Following are the values for the origin band depending on the pixel type

Pixel Type Default Start Value Max Value Total Images

(Bits) (No Origin) Supported

32 -16777216 -16777215 16777216 33549932 16 -32768 -32767 32767 65535 8 0 1 255 255

Tags: F(FALSE), T(TRUE), V(VALID), S(SPECIAL PIXEL HS, LS, NULL), N(NULL), I(INPUT), M(MOSAIC), HL(HS,LS)

For priority=mosaic (beneath), the input is placed beneath the mosaic i.e. the

input pixel will be copied to the mosaic only if the mosaic pixel is NULL.

Input Mosaic Output

V N I S,V HL,V M

For priority=input(on top), following is the criteria for pixel assignment:

—Options— —Images-—

HS LS NULL Input Mosaic Output

F F F V S,V I F F F S S,V M T OR T OR T V S,V I T OR T OR T S S,V I(H,L,N)

For priority=band, following is the criteria for pixel assignment:

—Options— —Images-—

HS LS NULL Input Mosaic Output

F F F V V Criteria based F F F V S I F F F S S,V M T OR T OR T S S,V I(H,L,N) T OR T OR T V V Criteria based T OR T OR T V S I

For priority=average, following is the criteria for pixel assignment:

—Options— —Images-—

HS LS NULL Input Mosaic Output Count

F F F V V Average count++ F F F V S I 1 F F F S S M 0 F F F S V M count T OR T OR T S S,V I(H,L,N) 0 T OR T OR T V V Average count++ T OR T OR T V S I 1

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 member variables could be corrupted

2009-09-30 Sharmila Prasad - Added capability to track the pixel origin. Priorities Top and Beneath can track origin for a single band input image only. Band priority can track origin of a multi-band input image based on a particular band. Also Band placement is flexible and any bands from the input cube can fit within the output mosaic. Also ability to allow HS, LS or NULL pixels from input to the mosaic(output). Added table for Origin Default values based on pixel type

2010-02-25 Sharmila Prasad - Changed stricmp to use IString function "Equal"

2010-10-21 Sharmila Prasad - The BandBin group must be carried thru to the mosaic at creation time regardless of matchbandbin flag

2011-01-18 Sharmila Prasad - Added "Average" priority feature, to double the number of mosaic bands to get Count info

2011-01-24 Sharmila Prasad - API to match DEM and also to add new group "mosaic" to hold ShapeModel attributes for the mosaic if Flag is Enabled

2011-09-23 Steven Lambright - Fixed table resizing code to not do nothing and eventually cause very, very bad things to happen (writing out of array bounds). Fixes #410.

2011-10-20 Sharmila Prasad - Fixes #0000462, allow Band Priority even if Tracking is not enabled

2011-12-30 Sharmila Prasad - Fixed #00587, Disable Tracking for multiband mosaic for ontop or beneath priority

2012-01-05 Sharmila Prasad - Fixed #00586 Allow Band Priority with no Tracking

2012-07-03 Steven Lambright and Stuart Sides - Updated to better follow good coding practices and the new Isis coding standards. Removed #define's, moved enums into the class, and stopped modifying member variables (makes local copies instead) in StartProcess where possible. There were flaws in the design that made it difficult to not carry over erroneous state from past method calls and cause difficult to reproduce problems. Fixes #967.

2012-08-16 Kimberly Oyama - Added a PvlObject, m_imagePositions, to store the image information (file name, start sample, and start line). An accessor, imagePositions(), for the PvlObject was also added. The image information is used as log output by automos, handmos, and mapmos. Fixes #976.

2013-03-27 Jeannie Backer - Added documentation and programmer comments. References #1248.

2014-03-28 Kimberly Oyama - Added check for count band when priority=average. The mosaic apps should fail when priority=average and there is no count band. Fixes #746.

2014-04-07 Kimberly Oyama - Updated the GetBandIndex() method to return the same number when you use the band number or band name. For example, if band 3 is the emission angle, GetBandIndex() should return 3 whether you enter 3 or emission angle. Modified BandPriorityWithNoTracking() so valid data is always placed on top of the mosaic regardless of the placement criteria (priority=band). The only way to place special or null pixels is to check those options in mapmos or automos. Fixes #1620. Fixes #1623.

2014-07-23 Janet Barrett - Fixed the StartProcess method to allow the overlay of an input file on a pre-existing output file. Fixed #751.

2015-01-15 Sasha Brownsberger - Added virtual keyword to several functions to ensure successful inheritance between Process and its child classes. Made destructor virtual. References #2215.

Definition at line 194 of file ProcessMosaic.h.

Member Enumeration Documentation

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

Isis::ProcessMosaic::ProcessMosaic ( )

ProcessMosaic Contructor.

Initialize the class members to default

Definition at line 47 of file ProcessMosaic.cpp.

Isis::ProcessMosaic::~ProcessMosaic ( )
virtual

Destroys the Mosaic object. It will close all opened cubes.

Definition at line 84 of file ProcessMosaic.cpp.

Member Function Documentation

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

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 1208 of file ProcessMosaic.cpp.

References Isis::PvlObject::findGroup(), Isis::PvlObject::findObject(), Isis::PvlContainer::keywords(), Isis::PvlKeyword::name(), Isis::PvlKeyword::setUnits(), Isis::PvlKeyword::size(), and Isis::PvlKeyword::unit().

void Isis::ProcessMosaic::AddDefaultBandBinGroup ( )
private

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 1302 of file ProcessMosaic.cpp.

References Isis::PvlObject::findObject().

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

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

- FileName Index for the origin band (default + zero based index)

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

Definition at line 1426 of file ProcessMosaic.cpp.

References Isis::IsHighPixel(), Isis::IsLowPixel(), Isis::IsNullPixel(), Isis::IsSpecial(), Isis::IsValidPixel(), Isis::Portal::SetPosition(), and Isis::Buffer::size().

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

Mosaicking for Band Priority with no Tracking.

Author
Sharmila Prasad (1/4/2012)

Definition at line 1476 of file ProcessMosaic.cpp.

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

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 283 of file Process.h.

References Isis::Process::p_bandStats.

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 721 of file Process.cpp.

References Isis::Statistics::AddData(), Isis::Cube::bandCount(), Isis::Progress::CheckStatus(), Isis::Buffer::DoubleBuffer(), Isis::Cube::lineCount(), Isis::Cube::read(), Isis::LineManager::SetLine(), Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), Isis::Buffer::size(), and Isis::toString().

void Isis::Process::ClearCubes ( )
inherited

Close owned cubes from the list and clear the list.

Definition at line 506 of file Process.cpp.

void Isis::Process::ClearInputCubes ( )
inherited

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

Definition at line 516 of file Process.cpp.

Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::FileTool::saveAsReducedCube(), and Isis::ProcessMapMosaic::SetOutputCube().

void Isis::Process::ClearOutputCubes ( )
inherited

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

Definition at line 530 of file Process.cpp.

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 297 of file Process.h.

References Isis::Process::p_cubeStats.

void Isis::Process::EndProcess ( )
virtualinherited
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::ProcessImportPds, Isis::ProcessByBrick, Isis::ProcessByBoxcar, Isis::ProcessByTile, Isis::ProcessGroundPolygons, and Isis::ProcessPolygons.

Definition at line 488 of file Process.cpp.

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

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

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

Definition at line 1342 of file ProcessMosaic.cpp.

References _FILEINFO_, Isis::PvlObject::findGroup(), and Isis::PvlKeyword::size().

bool Isis::ProcessMosaic::GetHighSaturationFlag ( ) const
See Also
SetHighSaturationFlag()

Definition at line 891 of file ProcessMosaic.cpp.

int Isis::ProcessMosaic::GetIndexOffsetByPixelType ( )
private

This method returns the start value depending on the pixel type 8,16,32 bit.

Returns
the start/offset value
Exceptions
iException::Message
Author
Sharmila Prasad (8/28/2009)

Definition at line 1567 of file ProcessMosaic.cpp.

References Isis::SizeOf().

int Isis::ProcessMosaic::GetInputStartBandInMosaic ( ) const

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

Definition at line 947 of file ProcessMosaic.cpp.

int Isis::ProcessMosaic::GetInputStartLineInMosaic ( ) const

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

Definition at line 931 of file ProcessMosaic.cpp.

int Isis::ProcessMosaic::GetInputStartSampleInMosaic ( ) const

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

Definition at line 939 of file ProcessMosaic.cpp.

bool Isis::ProcessMosaic::GetLowSaturationFlag ( ) const
See Also
SetLowSaturationFlag()

Definition at line 907 of file ProcessMosaic.cpp.

bool Isis::ProcessMosaic::GetNullFlag ( ) const
See Also
SetNullFlag()

Definition at line 915 of file ProcessMosaic.cpp.

int Isis::ProcessMosaic::GetOriginDefaultByPixelType ( )
private

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

parameters

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

Definition at line 1599 of file ProcessMosaic.cpp.

References _FILEINFO_, and Isis::SizeOf().

bool Isis::ProcessMosaic::GetTrackFlag ( ) const
See Also
SetTrackFlag()

Definition at line 923 of file ProcessMosaic.cpp.

bool Isis::ProcessMosaic::GetTrackStatus ( )
private

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 1662 of file ProcessMosaic.cpp.

References Isis::PvlObject::findKeyword(), Isis::PvlObject::hasKeyword(), Isis::PvlObject::hasObject(), Isis::PvlObject::object(), and Isis::PvlObject::objects().

PvlObject Isis::ProcessMosaic::imagePositions ( )

Accessor for the placed images and their locations.

Returns
The list of placed images

Definition at line 436 of file ProcessMosaic.cpp.

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

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 1143 of file ProcessMosaic.cpp.

References _FILEINFO_, Isis::PvlObject::findGroup(), Isis::PvlContainer::hasKeyword(), Isis::PvlContainer::keywords(), Isis::PvlContainer::name(), Isis::PvlKeyword::name(), and Isis::PvlKeyword::size().

void Isis::ProcessMosaic::MatchDEMShapeModel ( )
private

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 1015 of file ProcessMosaic.cpp.

References _FILEINFO_, Isis::PvlContainer::findKeyword(), Isis::PvlObject::findObject(), and Isis::PvlContainer::hasKeyword().

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 666 of file Process.cpp.

References _FILEINFO_, and Isis::PvlObject::findGroup().

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

Convert an ImageOverlay to a QString.

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

Definition at line 956 of file ProcessMosaic.cpp.

References _FILEINFO_, and Isis::toString().

bool Isis::ProcessMosaic::ProcessAveragePriority ( int  piPixel,
Portal piPortal,
Portal poPortal,
Portal porigPortal 
)
private

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
porigPortal- Count Portal
Returns
bool

Definition at line 1101 of file ProcessMosaic.cpp.

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

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

This method returns a pointer to a Progress object.

Returns
Progress*

Definition at line 263 of file Process.h.

References Isis::Process::p_progress.

Referenced by Isis::Equalization::calculateStatistics(), Isis::ProcessMapMosaic::RingsSetOutputCube(), and Isis::ProcessMapMosaic::SetOutputCube().

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 635 of file Process.cpp.

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

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 552 of file Process.cpp.

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

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 563 of file Process.cpp.

References Isis::PvlObject::addGroup(), Isis::PvlObject::addObject(), Isis::PvlObject::findObject(), Isis::PvlObject::group(), Isis::PvlObject::groups(), and Isis::PvlObject::hasObject().

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 646 of file Process.cpp.

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

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 625 of file Process.cpp.

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

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 591 of file Process.cpp.

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

void Isis::Process::PropagateTables ( const QString &  fromName)
inherited

Propagate the tables from the cube with the given filename to the output cube.

This is done at the time this method is called, not during normal processing.

Definition at line 600 of file Process.cpp.

References Isis::Cube::label(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Cube::open(), and Isis::Cube::read().

void Isis::ProcessMosaic::ResetCountBands ( )
private

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

Author
Sharmila Prasad (1/13/2011)

Definition at line 1066 of file ProcessMosaic.cpp.

References Isis::Portal::SetPosition(), and Isis::Buffer::size().

void Isis::ProcessMosaic::ResetOriginBand ( )
private

This method sets the origin band to defaults(unassigned value) depending on the pixel type.

parameters and no return value

Author
Sharmila Prasad (8/28/2009)

Definition at line 1632 of file ProcessMosaic.cpp.

References Isis::Portal::SetPosition(), and Isis::Buffer::size().

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

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

Definition at line 807 of file ProcessMosaic.cpp.

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

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

Definition at line 816 of file ProcessMosaic.cpp.

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

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

Definition at line 825 of file ProcessMosaic.cpp.

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

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

Definition at line 838 of file ProcessMosaic.cpp.

void Isis::ProcessMosaic::SetHighSaturationFlag ( bool  placeHighSatPixels)

When true, high saturation (HRS, HIS) will be considered valid data for the purposes of placing pixels in the output mosaic.

Definition at line 847 of file ProcessMosaic.cpp.

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".
requirementsUse to specify requirements for the input file. The following are requirments are checked against 1) ic_base::SizeMatch checks to make sure the input cube has the same bands, samples, and lines as the first input cube open using this method, 2) ic_base::SpatialMatch checks to make sure the input cube has the same samples and lines as the first input cube, 3) ic_base::Georeferenced checks to make sure latitude/longitudes can be obtained from the input cube, 4) ic_base::FullyGeoreferenced checks to make sure latitude/longitude, phase/incidence/emission, and other geometric parameters can be obtained from the input cube, 5) ic_base::OneBand checks to make sure the input cube has exactly one band. Note, that these requirements can be logically or'ed. For example, ic_base::SpatialMatch | ic_base::georeferenced. Defaults to 0
Exceptions
Isis::iException::Message

Reimplemented in Isis::ProcessByBrick, Isis::ProcessByLine, Isis::ProcessBySpectra, and Isis::ProcessBySample.

Definition at line 243 of file Process.cpp.

Referenced by Isis::ImageExporter::addChannel(), Isis::FileTool::saveAsEnlargedCube(), and Isis::ProcessGroundPolygons::SetStatCubes().

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.
requirementsSame as requirements on SetInputCube. See that method for more details. Defaults to 0
Returns
Cube*
Exceptions
Isis::iException::Message

Reimplemented in Isis::ProcessByBrick.

Definition at line 82 of file Process.cpp.

References _FILEINFO_, Isis::Cube::bandCount(), Isis::CubeAttributeInput::bands(), Isis::Cube::lineCount(), Isis::Cube::open(), Isis::Cube::sampleCount(), and Isis::Cube::setVirtualBands().

void Isis::Process::SetInputCube ( Isis::Cube inCube)
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

Reimplemented in Isis::ProcessByLine.

Definition at line 201 of file Process.cpp.

References _FILEINFO_, and Isis::Cube::isOpen().

Cube * Isis::ProcessMosaic::SetInputCube ( const QString &  parameter,
const int  ss = 1,
const int  sl = 1,
const int  sb = 1,
const int  ns = -1,
const int  nl = -1,
const int  nb = -1 
)
virtual

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 478 of file ProcessMosaic.cpp.

References _FILEINFO_, Isis::PvlObject::findGroup(), and Isis::toInt().

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 
)
virtual

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 548 of file ProcessMosaic.cpp.

References _FILEINFO_, Isis::PvlObject::findGroup(), and Isis::toInt().

void Isis::ProcessMosaic::SetLowSaturationFlag ( bool  placeLowSatPixels)

When true, low saturation (LRS, LIS) will be considered valid data for the purposes of placing pixels in the output mosaic.

Definition at line 861 of file ProcessMosaic.cpp.

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

Set the DEM match flag.

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

Definition at line 869 of file ProcessMosaic.cpp.

void Isis::ProcessMosaic::SetMosaicOrigin ( int &  index)

This method creates a table if not already created to hold the image file names if the track flag is true.

If table exists, checks if the image already exists and if it does not, then adds the new image file name. If the field size is smaller than the new image name, then it resizes all the records to new file size. When the table is newly created,it resets the origin band to default based on pixel type.

Parameters
index- the input file index
Returns
none
Exceptions
anexception if the number of images exceeds the pixel size.
iException::Message
Author
Sharmila Prasad (8/28/2009)

Definition at line 657 of file ProcessMosaic.cpp.

References _FILEINFO_, Isis::PvlObject::findGroup(), Isis::PvlObject::findKeyword(), Isis::PvlObject::hasKeyword(), Isis::PvlObject::hasObject(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Table::Records(), and Isis::toInt().

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

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

Definition at line 878 of file ProcessMosaic.cpp.

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 302 of file Process.cpp.

References _FILEINFO_.

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

Opens an output cube specified by the user.

This method is overloaded and adds the requirement that only one output cube can be specified. The output cube must exist before calling SetOutputCube.

Returns
Cube*
Parameters
psParameterUser parameter to obtain file to open. Typically, the value is "TO". For example, the user can specify on the command line TO=mosaic.cub and this method will attempt to open the cube "mosaic.cub" if the parameter was set to "TO". .
Exceptions
IException::Message

Reimplemented from Isis::Process.

Definition at line 596 of file ProcessMosaic.cpp.

References _FILEINFO_, Isis::PvlObject::findObject(), Isis::Cube::label(), and Isis::Cube::open().

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 221 of file Process.h.

void Isis::ProcessMosaic::StartProcess ( const int &  os,
const int &  ol,
const int &  ob 
)
virtual

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 114 of file ProcessMosaic.cpp.

References _FILEINFO_, Isis::PvlObject::findObject(), Isis::IsHighPixel(), Isis::IsLowPixel(), Isis::IsNullPixel(), Isis::IsValidPixel(), Isis::Portal::SetPosition(), Isis::Buffer::size(), and Isis::toString().

ProcessMosaic::ImageOverlay Isis::ProcessMosaic::StringToOverlay ( QString  imageOverlayString)
static

Convert a QString to an ImageOverlay (case-insensitive).

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

Definition at line 994 of file ProcessMosaic.cpp.

References _FILEINFO_.

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

Member Data Documentation

bool Isis::ProcessMosaic::m_enforceBandBinMatch
private

 True/False value to determine whether to 

enforce the input cube bandbin matches the mosaic bandbin group

Definition at line 343 of file ProcessMosaic.h.

bool Isis::ProcessMosaic::m_enforceMatchDEM
private

DEM of the input and mosaic should match.

Definition at line 347 of file ProcessMosaic.h.

PvlObject Isis::ProcessMosaic::m_imagePositions
private

List of images placed on the mosaic.

Definition at line 351 of file ProcessMosaic.h.

int Isis::ProcessMosaic::m_inb
private

The number of bands from the input cube.

Definition at line 336 of file ProcessMosaic.h.

int Isis::ProcessMosaic::m_inl
private

The number of lines from the input cube.

Definition at line 335 of file ProcessMosaic.h.

int Isis::ProcessMosaic::m_ins
private

The number of samples from the input cube.

Definition at line 334 of file ProcessMosaic.h.

int Isis::ProcessMosaic::m_isb
private

The starting band within the input cube.

Definition at line 333 of file ProcessMosaic.h.

int Isis::ProcessMosaic::m_isl
private

The starting line within the input cube.

Definition at line 332 of file ProcessMosaic.h.

int Isis::ProcessMosaic::m_iss
private

The starting sample within the input cube.

Definition at line 331 of file ProcessMosaic.h.

int Isis::ProcessMosaic::m_onb
private

The number of bands in the output cube.

Definition at line 341 of file ProcessMosaic.h.

int Isis::ProcessMosaic::m_osb
private

The starting band within the output cube.

Definition at line 340 of file ProcessMosaic.h.

int Isis::ProcessMosaic::m_osl
private

The starting line within the output cube.

Definition at line 339 of file ProcessMosaic.h.

int Isis::ProcessMosaic::m_oss
private

The starting sample within the output cube.

Definition at line 338 of file ProcessMosaic.h.

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 207 of file Process.h.

std::vector<Isis::Cube *> Isis::Process::OutputCubes
protectedinherited
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 180 of file Process.h.

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

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 187 of file Process.h.

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

bool Isis::Process::p_propagateHistory
protectedinherited

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

Definition at line 169 of file Process.h.

bool Isis::Process::p_propagateLabels
protectedinherited

Flag indicating if labels are be propagated to output cubes.

Definition at line 157 of file Process.h.

bool Isis::Process::p_propagateOriginalLabel
protectedinherited

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

Definition at line 173 of file Process.h.

bool Isis::Process::p_propagatePolygons
protectedinherited

Flag indicating if blobs are be propagated to output cubes.

Definition at line 165 of file Process.h.

bool Isis::Process::p_propagateTables
protectedinherited

Flag indicating if tables are be propagated to output cubes.

Definition at line 161 of file Process.h.

const char * Isis::ProcessMosaic::TRACKING_TABLE_NAME = "InputImages"
static

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.


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