|
Isis 3.0 Object Programmers' Reference |
Home |
Convert PDS archive files to Isis format. More...
#include <ProcessImportPds.h>
Public Types | |
| enum | PdsFileType { Image = 1, Qube = 2, SpectralQube = 4, L0 = 8, Rdn = 16, Loc = 32, Obs = 64, All = Image | Qube | SpectralQube | L0 | Rdn | Loc | Obs } |
| enum | Interleave { InterleaveUndefined, JP2, BSQ, BIL, BIP } |
| This enum includes how the document should be read: by BSQ, BIL, BIP, JP2, or InterleaveUndefined. More... | |
Public Member Functions | |
| ProcessImportPds () | |
| Constructor. | |
| void | SetPdsFile (const QString &pdsLabelFile, const QString &pdsDataFile, Pvl &pdsLabel, PdsFileType allowedTypes=All) |
| Set the input label file, data file and initialize a Pvl with the PDS labels. | |
| void | SetPdsFile (const Pvl &pdsLabelPvl, const QString &pdsDataFile, PdsFileType allowedTypes=All) |
| Set the input label PVL and data file and initialize a Pvl with the PDS labels. | |
| void | ProcessLabel (const QString &pdsDataFile, PdsFileType allowedTypes) |
| Load the PDS labels after determining what type of data file was provided. | |
| void | TranslatePdsProjection (Pvl &lab) |
| Fills the passed in label with the projection information from the PDS label file. | |
| void | TranslateIsis2Labels (Pvl &lab) |
| Translate as many of the ISIS2 labels as possible. | |
| void | TranslatePdsLabels (Pvl &lab) |
| Translate as many of the PDS labels as possible. | |
| bool | IsIsis2 () |
| Return true if ISIS2 cube, else return false. | |
| void | OmitOriginalLabel () |
| Prevents the Original Label blob from being written out to the end of the cube. | |
| Table & | ImportTable (QString pdsTableName) |
| This method will import the PDS table with the given name into an Isis Table object. | |
| void | StartProcess () |
| This method will write the cube and table data to the output cube. | |
| void | StartProcess (void funct(Isis::Buffer &out)) |
| Process the input file and send data to a method for specialized processing. | |
| void | EndProcess () |
| void | Finalize () |
| End the processing sequence and cleans up by closing cubes, freeing memory, etc. | |
| virtual void | StartProcess (void funct()) |
| In the base class, this method will invoked a user-specified function exactly one time. | |
| void | SetInputFile (const QString &file) |
| Sets the name of the input file to be read in the import StartProcess method and verifies its existance. | |
| QString | InputFile () |
| Sets the name of the input file to be read in the import StartProcess method and verifies its existance. | |
| Isis::Cube * | SetOutputCube (const QString ¶meter) |
| Create the output file. | |
| virtual Isis::Cube * | SetOutputCube (const QString &fname, Isis::CubeAttributeOutput &att) |
| Create the output file. | |
| virtual Isis::Cube * | SetOutputCube (const QString ¶meter, const int nsamps, const int nlines, const int nbands=1) |
| Allocates a user specified output cube whose size is specified by the programmer. | |
| virtual Isis::Cube * | SetOutputCube (const QString &fname, const Isis::CubeAttributeOutput &att, const int nsamps, const int nlines, const int nbands=1) |
| Allocates a output cube whose name and size is specified by the programmer. | |
| void | SetPixelType (const Isis::PixelType type) |
| Sets the pixel type of the input file. | |
| Isis::PixelType | PixelType () |
| Returns the pixel type. | |
| void | SetDimensions (const int ns, const int nl, const int nb) |
| Sets the physical size of the input cube. | |
| int | Samples () |
| Returns the number of samples. | |
| int | Lines () |
| Returns the number of lines. | |
| int | Bands () |
| Returns the number of bands. | |
| void | SetByteOrder (const Isis::ByteOrder order) |
| Sets the byte order of the input file. | |
| Isis::ByteOrder | ByteOrder () |
| Returns the byte order. | |
| void | SetFileHeaderBytes (const int bytes) |
| This method sets the number of bytes in the header of a file. | |
| void | SetFileTrailerBytes (const int bytes) |
| This method sets the number of bytes in the trailer of a file. | |
| void | SetDataHeaderBytes (const int bytes) |
| This method sets the number of bytes in the header of each datablock of a file. | |
| void | SetDataTrailerBytes (const int bytes) |
| This method sets the number of bytes in the trailer of each datablock of a file. | |
| void | SetDataPrefixBytes (const int bytes) |
| This method sets the number of bytes at the beginning of each data record of a file. | |
| void | SetDataSuffixBytes (const int bytes) |
| This method sets the number of bytes at the end of each data record of a file. | |
| void | SaveFileHeader () |
| This method marks the file header to be saved. | |
| void | SaveFileTrailer () |
| This method marks the file trailer to be saved. | |
| void | SaveDataHeader () |
| This method marks the data block headers to be saved. | |
| void | SaveDataTrailer () |
| This method marks the data block trailers to be saved. | |
| void | SaveDataPrefix () |
| This method marks the data prefix to be saved. | |
| void | SaveDataSuffix () |
| This method marks the data suffix to be saved. | |
| int | FileHeaderBytes () const |
| This method returns the number of file header bytes. | |
| int | FileTrailerBytes () const |
| This method returns the number of file trailer bytes. | |
| int | DataHeaderBytes () const |
| This method returns the number of data header bytes. | |
| int | DataTrailerBytes () const |
| This method returns the number of data trailer bytes. | |
| int | DataPrefixBytes () const |
| This method returns the number of data prefix bytes. | |
| int | DataSuffixBytes () const |
| This method returns the number of data duffix bytes. | |
| char * | FileHeader () |
| This method returns a pointer to the file header. | |
| char * | FileTrailer () |
| This method returns a pointer to the file trailer. | |
| std::vector< char * > | DataHeader () |
| This method returns a pointer to the data header. | |
| std::vector< char * > | DataTrailer () |
| This method returns a pointer to the data trailer. | |
| std::vector< std::vector< char * > > | DataPrefix () |
| This method returns a pointer to the data prefix. | |
| std::vector< std::vector< char * > > | DataSuffix () |
| This method returns a pointer to the data suffix. | |
| void | SetOrganization (const ProcessImport::Interleave org) |
| Sets the organization of the input cube. | |
| Interleave | Organization () const |
| Gets the organization of the input cube. | |
| void | SetBase (const double base) |
| Sets the core base of the input cube. | |
| void | SetBase (const std::vector< double > base) |
| Sets band dependent core base. | |
| void | SetMultiplier (const double mult) |
| Sets the core multiplier of the input cube. | |
| void | SetMultiplier (const std::vector< double > mult) |
| Sets band dependent core multiplier. | |
| void | SetSpecialValues (const double null, const double lrs, const double lis, const double hrs, const double his) |
| Sets a mapping of input pixel values to output special pixel values. | |
| void | SetNull (const double null_min, const double null_max) |
| Sets the range that will be considered Isis::Null. | |
| void | SetLRS (const double lrs_min, const double lrs_max) |
| Sets the range that will be considered Isis::Null. | |
| void | SetLIS (const double lis_min, const double lis_max) |
| Sets the range that will be considered Isis::Null. | |
| void | SetHRS (const double hrs_min, const double hrs_max) |
| Sets the range that will be considered Isis::Null. | |
| void | SetHIS (const double his_min, const double his_max) |
| Sets the range that will be considered Isis::Null. | |
| double | TestPixel (const double pixel) |
| Tests the pixel. | |
| virtual Isis::Cube * | SetInputCube (const QString ¶meter, const int requirements=0) |
| Opens an input cube specified by the user and verifies requirements are met. | |
| virtual Isis::Cube * | SetInputCube (const QString &fname, const Isis::CubeAttributeInput &att, int requirements=0) |
| Opens an input cube specified by the programmer and verifies requirements are met. | |
| virtual void | SetInputCube (Isis::Cube *inCube) |
| Set the InputCube vector to an opened Cube which was dynamically allocated. | |
| void | AddInputCube (Cube *cube, bool owned=true) |
| void | AddOutputCube (Cube *cube, bool owned=true) |
| void | ClearCubes () |
| Close owned cubes from the list and clear the list. | |
| void | ClearInputCubes () |
| Close owned input cubes from the list and clear the list. | |
| void | ClearOutputCubes () |
| Close owned output cubes from the list and clear the list. | |
| void | PropagateLabels (const bool prop) |
| This method allows the programmer to turn on/off the propagation of labels from the 1st input cube to any of the output cubes. | |
| void | PropagateLabels (const QString &cube) |
| This method allows the programmer to propagate labels from a specific secondary cube. | |
| void | PropagateTables (const bool prop) |
| This method allows the programmer to propagate input tables to the output cube (default is true) | |
| void | PropagateTables (const QString &fromName) |
| Propagate the tables from the cube with the given filename to the output cube. | |
| void | PropagatePolygons (const bool prop) |
| This method allows the programmer to propagate input blobs to the output cube (default is true) | |
| void | PropagateHistory (const bool prop) |
| This method allows the programmer to propagate history to the output cube (default is true) | |
| void | PropagateOriginalLabel (const bool prop) |
| This method allows the programmer to propagate original labels to the output cube (default is true) | |
| Isis::Progress * | Progress () |
| This method returns a pointer to a Progress object. | |
| QString | MissionData (const QString &mission, const QString &file, bool highestVersion=false) |
| This method reads the mission specific data directory from the user preference file, makes sure that mission is available in the Isis installation, and the attaches the provided input file to the directory in order to create a full file specification. | |
| void | WriteHistory (Cube &cube) |
| Writes out the History blob to the cube. | |
| void | CalculateStatistics () |
| Calculates and stores off statistics on every band of every cube added to this process via the SetInputCube method. | |
| std::vector< Isis::Statistics * > | BandStatistics (const unsigned index) |
| Get the vector of Statistics objects for each band separately of a specified input cube. | |
| Isis::Statistics * | CubeStatistics (const unsigned index) |
| Get the Statistics object for all bands of a specified input cube. | |
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 Types | |
| enum | Source { NOSOURCE, PDS, ISIS2 } |
| enum | EncodingType { NONE, JP2 } |
Private Member Functions | |
| void | ProcessDataFilePointer (PvlTranslationManager &pdsXlater, const bool &calcOffsetOnly) |
| Handles the DataFilePointer keyword, aka ^QUBE or ^IMAGE. | |
| void | ProcessPixelBitandType (PvlTranslationManager &pdsXlater) |
| Handles PixelType and BitsPerPixel Calls SetPixelType with the correct values. | |
| void | ProcessSpecialPixels (PvlTranslationManager &pdsXlater, const bool &isQube) |
| Handles all special pixel setting, ultimately, calls SetSpecialValues. | |
| void | ProcessPdsImageLabel (const QString &pdsDataFile) |
| Process the PDS label of type IMAGE. | |
| void | ProcessPdsQubeLabel (const QString &pdsDataFile, const QString &transFile) |
| Process the PDS label of type QUBE or SPECTRALQUBE. | |
| void | ProcessPdsM3Label (const QString &pdsDataFile, PdsFileType fileType) |
| Process Chandrayaan M3 PDS label. | |
| void | ExtractPdsProjection (PvlTranslationManager &pdsXlater) |
| Extract all possible PDS projection parameters from the PDS label. | |
| void | GetProjectionOffsetMults (double &xoff, double &yoff, double &xmult, double &ymult) |
| Read mults and offsets from a def file in order to calculate the upper left x/y. | |
| void | IdentifySource (Pvl &lab) |
| Identify the source of this file PDS or ISIS2. | |
| void | TranslateIsis2BandBin (Pvl &lab) |
| Fill as many of the Isis3 BandBin labels as possible. | |
| void | TranslateIsis2Instrument (Pvl &lab) |
| Fill as many of the Isis3 instrument labels as possible. | |
| void | TranslatePdsBandBin (Pvl &lab) |
| Fill as many of the Isis3 BandBin labels as possible. | |
| void | TranslatePdsArchive (Pvl &lab) |
| Fill as many of the Isis3 BandBin labels as possible. | |
Private Attributes | |
| Pvl | p_pdsLabel |
| Internalized PDS label. | |
| QString | p_labelFile |
| The filename where the PDS label came from. | |
| QString | p_transDir |
| Base data directory. | |
| EncodingType | p_encodingType |
| The encoding type of the image data. | |
| QString | p_jp2File |
The name of the file containing the | |
| QString | p_projection |
The name of the projection found in | |
| QString | p_targetName |
| double | p_equatorialRadius |
Equatorial radius found in the PDS | |
| double | p_polarRadius |
The polar radius found in the PDS | |
| QString | p_longitudeDirection |
| Longitude direction found in the PDS projection labels. | |
| int | p_longitudeDomain |
Longitude domain found in the PDS | |
| QString | p_latitudeType |
The latitude type found in the PDS | |
| double | p_minimumLatitude |
Minimum latitude found in the PDS | |
| double | p_maximumLatitude |
Maximum latitude found in the PDS | |
| double | p_minimumLongitude |
Minimum longitude found in the PDS | |
| double | p_maximumLongitude |
Maximum longitude found in the PDS | |
| double | p_pixelResolution |
Pixel resolution found in the PDS | |
| double | p_scaleFactor |
The scale factor found in the PDS | |
| double | p_rotation |
The rotation found in the PDS | |
| double | p_sampleProjectionOffset |
| double | p_lineProjectionOffset |
| double | p_upperLeftX |
| double | p_upperLeftY |
| bool | p_keepOriginalLabel |
determines whether or not to keep the OriginalLabel blob. | |
| std::vector< Table > | p_tables |
| Vector of Isis Table objects that were imported from PDS and need to be added to the imported cube file. | |
| Source | p_source |
Convert PDS archive files to Isis format.
This class is used to import PDS archive files into Isis format. The class can handle PDS images, qubes and spectral cubes. It can also convert projection information if it exists.
Here is an example of how to use ProcessImportPds
2003-01-24 Tracie Sucharski - Fixed bug in processing 8bit data. In the Swap method needed to return unsigned char, not char.
2003-02-13 Stuart Sides - Added a unit test.
2003-05-16 Stuart Sides - Modified schema from astrogeology... isis.astrogeology...
2003-05-30 Stuart Sides - Fixed compiler error after -O1 flag was added to g++
2003-09-10 Tracie Sucharski - Complete redesign to handle different raw file formats.
2003-10-09 Stuart Sides - Added capabilities for reading PDS files
2003-10-10 Stuart Sides - Added capabilities to get the translation files from the user preferences BASE directory.
2003-10-10 Stuart Sides - Fixed bug for PDS files. When the image name was explicitly given the open statement was attempting to open the label file.
2003-10-16 Stuart Sides - Added a section for debuging all the parameters which can be set before processing starts.
2003-10-16 Stuart Sides - Added a second parameter to the Pvl constructor in SetVicarFile. This allows the vicar label to be read into a Pvl without modifying the repeated "PROPERTY" keyword.
2003-10-23 Stuart Sides - Added new member functions "AddImportLabel()" and "AddImportLabel(Pvl). AddImportLabel() uses the original label file to create a Pvl and write it to the output cube label. AddImportLabel(Pvl) uses the Pvl argument to write the import label to the output cube.
2004-01-21 Jeff Anderson - Modified SetOutputCube method to propagate the input pixel type, base, and multipliers to the output cube. The old method always generated real pixel values in the output.
2004-01-22 Jeff Anderson - Modified the SetVicarFile method to return the vicar labels internalized in a PVL object.
2004-02-04 Jeff Anderson - Modified SetPdsFile method to allow for SPECTRAL_QUBE objects to handle Themis data.
2004-02-10 Stuart Sides - Separated PDS capabilities from Import.
2005-02-09 Elizabeth Ribelin - Modified file to support Doxygen documentation
2006-06-13 Brendan George - Modified to add OriginalLabel blob automatically, and added a function to allow the user to prevent this.
2006-07-12 Stuart Sides - Modified the translation of projection keywords such as CenterLongitude, so the would not throw and error if the keywods was not a number. This was necessary because map a planet creates PDS labels with "N/A" in several keywords.
2006-10-26 Stuart Sides - Added unsigned 16 bit ability
2006-11-16 Brendan George - Changed instances of "Foreign" to "Input" and "Native" to "Output"
2007-01-24 Stuart Sides - Added ability to identify the difference between PDS and ISIS2 files, and process them differently.
2007-02-08 Brendan George - Fixed TranslateIsis2Instrument to remove the appended z in the StartTime keyword, if present.
2007-04-09 Tracie Sucharski - Added GetProjectionOffsetMults method which will find the correct multiplication factors for the projection offsets depending on the keyword and pattern in pdsProjectionLineSampToXY.def. Added IsIsis2 method. Made changes to projection translation tables for additional values for Longitude direction, latitude type and if the min or max longitude values is greater than 180, change longitude domain to 360.
2007-05-31 Steven Koechle -Moddified to assume all signed bytes input pixels are actually unsigned.
2007-06-04 Jeff Anderson - Modified to deal with projection conversion generically
2007-08-07 Steven Lambright - Modified to support translating some PDS labels for pds2isis and default longitude domain is now 360.
2007-08-29 Steven Koechle - Modified to use new SetSpecialValues method from ProcessImport
2007-10-16 Steven Koechle - Modified TranslatePdsProjection() to not add the min & max lat long keywords if they have null values.
2008-05-12 Steven Lambright - Removed references to CubeInfo
2008-06-13 Steven Lambright - Updated algorithm to decide domain and calculate correct longitudes in ExtractPdsProjection
2008-06-13 Noah Hild - Added support for the FILE object
2008-06-13 Steven Lambright - Updated ExtractPdsProjection to change the latitude type to planetocentric if both the planet radii are the same
2008-08-08 Steven Lambright - Fixed bug where the longitude keywords could be incorrecty interpretted (minumum longitude and maximum longitude are swapped).
2009-07-16 Steven Lambright - Fixed bug where the longitude is misordered
2009-12-15 Steven Lambright - Hard-coded translation table is now a valid Pvl
2009-12-18 Janet Barrett - Added capability to process JPEG2000 files with a detached PDS label
2010-08-23 Steven Lambright - Non-numeric string values for PDS projection rotations are now supported.
2010-08-27 Steven Lambright - Longitude domain correction added for center and pole longitude keywords in PDS projections
2010-11-17 Eric Hyer - Inside ProcessPdsImageLabel method Absolute paths are now supported for the ^IMAGE Keyword
2010-12-09 Sharmila Prasad - Set default offset to be 1 for detatched label and offset not set
2011-02-11 Mackenzie Boyd - Added methods ProcessDataFilePointer, ProcessPixelBitandType, and ProcessSpecialPixels, removed duplicate code in ProcessImage and ProcessQube labels. Fixed functionality regarding ^QUBE pointer having no offest.
2011-04-27 Mackenzie Boyd - Changed ProcessQubeLabels to set BIP for BANDSAMPLELINE axes instead of LINEBANDSAMPLE and added exception for unknown storage order.
2012-05-03 Tracie Sucharski - Added a try/catch in SetPdsFile when attempting to read PDS label
2012-11-21 Jeannie Backer - Added methods and member variables to import binary PDS tables found in the PDS file. Added a default destructor. References #700.
2013-03-12 Steven Lambright and Tracie Sucharski - Added ProcessPdsRdnLabel() to handle Chandrayaan M3 RDN files. Added a file type to handle Chandrayaan Loc and Obs files on the same import as the Rdn files. Also added support for 64 bit input data. Note: There may be loss of precision since the output type is 32-bit. Return reference to imported table. Needed so that M3 table data can be flipped to match image data depending on yaw and orbit limb direction.
2014-02-11 Janet Barrett - Created new version of SetPdsFile method so that calling applications can intercept the PDS label before it gets loaded by this class. This is needed so that missing keywords can be added to the PDS label by the application before it gets loaded. This also required moving some of the code from the SetPdsFile method to a new method, ProcessLabel. Fixes #2036.
2014-03-19 Kristin Berry - Added a Finalize method identical to the old EndProcess method so that ProcessImportPds::Finalize is called, rather than Process::Finalize on ProcessImportPds objects. Marked EndProcess as deprecated.
2015-01-19 Sasha Brownsberger - Made destructor virtual. References #2215.
Definition at line 213 of file ProcessImportPds.h.
|
inherited |
This enum includes how the document should be read: by BSQ, BIL, BIP, JP2, or InterleaveUndefined.
| Enumerator | |
|---|---|
| InterleaveUndefined |
Undefined. |
| JP2 |
Jpeg 2000 Format (always band sequential). |
| BSQ |
Band Sequential Format (i.e. Band Interleaved). The first line of data is followed immediately by the next line in the same spectral band. |
| BIL |
Band Interleaved By Line Format (i.e. Row Interleaved). The first line of data is followed immediately by the first line of data in the next band. |
| BIP |
Band Interleaved By Pixel Format (i.e. Pixel Interleaved). The first pixel for all bands is followed by the second pixel for all bands. |
Definition at line 240 of file ProcessImport.h.
| Isis::ProcessImportPds::ProcessImportPds | ( | ) |
Constructor.
Definition at line 53 of file ProcessImportPds.cpp.
References Isis::PvlObject::findGroup().
|
inlineinherited |
Returns the number of bands.
Definition at line 195 of file ProcessImport.h.
References Isis::ProcessImport::p_nb.
|
inlineinherited |
Get the vector of Statistics objects for each band separately of a specified input cube.
| index | The index of the input cube in InputCubes |
Definition at line 283 of file Process.h.
References Isis::Process::p_bandStats.
|
inlineinherited |
Returns the byte order.
Definition at line 205 of file ProcessImport.h.
References Isis::ProcessImport::p_byteOrder.
|
inherited |
Calculates and stores off statistics on every band of every cube added to this process via the SetInputCube method.
The newly calculated statistics are stored in two ways: as a vector where each entry is a single Statistics object for every band of a particular input cube, and as a vector where each entry is a vector of Statistics objects, for each band separately, of a particular input cube.
Definition at line 721 of file Process.cpp.
References Isis::Statistics::AddData(), Isis::Cube::bandCount(), Isis::Progress::CheckStatus(), Isis::Buffer::DoubleBuffer(), Isis::Cube::lineCount(), Isis::Cube::read(), Isis::LineManager::SetLine(), Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), Isis::Buffer::size(), and Isis::toString().
|
inherited |
Close owned cubes from the list and clear the list.
Definition at line 506 of file Process.cpp.
|
inherited |
Close owned input cubes from the list and clear the list.
Definition at line 516 of file Process.cpp.
Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::FileTool::saveAsReducedCube(), and Isis::ProcessMapMosaic::SetOutputCube().
|
inherited |
Close owned output cubes from the list and clear the list.
Definition at line 530 of file Process.cpp.
|
inlineinherited |
Get the Statistics object for all bands of a specified input cube.
| index | The index of the input cube in InputCubes |
Definition at line 297 of file Process.h.
References Isis::Process::p_cubeStats.
|
inherited |
This method returns a pointer to the data header.
A data header is a block of non-image data at the beginning of each data block (for BSQ data blocks are bands). This is not included in the file header and does not include any record headers, such as line prefixes. In order to retrieve this data, the data header bytes must be set and the data header must be saved via SetDataHeaderBytes() and SaveDataHeader(), respectively. This method must be called only after StartProcess() has returned and before EndProcess() is called.
| Isis::iException::Message | "Data header was not saved. Use SaveDataHeader()." |
Definition at line 646 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_dataHeader, Isis::ProcessImport::p_saveDataHeader, and Isis::IException::Programmer.
|
inherited |
This method returns the number of data header bytes.
Definition at line 545 of file ProcessImport.cpp.
References Isis::ProcessImport::p_dataHeaderBytes.
|
inherited |
This method returns a pointer to the data prefix.
A data prefix is a block of non-image data at the beginning of each data record (for BSQ data records are lines). This is not included in the file header or the data header. In order to retrieve this data, the data prefix bytes must be set and the data prefix must be saved via SetDataPrefixBytes() and SaveDataPrefix(), respectively. This method must be called only after StartProcess() has returned and before EndProcess() is called.
| Isis::iException::Message | "Data prefix was not saved. Use SaveDataPrefix()." |
Definition at line 702 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_dataPre, Isis::ProcessImport::p_saveDataPre, and Isis::IException::Programmer.
|
inherited |
This method returns the number of data prefix bytes.
Definition at line 561 of file ProcessImport.cpp.
References Isis::ProcessImport::p_dataPreBytes.
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
|
inherited |
This method returns a pointer to the data suffix.
A data suffix is a block of non-image data at the end of each data record (for BSQ data records are lines). This is not included in the file trailer or the data trailer. In order to retrieve this data, the data suffix bytes must be set and the data suffix must be saved via SetDataSuffixBytes() and SaveDataSuffix(), respectively. This method must be called only after StartProcess() has returned and before EndProcess() is called.
| Isis::iException::Message | "Data suffix was not saved. Use SaveDataSuffix()." |
Definition at line 730 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_dataPost, Isis::ProcessImport::p_saveDataPost, and Isis::IException::Programmer.
|
inherited |
This method returns the number of data duffix bytes.
Definition at line 569 of file ProcessImport.cpp.
References Isis::ProcessImport::p_dataPostBytes.
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
|
inherited |
This method returns a pointer to the data trailer.
A data trailer is a block of non-image data at the end each data block (for BSQ data blocks are bands). This is not included in the file trailer and does not include any record trailers, such as line suffixes. In order to retrieve this data, the data trailer bytes must be set and the data trailer must be saved via SetDataTrailerBytes() and SaveDataTrailer(), respectively. This method must be called only after StartProcess() has returned and before EndProcess() is called.
| Isis::iException::Message | "Data trailer was not saved. Use SaveDataTrailer()." |
Definition at line 674 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_dataTrailer, Isis::ProcessImport::p_saveDataTrailer, and Isis::IException::Programmer.
|
inherited |
This method returns the number of data trailer bytes.
Definition at line 553 of file ProcessImport.cpp.
References Isis::ProcessImport::p_fileTrailerBytes.
|
virtual |
Reimplemented from Isis::Process.
Definition at line 1222 of file ProcessImportPds.cpp.
|
private |
Extract all possible PDS projection parameters from the PDS label.
| pdsXlater |
| Isis::iException::Message |
2007-04-12 Tracie Sucharski - Modified the projection translation tables to include additional versions of Longitude direction, latitude type and if the min or max longitude values is greater than 180, change longitude domain to 360. Read projection mults/offsets from def file so lat/lon values are correct.
2007-07-12 Stuart Sides- Modified to handle units of meters on the pixel resolution
2008-06-09 Tracie Sucharski, Added MinimumLongitude2 and MaximumLongitude2 for Magellan images.
The input file does not have a longitude domain. We need to figure it out!
The current process is two-step. First, we use the longitude direction to swap into what should be the proper order of min,max longitude. Then, if the values are still misordered, we have a 180 domain projection. Try converting the minimum to 180 domain, which hopefully results in ordering the min,max properly. Only do this to the minimum because if they are out of order, then it must be something like 330-30 which needs to be -30-30.
pdsImageProjection.trn assumes EasternMost is the MINIMUM, which is PositiveWest. For a PositiveEast image this swap should occur. On a PositiveWest image this swap should not occur.
Definition at line 1004 of file ProcessImportPds.cpp.
References _FILEINFO_, Isis::PvlTranslationManager::InputHasKeyword(), Isis::PvlTranslationManager::InputKeyword(), Isis::TProjection::To180Domain(), Isis::toDouble(), Isis::toInt(), Isis::PvlTranslationManager::Translate(), and Isis::PvlKeyword::unit().
|
inherited |
This method returns a pointer to the file header.
A file header is a block of non-image data at the beginning of the entire file. This does not include any section headers, such as band headers or line prefixes. In order to retrieve this data, the file header bytes must be set and the file header must be saved via SetFileHeaderBytes() and SaveFileHeader(), respectively. This method must be called only after StartProcess() has returned and before EndProcess() is called.
| Isis::iException::Message | "File header was not saved. Use SaveFileHeader()." |
Definition at line 592 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_fileHeader, Isis::ProcessImport::p_saveFileHeader, and Isis::IException::Programmer.
|
inherited |
This method returns the number of file header bytes.
Definition at line 529 of file ProcessImport.cpp.
References Isis::ProcessImport::p_fileHeaderBytes.
|
inherited |
This method returns a pointer to the file trailer.
A file trailer is a block of non-image data at the end of the entire file. This does not include any section trailers, such as band trailers or line suffixes. In order to retrieve this data, the file trailer bytes must be set and the file trailer must be saved via SetFileTrailerBytes() and SaveFileTrailer(), respectively. This method must be called only after StartProcess() has returned and before EndProcess() is called.
| Isis::iException::Message | "File trailer was not saved. Use SaveFileTrailer()." |
Definition at line 618 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_fileTrailer, Isis::ProcessImport::p_saveFileTrailer, and Isis::IException::Programmer.
|
inherited |
This method returns the number of file trailer bytes.
Definition at line 537 of file ProcessImport.cpp.
References Isis::ProcessImport::p_fileTrailerBytes.
|
virtual |
End the processing sequence and cleans up by closing cubes, freeing memory, etc.
Adds the OriginalLabel data to the end of the cube file, unless OmitOriginalLabel() has been called.
Reimplemented from Isis::Process.
Definition at line 1232 of file ProcessImportPds.cpp.
|
private |
Read mults and offsets from a def file in order to calculate the upper left x/y.
| [out] | xoff | (double &) x offset |
| [out] | yoff | (double &) y offset |
| [out] | xmult | (double &) x multiplicative factor |
| [out] | ymult | (double &) y multiplicative factor |
Definition at line 1424 of file ProcessImportPds.cpp.
References Isis::PvlObject::findObject(), Isis::PvlObject::group(), and Isis::PvlObject::groups().
|
private |
Identify the source of this file PDS or ISIS2.
| inputLabel | The label from the input file. |
Definition at line 1258 of file ProcessImportPds.cpp.
References Isis::PvlTranslationManager::InputHasKeyword().
| Table & Isis::ProcessImportPds::ImportTable | ( | QString | pdsTableName | ) |
This method will import the PDS table with the given name into an Isis Table object.
The table will be added to the cube file in the call to StartProcess().
| pdsTableName | Name of the PDS table object to be imported. |
Definition at line 1463 of file ProcessImportPds.cpp.
References Isis::ImportPdsTable::getFormattedName(), and Isis::ImportPdsTable::importTable().
|
inherited |
Sets the name of the input file to be read in the import StartProcess method and verifies its existance.
| file | The name of the input file to import. |
| Isis::iException::Message | "File does not exist." |
Definition at line 2080 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_inFile, and Isis::IException::Programmer.
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
| bool Isis::ProcessImportPds::IsIsis2 | ( | ) |
Return true if ISIS2 cube, else return false.
Definition at line 1296 of file ProcessImportPds.cpp.
|
inlineinherited |
Returns the number of lines.
Definition at line 187 of file ProcessImport.h.
References Isis::ProcessImport::p_nl.
|
inherited |
This method reads the mission specific data directory from the user preference file, makes sure that mission is available in the Isis installation, and the attaches the provided input file to the directory in order to create a full file specification.
| mission | Name of the mission data directory |
| file | Name of the file to attach to the end of the directory |
| highestVersion | If set to true the method will return the highest version number of the given file. Therefore, file must contain question marks such as "file???.dat". See the FileName class for more information on versioned files. Defaults to false. |
Definition at line 666 of file Process.cpp.
References _FILEINFO_, and Isis::PvlObject::findGroup().
| void Isis::ProcessImportPds::OmitOriginalLabel | ( | ) |
Prevents the Original Label blob from being written out to the end of the cube.
Definition at line 1247 of file ProcessImportPds.cpp.
|
inherited |
Gets the organization of the input cube.
Definition at line 755 of file ProcessImport.cpp.
References Isis::ProcessImport::p_organization.
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
|
inlineinherited |
Returns the pixel type.
Definition at line 170 of file ProcessImport.h.
References Isis::ProcessImport::p_pixelType.
|
private |
Handles the DataFilePointer keyword, aka ^QUBE or ^IMAGE.
There are two side effects of this method, those are SetInputFile and SetFileHeaderBytes, both are called during this method. Will not do SetInputFile if calcOffsetOnly is true
Definition at line 269 of file ProcessImportPds.cpp.
References _FILEINFO_, Isis::PvlTranslationManager::InputKeyword(), Isis::FileName::path(), Isis::PvlKeyword::size(), Isis::toInt(), Isis::PvlTranslationManager::Translate(), and Isis::PvlKeyword::unit().
| void Isis::ProcessImportPds::ProcessLabel | ( | const QString & | pdsDataFile, |
| PdsFileType | allowedTypes | ||
| ) |
Load the PDS labels after determining what type of data file was provided.
This code used to be part of the SetPdsFile method, but had to be moved to a separate method in order to allow calling applications to intercept the PDS labels before this method loaded them. This was necessary to fix problems in PDS labels such as adding missing keywords.
| pdsDataFile | The name of the PDS data file where the actual image/cube data is stored. This parameter can be an empty QString, in which case the label information will be searched to find the data file name or the data will be assumed to be after the label information. |
| Isis::iException::Message |
Definition at line 148 of file ProcessImportPds.cpp.
References _FILEINFO_, Isis::PvlTranslationManager::InputHasKeyword(), Isis::FileName::path(), and Isis::PvlTranslationManager::Translate().
|
private |
Process the PDS label of type IMAGE.
| pdsDataFile | The name of the PDS data file where the actual image/cube data is stored. This parameter can be an empty QString, in which case the label information will be searched to find the data file name or the data will be assumed to be after the label information. |
| Isis::iException::Message |
Definition at line 499 of file ProcessImportPds.cpp.
References _FILEINFO_, Isis::toDouble(), Isis::toInt(), and Isis::PvlTranslationManager::Translate().
|
private |
Process Chandrayaan M3 PDS label.
| pdsDataFile | The name of the PDS data file where the actual image/cube data is stored. This parameter can be an empty QString, in which case the label information will be searched to find the data file name or the data will be assumed to be after the label information. |
| Isis::iException::Message |
Definition at line 751 of file ProcessImportPds.cpp.
References _FILEINFO_, Isis::toDouble(), Isis::toInt(), and Isis::PvlTranslationManager::Translate().
|
private |
Process the PDS label of type QUBE or SPECTRALQUBE.
| pdsDataFile | The name of the PDS data file where the actual image/cube data is stored. This parameter can be an empty QString, in which case the label information will be searched to find the data file name or the data will be assumed to be after the label information. |
| transFile |
| Isis::iException::Message |
Definition at line 596 of file ProcessImportPds.cpp.
References _FILEINFO_, Isis::PvlTranslationManager::InputKeyword(), Isis::PvlKeyword::size(), Isis::toDouble(), and Isis::toInt().
|
private |
Handles PixelType and BitsPerPixel Calls SetPixelType with the correct values.
Definition at line 368 of file ProcessImportPds.cpp.
References _FILEINFO_, Isis::toInt(), Isis::toString(), and Isis::PvlTranslationManager::Translate().
|
private |
Handles all special pixel setting, ultimately, calls SetSpecialValues.
Definition at line 411 of file ProcessImportPds.cpp.
References Isis::His, Isis::Hrs, Isis::PvlTranslationManager::InputHasKeyword(), Isis::Lis, Isis::Lrs, Isis::toDouble(), and Isis::PvlTranslationManager::Translate().
|
inlineinherited |
This method returns a pointer to a Progress object.
Definition at line 263 of file Process.h.
References Isis::Process::p_progress.
Referenced by Isis::Equalization::calculateStatistics(), Isis::ProcessMapMosaic::RingsSetOutputCube(), and Isis::ProcessMapMosaic::SetOutputCube().
|
inherited |
This method allows the programmer to propagate history to the output cube (default is true)
| prop | Flag indicating if history is to be propagated to output cubes. |
Definition at line 635 of file Process.cpp.
Referenced by 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. |
Definition at line 552 of file Process.cpp.
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. |
Definition at line 563 of file Process.cpp.
References Isis::PvlObject::addGroup(), Isis::PvlObject::addObject(), Isis::PvlObject::findObject(), Isis::PvlObject::group(), Isis::PvlObject::groups(), and Isis::PvlObject::hasObject().
|
inherited |
This method allows the programmer to propagate original labels to the output cube (default is true)
| prop | Flag indicating if original labels is to be propagated to output cubes. |
Definition at line 646 of file Process.cpp.
Referenced by 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. |
Definition at line 625 of file Process.cpp.
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. |
Definition at line 591 of file Process.cpp.
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.
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().
|
inlineinherited |
Returns the number of samples.
Definition at line 179 of file ProcessImport.h.
References Isis::ProcessImport::p_ns.
|
inherited |
This method marks the data block headers to be saved.
A data header is a block of non-image data at the beginning of each data block (for BSQ data blocks are bands). This is not included in the file header and does not include any record headers, such as line prefixes. Each of the header blocks will be saved inside StartProcess(). It must be called after setting the size with SetDataHeaderBytes() and before StartProcess() is called. This data will only be available via DataHeader() after StartProcess() has returned and before EndProcess() is called.
| Isis::iException::Message | "Data header bytes equals 0. There is nothing to save. Use SetDataHeaderBytes() first." |
Definition at line 429 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_dataHeaderBytes, Isis::ProcessImport::p_saveDataHeader, and Isis::IException::Programmer.
|
inherited |
This method marks the data prefix to be saved.
A data prefix is a block of non-image data at the beginning of each data record (for BSQ data records are lines). This is not included in the file header or the data header. Each of the data prefixes will be saved inside StartProcess(). It must be called after setting the size with SetDataPrefixBytes() and before StartProcess() is called. This data will only be available via DataPrefix() after StartProcess() has returned and before EndProcess() is called.
| Isis::iException::Message | "Data prefix bytes equals 0. There is nothing to save. Use SetDataPrefixBytes() first." |
Definition at line 486 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_dataPreBytes, Isis::ProcessImport::p_saveDataPre, and Isis::IException::Programmer.
|
inherited |
This method marks the data suffix to be saved.
A data suffix is a block of non-image data at the end of each data record (for BSQ data records are lines). This is not included in the file trailer or the data trailer. Each of the data suffixes will be saved inside StartProcess(). It must be called after setting the size with SetDataPrefixBytes() and before StartProcess() is called. This data will only be available via DataPrefix() after StartProcess() has returned and before EndProcess() is called.
| Isis::iException::Message | "Data suffix bytes equals 0. There is nothing to save. Use SetDataSuffixBytes() first." |
Definition at line 515 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_dataPostBytes, Isis::ProcessImport::p_saveDataPost, and Isis::IException::Programmer.
|
inherited |
This method marks the data block trailers to be saved.
A data trailer is a block of non-image data at the end of each data block (for BSQ data blocks are bands). This is not included in the file trailer and does not include any record trailers, such as line suffixes. Each of the trailer blocks will be saved inside StartProcess(). It must be called after setting the size with SetDataTrailerBytes() and before StartProcess() is called. This data will only be available via DataTrailer() after StartProcess() has returned and before EndProcess() is called.
| Isis::iException::Message | "Data trailer bytes equals 0. There is nothing to save. Use SetDataTrailerBytes() first." |
Definition at line 458 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_dataTrailerBytes, Isis::ProcessImport::p_saveDataTrailer, and Isis::IException::Programmer.
|
inherited |
This method marks the file header to be saved.
A file header is a block of non-image data at the beginning of the entire file. This does not include any section headers, such as band headers or line prefixes. The file header will be saved inside StartProcess(). It must be called after setting the size with SetFileHeaderBytes() and before StartProcess() is called. This data will only be available via FileHeader() after StartProcess() has returned and before EndProcess() is called.
| Isis::iException::Message | "File header bytes equals 0. There is nothing to save. Use SetFileHeaderBytes() first." |
Definition at line 373 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_fileHeaderBytes, Isis::ProcessImport::p_saveFileHeader, and Isis::IException::Programmer.
|
inherited |
This method marks the file trailer to be saved.
A file trailer is a block of non-image data at the end of the entire file. This does not include any section trailers, such as band trailers or line suffixes. The file trailer will be saved inside StartProcess(). It must be called after setting the size with SetFileTrailerBytes() and before StartProcess() is called. This data will only be available via FileTrailer() after StartProcess() has returned and before EndProcess() is called.
| Isis::iException::Message | "File trailer bytes equals 0. There is nothing to save. Use SetFileTrailerBytes() first." |
Definition at line 400 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_fileTrailerBytes, Isis::ProcessImport::p_saveFileTrailer, and Isis::IException::Programmer.
|
inherited |
Sets the core base of the input cube.
Defaults to zero if not invoked.
| base | Core base |
Definition at line 765 of file ProcessImport.cpp.
References Isis::ProcessImport::p_base.
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
|
inherited |
Sets band dependent core base.
| base | A vector containing the base for each band. |
Definition at line 776 of file ProcessImport.cpp.
References Isis::ProcessImport::p_base.
|
inherited |
Sets the byte order of the input file.
This must be invoked prior to SetOutputCube.
| order | The enumerated byte order Isis::Lsb or Isis::Msb |
Definition at line 170 of file ProcessImport.cpp.
References Isis::ProcessImport::p_byteOrder.
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
|
inherited |
This method sets the number of bytes in the header of each datablock of a file.
A data header is a block of non-image data at the beginning of each data block (for BSQ data blocks are bands). This is not included in the file header and does not include any record headers, such as line prefixes. It must be called before StartProcess(). This data will only be available if saved via SaveDataHeader() and may be accessed via DataHeader() after StartProcess() has returned and before EndProcess() is called. If not invoked the default is 0.
| bytes | Number of bytes |
| Isis::iException::Message | "Illegal data header size." (when bytes < 0) |
Definition at line 254 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_dataHeaderBytes, Isis::IException::Programmer, and Isis::toString().
|
inherited |
This method sets the number of bytes at the beginning of each data record of a file.
A data prefix is a block of non-image data at the beginning of each data record (for BSQ data records are lines). This is not included in the file header or the data header. It must be called before StartProcess(). This data will only be available if saved via SaveDataPrefix() and may be accessed via DataPrefix() after StartProcess() has returned and before EndProcess() is called. If not invoked the default is 0.
| bytes | Number of bytes |
| Isis::iException::Message | "Illegal data prefix size." (when bytes < 0) |
Definition at line 314 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_dataPreBytes, Isis::IException::Programmer, and Isis::toString().
|
inherited |
This method sets the number of bytes at the end of each data record of a file.
A data suffix is a block of non-image data at the end of each data record (for BSQ data records are lines). This is not included in the file trailer or the data trailer. It must be called before StartProcess(). This data will only be available if saved via SaveDataSuffix() and may be accessed via DataSuffix() after StartProcess() has returned and before EndProcess() is called. If not invoked the default is 0.
| bytes | Number of bytes |
| Isis::iException::Message | "Illegal data suffix size." (when bytes < 0) |
Definition at line 344 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_dataPostBytes, Isis::IException::Programmer, and Isis::toString().
|
inherited |
This method sets the number of bytes in the trailer of each datablock of a file.
A data trailer is a block of non-image data at the end of each data block (for BSQ data blocks are bands). This is not included in the file trailer and does not include any record trailers, such as line suffixes. It must be called before StartProcess(). This data will only be available if saved via SaveDataTrailer() and may be accessed via DataTrailer() after StartProcess() has returned and before EndProcess() is called. If not invoked the default is 0.
| bytes | Number of bytes |
| Isis::iException::Message | "Illegal data trailer size." (when bytes < 0) |
Definition at line 284 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_dataTrailerBytes, Isis::IException::Programmer, and Isis::toString().
|
inherited |
Sets the physical size of the input cube.
This must be invoked prior to setOutputCube.
| ns | Number of samples |
| nl | Number of lines |
| nb | Number of bands |
| Isis::iException::Message | "Illegal dimension." |
Definition at line 150 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_nb, Isis::ProcessImport::p_nl, Isis::ProcessImport::p_ns, Isis::IException::Programmer, and Isis::toString().
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
|
inherited |
This method sets the number of bytes in the header of a file.
The file header is a block of non-image data at the beginning of the entire file. This does not include any section headers, such as band headers or line prefixes. Typically it is used to delineate the boundary of the binary or ascii labels. It must be called before StartProcess(). This data will only be available if saved via SaveFileHeader() and may be accessed via FileHeader() after StartProcess() has returned and before EndProcess() is called. If not invoked the default is 0.
| bytes | Number of bytes |
| Isis::iException::Message | "Illegal file header size." (when bytes < 0) |
Definition at line 195 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_fileHeaderBytes, Isis::IException::Programmer, and Isis::toString().
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
|
inherited |
This method sets the number of bytes in the trailer of a file.
The trailer is a block of non-image data at the end of the entire file. This does not include any section trailers, such as band trailers or line suffixes. It must be called before StartProcess(). This data will only be available if saved via SaveFileTrailer() and may be accessed via FileTrailer() after StartProcess() has returned and before EndProcess() is called. If not invoked the default is 0.
| bytes | Number of bytes |
| Isis::iException::Message | "Illegal file trailer size." (when bytes < 0) |
Definition at line 225 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_fileTrailerBytes, Isis::IException::Programmer, and Isis::toString().
|
inherited |
Sets the range that will be considered Isis::Null.
| his_min | The double precision value used to identify the min range of his pixels in the image being imported. |
| his_max | The double precision value used to identify the max range of his pixels in the image being imported. |
Definition at line 909 of file ProcessImport.cpp.
References Isis::ProcessImport::CheckPixelRange(), Isis::ProcessImport::p_his_max, and Isis::ProcessImport::p_his_min.
Referenced by Isis::ProcessImport::ProcessImport(), and Isis::ProcessImport::SetSpecialValues().
|
inherited |
Sets the range that will be considered Isis::Null.
| hrs_min | The double precision value used to identify the min range of hrs pixels in the image being imported. |
| hrs_max | The double precision value used to identify the max range of hrs pixels in the image being imported. |
Definition at line 892 of file ProcessImport.cpp.
References Isis::ProcessImport::CheckPixelRange(), Isis::ProcessImport::p_hrs_max, and Isis::ProcessImport::p_hrs_min.
Referenced by Isis::ProcessImport::ProcessImport(), and Isis::ProcessImport::SetSpecialValues().
|
virtualinherited |
Opens an input cube specified by the user and verifies requirements are met.
| parameter | User parameter to obtain file to open. Typically, the value is "FROM". For example, the user can specify on the command line FROM=myfile.cub and this method will attempt to open the cube "myfile.cub" if the parameter was set to "FROM". |
| requirements | Use to specify requirements for the input file. The following are requirments are checked against 1) ic_base::SizeMatch checks to make sure the input cube has the same bands, samples, and lines as the first input cube open using this method, 2) ic_base::SpatialMatch checks to make sure the input cube has the same samples and lines as the first input cube, 3) ic_base::Georeferenced checks to make sure latitude/longitudes can be obtained from the input cube, 4) ic_base::FullyGeoreferenced checks to make sure latitude/longitude, phase/incidence/emission, and other geometric parameters can be obtained from the input cube, 5) ic_base::OneBand checks to make sure the input cube has exactly one band. Note, that these requirements can be logically or'ed. For example, ic_base::SpatialMatch | ic_base::georeferenced. Defaults to 0 |
| Isis::iException::Message |
Reimplemented in Isis::ProcessByBrick, Isis::ProcessByLine, Isis::ProcessBySpectra, and Isis::ProcessBySample.
Definition at line 243 of file Process.cpp.
Referenced by Isis::ImageExporter::addChannel(), Isis::FileTool::saveAsEnlargedCube(), and Isis::ProcessGroundPolygons::SetStatCubes().
|
virtualinherited |
Opens an input cube specified by the programmer and verifies requirements are met.
| fname | Programmer specified work file. For example, "myfile.cub". |
| att | The cube attributes to use when opening the input cube. |
| requirements | Same as requirements on SetInputCube. See that method for more details. Defaults to 0 |
| Isis::iException::Message |
Reimplemented in Isis::ProcessByBrick.
Definition at line 82 of file Process.cpp.
References _FILEINFO_, Isis::Cube::bandCount(), Isis::CubeAttributeInput::bands(), Isis::Cube::lineCount(), Isis::Cube::open(), Isis::Cube::sampleCount(), and Isis::Cube::setVirtualBands().
|
virtualinherited |
Set the InputCube vector to an opened Cube which was dynamically allocated.
This is used if there already exists a valid opened cube
| inCube | - Pointer to input Cube |
Reimplemented in Isis::ProcessByLine.
Definition at line 201 of file Process.cpp.
References _FILEINFO_, and Isis::Cube::isOpen().
|
inherited |
Sets the name of the input file to be read in the import StartProcess method and verifies its existance.
| file | The name of the input file to import. |
| Isis::iException::Message | "File does not exist." |
Definition at line 2063 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_inFile, and Isis::IException::User.
Referenced by Isis::ProcessImportFits::setFitsFile().
|
inherited |
Sets the range that will be considered Isis::Null.
| lis_min | The double precision value used to identify the min range of lis pixels in the image being imported. |
| lis_max | The double precision value used to identify the max range of lis pixels in the image being imported. |
Definition at line 875 of file ProcessImport.cpp.
References Isis::ProcessImport::CheckPixelRange(), Isis::ProcessImport::p_lis_max, and Isis::ProcessImport::p_lis_min.
Referenced by Isis::ProcessImport::ProcessImport(), and Isis::ProcessImport::SetSpecialValues().
|
inherited |
Sets the range that will be considered Isis::Null.
| lrs_min | The double precision value used to identify the min range of lrs pixels in the image being imported. |
| lrs_max | The double precision value used to identify the max range of lrs pixels in the image being imported. |
Definition at line 858 of file ProcessImport.cpp.
References Isis::ProcessImport::CheckPixelRange(), Isis::ProcessImport::p_lrs_max, and Isis::ProcessImport::p_lrs_min.
Referenced by Isis::ProcessImport::ProcessImport(), and Isis::ProcessImport::SetSpecialValues().
|
inherited |
Sets the core multiplier of the input cube.
Defaults to one if not invoked.
| mult | Core base |
Definition at line 786 of file ProcessImport.cpp.
References Isis::ProcessImport::p_mult.
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
|
inherited |
Sets band dependent core multiplier.
| mult | A vector containing the multiplier for each band. |
Definition at line 797 of file ProcessImport.cpp.
References Isis::ProcessImport::p_mult.
|
inherited |
Sets the range that will be considered Isis::Null.
| null_min | The double precision value used to identify the min range of null pixels in the image being imported. |
| null_max | The double precision value used to identify the max range of null pixels in the image being imported. |
Definition at line 841 of file ProcessImport.cpp.
References Isis::ProcessImport::CheckPixelRange(), Isis::ProcessImport::p_null_max, and Isis::ProcessImport::p_null_min.
Referenced by Isis::ProcessImport::ProcessImport(), and Isis::ProcessImport::SetSpecialValues().
|
inherited |
Sets the organization of the input cube.
If not invoked it is assumed Isis::Import::Bsq.
| org | The enumerated organizations either Isis::Import::Bsq Isis::Import::Bil or Isis::Import::Bip |
Definition at line 746 of file ProcessImport.cpp.
References Isis::ProcessImport::p_organization.
|
virtualinherited |
Create the output file.
Note that all the appropiate calls to at least SetDimensions and SetPixelType should be made prior to calling this method.
| parameter | The parameter name that holds the output file name. |
| Isis::iException::Message | "Unsupported pixel type." |
Reimplemented from Isis::Process.
Definition at line 1026 of file ProcessImport.cpp.
References _FILEINFO_, IsisAml::GetOutputAttribute(), Isis::Application::GetUserInterface(), Isis::ProcessImport::p_base, Isis::ProcessImport::p_mult, Isis::ProcessImport::p_nb, Isis::ProcessImport::p_nl, Isis::ProcessImport::p_ns, Isis::ProcessImport::p_pixelType, Isis::PixelTypeName(), Isis::IException::Programmer, Isis::CubeAttributeOutput::propagateMinimumMaximum(), Isis::CubeAttributeOutput::propagatePixelType(), Isis::CubeAttributeOutput::setMaximum(), Isis::CubeAttributeOutput::setMinimum(), Isis::Process::SetOutputCube(), and Isis::CubeAttributeOutput::setPixelType().
|
virtualinherited |
Create the output file.
Note that all the appropiate calls to at least SetDimensions should be invoked prior to calling this method.
| fname | The output file name. |
| att | An output cube attribute to define the characteristics of the output cube. |
| Isis::iException::Message | "File is not in a supported organization." |
Definition at line 1088 of file ProcessImport.cpp.
References Isis::ProcessImport::p_nb, Isis::ProcessImport::p_nl, Isis::ProcessImport::p_ns, and Isis::Process::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 |
Definition at line 302 of file Process.cpp.
References _FILEINFO_.
|
virtualinherited |
Allocates a output cube whose name and size is specified by the programmer.
| fname | Name of the output cube to allocate |
| att | The cube attributes to use when creating the output cube. |
| ns | Number of samples to allocate |
| nl | Number of lines to allocate |
| nb | Number of bands to allocate |
| Isis::iException::Message |
Definition at line 334 of file Process.cpp.
References _FILEINFO_, Isis::PvlObject::addGroup(), Isis::PvlObject::addObject(), Isis::AttachedLabel, Isis::CubeAttributeOutput::byteOrder(), Isis::Cube::create(), Isis::CubeAttributeOutput::fileFormat(), Isis::PvlObject::findObject(), Isis::PvlObject::group(), Isis::PvlObject::groups(), Isis::PvlContainer::isNamed(), Isis::Cube::label(), Isis::Cube::labelSize(), Isis::CubeAttributeOutput::maximum(), Isis::CubeAttributeOutput::minimum(), Isis::PvlContainer::name(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Cube::pixelType(), Isis::CubeAttributeOutput::pixelType(), Isis::CubeAttributeOutput::propagateMinimumMaximum(), Isis::CubeAttributeOutput::propagatePixelType(), Isis::Cube::setBaseMultiplier(), Isis::Cube::setByteOrder(), Isis::Cube::setDimensions(), Isis::Cube::setFormat(), Isis::Cube::setLabelsAttached(), Isis::Cube::setLabelSize(), Isis::Cube::setMinMax(), Isis::Cube::setPixelType(), and Isis::Cube::write().
| void Isis::ProcessImportPds::SetPdsFile | ( | const QString & | pdsLabelFile, |
| const QString & | pdsDataFile, | ||
| Isis::Pvl & | pdsLabel, | ||
| PdsFileType | allowedTypes = All |
||
| ) |
Set the input label file, data file and initialize a Pvl with the PDS labels.
| pdsLabelFile | The name of the PDS label file.This must be the file where the label is. It can be an attached or detached label. |
| pdsDataFile | The name of the PDS data file where the actual image/cube data is stored. This parameter can be an empty QString, in which case the label information will be searched to find the data file name or the data will be assumed to be after the label information. |
| pdsLabel | The label from the input PDS/Isis2 file |
| Isis::iException::Message |
Definition at line 110 of file ProcessImportPds.cpp.
References _FILEINFO_, and Isis::Pvl::read().
| void Isis::ProcessImportPds::SetPdsFile | ( | const Pvl & | pdsLabelPvl, |
| const QString & | pdsDataFile, | ||
| PdsFileType | allowedTypes = All |
||
| ) |
Set the input label PVL and data file and initialize a Pvl with the PDS labels.
This method was written to allow the calling application to intercept the PDS labels and make any modifications to them necessary (such as adding missing keywords like TARGET_NAME) before this class loads them. See the kaguyatc2isis program for an example.
| pdsLabelPvl | The PVL containing the PDS label. |
| pdsDataFile | The name of the PDS data file where the actual image/cube data is stored. This parameter cannot be empty. |
| Isis::iException::Message |
Definition at line 82 of file ProcessImportPds.cpp.
|
inherited |
Sets the pixel type of the input file.
| type | The enumerated pixel type Isis::Real, Isis::SignedWord, or Isis::UnsignedByte. This must be invoked prior to setOutputCube |
| Isis::iException::Message | "Unsupported pixel type." |
Definition at line 124 of file ProcessImport.cpp.
References _FILEINFO_, Isis::ProcessImport::p_pixelType, Isis::PixelTypeName(), and Isis::IException::Programmer.
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
|
inherited |
Sets a mapping of input pixel values to output special pixel values.
| null | The double precision value used to identify null pixels in the image being imported. |
| lrs | The double precisiion value used to identify low representation saturation LRS pixels in the image being imported. |
| lis | The double precision value used to identify low instrument saturation LIS pixels in the image being imported. |
| hrs | The double precision value used to identify high representation saturation HRS pixels in the image being imported. |
| his | The double precision value used to identify high instrument saturation HIS pixels in the image being imported. |
Definition at line 820 of file ProcessImport.cpp.
References Isis::ProcessImport::SetHIS(), Isis::ProcessImport::SetHRS(), Isis::ProcessImport::SetLIS(), Isis::ProcessImport::SetLRS(), and Isis::ProcessImport::SetNull().
|
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 |
|
virtual |
This method will write the cube and table data to the output cube.
Reimplemented from Isis::ProcessImport.
Definition at line 1485 of file ProcessImportPds.cpp.
|
virtual |
Process the input file and send data to a method for specialized processing.
The method is expected to write the data after it has processed it if necessary.
| funct | Method that accepts Isis::Buffer as an input parameter, processes the image, and has no return value. |
| Isis::iException::Message | "File is not a supported organization." |
Reimplemented from Isis::ProcessImport.
Definition at line 1504 of file ProcessImportPds.cpp.
|
inherited |
Tests the pixel.
If it is valid it will return the dn value, otherwise it will return the Isis special pixel value that corresponds to it
| pixel | The double precision value that represents a pixel. |
Definition at line 994 of file ProcessImport.cpp.
References Isis::ProcessImport::p_his_min, Isis::ProcessImport::p_hrs_min, Isis::ProcessImport::p_lis_min, Isis::ProcessImport::p_lrs_min, and Isis::ProcessImport::p_null_min.
Referenced by Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), and Isis::ProcessImport::ProcessJp2().
|
private |
Fill as many of the Isis3 BandBin labels as possible.
| lab | The lable where the translated Isis2 keywords will be placed |
Definition at line 1339 of file ProcessImportPds.cpp.
References Isis::PvlObject::findGroup().
|
private |
Fill as many of the Isis3 instrument labels as possible.
| lab | The label where the tramslated Isis2 keywords will be placed |
Definition at line 1358 of file ProcessImportPds.cpp.
References Isis::PvlObject::findGroup(), and Isis::PvlContainer::hasKeyword().
| void Isis::ProcessImportPds::TranslateIsis2Labels | ( | Isis::Pvl & | lab | ) |
Translate as many of the ISIS2 labels as possible.
| lab | The label where the translated Isis2 keywords will be placed |
Definition at line 1314 of file ProcessImportPds.cpp.
|
private |
Fill as many of the Isis3 BandBin labels as possible.
| lab | The lable where the translated PDS keywords will be placed |
Definition at line 1402 of file ProcessImportPds.cpp.
|
private |
Fill as many of the Isis3 BandBin labels as possible.
| lab | The lable where the translated PDS keywords will be placed |
Definition at line 1386 of file ProcessImportPds.cpp.
| void Isis::ProcessImportPds::TranslatePdsLabels | ( | Isis::Pvl & | lab | ) |
Translate as many of the PDS labels as possible.
| lab | The label where the translated Isis2 keywords will be placed |
Definition at line 1327 of file ProcessImportPds.cpp.
| void Isis::ProcessImportPds::TranslatePdsProjection | ( | Isis::Pvl & | lab | ) |
Fills the passed in label with the projection information from the PDS label file.
The application must write add the projection parameters to the output cube if desired.
| lab | The label where the projection parameters will be placed. |
Definition at line 861 of file ProcessImportPds.cpp.
References Isis::PvlObject::addGroup(), Isis::PvlObject::findGroup(), Isis::PvlTranslationManager::InputHasKeyword(), and Isis::toString().
|
inherited |
Writes out the History blob to the cube.
Definition at line 687 of file Process.cpp.
References Isis::History::AddEntry(), Isis::PvlContainer::isNamed(), Isis::PvlObject::object(), Isis::PvlObject::objects(), and Isis::Cube::write().
Referenced by Isis::ImageImporter::import().
|
protectedinherited |
A vector of pointers to opened Cube objects.
The pointers are established in the SetInputCube/SetInputWorkCube methods.
Definition at line 193 of file Process.h.
Referenced by Isis::ProcessExport::CreateWorldFile(), Isis::ProcessExport::GetBuffersBIL(), Isis::ProcessExport::GetBuffersBIP(), Isis::ProcessExport::GetBuffersBSQ(), Isis::ProcessExport::InitProcess(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessByBrick::ProcessCubes(), Isis::ProcessExport::SetInputRange(), Isis::ProcessByQuickFilter::StartProcess(), and Isis::ProcessExport::StartProcess().
|
protectedinherited |
|
protectedinherited |
A vector of pointers to allocated Cube objects.
The pointers are established in the SetOutputCube method.
Definition at line 199 of file Process.h.
Referenced by Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessByBrick::ProcessCubes(), Isis::ProcessImport::ProcessJp2(), and Isis::ProcessByQuickFilter::StartProcess().
|
protectedinherited |
Holds the calculated statistics for each band separately of every input cubei after the CalculateStatistics method is called.
Definition at line 180 of file Process.h.
Referenced by Isis::Process::BandStatistics().
|
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().
|
private |
The encoding type of the image data.
The only encoding type currently supported is JP2 (JPEG2000).
Definition at line 291 of file ProcessImportPds.h.
|
private |
Equatorial radius found in the PDS
projection labels
Definition at line 301 of file ProcessImportPds.h.
|
private |
The name of the file containing the
encoded JP2 data.
Definition at line 294 of file ProcessImportPds.h.
|
private |
determines whether or not to keep the
OriginalLabel blob.
Definition at line 330 of file ProcessImportPds.h.
|
private |
The filename where the PDS label came from.
Definition at line 286 of file ProcessImportPds.h.
|
private |
The latitude type found in the PDS
projection labels
Definition at line 309 of file ProcessImportPds.h.
|
private |
Longitude direction found in the PDS projection labels.
Definition at line 305 of file ProcessImportPds.h.
|
private |
Longitude domain found in the PDS
projection labels
Definition at line 307 of file ProcessImportPds.h.
|
private |
Maximum latitude found in the PDS
projection labels
Definition at line 313 of file ProcessImportPds.h.
|
private |
Maximum longitude found in the PDS
projection labels
Definition at line 317 of file ProcessImportPds.h.
|
private |
Minimum latitude found in the PDS
projection labels
Definition at line 311 of file ProcessImportPds.h.
|
private |
Minimum longitude found in the PDS
projection labels
Definition at line 315 of file ProcessImportPds.h.
|
private |
Internalized PDS label.
Definition at line 285 of file ProcessImportPds.h.
|
private |
Pixel resolution found in the PDS
projection labels
Definition at line 319 of file ProcessImportPds.h.
|
private |
The polar radius found in the PDS
projection labels
Definition at line 303 of file ProcessImportPds.h.
|
protectedinherited |
Pointer to a Progress object.
Definition at line 153 of file Process.h.
Referenced by Isis::ProcessExport::InitProcess(), Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessExport::ProcessExport(), Isis::ProcessImport::ProcessImport(), Isis::ProcessImport::ProcessJp2(), Isis::Process::Progress(), Isis::ProcessByBrick::RunProcess(), Isis::ProcessByQuickFilter::StartProcess(), and Isis::ProcessExport::StartProcess().
|
private |
The name of the projection found in
the PDS projection labels
Definition at line 298 of file ProcessImportPds.h.
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
private |
|
private |
The scale factor found in the PDS
projection labels
Definition at line 321 of file ProcessImportPds.h.
|
private |
Vector of Isis Table objects that were imported from PDS and need to be added to the imported cube file.
Definition at line 332 of file ProcessImportPds.h.
|
private |
Base data directory.
Definition at line 288 of file ProcessImportPds.h.