Isis 3 Developer Reference
|
Derivative of Process, designed for geometric transformations. More...
#include <ProcessRubberSheet.h>
Public Member Functions | |
ProcessRubberSheet (int startSize=128, int endSize=8) | |
Constructs a ProcessRubberSheet class with the default tile size range. More... | |
virtual | ~ProcessRubberSheet () |
Destroys the RubberSheet object. More... | |
virtual void | StartProcess (Transform &trans, Interpolator &interp) |
Applies a Transform and an Interpolator to every pixel in the output cube. More... | |
void | processPatchTransform (Transform &trans, Interpolator &interp) |
Applies a Transform and an Interpolator to small patches. More... | |
void | BandChange (void(*funct)(const int band)) |
Registers a function to be called when the current output cube band number changes. More... | |
void | ForceTile (double Samp, double Line) |
void | SetTiling (long long start, long long end) |
This sets the start and end tile sizes for the rubber sheet; numbers are inclusive and must be powers of 2. More... | |
void | setPatchParameters (int startSample, int startLine, int samples, int lines, int sampleIncrement, int lineIncrement) |
This method allows the programmer to override the default values for patch parameters used in the patch transform method (processPatchTransform) More... | |
virtual void | StartProcess (void funct()) |
In the base class, this method will invoked a user-specified function exactly one time. More... | |
virtual void | EndProcess () |
End the processing sequence and cleans up by closing cubes, freeing memory, etc. More... | |
virtual void | Finalize () |
Cleans up by closing cubes and freeing memory for owned cubes. More... | |
virtual Isis::Cube * | SetInputCube (const QString ¶meter, const int requirements=0) |
Opens an input cube specified by the user and verifies requirements are met. More... | |
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. More... | |
virtual void | SetInputCube (Isis::Cube *inCube) |
Set the InputCube vector to an opened Cube which was dynamically allocated. More... | |
virtual Isis::Cube * | SetOutputCube (const QString ¶meter) |
Allocates a user-specified output cube whose size matches the first input cube. More... | |
virtual Isis::Cube * | SetOutputCube (const QString ¶meter, const int nsamps, const int nlines, const int nbands=1) |
Allocates a user specified output cube whose size is specified by the programmer. More... | |
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. More... | |
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. More... | |
void | ClearInputCubes () |
Close owned input cubes from the list and clear the list. More... | |
void | ClearOutputCubes () |
Close owned output cubes from the list and clear the list. More... | |
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. More... | |
void | PropagateLabels (const QString &cube) |
This method allows the programmer to propagate labels from a specific secondary cube. More... | |
void | PropagateTables (const bool prop) |
This method allows the programmer to propagate input tables to the output cube (default is true) More... | |
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. More... | |
void | PropagatePolygons (const bool prop) |
This method allows the programmer to propagate input blobs to the output cube (default is true) More... | |
void | PropagateHistory (const bool prop) |
This method allows the programmer to propagate history to the output cube (default is true) More... | |
void | PropagateOriginalLabel (const bool prop) |
This method allows the programmer to propagate original labels to the output cube (default is true) More... | |
Isis::Progress * | Progress () |
This method returns a pointer to a Progress object. More... | |
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. More... | |
void | WriteHistory (Cube &cube) |
Writes out the History blob to the cube. More... | |
void | CalculateStatistics () |
Calculates and stores off statistics on every band of every cube added to this process via the SetInputCube method. More... | |
std::vector< Isis::Statistics * > | BandStatistics (const unsigned index) |
Get the vector of Statistics objects for each band separately of a specified input cube. More... | |
Isis::Statistics * | CubeStatistics (const unsigned index) |
Get the Statistics object for all bands of a specified input cube. More... | |
Protected Attributes | |
Isis::Progress * | p_progress |
Pointer to a Progress object. More... | |
bool | p_propagateLabels |
Flag indicating if labels are be propagated to output cubes. More... | |
bool | p_propagateTables |
Flag indicating if tables are be propagated to output cubes. More... | |
bool | p_propagatePolygons |
Flag indicating if blobs are be propagated to output cubes. More... | |
bool | p_propagateHistory |
Flag indicating if history is to be propagated to output cubes. More... | |
bool | p_propagateOriginalLabel |
Flag indicating if original lable is to be propagated to output cubes. More... | |
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. More... | |
std::vector< Isis::Statistics *> | p_cubeStats |
Holds the calculated statistics for every band together of every input cubei after the CalculateStatistics method is called. More... | |
std::vector< Isis::Cube * > | InputCubes |
A vector of pointers to opened Cube objects. More... | |
std::vector< Isis::Cube * > | OutputCubes |
A vector of pointers to allocated Cube objects. More... | |
QSet< Isis::Cube * > * | m_ownedCubes |
A list of cubes owned by this instant. More... | |
Derivative of Process, designed for geometric transformations.
This is the processing class for geometric transformations of cube data. Objects of this class can be used to apply rubber sheet transformations from one space to another, such as converting from one map projection to another or from instrument space to ground space. Each pixel position in the output cube will be processed by querying a transformer to find what input pixel should be used and an interpolator to find the value of the pixel. Any application using this class must supply a Transform object and an Interpolator object. This class allows only one input cube and one output cube.
Isis::ProcessRubberSheet::ProcessRubberSheet | ( | int | startSize = 128 , |
int | endSize = 8 |
||
) |
Constructs a ProcessRubberSheet class with the default tile size range.
startSize | Beginning size of output tiles for reverse driven geom |
endSize | Minimum size of output tiles for reverse driven geom |
References Isis::Null.
|
inlinevirtual |
Destroys the RubberSheet object.
|
inherited |
|
inherited |
void Isis::ProcessRubberSheet::BandChange | ( | void(*)(const int band) | funct | ) |
Registers a function to be called when the current output cube band number changes.
This includes the first time. If and application does NOT need to be notified when the processing is about to proceed to the next band there is no need to call this member. The application function will not be called.
funct | (const int band) An application defined function which will be called every time the current band number changes. |
|
inlineinherited |
Get the vector of Statistics objects for each band separately of a specified input cube.
index | The index of the input cube in InputCubes |
References Isis::Process::p_bandStats.
|
inherited |
Calculates and stores off statistics on every band of every cube added to this process via the SetInputCube method.
The newly calculated statistics are stored in two ways: as a vector where each entry is a single Statistics object for every band of a particular input cube, and as a vector where each entry is a vector of Statistics objects, for each band separately, of a particular input cube.
References Isis::Statistics::AddData(), Isis::Cube::bandCount(), Isis::Progress::CheckStatus(), Isis::Buffer::DoubleBuffer(), Isis::Cube::lineCount(), Isis::Cube::read(), Isis::LineManager::SetLine(), Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), Isis::Buffer::size(), and Isis::toString().
|
inherited |
Close owned cubes from the list and clear the list.
|
inherited |
Close owned input cubes from the list and clear the list.
Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and Isis::ProcessMapMosaic::SetOutputCube().
|
inherited |
Close owned output cubes from the list and clear the list.
|
inlineinherited |
Get the Statistics object for all bands of a specified input cube.
index | The index of the input cube in InputCubes |
References Isis::Process::p_cubeStats.
|
virtualinherited |
End the processing sequence and cleans up by closing cubes, freeing memory, etc.
Reimplemented in Isis::ProcessImportPds, Isis::ProcessMosaic, Isis::ProcessByBrick, Isis::ProcessByBoxcar, Isis::ProcessByTile, Isis::ProcessGroundPolygons, and Isis::ProcessPolygons.
Referenced by Isis::ProcessByBoxcar::EndProcess().
|
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.
Referenced by Isis::ProcessByBoxcar::Finalize().
|
inline |
|
inherited |
This method reads the mission specific data directory from the user preference file, makes sure that mission is available in the Isis installation, and the attaches the provided input file to the directory in order to create a full file specification.
mission | Name of the mission data directory |
file | Name of the file to attach to the end of the directory |
highestVersion | If set to true the method will return the highest version number of the given file. Therefore, file must contain question marks such as "file???.dat". See the FileName class for more information on versioned files. Defaults to false. |
References _FILEINFO_, Isis::FileName::expanded(), Isis::FileName::fileExists(), Isis::PvlObject::findGroup(), Isis::FileName::highestVersion(), and Isis::Preference::Preferences().
void Isis::ProcessRubberSheet::processPatchTransform | ( | Transform & | trans, |
Interpolator & | interp | ||
) |
Applies a Transform and an Interpolator to small patches.
The transform should define a mapping from input pixel coordinates to output pixel coordinates. The input image will be broken into many small patches (default 5x5). The four corners of each input patch will be mapped into the output cube using the transform. This will provide four corresponding output patch coordinates. These four coordinates (input and output) will be used to compute an affine transform from output coordinate to input coordinates. The affine transform is then used to quickly compute input coordinates (fractional). This input coordinate is then used in the interp object in order to geometrically move input pixels to output pixels.
trans | A fully initialized Transform object. The Transform member of this object is used to calculate an output pixel location given an input pixel location. |
interp | A fully initialized Interpolator object. The Interpolate member of this object is used to calculate output pixel values. |
iException::Message |
References _FILEINFO_, Isis::Interpolator::HotLine(), Isis::Interpolator::HotSample(), Isis::Interpolator::Lines(), and Isis::Interpolator::Samples().
|
inlineinherited |
This method returns a pointer to a Progress object.
References Isis::Process::p_progress.
Referenced by Isis::Equalization::applyCorrection(), Isis::Equalization::calculateBandStatistics(), Isis::HiEqualization::calculateStatistics(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::ProcessMapMosaic::SetOutputCube(), and Isis::SpectralDefinition2D::SpectralDefinition2D().
|
inherited |
This method allows the programmer to propagate history to the output cube (default is true)
prop | Flag indicating if history is to be propagated to output cubes. |
Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and Isis::ProcessMapMosaic::SetOutputCube().
|
inherited |
This method allows the programmer to turn on/off the propagation of labels from the 1st input cube to any of the output cubes.
By default, propagation occurs automatically in the Process class when a call to either of the SetOutputCube methods is invoked. If the program * requires no propagation then utilize this method. This method can be invoked between successive calls of SetOutputCube so that some cube will have labels propagated while others will not.
prop | Flag indicating if labels are be propagated to output cubes. |
Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and Isis::ProcessMapMosaic::SetOutputCube().
|
inherited |
This method allows the programmer to propagate labels from a specific secondary cube.
cube | IString containing the name of the cube containing the labels to propagate. |
References Isis::PvlObject::addGroup(), Isis::PvlObject::addObject(), Isis::PvlObject::findObject(), Isis::PvlObject::group(), Isis::PvlObject::groups(), and Isis::PvlObject::hasObject().
|
inherited |
This method allows the programmer to propagate original labels to the output cube (default is true)
prop | Flag indicating if original labels is to be propagated to output cubes. |
Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and Isis::ProcessMapMosaic::SetOutputCube().
|
inherited |
This method allows the programmer to propagate input blobs to the output cube (default is true)
prop | Flag indicating if input blobs are to be propagated to output cubes. |
Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and Isis::ProcessMapMosaic::SetOutputCube().
|
inherited |
This method allows the programmer to propagate input tables to the output cube (default is true)
prop | Flag indicating if input tables are to be propagated to output cubes. |
Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), and Isis::ProcessMapMosaic::SetOutputCube().
|
inherited |
Propagate the tables from the cube with the given filename to the output cube.
This is done at the time this method is called, not during normal processing. The names of the tables to propagate can be provided through the second paramter, by specifing a list of table names. Not providing any list (or providing an empty list) will propagate all tables.
fromName | QString of the name of the cube containing the tables to propagate. |
tableNames | List of QStrings of the names of the tables to propagate; default is empty, which indicates that all tables will be propagated. |
References Isis::Cube::label(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Cube::open(), and Isis::Cube::read().
|
virtualinherited |
Opens an input cube specified by the user and verifies requirements are met.
parameter | User parameter to obtain file to open. Typically, the value is "FROM". For example, the user can specify on the command line FROM=myfile.cub and this method will attempt to open the cube "myfile.cub" if the parameter was set to "FROM". |
requirements | Use to specify requirements for the input file. The following are requirments are checked against 1) ic_base::SizeMatch checks to make sure the input cube has the same bands, samples, and lines as the first input cube open using this method, 2) ic_base::SpatialMatch checks to make sure the input cube has the same samples and lines as the first input cube, 3) ic_base::Georeferenced checks to make sure latitude/longitudes can be obtained from the input cube, 4) ic_base::FullyGeoreferenced checks to make sure latitude/longitude, phase/incidence/emission, and other geometric parameters can be obtained from the input cube, 5) ic_base::OneBand checks to make sure the input cube has exactly one band. Note, that these requirements can be logically or'ed. For example, ic_base::SpatialMatch | ic_base::georeferenced. Defaults to 0 |
Isis::iException::Message |
Reimplemented in Isis::ProcessByLine, Isis::ProcessByBrick, Isis::ProcessBySpectra, and Isis::ProcessBySample.
Referenced by Isis::ProcessGroundPolygons::SetStatCubes().
|
virtualinherited |
Opens an input cube specified by the programmer and verifies requirements are met.
fname | Programmer specified work file. For example, "myfile.cub". |
att | The cube attributes to use when opening the input cube. |
requirements | Same as requirements on SetInputCube. See that method for more details. Defaults to 0 |
Isis::iException::Message |
Reimplemented in Isis::ProcessByBrick.
References _FILEINFO_, Isis::AllMatchOrOne, Isis::Cube::bandCount(), Isis::BandMatchOrOne, Isis::CubeAttributeInput::bands(), Isis::Cube::lineCount(), Isis::OneBand, Isis::Cube::open(), Isis::ReadWrite, Isis::Cube::sampleCount(), Isis::Cube::setVirtualBands(), Isis::SizeMatch, and Isis::SpatialMatch.
|
virtualinherited |
Set the InputCube vector to an opened Cube which was dynamically allocated.
This is used if there already exists a valid opened cube
inCube | - Pointer to input Cube |
Reimplemented in Isis::ProcessByLine.
References _FILEINFO_, and Isis::Cube::isOpen().
|
virtualinherited |
Allocates a user-specified output cube whose size matches the first input cube.
parameter | User specified output file. For example, "TO" is a popular user parameter. If the user specified TO=output.cub, then this routine would allocate the file output.cub with size specified by the first opened input cube. The output pixel type will be propagated from the first loaded input cube or will use the value in the application XML file for pixelType. |
Isis::iException::Message |
Reimplemented in Isis::ProcessMosaic, Isis::ProcessImport, and Isis::ProcessMapMosaic.
References _FILEINFO_.
Referenced by Isis::ProcessImport::SetOutputCube().
|
virtualinherited |
Allocates a user specified output cube whose size is specified by the programmer.
parameter | User specified output file. For example, "TO" is a popular user parameter. If the user specified TO=output.cub, then this routine would allocate the file output.cub with size specified by the first opened input cube. The output pixel type will be propagated from the first loaded input cube or will use the value in the application XML file for pixelType. |
ns | Number of samples to allocate |
nl | Number of lines to allocate |
nb | Number of bands to allocate |
Isis::iException::Message |
References _FILEINFO_.
|
virtualinherited |
Allocates a output cube whose name and size is specified by the programmer.
fname | Name of the output cube to allocate |
att | The cube attributes to use when creating the output cube. |
ns | Number of samples to allocate |
nl | Number of lines to allocate |
nb | Number of bands to allocate |
Isis::iException::Message |
References _FILEINFO_, Isis::PvlObject::addGroup(), Isis::PvlObject::addObject(), Isis::AttachedLabel, Isis::CubeAttributeOutput::byteOrder(), Isis::Cube::create(), Isis::CubeAttributeOutput::fileFormat(), Isis::PvlObject::findObject(), Isis::PvlObject::group(), Isis::PvlObject::groups(), Isis::PvlContainer::isNamed(), Isis::Cube::label(), Isis::CubeAttributeOutput::labelAttachment(), Isis::Cube::labelSize(), Isis::CubeAttributeOutput::maximum(), Isis::CubeAttributeOutput::minimum(), Isis::PvlContainer::name(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Cube::pixelType(), Isis::CubeAttributeOutput::pixelType(), Isis::CubeAttributeOutput::propagateMinimumMaximum(), Isis::CubeAttributeOutput::propagatePixelType(), Isis::Real, Isis::Cube::setBaseMultiplier(), Isis::Cube::setByteOrder(), Isis::Cube::setDimensions(), Isis::Cube::setFormat(), Isis::Cube::setLabelsAttached(), Isis::Cube::setLabelSize(), Isis::Cube::setMinMax(), Isis::Cube::setPixelType(), Isis::SignedInteger, Isis::SignedWord, Isis::UnsignedByte, Isis::UnsignedInteger, Isis::UnsignedWord, and Isis::Cube::write().
void Isis::ProcessRubberSheet::setPatchParameters | ( | int | startSample, |
int | startLine, | ||
int | samples, | ||
int | lines, | ||
int | sampleIncrement, | ||
int | lineIncrement | ||
) |
This method allows the programmer to override the default values for patch parameters used in the patch transform method (processPatchTransform)
startSample | The starting sample in the input cube to process the default is 1. |
startLine | The starting line in the input cube to process the default is 1. It would unusual to use something other than 1, however, for pushframe cameras it would make sense to use the framelet size + 1 for even cubes and 1 for odd cubes. |
samples | The number of samples in each input patch. The default is five. Larger values can make the patch algorithm run faster at the risk of transforming improperly because an affine transform is not necessarily equal to the geometric transform defined by the Transform object given to the processPatchTransform method. This is especially important to consider during image orthorectification if the DEM is high resolution. |
lines | The number of lines in each input patch. The default is five. Larger values can make the patch algorithm run faster at the risk of transforming improperly because an affine transform is not necessarily equal to the geometric transform defined by the Transform object given to the processPatchTransform method. This is especially important to consider during image orthorectification if the DEM is high resolution. Also for pushframe cameras the line size for patches should divide nicely into the framelet size. |
sampleIncrement | The number of input samples to increment for the next patch. The default is 4 which is one less than the default patch size. This guarantees overlap so that there is not gaps in the output cube. |
sampleIncrement | The number of input lines to increment for the next patch. The default is 4 which is one less than the default patch size. This guarantees overlap so that there is not gaps in the output cube. In rare instances (pushframe cameras) the line increment should be twice the framelet height which will prevent processing of NULL framelets. |
|
inline |
This sets the start and end tile sizes for the rubber sheet; numbers are inclusive and must be powers of 2.
start | Start position; must be at least 4 and a power of 2 |
end | End position; must be at least 4, a power of 2 and less than start |
|
virtual |
Applies a Transform and an Interpolator to every pixel in the output cube.
The output cube is written using an Tile and the input cube is read using a Portal. The input cube and output cube must be initialized prior to calling this method. Output pixels which come from outside the input cube are set to NULL8.
trans | A fully initialized Transform object. The Transform member of this object is used to calculate what input pixel location should be used to interpolate the output pixel value. |
interp | A fully initialized Interpolator object. The Interpolate member of this object is used to calculate output pixel values. |
IException::Message |
References _FILEINFO_, Isis::Buffer::Band(), Isis::BufferManager::begin(), Isis::BufferManager::end(), Isis::Interpolator::HotLine(), Isis::Interpolator::HotSample(), Isis::Interpolator::Lines(), Isis::Interpolator::Samples(), Isis::TileManager::SetTile(), and Isis::TileManager::Tiles().
|
inlinevirtualinherited |
In the base class, this method will invoked a user-specified function exactly one time.
In derived classes such as ProcessByLine, the StartProcess will invoke a user-specified function for every line in a cube.
funct() | Name of your processing function |
|
inherited |
Writes out the History blob to the cube.
References Isis::History::AddEntry(), Isis::iApp, Isis::PvlContainer::isNamed(), Isis::PvlObject::object(), Isis::PvlObject::objects(), and Isis::Cube::write().
Referenced by Isis::ImageImporter::import().
|
protectedinherited |
A vector of pointers to opened Cube objects.
The pointers are established in the SetInputCube/SetInputWorkCube methods.
Referenced by Isis::ProcessExport::CreateWorldFile(), Isis::ProcessExport::GetBuffersBIL(), Isis::ProcessExport::GetBuffersBIP(), Isis::ProcessExport::GetBuffersBSQ(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessExport::ProcessCubes(), Isis::ProcessByBrick::ProcessCubes(), Isis::ProcessExport::SetInputRange(), Isis::ProcessByQuickFilter::StartProcess(), and Isis::ProcessExport::StartProcess().
|
protectedinherited |
|
protectedinherited |
A vector of pointers to allocated Cube objects.
The pointers are established in the SetOutputCube method.
Referenced by Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessByBrick::ProcessCubes(), Isis::ProcessImport::ProcessJp2(), and Isis::ProcessByQuickFilter::StartProcess().
|
protectedinherited |
Holds the calculated statistics for each band separately of every input cubei after the CalculateStatistics method is called.
Referenced by Isis::Process::BandStatistics().
|
protectedinherited |
Holds the calculated statistics for every band together of every input cubei after the CalculateStatistics method is called.
Referenced by Isis::Process::CubeStatistics().
|
protectedinherited |
Pointer to a Progress object.
Referenced by Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessExport::ProcessCubes(), Isis::ProcessExport::ProcessExport(), Isis::ProcessImport::ProcessImport(), Isis::ProcessImport::ProcessJp2(), Isis::Process::Progress(), Isis::ProcessByQuickFilter::StartProcess(), and Isis::ProcessExport::StartProcess().
|
protectedinherited |
Flag indicating if history is to be propagated to output cubes.
|
protectedinherited |
Flag indicating if labels are be propagated to output cubes.
|
protectedinherited |
Flag indicating if original lable is to be propagated to output cubes.
|
protectedinherited |
Flag indicating if blobs are be propagated to output cubes.
|
protectedinherited |
Flag indicating if tables are be propagated to output cubes.