 |
Isis 3 Programmer Reference
|
|
Isis 3 Programmer Reference
|
Byte swapper. More...
#include <ProcessImport.h>
Public Types | |
| enum | VAXDataType { VAX_REAL, VAX_INT } |
| enum | VAXSpecialPixel { VAX_MIN4, VAX_NULL4, VAX_LRS4, VAX_LIS4, VAX_HIS4, VAX_HRS4 } |
| 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 | |
| ProcessImport () | |
| Constructs an Import object. More... | |
| virtual | ~ProcessImport () |
| Destroys the Import object. More... | |
| virtual void | StartProcess () |
| Process the input file and write it to the output. More... | |
| virtual void | StartProcess (void funct(Isis::Buffer &out)) |
| Process the input file and send data to method. More... | |
| void | SetInputFile (const QString &file) |
| Sets the name of the input file to be read in the import StartProcess method and verifies its existance. More... | |
| QString | InputFile () |
| Sets the name of the input file to be read in the import StartProcess method and verifies its existance. More... | |
| Isis::Cube * | SetOutputCube (const QString ¶meter) |
| Create the output file. More... | |
| virtual Isis::Cube * | SetOutputCube (const QString &fname, Isis::CubeAttributeOutput &att) |
| Create the output file. More... | |
| void | SetPixelType (const Isis::PixelType type) |
| Sets the pixel type of the input file. More... | |
| Isis::PixelType | PixelType () |
| Returns the pixel type. More... | |
| void | SetDimensions (const int ns, const int nl, const int nb) |
| Sets the physical size of the input cube. More... | |
| int | Samples () |
| Returns the number of samples. More... | |
| int | Lines () |
| Returns the number of lines. More... | |
| int | Bands () |
| Returns the number of bands. More... | |
| void | SetByteOrder (const Isis::ByteOrder order) |
| Sets the byte order of the input file. More... | |
| Isis::ByteOrder | ByteOrder () |
| Returns the byte order. More... | |
| bool | IsVAXSpecial (unsigned int *vax, VAXSpecialPixel pix) |
| Determines if the VAX encoded pixel value is special or not. More... | |
| double | VAXConversion (void *ibuf) |
| Conversion routine which translates VAX_REAL to IEEE_REAL. More... | |
| void | SetSuffixOffset (int samples, int lines, int coreBands, int itemBytes) |
| void | SetSuffixPixelType (const Isis::PixelType type) |
| void | SetVAXConvert (const bool vax_convert) |
| Sets the VAX flag of the input cube. More... | |
| void | SetFileHeaderBytes (const int bytes) |
| This method sets the number of bytes in the header of a file. More... | |
| void | SetFileTrailerBytes (const int bytes) |
| This method sets the number of bytes in the trailer of a file. More... | |
| void | SetDataHeaderBytes (const int bytes) |
| This method sets the number of bytes in the header of each datablock of a file. More... | |
| void | SetDataTrailerBytes (const int bytes) |
| This method sets the number of bytes in the trailer of each datablock of a file. More... | |
| void | SetDataPrefixBytes (const int bytes) |
| This method sets the number of bytes at the beginning of each data record of a file. More... | |
| void | SetDataSuffixBytes (const int bytes) |
| This method sets the number of bytes at the end of each data record of a file. More... | |
| void | SaveFileHeader () |
| This method marks the file header to be saved. More... | |
| void | SaveFileTrailer () |
| This method marks the file trailer to be saved. More... | |
| void | SaveDataHeader () |
| This method marks the data block headers to be saved. More... | |
| void | SaveDataTrailer () |
| This method marks the data block trailers to be saved. More... | |
| void | SaveDataPrefix () |
| This method marks the data prefix to be saved. More... | |
| void | SaveDataSuffix () |
| This method marks the data suffix to be saved. More... | |
| int | FileHeaderBytes () const |
| This method returns the number of file header bytes. More... | |
| int | FileTrailerBytes () const |
| This method returns the number of file trailer bytes. More... | |
| int | DataHeaderBytes () const |
| This method returns the number of data header bytes. More... | |
| int | DataTrailerBytes () const |
| This method returns the number of data trailer bytes. More... | |
| int | DataPrefixBytes () const |
| This method returns the number of data prefix bytes. More... | |
| int | DataSuffixBytes () const |
| This method returns the number of data duffix bytes. More... | |
| char * | FileHeader () |
| This method returns a pointer to the file header. More... | |
| char * | FileTrailer () |
| This method returns a pointer to the file trailer. More... | |
| std::vector< char * > | DataHeader () |
| This method returns a pointer to the data header. More... | |
| std::vector< char * > | DataTrailer () |
| This method returns a pointer to the data trailer. More... | |
| std::vector< std::vector< char * > > | DataPrefix () |
| This method returns a pointer to the data prefix. More... | |
| std::vector< std::vector< char * > > | DataSuffix () |
| This method returns a pointer to the data suffix. More... | |
| void | SetOrganization (const ProcessImport::Interleave org) |
| Sets the organization of the input cube. More... | |
| Interleave | Organization () const |
| Gets the organization of the input cube. More... | |
| void | SetBase (const double base) |
| Sets the core base of the input cube. More... | |
| void | SetMultiplier (const double mult) |
| Sets the core multiplier of the input cube. More... | |
| void | SetBase (const std::vector< double > base) |
| Sets band dependent core base. More... | |
| void | SetMultiplier (const std::vector< double > mult) |
| Sets band dependent core multiplier. More... | |
| 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. More... | |
| void | SetNull (const double null_min, const double null_max) |
| Sets the range that will be considered Isis::Null. More... | |
| void | SetLRS (const double lrs_min, const double lrs_max) |
| Sets the range that will be considered Isis::Null. More... | |
| void | SetLIS (const double lis_min, const double lis_max) |
| Sets the range that will be considered Isis::Null. More... | |
| void | SetHRS (const double hrs_min, const double hrs_max) |
| Sets the range that will be considered Isis::Null. More... | |
| void | SetHIS (const double his_min, const double his_max) |
| Sets the range that will be considered Isis::Null. More... | |
| double | TestPixel (const double pixel) |
| Tests the pixel. More... | |
| void | ProcessBsq (void funct(Isis::Buffer &out)=NULL) |
| Process the import data as a band sequential file. More... | |
| void | ProcessBil (void funct(Isis::Buffer &out)=NULL) |
| Function to process files stored as Band Interleaved by Line. More... | |
| void | ProcessBip (void funct(Isis::Buffer &out)=NULL) |
| Function to process files stored as Band Interleaved by Pixel. More... | |
| void | ProcessJp2 (void funct(Isis::Buffer &out)=NULL) |
| Function to process files containing compressed JPEG2000 data (which is always BSQ but is processed as BIL with one or more lines stored sequentially for each band). More... | |
| void | CheckPixelRange (QString pixelName, double min, double max) |
| Checks the special pixel range of the given against all other special pixel value ranges, making sure none overlap. 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, 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... | |
Private Attributes | |
| QString | p_inFile |
| Input file name. More... | |
| Isis::PixelType | p_pixelType |
| Pixel type of input data. More... | |
| Isis::PixelType | p_suffixPixelType |
| The pixel type of the suffix data. More... | |
| int | p_ns |
| Number of samples. More... | |
| int | p_nl |
| Number of lines. More... | |
| int | p_nb |
| Number of bands. More... | |
| Isis::ByteOrder | p_byteOrder |
| Byte order of data. More... | |
| int | p_suffixData |
| The number of bytes past the file header bytes where the suffix data bands are stored. More... | |
| int | p_fileHeaderBytes |
| The number of bytes of non-image data at the beginning of a file. More... | |
| int | p_fileTrailerBytes |
| The number of bytes of non-image data at the end of a file. More... | |
| int | p_dataHeaderBytes |
| Number of bytes of non-image data after the file header and before the image data of each data block, such as band header data in a band sequential file. More... | |
| int | p_dataTrailerBytes |
| Number of bytes of non-image data after the image data of each data block, such as band trailer data in a band sequential file. More... | |
| int | p_dataPreBytes |
| Number of bytes of non-image data preceding each data record, such as line prefix data in a band sequential file. More... | |
| int | p_dataPostBytes |
| Number of bytes of non-image data following each data record, such as line suffix data in a band sequential file. More... | |
| bool | p_saveFileHeader |
| Flag indicating whether to save the file header or not. More... | |
| bool | p_saveDataHeader |
| Flag indicating whether to save the data header or not. More... | |
| bool | p_saveDataTrailer |
| Flag indicating whether to save the data trailer or not. More... | |
| bool | p_saveDataPre |
| Flag indicating whether to save the data prefix or not. More... | |
| bool | p_saveDataPost |
| Flag indicating whether to save the data suffix or not. More... | |
| bool | p_saveFileTrailer |
| Flag indicating whether to save the file trailer or not. More... | |
| char * | p_fileHeader |
| The file header. More... | |
| std::vector< char * > | p_dataHeader |
| The data header. More... | |
| std::vector< char * > | p_dataTrailer |
| The data trailer. More... | |
| std::vector< std::vector< char * > > | p_dataPre |
| The data prefix. More... | |
| std::vector< std::vector< char * > > | p_dataPost |
| The data suffix. More... | |
| char * | p_fileTrailer |
| The file trailer. More... | |
| bool | p_vax_convert |
| ProcessImport::Interleave | p_organization |
| The format of the input file. More... | |
| std::vector< double > | p_base |
| An array containing the core base for each band. More... | |
| std::vector< double > | p_mult |
| An array containing the core multiplier for each band. More... | |
| double | p_null_min |
| The pixel value which is the lower bound of NULL data. More... | |
| double | p_null_max |
| The pixel value which is the upper bound of NULL data. More... | |
| double | p_hrs_min |
| The pixel value which is the lower bound of HRS data. More... | |
| double | p_hrs_max |
| The pixel value which is the upper bound of HRS data. More... | |
| double | p_his_min |
| The pixel value which is the lower bound of HIS data. More... | |
| double | p_his_max |
| The pixel value which is the upper bound of HIS data. More... | |
| double | p_lrs_min |
| The pixel value which is the lower bound of LRS data. More... | |
| double | p_lrs_max |
| The pixel value which is the upper bound of LRS data. More... | |
| double | p_lis_min |
| The pixel value which is the lower bound of LIS data. More... | |
| double | p_lis_max |
| The pixel value which is the upper bound of LIS data. More... | |
Byte swapper.
This class is used to import an image into Isis. It is a powerful base class which can be used to skip over header bytes, trailer bytes, prefix and/or suffix bytes. By deriving off of this class it can be used to Import vicar, PDS, fits, or many other standard format images.
Here is an example of how to use ProcessImport
If you would like to see ProcessImport being used in implementation, see raw2isis.cpp or for a class that implements ProcessImport, see 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-05 Jeff Anderson - Refactored the class
2004-02-10 Stuart Sides - Added new member AddLabel
2004-02-10 Stuart Sides - Modified the SetOutputCube member to create a real output file by default if the number of core base and multipliers is more than one.
2005-02-09 Elizabeth Ribelin - Modified file to support Doxygen documentation
2005-04-08 Leah Dahmer - added missing documentation.
2006-04-21 Brendan George - Implemented ProcessBil()
2006-10-26 Stuart Sides - Added unsigned 16 bit ability
2007-10-05 Steven Lambright - Added StartProcess method that passes data back to a function instead of writing it out to a file.
2007-11-13 Janet Barrett - Added the ProcessBip capability
2008-02-22 Steven Lambright - Fixed a memory leak and improved the way the destructor detects allocated pointers.
2008-08-18 Jeannie Walldren - Modified documentation and added method SetFileTrailerBytes().
2008-09-16 Christopher Austin - Added error throwing for the setting of special pixel ranges that overlap by adding CheckPixelRange().
2009-12-14 Janet Barrett - Added capability to import JPEG2000 files.
2011-08-19 Jeannie Backer - Modified unitTest to use $temporary variable instead of /tmp directory.
2012-11-21 Kimberly Oyama and Steven Lambright - Modified the ProcessBil() and ProcessBip() methods to use the BoxcarCachingAlgorithm instead of the RegionalCachingAlgorithm. Also added unit tests to exercise the modified methods. Fixes #819.
2013-03-12 Steven Lambright and Tracie Sucharski - Added support for 64 bit input data. Note: Possibility of lost precision since ouput is in 32 bit.
2013-03-27 Jeannie Backer - Added programmer comments and documentation. Changed parameter name from "parameter" to "fname" in SetOutputCube() method. References #1248.
2015-01-15 Sasha Brownsberger - Added virtual keyword to several functions to ensure successful inheritance between Process and its child classes. Added virtual keyword to destructor. References #2215.
2016-02-23 Tyler Wilson - Added VAXConversion(...) and IsVAXSpecial(...) routines for importing Galileo NIMS qubs which were originally saved in VAX format. Also added SetSuffixOffset for reading suffix band data from NIMS cubes. References #2368.
2016-04-20 Jeannie Backer - Merged Janet Barret's changes to handle SignedInteger imports. Brought code closer to coding standards.
2016-04-21 Makayla Shepherd - Added UnsignedWord pixel type handling.
2017-05-29 Kristin Berry - Added support for data trailers in BIP files and fixed a typo so that DataTrailerBytes() will return the correct value. References #3888.
2018-05-01 Jesse Mapel - Changed data suffix and prefix in BIP files. Previously, data suffixes and prefixes were for each band before/after each line. Now, data suffixes and prefixes are before/after each sample. For a RGB, 3-band image with n samples a line of data was previously | Header | R prefix | G prefix | B prefix | R 1 | G 1 | B 1| ... | R n | G n | B n| R suffix | G suffix | B suffix | Trailer |. Now it is | Header | Prefix 1 | R 1 | G 1 | B 1 | Suffix 1 | ... | Prefix n | R n | G n | B n | Suffix n | Trailer |. This change was made to accomodate Rosetta VIRTIS-m calibrated data files and has no impact on other supported BIP files. Fixes #5398.
2018-07-19 Tyler Wilson - Added support for 4-byte UnsignedInteger special pixel values.
Definition at line 170 of file ProcessImport.h.
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 291 of file ProcessImport.h.
| Isis::ProcessImport::ProcessImport | ( | ) |
Constructs an Import object.
Definition at line 51 of file ProcessImport.cpp.
References BSQ, p_base, p_byteOrder, p_dataHeaderBytes, p_dataPostBytes, p_dataPreBytes, p_dataTrailerBytes, p_fileHeader, p_fileHeaderBytes, p_fileTrailer, p_inFile, p_mult, p_nb, p_nl, p_ns, p_organization, p_pixelType, Isis::Process::p_progress, p_saveDataHeader, p_saveDataPost, p_saveDataPre, p_saveDataTrailer, p_saveFileHeader, p_saveFileTrailer, p_suffixData, p_suffixPixelType, SetHIS(), SetHRS(), SetLIS(), SetLRS(), SetNull(), and Isis::Progress::SetText().
|
virtual |
Destroys the Import object.
Definition at line 92 of file ProcessImport.cpp.
References p_dataHeader, p_dataPost, p_dataPre, p_dataTrailer, p_fileHeader, and p_fileTrailer.
|
inline |
Returns the number of bands.
Definition at line 239 of file ProcessImport.h.
References 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 290 of file Process.h.
References Isis::Process::p_bandStats.
|
inline |
Returns the byte order.
Definition at line 250 of file ProcessImport.h.
References 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 737 of file Process.cpp.
References Isis::Statistics::AddData(), Isis::Cube::bandCount(), Isis::Progress::CheckStatus(), Isis::Buffer::DoubleBuffer(), Isis::Cube::lineCount(), Isis::Cube::read(), Isis::LineManager::SetLine(), Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), Isis::Buffer::size(), and Isis::toString().
| void Isis::ProcessImport::CheckPixelRange | ( | QString | pixelName, |
| double | pixelMin, | ||
| double | pixelMax | ||
| ) |
Checks the special pixel range of the given against all other special pixel value ranges, making sure none overlap.
| pixelName | Name of the special pixel type to be displayed in the error message. |
| pixelMin | The minimum value of the special pixel range |
| pixelMax | The maximum value of the special pixel range |
Definition at line 1112 of file ProcessImport.cpp.
References _FILEINFO_, p_his_max, p_his_min, p_hrs_max, p_hrs_min, p_lis_max, p_lis_min, p_lrs_max, p_lrs_min, p_null_max, p_null_min, Isis::toString(), and Isis::IException::User.
Referenced by SetHIS(), SetHRS(), SetLIS(), SetLRS(), and SetNull().
|
inherited |
Close owned cubes from the list and clear the list.
Definition at line 509 of file Process.cpp.
|
inherited |
Close owned input cubes from the list and clear the list.
Definition at line 519 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 533 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 304 of file Process.h.
References Isis::Process::p_cubeStats.
| std::vector< char * > Isis::ProcessImport::DataHeader | ( | ) |
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 821 of file ProcessImport.cpp.
References _FILEINFO_, p_dataHeader, p_saveDataHeader, and Isis::IException::Programmer.
| int Isis::ProcessImport::DataHeaderBytes | ( | ) | const |
This method returns the number of data header bytes.
Definition at line 719 of file ProcessImport.cpp.
References p_dataHeaderBytes.
| std::vector< std::vector< char * > > Isis::ProcessImport::DataPrefix | ( | ) |
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 877 of file ProcessImport.cpp.
References _FILEINFO_, p_dataPre, p_saveDataPre, and Isis::IException::Programmer.
| int Isis::ProcessImport::DataPrefixBytes | ( | ) | const |
This method returns the number of data prefix bytes.
Definition at line 735 of file ProcessImport.cpp.
References p_dataPreBytes.
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
| std::vector< std::vector< char * > > Isis::ProcessImport::DataSuffix | ( | ) |
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 905 of file ProcessImport.cpp.
References _FILEINFO_, p_dataPost, p_saveDataPost, and Isis::IException::Programmer.
| int Isis::ProcessImport::DataSuffixBytes | ( | ) | const |
This method returns the number of data duffix bytes.
Definition at line 743 of file ProcessImport.cpp.
References p_dataPostBytes.
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
| std::vector< char * > Isis::ProcessImport::DataTrailer | ( | ) |
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 849 of file ProcessImport.cpp.
References _FILEINFO_, p_dataTrailer, p_saveDataTrailer, and Isis::IException::Programmer.
| int Isis::ProcessImport::DataTrailerBytes | ( | ) | const |
This method returns the number of data trailer bytes.
Definition at line 727 of file ProcessImport.cpp.
References p_dataTrailerBytes.
|
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.
Definition at line 483 of file Process.cpp.
Referenced by Isis::ImageExporter::createWorldFile(), Isis::ProcessByBoxcar::EndProcess(), and Isis::FileTool::saveAsEnlargedCube().
| char * Isis::ProcessImport::FileHeader | ( | ) |
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 767 of file ProcessImport.cpp.
References _FILEINFO_, p_fileHeader, p_saveFileHeader, and Isis::IException::Programmer.
| int Isis::ProcessImport::FileHeaderBytes | ( | ) | const |
This method returns the number of file header bytes.
Definition at line 702 of file ProcessImport.cpp.
References p_fileHeaderBytes.
| char * Isis::ProcessImport::FileTrailer | ( | ) |
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 793 of file ProcessImport.cpp.
References _FILEINFO_, p_fileTrailer, p_saveFileTrailer, and Isis::IException::Programmer.
| int Isis::ProcessImport::FileTrailerBytes | ( | ) | const |
This method returns the number of file trailer bytes.
Definition at line 711 of file ProcessImport.cpp.
References p_fileTrailerBytes.
|
virtualinherited |
Cleans up by closing cubes and freeing memory for owned cubes.
Clears the lists for all cubes.
Reimplemented in Isis::ProcessImportPds, Isis::ProcessByBrick, Isis::ProcessByBoxcar, Isis::ProcessByTile, Isis::ProcessGroundPolygons, and Isis::ProcessPolygons.
Definition at line 491 of file Process.cpp.
Referenced by Isis::ProcessByBoxcar::Finalize().
| QString Isis::ProcessImport::InputFile | ( | ) |
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 2308 of file ProcessImport.cpp.
References _FILEINFO_, p_inFile, and Isis::IException::Programmer.
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
| bool Isis::ProcessImport::IsVAXSpecial | ( | unsigned int * | vax, |
| VAXSpecialPixel | pix | ||
| ) |
Determines if the VAX encoded pixel value is special or not.
| vax | A pointer to a VAX pixel |
| pix | An enumerated value indicating the VAX pixel type |
Definition at line 132 of file ProcessImport.cpp.
Referenced by VAXConversion().
|
inline |
Returns the number of lines.
Definition at line 230 of file ProcessImport.h.
References 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 682 of file Process.cpp.
References _FILEINFO_, Isis::FileName::expanded(), Isis::FileName::fileExists(), Isis::PvlObject::findGroup(), and Isis::FileName::highestVersion().
| ProcessImport::Interleave Isis::ProcessImport::Organization | ( | ) | const |
Gets the organization of the input cube.
Definition at line 942 of file ProcessImport.cpp.
References p_organization.
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
|
inline |
Returns the pixel type.
Definition at line 210 of file ProcessImport.h.
References p_pixelType.
| void Isis::ProcessImport::ProcessBil | ( | void | functIsis::Buffer &out = NULL | ) |
Function to process files stored as Band Interleaved by Line.
| funct | Method that accepts Isis::Buffer as an input parameter, processes the image, and has no return value. |
| Isis::iException::Message | "Cannot open input file." |
| Isis::iException::Message | "Cannot read file. Position[]. Byte count[]" |
Definition at line 1615 of file ProcessImport.cpp.
References _FILEINFO_, Isis::Progress::CheckStatus(), Isis::EndianSwapper::Double(), Isis::FileName::expanded(), Isis::EndianSwapper::Float(), Isis::EndianSwapper::Int(), Isis::IException::Io, Isis::IsValidPixel(), Isis::Process::OutputCubes, p_base, p_byteOrder, p_dataHeaderBytes, p_dataPost, p_dataPostBytes, p_dataPre, p_dataPreBytes, p_fileHeader, p_fileHeaderBytes, p_fileTrailer, p_fileTrailerBytes, p_inFile, p_mult, p_nb, p_nl, p_ns, p_pixelType, Isis::Process::p_progress, p_saveDataPost, p_saveDataPre, p_saveFileHeader, p_saveFileTrailer, p_suffixData, Isis::Progress::SetMaximumSteps(), Isis::EndianSwapper::ShortInt(), Isis::SizeOf(), TestPixel(), Isis::toString(), Isis::EndianSwapper::Uint32_t(), Isis::EndianSwapper::UnsignedShortInt(), and VAXConversion().
Referenced by StartProcess().
| void Isis::ProcessImport::ProcessBip | ( | void | functIsis::Buffer &out = NULL | ) |
Function to process files stored as Band Interleaved by Pixel.
| funct | Method that accepts Isis::Buffer as an input parameter, processes the image, and has no return value. |
| Isis::iException::Message | "Cannot open input file." |
| Isis::iException::Message | "Cannot read file. Position[]. Byte count[]" |
Definition at line 1860 of file ProcessImport.cpp.
References _FILEINFO_, Isis::Progress::CheckStatus(), Isis::EndianSwapper::Double(), Isis::FileName::expanded(), Isis::EndianSwapper::Float(), Isis::EndianSwapper::Int(), Isis::IException::Io, Isis::IsValidPixel(), Isis::Process::OutputCubes, p_base, p_byteOrder, p_dataHeaderBytes, p_dataPost, p_dataPostBytes, p_dataPre, p_dataPreBytes, p_dataTrailer, p_dataTrailerBytes, p_fileHeader, p_fileHeaderBytes, p_fileTrailer, p_fileTrailerBytes, p_inFile, p_mult, p_nb, p_nl, p_ns, p_pixelType, Isis::Process::p_progress, p_saveDataPost, p_saveDataPre, p_saveDataTrailer, p_saveFileHeader, p_saveFileTrailer, p_suffixData, Isis::Progress::SetMaximumSteps(), Isis::EndianSwapper::ShortInt(), Isis::SizeOf(), TestPixel(), Isis::toString(), Isis::EndianSwapper::Uint32_t(), Isis::EndianSwapper::UnsignedShortInt(), and VAXConversion().
Referenced by StartProcess().
| void Isis::ProcessImport::ProcessBsq | ( | void | functIsis::Buffer &out = NULL | ) |
Process the import data as a band sequential file.
| funct | Method that accepts Isis::Buffer as an input parameter, processes the image, and has no return value. |
| Isis::iException::Message | "Cannot open input file." |
| Isis::iException::Message | "Cannot read file. Position[]. Byte count[]" |
Definition at line 1352 of file ProcessImport.cpp.
References _FILEINFO_, Isis::Progress::CheckStatus(), Isis::EndianSwapper::Double(), Isis::FileName::expanded(), Isis::EndianSwapper::Float(), Isis::EndianSwapper::Int(), Isis::IException::Io, Isis::IsValidPixel(), Isis::Process::OutputCubes, p_base, p_byteOrder, p_dataHeader, p_dataHeaderBytes, p_dataPost, p_dataPostBytes, p_dataPre, p_dataPreBytes, p_dataTrailer, p_dataTrailerBytes, p_fileHeader, p_fileHeaderBytes, p_fileTrailer, p_fileTrailerBytes, p_inFile, p_mult, p_nb, p_nl, p_ns, p_pixelType, Isis::Process::p_progress, p_saveDataHeader, p_saveDataPost, p_saveDataPre, p_saveDataTrailer, p_saveFileHeader, p_saveFileTrailer, p_suffixData, Isis::Progress::SetMaximumSteps(), Isis::EndianSwapper::ShortInt(), Isis::SizeOf(), TestPixel(), Isis::toString(), Isis::EndianSwapper::Uint32_t(), Isis::EndianSwapper::UnsignedShortInt(), and VAXConversion().
Referenced by StartProcess().
| void Isis::ProcessImport::ProcessJp2 | ( | void | functIsis::Buffer &out = NULL | ) |
Function to process files containing compressed JPEG2000 data (which is always BSQ but is processed as BIL with one or more lines stored sequentially for each band).
There is no need to set up an Isis::EndianSwapper because JP2 data is always assumed to be in MSB format. The Kakadu library does an automatic byte swap for the current architecture.
| funct | Method that accepts Isis::Buffer as an input parameter, processes the image, and has no return value. |
| Isis::iException::Message | "Cannot open input file." |
| Isis::iException::Message | "Cannot read file. Position[]. Byte count[]" |
Definition at line 2112 of file ProcessImport.cpp.
References Isis::Progress::CheckStatus(), Isis::IsValidPixel(), Isis::JP2Decoder::OpenFile(), Isis::Process::OutputCubes, p_base, p_dataPost, p_dataPostBytes, p_dataPre, p_dataPreBytes, p_inFile, p_mult, p_nb, p_nl, p_ns, p_pixelType, Isis::Process::p_progress, p_saveDataPost, p_saveDataPre, Isis::JP2Decoder::Read(), Isis::Progress::SetMaximumSteps(), Isis::SizeOf(), and TestPixel().
Referenced by StartProcess().
|
inlineinherited |
This method returns a pointer to a Progress object.
Definition at line 270 of file Process.h.
References Isis::Process::p_progress.
Referenced by Isis::Equalization::applyCorrection(), Isis::Equalization::calculateBandStatistics(), 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. |
Definition at line 651 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 555 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 566 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 662 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 641 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 594 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. 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. |
Definition at line 614 of file Process.cpp.
References Isis::Cube::label(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Cube::open(), and Isis::Cube::read().
|
inline |
Returns the number of samples.
Definition at line 221 of file ProcessImport.h.
References p_ns.
| void Isis::ProcessImport::SaveDataHeader | ( | ) |
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 602 of file ProcessImport.cpp.
References _FILEINFO_, p_dataHeaderBytes, p_saveDataHeader, and Isis::IException::Programmer.
| void Isis::ProcessImport::SaveDataPrefix | ( | ) |
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 659 of file ProcessImport.cpp.
References _FILEINFO_, p_dataPreBytes, p_saveDataPre, and Isis::IException::Programmer.
| void Isis::ProcessImport::SaveDataSuffix | ( | ) |
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 688 of file ProcessImport.cpp.
References _FILEINFO_, p_dataPostBytes, p_saveDataPost, and Isis::IException::Programmer.
| void Isis::ProcessImport::SaveDataTrailer | ( | ) |
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 631 of file ProcessImport.cpp.
References _FILEINFO_, p_dataTrailerBytes, p_saveDataTrailer, and Isis::IException::Programmer.
| void Isis::ProcessImport::SaveFileHeader | ( | ) |
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 546 of file ProcessImport.cpp.
References _FILEINFO_, p_fileHeaderBytes, p_saveFileHeader, and Isis::IException::Programmer.
| void Isis::ProcessImport::SaveFileTrailer | ( | ) |
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 573 of file ProcessImport.cpp.
References _FILEINFO_, p_fileTrailerBytes, p_saveFileTrailer, and Isis::IException::Programmer.
| void Isis::ProcessImport::SetBase | ( | const double | base | ) |
Sets the core base of the input cube.
Defaults to zero if not invoked.
| base | Core base |
Definition at line 952 of file ProcessImport.cpp.
References p_base.
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
| void Isis::ProcessImport::SetBase | ( | const std::vector< double > | base | ) |
Sets band dependent core base.
| base | A vector containing the base for each band. |
Definition at line 963 of file ProcessImport.cpp.
References p_base.
| void Isis::ProcessImport::SetByteOrder | ( | const Isis::ByteOrder | order | ) |
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 338 of file ProcessImport.cpp.
References p_byteOrder.
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
| void Isis::ProcessImport::SetDataHeaderBytes | ( | const int | bytes | ) |
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 422 of file ProcessImport.cpp.
References _FILEINFO_, p_dataHeaderBytes, Isis::IException::Programmer, and Isis::toString().
| void Isis::ProcessImport::SetDataPrefixBytes | ( | const int | bytes | ) |
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 487 of file ProcessImport.cpp.
References _FILEINFO_, p_dataPreBytes, Isis::IException::Programmer, and Isis::toString().
| void Isis::ProcessImport::SetDataSuffixBytes | ( | const int | bytes | ) |
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 517 of file ProcessImport.cpp.
References _FILEINFO_, p_dataPostBytes, Isis::IException::Programmer, and Isis::toString().
| void Isis::ProcessImport::SetDataTrailerBytes | ( | const int | bytes | ) |
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 457 of file ProcessImport.cpp.
References _FILEINFO_, p_dataTrailerBytes, Isis::IException::Programmer, and Isis::toString().
| void Isis::ProcessImport::SetDimensions | ( | const int | ns, |
| const int | nl, | ||
| const int | nb | ||
| ) |
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 318 of file ProcessImport.cpp.
References _FILEINFO_, p_nb, p_nl, p_ns, Isis::IException::Programmer, and Isis::toString().
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
| void Isis::ProcessImport::SetFileHeaderBytes | ( | const int | bytes | ) |
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 363 of file ProcessImport.cpp.
References _FILEINFO_, p_fileHeaderBytes, Isis::IException::Programmer, and Isis::toString().
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
| void Isis::ProcessImport::SetFileTrailerBytes | ( | const int | bytes | ) |
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 393 of file ProcessImport.cpp.
References _FILEINFO_, p_fileTrailerBytes, Isis::IException::Programmer, and Isis::toString().
| void Isis::ProcessImport::SetHIS | ( | const double | his_min, |
| const double | his_max | ||
| ) |
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 1096 of file ProcessImport.cpp.
References CheckPixelRange(), p_his_max, and p_his_min.
Referenced by ProcessImport(), and SetSpecialValues().
| void Isis::ProcessImport::SetHRS | ( | const double | hrs_min, |
| const double | hrs_max | ||
| ) |
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 1079 of file ProcessImport.cpp.
References CheckPixelRange(), p_hrs_max, and p_hrs_min.
Referenced by ProcessImport(), and 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::ProcessByLine, Isis::ProcessByBrick, Isis::ProcessBySpectra, and Isis::ProcessBySample.
Definition at line 243 of file Process.cpp.
Referenced by Isis::ImageExporter::addChannel(), Isis::JigsawRunWidget::on_JigsawAcceptButton_clicked(), 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().
| void Isis::ProcessImport::SetInputFile | ( | const QString & | file | ) |
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 2291 of file ProcessImport.cpp.
References _FILEINFO_, p_inFile, and Isis::IException::User.
Referenced by Isis::ProcessImportFits::setFitsFile().
| void Isis::ProcessImport::SetLIS | ( | const double | lis_min, |
| const double | lis_max | ||
| ) |
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 1062 of file ProcessImport.cpp.
References CheckPixelRange(), p_lis_max, and p_lis_min.
Referenced by ProcessImport(), and SetSpecialValues().
| void Isis::ProcessImport::SetLRS | ( | const double | lrs_min, |
| const double | lrs_max | ||
| ) |
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 1045 of file ProcessImport.cpp.
References CheckPixelRange(), p_lrs_max, and p_lrs_min.
Referenced by ProcessImport(), and SetSpecialValues().
| void Isis::ProcessImport::SetMultiplier | ( | const double | mult | ) |
Sets the core multiplier of the input cube.
Defaults to one if not invoked.
| mult | Core base |
Definition at line 973 of file ProcessImport.cpp.
References p_mult.
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
| void Isis::ProcessImport::SetMultiplier | ( | const std::vector< double > | mult | ) |
Sets band dependent core multiplier.
| mult | A vector containing the multiplier for each band. |
Definition at line 984 of file ProcessImport.cpp.
References p_mult.
| void Isis::ProcessImport::SetNull | ( | const double | null_min, |
| const double | null_max | ||
| ) |
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 1028 of file ProcessImport.cpp.
References CheckPixelRange(), p_null_max, and p_null_min.
Referenced by ProcessImport(), and SetSpecialValues().
| void Isis::ProcessImport::SetOrganization | ( | const ProcessImport::Interleave | org | ) |
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 921 of file ProcessImport.cpp.
References p_organization.
|
virtual |
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 1213 of file ProcessImport.cpp.
References _FILEINFO_, IsisAml::GetOutputAttribute(), Isis::Application::GetUserInterface(), p_base, p_mult, p_nb, p_nl, p_ns, 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().
|
virtual |
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 1284 of file ProcessImport.cpp.
References p_nb, p_nl, 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::ProcessImport::SetPixelType | ( | const Isis::PixelType | type | ) |
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 278 of file ProcessImport.cpp.
References _FILEINFO_, p_pixelType, Isis::PixelTypeName(), and Isis::IException::Programmer.
Referenced by Isis::ProcessImportFits::setProcessFileStructure().
| void Isis::ProcessImport::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.
| 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 1007 of file ProcessImport.cpp.
References SetHIS(), SetHRS(), SetLIS(), SetLRS(), and SetNull().
| void Isis::ProcessImport::SetVAXConvert | ( | const bool | vax_convert | ) |
Sets the VAX flag of the input cube.
If true, then the core pixel type of the input cube is VAX, and VAX conversion routines need to be run to convert the pixels to IEEE format.
| vax_convert | Flag indicating whether or not to run VAX conersion methods |
Definition at line 933 of file ProcessImport.cpp.
|
virtual |
Process the input file and write it to the output.
Reimplemented in Isis::ProcessImportPds.
Definition at line 1291 of file ProcessImport.cpp.
References _FILEINFO_, BIL, BIP, BSQ, JP2, p_inFile, p_organization, ProcessBil(), ProcessBip(), ProcessBsq(), ProcessJp2(), and Isis::IException::Programmer.
|
virtual |
Process the input file and send data to method.
| 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 in Isis::ProcessImportPds.
Definition at line 1321 of file ProcessImport.cpp.
References _FILEINFO_, BIL, BIP, BSQ, JP2, p_inFile, p_organization, ProcessBil(), ProcessBip(), ProcessBsq(), ProcessJp2(), and Isis::IException::Programmer.
|
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 |
| double Isis::ProcessImport::TestPixel | ( | const double | pixel | ) |
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 1181 of file ProcessImport.cpp.
References p_his_min, p_hrs_min, p_lis_min, p_lrs_min, and p_null_min.
Referenced by ProcessBil(), ProcessBip(), ProcessBsq(), and ProcessJp2().
| double Isis::ProcessImport::VAXConversion | ( | void * | ibuf | ) |
Conversion routine which translates VAX_REAL to IEEE_REAL.
| ibuf | Memory buffer of input data to be converted |
Definition at line 185 of file ProcessImport.cpp.
References Isis::IsLsb(), IsVAXSpecial(), and p_byteOrder.
Referenced by ProcessBil(), ProcessBip(), and ProcessBsq().
|
inherited |
Writes out the History blob to the cube.
Definition at line 703 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 200 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 206 of file Process.h.
Referenced by ProcessBil(), ProcessBip(), ProcessBsq(), Isis::ProcessByBrick::ProcessCube(), Isis::ProcessByBrick::ProcessCubes(), 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 187 of file Process.h.
Referenced by Isis::Process::BandStatistics().
|
private |
An array containing the core base for each band.
If there is only one value in the vector then that base applies to all bands.
Definition at line 404 of file ProcessImport.h.
Referenced by ProcessBil(), ProcessBip(), ProcessBsq(), ProcessImport(), ProcessJp2(), SetBase(), and SetOutputCube().
|
private |
Byte order of data.
Definition at line 348 of file ProcessImport.h.
Referenced by ByteOrder(), ProcessBil(), ProcessBip(), ProcessBsq(), ProcessImport(), SetByteOrder(), and VAXConversion().
|
protectedinherited |
Holds the calculated statistics for every band together of every input cubei after the CalculateStatistics method is called.
Definition at line 194 of file Process.h.
Referenced by Isis::Process::CubeStatistics().
|
private |
The data header.
Definition at line 389 of file ProcessImport.h.
Referenced by DataHeader(), ProcessBsq(), and ~ProcessImport().
|
private |
Number of bytes of non-image data after the file header and before the image data of each data block, such as band header data in a band sequential file.
Definition at line 362 of file ProcessImport.h.
Referenced by DataHeaderBytes(), ProcessBil(), ProcessBip(), ProcessBsq(), ProcessImport(), SaveDataHeader(), and SetDataHeaderBytes().
|
private |
The data suffix.
Definition at line 392 of file ProcessImport.h.
Referenced by DataSuffix(), ProcessBil(), ProcessBip(), ProcessBsq(), ProcessJp2(), and ~ProcessImport().
|
private |
Number of bytes of non-image data following each data record, such as line suffix data in a band sequential file.
Definition at line 373 of file ProcessImport.h.
Referenced by DataSuffixBytes(), ProcessBil(), ProcessBip(), ProcessBsq(), ProcessImport(), ProcessJp2(), SaveDataSuffix(), and SetDataSuffixBytes().
|
private |
The data prefix.
Definition at line 391 of file ProcessImport.h.
Referenced by DataPrefix(), ProcessBil(), ProcessBip(), ProcessBsq(), ProcessJp2(), and ~ProcessImport().
|
private |
Number of bytes of non-image data preceding each data record, such as line prefix data in a band sequential file.
Definition at line 370 of file ProcessImport.h.
Referenced by DataPrefixBytes(), ProcessBil(), ProcessBip(), ProcessBsq(), ProcessImport(), ProcessJp2(), SaveDataPrefix(), and SetDataPrefixBytes().
|
private |
The data trailer.
Definition at line 390 of file ProcessImport.h.
Referenced by DataTrailer(), ProcessBip(), ProcessBsq(), and ~ProcessImport().
|
private |
Number of bytes of non-image data after the image data of each data block, such as band trailer data in a band sequential file.
Definition at line 366 of file ProcessImport.h.
Referenced by DataTrailerBytes(), ProcessBip(), ProcessBsq(), ProcessImport(), SaveDataTrailer(), and SetDataTrailerBytes().
|
private |
The file header.
Definition at line 388 of file ProcessImport.h.
Referenced by FileHeader(), ProcessBil(), ProcessBip(), ProcessBsq(), ProcessImport(), and ~ProcessImport().
|
private |
The number of bytes of non-image data at the beginning of a file.
This does not include any section headers such as band headers.
Definition at line 354 of file ProcessImport.h.
Referenced by FileHeaderBytes(), ProcessBil(), ProcessBip(), ProcessBsq(), ProcessImport(), SaveFileHeader(), and SetFileHeaderBytes().
|
private |
The file trailer.
Definition at line 393 of file ProcessImport.h.
Referenced by FileTrailer(), ProcessBil(), ProcessBip(), ProcessBsq(), ProcessImport(), and ~ProcessImport().
|
private |
The number of bytes of non-image data at the end of a file.
This does not include any section trailers such as band trailers.
Definition at line 358 of file ProcessImport.h.
Referenced by FileTrailerBytes(), ProcessBil(), ProcessBip(), ProcessBsq(), SaveFileTrailer(), and SetFileTrailerBytes().
|
private |
The pixel value which is the upper bound of HIS data.
All pixels between this value and the min will be converted to the Isis HIS value.
Definition at line 433 of file ProcessImport.h.
Referenced by CheckPixelRange(), and SetHIS().
|
private |
The pixel value which is the lower bound of HIS data.
All pixels between this value and the max will be converted to the Isis HIS value.
Definition at line 429 of file ProcessImport.h.
Referenced by CheckPixelRange(), SetHIS(), and TestPixel().
|
private |
The pixel value which is the upper bound of HRS data.
All pixels between this value and the min will be converted to the Isis HRS value.
Definition at line 425 of file ProcessImport.h.
Referenced by CheckPixelRange(), and SetHRS().
|
private |
The pixel value which is the lower bound of HRS data.
All pixels between this value and the max will be converted to the Isis HRS value.
Definition at line 421 of file ProcessImport.h.
Referenced by CheckPixelRange(), SetHRS(), and TestPixel().
|
private |
Input file name.
Definition at line 341 of file ProcessImport.h.
Referenced by InputFile(), ProcessBil(), ProcessBip(), ProcessBsq(), ProcessImport(), ProcessJp2(), SetInputFile(), and StartProcess().
|
private |
The pixel value which is the upper bound of LIS data.
All pixels between this value and the min will be converted to the Isis LIS value.
Definition at line 449 of file ProcessImport.h.
Referenced by CheckPixelRange(), and SetLIS().
|
private |
The pixel value which is the lower bound of LIS data.
All pixels between this value and the max will be converted to the Isis LIS value.
Definition at line 445 of file ProcessImport.h.
Referenced by CheckPixelRange(), SetLIS(), and TestPixel().
|
private |
The pixel value which is the upper bound of LRS data.
All pixels between this value and the min will be converted to the Isis LRS value.
Definition at line 441 of file ProcessImport.h.
Referenced by CheckPixelRange(), and SetLRS().
|
private |
The pixel value which is the lower bound of LRS data.
All pixels between this value and the max will be converted to the Isis LRS value.
Definition at line 437 of file ProcessImport.h.
Referenced by CheckPixelRange(), SetLRS(), and TestPixel().
|
private |
An array containing the core multiplier for each band.
If there is only one value in the vector then that multiplier applies to all bands.
Definition at line 408 of file ProcessImport.h.
Referenced by ProcessBil(), ProcessBip(), ProcessBsq(), ProcessImport(), ProcessJp2(), SetMultiplier(), and SetOutputCube().
|
private |
Number of bands.
Definition at line 347 of file ProcessImport.h.
Referenced by Bands(), ProcessBil(), ProcessBip(), ProcessBsq(), ProcessImport(), ProcessJp2(), SetDimensions(), and SetOutputCube().
|
private |
Number of lines.
Definition at line 346 of file ProcessImport.h.
Referenced by Lines(), ProcessBil(), ProcessBip(), ProcessBsq(), ProcessImport(), ProcessJp2(), SetDimensions(), and SetOutputCube().
|
private |
Number of samples.
Definition at line 345 of file ProcessImport.h.
Referenced by ProcessBil(), ProcessBip(), ProcessBsq(), ProcessImport(), ProcessJp2(), Samples(), SetDimensions(), and SetOutputCube().
|
private |
The pixel value which is the upper bound of NULL data.
All pixels between this value and the min will be converted to the Isis NULL value.
Definition at line 417 of file ProcessImport.h.
Referenced by CheckPixelRange(), and SetNull().
|
private |
The pixel value which is the lower bound of NULL data.
All pixels between this value and the max will be converted to the Isis NULL value.
Definition at line 413 of file ProcessImport.h.
Referenced by CheckPixelRange(), SetNull(), and TestPixel().
|
private |
The format of the input file.
Possible values are BSQ for band sequential, BIL for band interleaved by line and BIP for band interleaved by pixel.
Definition at line 397 of file ProcessImport.h.
Referenced by Organization(), ProcessImport(), SetOrganization(), and StartProcess().
|
private |
Pixel type of input data.
Definition at line 342 of file ProcessImport.h.
Referenced by PixelType(), ProcessBil(), ProcessBip(), ProcessBsq(), ProcessImport(), ProcessJp2(), SetOutputCube(), and SetPixelType().
|
protectedinherited |
Pointer to a Progress object.
Definition at line 160 of file Process.h.
Referenced by Isis::ProcessExport::InitProcess(), ProcessBil(), ProcessBip(), ProcessBsq(), Isis::ProcessExport::ProcessExport(), ProcessImport(), ProcessJp2(), Isis::Process::Progress(), Isis::ProcessByBrick::RunProcess(), Isis::ProcessByQuickFilter::StartProcess(), and Isis::ProcessExport::StartProcess().
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
private |
Flag indicating whether to save the data header or not.
Definition at line 378 of file ProcessImport.h.
Referenced by DataHeader(), ProcessBsq(), ProcessImport(), and SaveDataHeader().
|
private |
Flag indicating whether to save the data suffix or not.
Definition at line 384 of file ProcessImport.h.
Referenced by DataSuffix(), ProcessBil(), ProcessBip(), ProcessBsq(), ProcessImport(), ProcessJp2(), and SaveDataSuffix().
|
private |
Flag indicating whether to save the data prefix or not.
Definition at line 382 of file ProcessImport.h.
Referenced by DataPrefix(), ProcessBil(), ProcessBip(), ProcessBsq(), ProcessImport(), ProcessJp2(), and SaveDataPrefix().
|
private |
Flag indicating whether to save the data trailer or not.
Definition at line 380 of file ProcessImport.h.
Referenced by DataTrailer(), ProcessBip(), ProcessBsq(), ProcessImport(), and SaveDataTrailer().
|
private |
Flag indicating whether to save the file header or not.
Definition at line 376 of file ProcessImport.h.
Referenced by FileHeader(), ProcessBil(), ProcessBip(), ProcessBsq(), ProcessImport(), and SaveFileHeader().
|
private |
Flag indicating whether to save the file trailer or not.
Definition at line 386 of file ProcessImport.h.
Referenced by FileTrailer(), ProcessBil(), ProcessBip(), ProcessBsq(), ProcessImport(), and SaveFileTrailer().
|
private |
The number of bytes past the file header bytes where the suffix data bands are stored.
Definition at line 350 of file ProcessImport.h.
Referenced by ProcessBil(), ProcessBip(), ProcessBsq(), and ProcessImport().
|
private |
The pixel type of the suffix data.
Definition at line 344 of file ProcessImport.h.
Referenced by ProcessImport().