Isis 3 Programmer Reference
|
Process class for exporting cubes to PDS standards. More...
#include <ProcessExportPds.h>
Public Types | |
enum | PdsFileType { Image, Qube, SpectralQube, JP2Image } |
File type to be exported. More... | |
enum | PdsResolution { Meter, Kilometer } |
Resolution units per pixel of the exported PDS file. More... | |
enum | PdsExportType { Stream, Fixed } |
Record format type of exported PDS file. More... | |
enum | ExportFormat { BSQ, BIL, BIP, JP2 } |
Storage order enumeration. More... | |
Public Member Functions | |
ProcessExportPds () | |
Default Constructor - Set to default the data members. More... | |
~ProcessExportPds () | |
Destructor. More... | |
void | StandardAllMapping (Pvl &mainPvl) |
Create the standard keywords for the IMAGE_MAP_PROJECTION group in a PDS label. More... | |
void | StreamImageRoot (Pvl &mainPvl) |
Create the standard keywords for the ROOT object in a PDS IMAGE file. More... | |
void | FixedImageRoot (Pvl &mainPvl) |
Create the fixed keywords for the ROOT object in a PDS IMAGE file. More... | |
void | StreamJP2ImageRoot (Pvl &mainPvl) |
Create the standard keywords for the ROOT object in a PDS JP2 IMAGE file. More... | |
void | FixedJP2ImageRoot (Pvl &mainPvl) |
Create the fixed keywords for the ROOT object in a PDS JP2 IMAGE file. More... | |
void | StandardImageImage (Pvl &mainPvl) |
Create the standard keywords for an IMAGE object in a PDS IMAGE file. More... | |
void | StandardJP2Image (Pvl &mainPvl) |
Create the standard keywords for an IMAGE object in a PDS JP2 IMAGE file. More... | |
void | SetPdsResolution (PdsResolution resolutionUnits) |
Mutator method to set the output PDS image resolution to meters per pixel or kilometers per pixel. More... | |
void | SetExportType (PdsExportType recordFormat) |
Mutator method to set the output PDS image record type to stream or fixed. More... | |
virtual Pvl & | StandardPdsLabel (ProcessExportPds::PdsFileType type) |
Create a standard PDS label of the type specified. More... | |
void | OutputLabel (std::ofstream &pdsFileStream) |
Write the PDS label to the supplied stream. More... | |
void | updateChecksumInLabel (std::ofstream &pdsFileStream) |
Updates the CHECKSUM value on the label and rewrites to the output file. More... | |
void | OutputDetachedLabel () |
Write the PDS label to the a detached file. More... | |
void | ExportTable (Isis::Table isisTable, QString detachedPdsTableFileName="") |
This method will add a table to be exported to PDS. More... | |
void | StartProcess (std::ofstream &fout) |
This method fills the image data of the PDS file using the parent class ProcessExport::StartProcess, then appends any attached tables. More... | |
bool | Detached () |
Accessor function returns true if the output PDS file is set to detached. More... | |
bool | Attached () |
Accessor function returns true if the output PDS file is set to attached. More... | |
void | SetDetached (QString detachedLabelFile) |
Mutator method to set the output PDS file to detached. More... | |
void | SetAttached () |
Mutator method to set the output PDS file to attached. More... | |
void | ForceBands (bool force) |
Mutator method to set how the the BANDS keyword will be handled. More... | |
void | ForceBandName (bool force) |
Mutator method to set how the BAND_NAME keyword will be handled. More... | |
void | ForceCenterFilterWavelength (bool force) |
Mutator method to set how the CENTER_FILTER_WAVELENGTH keyword will be handled. More... | |
void | ForceBandwidth (bool force) |
Mutator method to set how the BANDWIDTH keyword will be handled. More... | |
void | ForceBandStorageType (bool force) |
Mutator method to set how the BAND_STORAGE_TYPE keyword will be handled. More... | |
void | ForceOffset (bool force) |
Mutator method to set how the OFFSET keyword will be handled. More... | |
void | ForceScalingFactor (bool force) |
Mutator method to set how the SCALING_FACTOR keyword will be handled. More... | |
void | ForceSampleBits (bool force) |
Mutator method to set how the SAMPLE_BITS keyword will be handled. More... | |
void | ForceSampleBitMask (bool force) |
Mutator method to set how the SAMPLE_BIT_MASK keyword will be handled. More... | |
void | ForceSampleType (bool force) |
Mutator method to set how the SAMPLE_TYPE keyword will be handled. More... | |
void | ForceCoreNull (bool force) |
Mutator method to set how the CORE_NULL keyword will be handled. More... | |
void | ForceCoreLrs (bool force) |
Mutator method to set how the CORE_LOW_REPR_SATURATION keyword will be handled. More... | |
void | ForceCoreLis (bool force) |
Mutator method to set how the CORE_LOW_INSTR_SATURATION keyword will be handled. More... | |
void | ForceCoreHrs (bool force) |
Mutator method to set how the CORE_HIGH_REPR_SATURATION keyword will be handled. More... | |
void | ForceCoreHis (bool force) |
Mutator method to set how the CORE_HIGH_INSTR_SATURATION keyword will be handled. More... | |
virtual void | StartProcess (void funct(Isis::Buffer &in)) |
This method invokes the process operation over a single input cube. More... | |
virtual void | StartProcess (void funct(std::vector< Isis::Buffer * > &in)) |
virtual void | StartProcess (std::ofstream &fout) |
Write an entire cube to an output file stream. More... | |
virtual void | StartProcess (void funct(Isis::Buffer &in)) |
This method invokes the process operation over a single input cube. More... | |
virtual void | StartProcess (void funct(std::vector< Isis::Buffer * > &in)) |
virtual void | StartProcess (void funct()) |
In the base class, this method will invoked a user-specified function exactly one time. More... | |
void | SetOutputRange (const double minimum, const double maximum) |
Set output pixel range in Buffer. More... | |
void | SetOutputNull (const double value) |
Set output special pixel value for NULL. More... | |
void | SetOutputLis (const double value) |
Set output special pixel value for LIS. More... | |
void | SetOutputLrs (const double value) |
Set output special pixel value for LRS. More... | |
void | SetOutputHis (const double value) |
Set output special pixel value for HIS. More... | |
void | SetOutputHrs (const double value) |
Set output special pixel value for HRS. More... | |
double | OutputNull () |
Return the output special pixel value for NULL. More... | |
double | OutputLis () |
Return the output special pixel value for LIS. More... | |
double | OutputLrs () |
Return the output special pixel value for LRS. More... | |
double | OutputHis () |
Return the output special pixel value for HIS. More... | |
double | OutputHrs () |
Return the output special pixel value for HRS. More... | |
bool | HasInputRange () const |
void | SetInputRange () |
Set input pixel range from user. More... | |
void | SetInputRange (UserInterface &ui) |
void | SetInputRange (const double minimum, const double maximum) |
Set input pixel range from to a linear stretch. More... | |
void | SetInputRange (const double minimum, const double maximum, const int index) |
Set input pixel range from to a linear stretch. More... | |
void | SetInputRange (const double minimum, const double middle, const double maximum) |
Set input pixel range from to a piecewise linear stretch. More... | |
void | SetInputRange (const double minimum, const double middle, const double maximum, const int index) |
Set input pixel range from to a piecewise linear stretch. More... | |
void | CreateWorldFile (const QString &worldFile) |
Create a standard world file for the input cube. More... | |
void | SetOutputEndian (enum ByteOrder endianness) |
Set byte endianness of the output cube. More... | |
void | SetOutputType (Isis::PixelType pixelIn) |
Set output pixel bit type in Buffer. More... | |
void | setCanGenerateChecksum (bool flag) |
@description Set m_canGenerateChecksum which determines if we can generate a MD5 checksum on the image data. More... | |
bool | canGenerateChecksum () |
@description Return if we can generate a checksum More... | |
QString | checksum () |
@description Generates a file checksum. More... | |
double | GetInputMinimum (unsigned int n=0) const |
Get the valid minimum pixel value for the Nth input cube. More... | |
double | GetInputMaximum (unsigned int n=0) const |
Get the valid maximum pixel value for the Nth input cube. More... | |
double | GetOutputMinimum () |
Get the valid minimum pixel value to be written to the output file. More... | |
double | GetOutputMaximum () |
Get the valid maximum pixel value to be written to the output file. More... | |
void | setFormat (ExportFormat format) |
Sets the storage order of the output file. More... | |
template<typename Functor > | |
void | ProcessCubes (const Functor &functor) |
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, int requirements=0) |
Set the InputCube vector to an opened Cube which was dynamically allocated. More... | |
virtual Isis::Cube * | SetOutputCube (const QString ¶meter) |
Allocates a user-specified output cube whose size matches the first input cube. More... | |
virtual Isis::Cube * | SetOutputCube (const QString ¶meter, const int nsamps, const int nlines, const int nbands=1) |
Allocates a user specified output cube whose size is specified by the programmer. More... | |
virtual Isis::Cube * | SetOutputCube (const QString &fname, const Isis::CubeAttributeOutput &att, const int nsamps, const int nlines, const int nbands=1) |
Allocates a output cube whose name and size is specified by the programmer. More... | |
virtual Isis::Cube * | SetOutputCubeStretch (const QString ¶meter, UserInterface *ui=nullptr) |
Allocates a user-specified output cube whose size matches the first input cube. More... | |
virtual Isis::Cube * | SetOutputCubeStretch (const QString ¶meter, const int nsamps, const int nlines, const int nbands=1, UserInterface *ui=nullptr) |
Allocates a user specified output cube whose size is specified by the programmer. More... | |
void | AddInputCube (Cube *cube, bool owned=true) |
void | AddOutputCube (Cube *cube, bool owned=true) |
void | CheckRequirements (const Cube *cube, const int requirements) |
Checks to make sure the input cube meets the inputted requirements. More... | |
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 Member Functions | |
int | LineBytes () |
Return the line bytes (record size) for the input cube, at present this is based on the number of samples and the bytes per pixel. More... | |
int | LabelSize () |
Return the size of the output PDS label. More... | |
virtual void | CreateImageLabel () |
Create a standard PDS label for type IMAGE. More... | |
void | CreateQubeLabel () |
Create a standard PDS label for type QUBE. More... | |
void | CreateSpectralQubeLabel () |
Create a standard PDS label for type SPECTRAL_QUBE. More... | |
QString | ProjectionName (Pvl &inputLabel) |
Return a projection name. More... | |
std::vector< BufferManager * > | GetBuffers () |
std::vector< BufferManager * > | GetBuffersBSQ () |
A single line of input data from each input cube will be passed to the line processing function. More... | |
std::vector< BufferManager * > | GetBuffersBIL () |
A single line of input data from each input cube will be passed to the line processing function. More... | |
std::vector< BufferManager * > | GetBuffersBIP () |
A single band of input data from each input cube will be passed to the band processing function. More... | |
Protected Attributes | |
PvlFormatPds * | m_formatter |
Used to determine how to format the keyword values in the PDS file. More... | |
Pvl * | m_label |
Exported PDS label. More... | |
PdsExportType | m_exportType |
Stream or Fixed. More... | |
ExportFormat | p_format |
Current storage order. More... | |
double | p_outputMinimum |
Desired minimum pixel value in the Buffer. More... | |
double | p_outputMiddle |
Middle pixel value (minimum+maximun)/2.0 in the Buffer. More... | |
double | p_outputMaximum |
Desired maximum pixel value in the Buffer. More... | |
std::vector< double > | p_inputMinimum |
Minimum pixel value in the input cube to be mapped to the minimum value in the Buffer. More... | |
std::vector< double > | p_inputMiddle |
Middle pixel value in the input cube to be mapped to the (minimum+maximum)/2.0 value in the Buffer. More... | |
std::vector< double > | p_inputMaximum |
Maximum pixel value in the input cube to be mapped to the maximum value in the Buffer. More... | |
EndianSwapper * | p_endianSwap |
Object to swap the endianness of the raw output to either MSB or LSB. More... | |
ByteOrder | p_endianType |
The byte order of the output file. More... | |
PixelType | p_pixelType |
The bits per pixel of the output image. More... | |
std::vector< Stretch * > | p_str |
Stretch object to ensure a reasonable range of pixel values in the output data. More... | |
double | p_Null |
The output value for pixels whose input DNs are Null values. More... | |
double | p_Lis |
The output value for pixels whose input DNs are Low Instrument Saturation values. More... | |
double | p_Lrs |
The output value for pixels whose input DNs are Low Representation Saturation values. More... | |
double | p_His |
The output value for pixels whose input DNs are High Instrument Saturation values. More... | |
double | p_Hrs |
The output value for pixels whose input DNs are High Representation Saturation values. More... | |
bool | p_Null_Set |
Indicates whether p_Null has been set (i.e. More... | |
bool | p_Lis_Set |
Indicates whether p_Lis has been set (i.e. More... | |
bool | p_Lrs_Set |
Indicates whether p_Lrs has been set (i.e. More... | |
bool | p_His_Set |
Indicates whether p_His has been set (i.e. More... | |
bool | p_Hrs_Set |
Indicates whether p_Hrs has been set (i.e. More... | |
QCryptographicHash * | m_cryptographicHash |
A cryptographic hash that will generate an MD5 checksum of the image data. More... | |
bool | m_canGenerateChecksum |
Flag to determine if a file checksum will be generated. More... | |
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 Member Functions | |
void | isisOut8 (Buffer &in, std::ofstream &fout) |
Method for writing 8-bit unsigned pixel data to a file stream. More... | |
void | isisOut16s (Buffer &in, std::ofstream &fout) |
Method for writing 16-bit signed pixel data to a file stream. More... | |
void | isisOut16u (Buffer &in, std::ofstream &fout) |
Method for writing 16-bit unsigned pixel data to a file stream. More... | |
void | isisOut32 (Buffer &in, std::ofstream &fout) |
Method for writing 32-bit signed floating point pixels data to a file stream. More... | |
void | isisOut64 (Buffer &in, std::ofstream &fout) |
Method for writing 64-bit signed double precision floating point pixels data to a file stream. More... | |
void | InitProcess () |
Convenience method that checks to make sure the user is only using valid input to the StartProcess method. More... | |
Private Attributes | |
PdsResolution | m_exportResolution |
Meters or kilometers. More... | |
bool | m_forceBands |
Indicates whether to keep the BANDS keyword in the PDS labels. More... | |
bool | m_forceBandName |
Indicates whether to keep the BAND_NAME keyword in the PDS labels. More... | |
bool | m_forceCenterFilterWavelength |
Indicates whether to keep the CENTER_FILTER_WAVELENGTH keyword in the PDS labels. More... | |
bool | m_forceBandwidth |
Indicates whether to keep the BANDWIDTH keyword in the PDS labels. More... | |
bool | m_forceBandStorageType |
Indicates whether to add the BAND_STORAGE_TYPE keyword in the PDS labels. More... | |
bool | m_forceOffset |
Indicates whether to add the OFFSET keyword in the PDS labels. More... | |
bool | m_forceScalingFactor |
Indicates whether to add the SCALING_FACTOR keyword in the PDS labels. More... | |
bool | m_forceSampleBits |
Indicates whether to add the SAMPLE_BITS keyword in the PDS labels. More... | |
bool | m_forceSampleBitMask |
Indicates whether to add the SAMPLE_BIT_MASK keyword in the PDS labels. More... | |
bool | m_forceSampleType |
Indicates whether to add the SAMPLE_TYPE keyword in the PDS labels. More... | |
bool | m_forceCoreNull |
Indicates whether to add the CORE_NULL keyword in the PDS labels. More... | |
bool | m_forceCoreLrs |
Indicates whether to add the CORE_LOW_REPR_SATURATION keyword in the PDS labels. More... | |
bool | m_forceCoreLis |
Indicates whether to add the CORE_LOW_INSTR_SATURATION keyword in the PDS labels. More... | |
bool | m_forceCoreHrs |
Indicates whether to add the CORE_HIGH_REPR_SATURATION keyword in the PDS labels. More... | |
bool | m_forceCoreHis |
Indicates whether to add the CORE_HIGH_INSTR_SATURATION keyword in the PDS labels. More... | |
bool | m_detachedLabel |
Indicates whether the PDS file will be detached. More... | |
QString | m_detachedPdsLabelFile |
The name of the detached PDS label file. More... | |
PdsFileType | m_pdsFileType |
Image, Qube, Spectral Qube, or JP2 Image. More... | |
std::vector< int > | m_tableStartRecord |
Record number where the added table data begins. More... | |
std::vector< int > | m_tableRecords |
Number of records in each added table. More... | |
std::vector< char * > | m_tableBuffers |
Vector containing the binary table data for each of the added tables. More... | |
Process class for exporting cubes to PDS standards.
This class extends the ProcessExport class to allow the user to export cubes to PDS format.
Tables from the cube may also be exported. These exported PDS tables may be attached or detached. This should correspond to whether the labels of the exported PDS file are attached or detached. NOTE: If attached, the labels of the table should not be altered in the export program unless functionality is added to deal with the new start byte values for the tables.
Definition at line 78 of file ProcessExportPds.h.
|
inherited |
Storage order enumeration.
Enumerator | |
---|---|
BSQ | Band sequential. |
BIL | Band interleaved by line. |
BIP | Band interleaved by pixel. |
JP2 | Compressed JPEG2000. |
Definition at line 116 of file ProcessExport.h.
Record format type of exported PDS file.
Enumerator | |
---|---|
Stream | Stream Records. This type is generally used for ASCII files. |
Fixed | Fixed length records. PDS recommends that FIXED_LENGTH records are used whenever possible. |
Definition at line 110 of file ProcessExportPds.h.
File type to be exported.
Enumerator | |
---|---|
Image | Two dimensional array of line/sample values. These files generallly have the extension *.img or *.imq |
Qube | Multi-dimensional array (1-3 dimensional) whose axes may be interpreted as line/sample/band. These files generally have the extension *.qub |
SpectralQube | Three dimensional objects with two spatial dimensions and one spectral dimension. These files generally have the extension *.qub |
JP2Image | Image coding system JPEG 2000 formatted image. These files generally have the extension *.jp2 |
Definition at line 84 of file ProcessExportPds.h.
Resolution units per pixel of the exported PDS file.
Enumerator | |
---|---|
Meter | Meters per pixel. |
Kilometer | Kilometers per pixel. |
Definition at line 100 of file ProcessExportPds.h.
Isis::ProcessExportPds::ProcessExportPds | ( | ) |
Default Constructor - Set to default the data members.
Definition at line 36 of file ProcessExportPds.cpp.
Isis::ProcessExportPds::~ProcessExportPds | ( | ) |
Destructor.
Definition at line 68 of file ProcessExportPds.cpp.
bool Isis::ProcessExportPds::Attached | ( | ) |
Accessor function returns true if the output PDS file is set to attached.
Definition at line 1091 of file ProcessExportPds.cpp.
|
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 279 of file Process.h.
References Isis::Process::p_bandStats.
|
inherited |
Calculates and stores off statistics on every band of every cube added to this process via the SetInputCube method.
The newly calculated statistics are stored in two ways: as a vector where each entry is a single Statistics object for every band of a particular input cube, and as a vector where each entry is a vector of Statistics objects, for each band separately, of a particular input cube.
Definition at line 824 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 |
@description Return if we can generate a checksum
Definition at line 684 of file ProcessExport.cpp.
References Isis::ProcessExport::m_canGenerateChecksum.
|
inherited |
Checks to make sure the input cube meets the inputted requirements.
cube | Cube to check |
requirements | Use to specify requirements for the input file. The following requirments are checked against 1) ic_base::SizeMatch checks to make sure the input cube has the same bands, samples, and lines as the first input cube open using this method, 2) ic_base::SpatialMatch checks to make sure the input cube has the same samples and lines as the first input cube, 3) ic_base::Georeferenced checks to make sure latitude/longitudes can be obtained from the input cube, 4) ic_base::FullyGeoreferenced checks to make sure latitude/longitude, phase/incidence/emission, and other geometric parameters can be obtained from the input cube, 5) ic_base::OneBand checks to make sure the input cube has exactly one band. Note, that these requirements can be logically or'ed. For example, ic_base::SpatialMatch | ic_base::georeferenced. Defaults to 0 |
Isis::iException::Message |
Definition at line 503 of file Process.cpp.
References Isis::Cube::bandCount(), Isis::Cube::fileName(), Isis::Cube::lineCount(), and Isis::Cube::sampleCount().
|
inherited |
@description Generates a file checksum.
This must be called after StartProcess.
Definition at line 694 of file ProcessExport.cpp.
References Isis::ProcessExport::m_canGenerateChecksum, Isis::ProcessExport::m_cryptographicHash, and Isis::IException::Programmer.
|
inherited |
Close owned cubes from the list and clear the list.
Definition at line 593 of file Process.cpp.
|
inherited |
Close owned input cubes from the list and clear the list.
Definition at line 603 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 617 of file Process.cpp.
|
protectedvirtual |
Create a standard PDS label for type IMAGE.
Definition at line 119 of file ProcessExportPds.cpp.
|
protected |
Create a standard PDS label for type QUBE.
Definition at line 161 of file ProcessExportPds.cpp.
References Isis::PvlObject::findObject(), and Isis::PvlObject::hasObject().
|
protected |
Create a standard PDS label for type SPECTRAL_QUBE.
Definition at line 182 of file ProcessExportPds.cpp.
References Isis::PvlObject::findObject(), and Isis::PvlObject::hasObject().
|
inherited |
Create a standard world file for the input cube.
This method creates a standard world file from the mapping group of the input cube.
worldFile | [in] Reference to a string containing the name of a file to write the world information to. |
Definition at line 1255 of file ProcessExport.cpp.
References Isis::Process::InputCubes, Isis::Projection::Resolution(), Isis::Projection::SetWorld(), Isis::Projection::XCoord(), and Isis::Projection::YCoord().
Referenced by Isis::ImageExporter::createWorldFile().
|
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 293 of file Process.h.
References Isis::Process::p_cubeStats.
bool Isis::ProcessExportPds::Detached | ( | ) |
Accessor function returns true if the output PDS file is set to detached.
Definition at line 1082 of file ProcessExportPds.cpp.
|
virtualinherited |
End the processing sequence and cleans up by closing cubes, freeing memory, etc.
Reimplemented in Isis::ProcessPolygons, Isis::ProcessMosaic, Isis::ProcessImportPds, Isis::ProcessGroundPolygons, Isis::ProcessByTile, Isis::ProcessByBrick, and Isis::ProcessByBoxcar.
Definition at line 455 of file Process.cpp.
Referenced by Isis::ImageExporter::createWorldFile(), Isis::ProcessByBoxcar::EndProcess(), and Isis::FileTool::saveAsEnlargedCube().
void Isis::ProcessExportPds::ExportTable | ( | Isis::Table | isisTable, |
QString | detachedPdsTableFileName = "" |
||
) |
This method will add a table to be exported to PDS.
If the output PDS labels are set to detached, the PDS table will be written to a detached file in this method. If the output PDS product is set to attached, the table will be added to a buffer and written to the PDS file when the StartProcess() method is called. Attached tables are written to the file after the image data.
Warning: If attached tables are exported and the labels of these tables are modified, the start byte value of the labels will need to be updated. There is no existing method (UpdateAttachedTableLabels) to do this in ProcessExportPds. If this functionality is needed, this class will need to be modified accordingly.
IException::Unknown | - "The output PDS file has been set to attached and a detached PDS table file name has been given. If detached is preferred, set the process to detached SetDetached() and call StandardPdsLabel() before calling ExportTable()." @throw IException::Unknown - "The output PDS file has been set to detached. A file name for the detached ouput PDS table file is required. If an attached output file is prefered, use the method ProcessExportPds::SetAttached() before calling ExportTable()." |
isisTable | The ISIS Table object to be exported to PDS. |
detachedPdsTableFileName | The name of the exported PDS table file, if detached. This value should not include a path. The path from the label file will be used. |
Definition at line 996 of file ProcessExportPds.cpp.
References Isis::PvlObject::addObject(), Isis::ExportPdsTable::exportTable(), Isis::ExportPdsTable::formatPdsTableName(), Isis::FileName::path(), Isis::Table::Records(), and Isis::toString().
|
virtualinherited |
Cleans up by closing cubes and freeing memory for owned cubes.
Clears the lists for all cubes.
Reimplemented in Isis::ProcessPolygons, Isis::ProcessImportPds, Isis::ProcessGroundPolygons, Isis::ProcessByTile, Isis::ProcessByBrick, and Isis::ProcessByBoxcar.
Definition at line 463 of file Process.cpp.
Referenced by Isis::ProcessByBoxcar::Finalize().
void Isis::ProcessExportPds::FixedImageRoot | ( | Pvl & | mainPvl | ) |
Create the fixed keywords for the ROOT object in a PDS IMAGE file.
mainPvl |
Definition at line 295 of file ProcessExportPds.cpp.
References Isis::FileName::name().
void Isis::ProcessExportPds::FixedJP2ImageRoot | ( | Pvl & | mainPvl | ) |
Create the fixed keywords for the ROOT object in a PDS JP2 IMAGE file.
mainPvl |
Definition at line 330 of file ProcessExportPds.cpp.
References Isis::PvlObject::addObject(), Isis::FileName::name(), and Isis::toString().
void Isis::ProcessExportPds::ForceBandName | ( | bool | force | ) |
Mutator method to set how the BAND_NAME keyword will be handled.
If false and the BAND_NAME keyword exists in the IMAGE object of the PDS labels, the keyword will be removed. This member variable defaults to true in the ProcessExportPds constructor.
force | Indicates whether to force the process to keep the BAND_NAME keyword in the PDS image labels. |
Definition at line 1137 of file ProcessExportPds.cpp.
void Isis::ProcessExportPds::ForceBands | ( | bool | force | ) |
Mutator method to set how the the BANDS keyword will be handled.
If false, the BANDS keyword will be removed from the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.
force | Indicates whether to force the process to keep the BANDS keyword in the PDS image labels. |
Definition at line 1124 of file ProcessExportPds.cpp.
void Isis::ProcessExportPds::ForceBandStorageType | ( | bool | force | ) |
Mutator method to set how the BAND_STORAGE_TYPE keyword will be handled.
If true, the BAND_STORAGE_TYPE keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.
force | Indicates whether to force the process to add the BAND_STORAGE_TYPE keyword in the PDS image labels. |
Definition at line 1176 of file ProcessExportPds.cpp.
void Isis::ProcessExportPds::ForceBandwidth | ( | bool | force | ) |
Mutator method to set how the BANDWIDTH keyword will be handled.
If false and the BANDWIDTH keyword exists in the IMAGE object of the PDS labels, the keyword will be removed. This member variable defaults to true in the ProcessExportPds constructor.
force | Indicates whether to force the process to keep the BANDWIDTH keyword in the PDS image labels. |
Definition at line 1163 of file ProcessExportPds.cpp.
void Isis::ProcessExportPds::ForceCenterFilterWavelength | ( | bool | force | ) |
Mutator method to set how the CENTER_FILTER_WAVELENGTH keyword will be handled.
If false and the CENTER_FILTER_WAVELENGTH keyword exists in the IMAGE object of the PDS labels, the keyword will be removed. This member variable defaults to true in the ProcessExportPds constructor.
force | Indicates whether to force the process to keep the CENTER_FILTER_WAVELENGTH keyword in the PDS image labels. |
Definition at line 1150 of file ProcessExportPds.cpp.
void Isis::ProcessExportPds::ForceCoreHis | ( | bool | force | ) |
Mutator method to set how the CORE_HIGH_INSTR_SATURATION keyword will be handled.
If true, the CORE_HIGH_INSTR_SATURATION keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.
force | Indicates whether to force the process to add the CORE_HIGH_INSTR_SATURATION keyword in the PDS image labels. |
Definition at line 1309 of file ProcessExportPds.cpp.
void Isis::ProcessExportPds::ForceCoreHrs | ( | bool | force | ) |
Mutator method to set how the CORE_HIGH_REPR_SATURATION keyword will be handled.
If true, the CORE_HIGH_REPR_SATURATION keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.
force | Indicates whether to force the process to add the CORE_HIGH_REPR_SATURATION keyword in the PDS image labels. |
Definition at line 1295 of file ProcessExportPds.cpp.
void Isis::ProcessExportPds::ForceCoreLis | ( | bool | force | ) |
Mutator method to set how the CORE_LOW_INSTR_SATURATION keyword will be handled.
If true, the CORE_LOW_INSTR_SATURATION keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.
force | Indicates whether to force the process to add the CORE_LOW_INSTR_SATURATION keyword in the PDS image labels. |
Definition at line 1281 of file ProcessExportPds.cpp.
void Isis::ProcessExportPds::ForceCoreLrs | ( | bool | force | ) |
Mutator method to set how the CORE_LOW_REPR_SATURATION keyword will be handled.
If true, the CORE_LOW_REPR_SATURATION keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.
force | Indicates whether to force the process to add the CORE_LOW_REPR_SATURATION keyword in the PDS image labels. |
Definition at line 1267 of file ProcessExportPds.cpp.
void Isis::ProcessExportPds::ForceCoreNull | ( | bool | force | ) |
Mutator method to set how the CORE_NULL keyword will be handled.
If true, the CORE_NULL keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.
force | Indicates whether to force the process to add the CORE_NULL keyword in the PDS image labels. |
Definition at line 1254 of file ProcessExportPds.cpp.
void Isis::ProcessExportPds::ForceOffset | ( | bool | force | ) |
Mutator method to set how the OFFSET keyword will be handled.
If true, the OFFSET keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.
force | Indicates whether to force the process to add the OFFSET keyword in the PDS image labels. |
Definition at line 1189 of file ProcessExportPds.cpp.
void Isis::ProcessExportPds::ForceSampleBitMask | ( | bool | force | ) |
Mutator method to set how the SAMPLE_BIT_MASK keyword will be handled.
If true, the SAMPLE_BIT_MASK keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.
force | Indicates whether to force the process to add the SAMPLE_BIT_MASK keyword in the PDS image labels. |
Definition at line 1228 of file ProcessExportPds.cpp.
void Isis::ProcessExportPds::ForceSampleBits | ( | bool | force | ) |
Mutator method to set how the SAMPLE_BITS keyword will be handled.
If true, the SAMPLE_BITS keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.
force | Indicates whether to force the process to add the SAMPLE_BITS keyword in the PDS image labels. |
Definition at line 1215 of file ProcessExportPds.cpp.
void Isis::ProcessExportPds::ForceSampleType | ( | bool | force | ) |
Mutator method to set how the SAMPLE_TYPE keyword will be handled.
If true, the SAMPLE_TYPE keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.
force | Indicates whether to force the process to add the SAMPLE_TYPE keyword in the PDS image labels. |
Definition at line 1241 of file ProcessExportPds.cpp.
void Isis::ProcessExportPds::ForceScalingFactor | ( | bool | force | ) |
Mutator method to set how the SCALING_FACTOR keyword will be handled.
If true, the SCALING_FACTOR keyword will be added to the IMAGE object of the PDS labels. This member variable defaults to true in the ProcessExportPds constructor.
force | Indicates whether to force the process to add the SCALING_FACTOR keyword in the PDS image labels. |
Definition at line 1202 of file ProcessExportPds.cpp.
|
protectedinherited |
A single line of input data from each input cube will be passed to the line processing function.
Note the data will be stretched based on the invocations of the SetInputRange and SetOutputRange methods.
funct | (Isis::Buffer &b) Name of your line processing function. The buffer in will contain stretched input cube pixels for an entire line of each input cube. These pixels must be written to the foreign output file (e.g, jpg, tif, etc). |
Definition at line 944 of file ProcessExport.cpp.
References Isis::BufferManager::begin(), Isis::Process::InputCubes, and Isis::IException::Programmer.
|
protectedinherited |
A single band of input data from each input cube will be passed to the band processing function.
Note the data will be stretched based on the invocations of the SetInputRange and SetOutputRange methods.
funct | (Isis::Buffer &b) Name of your band processing function. The buffer in will contain stretched input cube pixels for an entire line of each input cube. These pixels must be written to the foreign output file (e.g, jpg, tif, etc). |
Definition at line 982 of file ProcessExport.cpp.
References Isis::BufferManager::begin(), Isis::Process::InputCubes, and Isis::IException::Programmer.
|
protectedinherited |
A single line of input data from each input cube will be passed to the line processing function.
Note the data will be stretched based on the invocations of the SetInputRange and SetOutputRange methods.
funct | (Isis::Buffer &b) Name of your line processing function. The buffer in will contain stretched input cube pixels for an entire line of each input cube. These pixels must be written to the foreign output file (e.g, jpg, tif, etc). |
Definition at line 905 of file ProcessExport.cpp.
References Isis::BufferManager::begin(), Isis::Process::InputCubes, and Isis::IException::Programmer.
|
inherited |
Get the valid maximum pixel value for the Nth input cube.
Definition at line 429 of file ProcessExport.cpp.
References Isis::ProcessExport::p_inputMaximum, and Isis::IException::Programmer.
|
inherited |
Get the valid minimum pixel value for the Nth input cube.
Definition at line 418 of file ProcessExport.cpp.
References Isis::ProcessExport::p_inputMinimum, and Isis::IException::Programmer.
|
inlineinherited |
Get the valid maximum pixel value to be written to the output file.
Definition at line 165 of file ProcessExport.h.
References Isis::ProcessExport::p_outputMaximum.
|
inlineinherited |
Get the valid minimum pixel value to be written to the output file.
Definition at line 161 of file ProcessExport.h.
References Isis::ProcessExport::p_outputMinimum.
|
privateinherited |
Convenience method that checks to make sure the user is only using valid input to the StartProcess method.
Set cube up for processing.
Also sets the cube up to be processed by performing the necessary stretches.
This method is called from startProcess() to validate the input cube before processing and to ready the input cube for reading line by line in the cases of BSQ and BIL, or reading band by band in the case of BIP.
Isis::iException::Message | - No input cube was specified |
Definition at line 726 of file ProcessExport.cpp.
References Isis::ProcessExport::BIP, Isis::Progress::CheckStatus(), Isis::Process::InputCubes, Isis::IsValidPixel(), Isis::ProcessExport::OutputHis(), Isis::ProcessExport::OutputHrs(), Isis::ProcessExport::OutputLis(), Isis::ProcessExport::OutputLrs(), Isis::ProcessExport::OutputNull(), Isis::ProcessExport::p_format, Isis::ProcessExport::p_inputMaximum, Isis::ProcessExport::p_inputMiddle, Isis::ProcessExport::p_inputMinimum, Isis::ProcessExport::p_outputMaximum, Isis::ProcessExport::p_outputMiddle, Isis::ProcessExport::p_outputMinimum, Isis::Process::p_progress, Isis::ProcessExport::p_str, Isis::IException::Programmer, and Isis::Progress::SetMaximumSteps().
Referenced by Isis::ProcessExport::StartProcess().
|
privateinherited |
Method for writing 16-bit signed pixel data to a file stream.
Write a buffer of 16-bit signed pixel data to a stream.
This method takes a buffer of data and assumes that it is 16-bit signed pixel data. It will apply the necessary endian swap to the data and write it out to the output file buffer that the user specifies. The user can only expect to access this method indirectly by calling the StartProcess method.
&in | Reference to a single buffer of pixel data. Note that this buffer will already have had the necessary stretching operations, though it will have the native endianness of the system. |
&fout | Name of the file stream to which the buffer of pixel data will be written. |
Definition at line 1136 of file ProcessExport.cpp.
References Isis::ProcessExport::p_endianSwap, Isis::EndianSwapper::ShortInt(), and Isis::Buffer::size().
Referenced by Isis::ProcessExport::StartProcess().
|
privateinherited |
Method for writing 16-bit unsigned pixel data to a file stream.
Write a bufferof 16-bit unsigned pixel data to a stream.
This method takes a buffer of data and assumes that it is 16-bit unsigned pixel data. It will apply the necessary endian swap to the data and write it out to the output file buffer that the user specifies. The user can only expect to access this method indirectly by calling the StartProcess method.
&in | Reference to a single buffer of pixel data. Note that this buffer will already have had the necessary stretching operations, though it will have the native endianness of the system. |
&fout | Name of the file stream to which the buffer of pixel data will be written. |
Definition at line 1183 of file ProcessExport.cpp.
References Isis::ProcessExport::p_endianSwap, Isis::Buffer::size(), and Isis::EndianSwapper::UnsignedShortInt().
Referenced by Isis::ProcessExport::StartProcess().
|
privateinherited |
Method for writing 32-bit signed floating point pixels data to a file stream.
Write a buffer of 32-bit floating point pixel data to a stream.
This method takes a buffer of data and assumes that it is 32-bit floating point pixel data. It will apply the necessary endian swap to the data and write it out to the output file buffer that the user specifies. The user can only expect to access this method indirectly by calling the StartProcess method.
&in | Reference to a single buffer of pixel data. Note that this buffer will already have had the necessary stretching operations, though it will have the native endianness of the system. |
&fout | Name of the file stream to which the buffer of pixel data will be written. |
Definition at line 1223 of file ProcessExport.cpp.
References Isis::EndianSwapper::ExportFloat(), Isis::ProcessExport::p_endianSwap, and Isis::Buffer::size().
Referenced by Isis::ProcessExport::StartProcess().
|
privateinherited |
Method for writing 64-bit signed double precision floating point pixels data to a file stream.
|
privateinherited |
Method for writing 8-bit unsigned pixel data to a file stream.
Write a buffer of 8-bit pixel data to a stream.
This method takes a buffer of data and assumes that it is 8 bit pixel data. It will apply the necessary endian swap to the data and write it out to the output file buffer that the user specifies. The user can only expect to access this method indirectly by calling the StartProcess method
&in | Reference to a single buffer of pixel data. Note that this buffer will already have had the necessary stretching operations, though it will have the native endianness of the system. |
&fout | Name of the file stream to which the buffer of pixel data will be written. |
Definition at line 1099 of file ProcessExport.cpp.
References Isis::Buffer::size().
Referenced by Isis::ProcessExport::StartProcess().
|
protected |
Return the size of the output PDS label.
Definition at line 850 of file ProcessExportPds.cpp.
|
protected |
Return the line bytes (record size) for the input cube, at present this is based on the number of samples and the bytes per pixel.
Definition at line 837 of file ProcessExportPds.cpp.
References Isis::Cube::sampleCount(), and Isis::SizeOf().
|
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 768 of file Process.cpp.
References Isis::FileName::expanded(), Isis::FileName::fileExists(), Isis::PvlObject::findGroup(), and Isis::FileName::highestVersion().
void Isis::ProcessExportPds::OutputDetachedLabel | ( | ) |
Write the PDS label to the a detached file.
The PDS keywords that have place holder "?" for their values (such as LABEL_RECORDS and ^IMAGE) will be updated to their correct values before they are written.
Definition at line 866 of file ProcessExportPds.cpp.
|
inherited |
Return the output special pixel value for HIS.
Definition at line 569 of file ProcessExport.cpp.
References Isis::ProcessExport::p_His, Isis::ProcessExport::p_His_Set, and Isis::ProcessExport::p_outputMaximum.
Referenced by Isis::ProcessExport::InitProcess().
|
inherited |
Return the output special pixel value for HRS.
Definition at line 577 of file ProcessExport.cpp.
References Isis::ProcessExport::p_Hrs, Isis::ProcessExport::p_Hrs_Set, and Isis::ProcessExport::p_outputMaximum.
Referenced by Isis::ProcessExport::InitProcess().
void Isis::ProcessExportPds::OutputLabel | ( | std::ofstream & | os | ) |
Write the PDS label to the supplied stream.
The PDS keywords that have place holder "?" for their values (such as LABEL_RECORDS and ^IMAGE) will be updated to their correct values before they are written.
Output | file stream to which the pds label will be written. |
Definition at line 885 of file ProcessExportPds.cpp.
References Isis::toString().
|
inherited |
Return the output special pixel value for LIS.
Definition at line 553 of file ProcessExport.cpp.
References Isis::ProcessExport::p_Lis, Isis::ProcessExport::p_Lis_Set, and Isis::ProcessExport::p_outputMinimum.
Referenced by Isis::ProcessExport::InitProcess().
|
inherited |
Return the output special pixel value for LRS.
Definition at line 561 of file ProcessExport.cpp.
References Isis::ProcessExport::p_Lrs, Isis::ProcessExport::p_Lrs_Set, and Isis::ProcessExport::p_outputMinimum.
Referenced by Isis::ProcessExport::InitProcess().
|
inherited |
Return the output special pixel value for NULL.
Definition at line 545 of file ProcessExport.cpp.
References Isis::ProcessExport::p_Null, Isis::ProcessExport::p_Null_Set, and Isis::ProcessExport::p_outputMinimum.
Referenced by Isis::ProcessExport::InitProcess().
|
inlineinherited |
This method returns a pointer to a Progress object.
Definition at line 259 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().
|
protected |
Return a projection name.
inputLabel |
Definition at line 823 of file ProcessExportPds.cpp.
References Isis::Projection::Name().
|
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 737 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 639 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 650 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 748 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 727 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 678 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 698 of file Process.cpp.
References Isis::Cube::close(), Isis::Cube::label(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Cube::open(), and Isis::Cube::read().
void Isis::ProcessExportPds::SetAttached | ( | ) |
Mutator method to set the output PDS file to attached.
In this case, there will be a single output file containing the PDS label, image data, and any PDS tables that are added.
Definition at line 1072 of file ProcessExportPds.cpp.
|
inherited |
@description Set m_canGenerateChecksum which determines if we can generate a MD5 checksum on the image data.
flag | boolean to generate the checksum or not |
Definition at line 673 of file ProcessExport.cpp.
References Isis::ProcessExport::m_canGenerateChecksum.
void Isis::ProcessExportPds::SetDetached | ( | QString | detachedLabelFile | ) |
Mutator method to set the output PDS file to detached.
In this case, there will be separate output files containing the PDS label, image data, and any PDS tables that are added.
detachedLabelFile | A string containing the name of the detached PDS label file |
Definition at line 1061 of file ProcessExportPds.cpp.
void Isis::ProcessExportPds::SetExportType | ( | PdsExportType | recordFormat | ) |
Mutator method to set the output PDS image record type to stream or fixed.
recordFormat | Enumerated value for the record type of the exported PDS file. |
Definition at line 1112 of file ProcessExportPds.cpp.
|
inlineinherited |
Sets the storage order of the output file.
Definition at line 170 of file ProcessExport.h.
References Isis::ProcessExport::p_format.
Referenced by Isis::ImageExporter::initializeProcess(), and Isis::ProcessExport::ProcessExport().
|
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 | Requirements to check that the input cube meets. See CheckRequirements(). |
Isis::iException::Message |
Reimplemented in Isis::ProcessByBrick.
Definition at line 66 of file Process.cpp.
References Isis::CubeAttributeInput::bands(), Isis::Cube::open(), and Isis::Cube::setVirtualBands().
|
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 | Requirements to check that the input cube meets. See CheckRequirements(). |
Isis::iException::Message |
Reimplemented in Isis::ProcessBySample, Isis::ProcessByBrick, Isis::ProcessBySpectra, and Isis::ProcessByLine.
Definition at line 136 of file Process.cpp.
Referenced by Isis::ImageExporter::addChannel(), Isis::JigsawRunWidget::on_JigsawAcceptButton_clicked(), Isis::FileTool::saveAsEnlargedCube(), and Isis::ProcessGroundPolygons::SetStatCubes().
|
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 |
requirements | Requirements to check that the input cube meets. See CheckRequirements(). |
Definition at line 107 of file Process.cpp.
References Isis::Cube::isOpen().
|
inherited |
Set input pixel range from user.
This method performs the same function as SetInputRange(min,max) and SetInputRange(min,mid,max). However, the information for min/mid/max is obtained from the user via the command line. Therefore you must include the following parameter group in your application XML file:
Definition at line 359 of file ProcessExport.cpp.
References Isis::Application::GetUserInterface().
Referenced by Isis::ImageExporter::addChannel(), Isis::ProcessExport::SetInputRange(), and Isis::ImageExporter::write().
|
inherited |
Set input pixel range from to a linear stretch.
This method allows the programmer to define what range of input pixels in the input cube get mapped to the output range in the Buffer. By default the output range is 0.0 to 1.0 (can be overridden using the SetOutputRange method). This version of SetInputRange allows the programmer to perform a simple linear stretch. That is, "minimum:0.0 maximum:1.0" or minimum is mapped to 0.0, maximum is mapped to 1.0 everything inbetween is mapped linearly (e.g., (minimum+maximum)/2.0:0.5). Also, everything less than the minimum is mapped to 0.0 and everything more than the maximum is mapped to 1.0. If you are uncertain about how stretches operate see the Stretch object. If the input range is never set, no stretch will occur.
minimum | Minimum pixel value in the input cube to be mapped to the minimum value in the Buffer |
maximum | Maximum pixel value in the input cube to be mapped to the maximum value in the Buffer |
Isis::iException::Message |
Definition at line 93 of file ProcessExport.cpp.
References Isis::ProcessExport::SetInputRange().
|
inherited |
Set input pixel range from to a linear stretch.
This method allows the programmer to define what range of input pixels in the input cube get mapped to the output range in the Buffer. By default the output range is 0.0 to 1.0 (can be overridden using the SetOutputRange method). This version of SetInputRange allows the programmer to perform a simple linear stretch. That is, "minimum:0.0 maximum:1.0" or minimum is mapped to 0.0, maximum is mapped to 1.0 everything inbetween is mapped linearly (e.g., (minimum+maximum)/2.0:0.5). Also, everything less than the minimum is mapped to 0.0 and everything more than the maximum is mapped to 1.0. If you are uncertain about how stretches operate see the Stretch object. If the input range is never set, no stretch will occur.
minimum | Minimum pixel value in the input cube to be mapped to the minimum value in the Buffer |
maximum | Maximum pixel value in the input cube to be mapped to the maximum value in the Buffer |
index | The index of the channel you are setting |
Isis::iException::Message |
Definition at line 122 of file ProcessExport.cpp.
References Isis::ProcessExport::SetInputRange().
|
inherited |
Set input pixel range from to a piecewise linear stretch.
This method allows the programmer to define what range of input pixels in the input cube get mapped to the output range in the Buffer. By default the output range is 0.0 to 1.0 (can be overridden using the SetOutputRange method). This version of SetInputRange allows the programmer to perform a piecewise linear stretch. That is,"minimum:0.0 middle:0.5 maximum:1.0". The pixels from the input cube between minimum and middle are mapped to 0.0 and 0.5 linearly, while pixels between middle and maximum are mapped to 0.5 and 1.0 linearly. Those outside the range of minimum and maximum are mapped to 0.0 and 1.0 respectively. If you are uncertain about how stretches operate see the Stretch object. If the input range is never set, no stretch will occur.
minimum | Minimum pixel value in the input cube to be mapped to the minimum value in the Buffer |
middle | Middle pixel value in the input cube to be mapped to the (minimum+maximum)/2.0 value in the Buffer |
maximum | Maximum pixel value in the input cube to be mapped to the maximum value in the Buffer |
Isis::IException::Message |
Definition at line 153 of file ProcessExport.cpp.
References Isis::Process::InputCubes, Isis::ProcessExport::p_inputMaximum, Isis::ProcessExport::p_inputMiddle, Isis::ProcessExport::p_inputMinimum, and Isis::IException::Programmer.
|
inherited |
Set input pixel range from to a piecewise linear stretch.
This method allows the programmer to define what range of input pixels in the input cube get mapped to the output range in the Buffer. By default the output range is 0.0 to 1.0 (can be overridden using the SetOutputRange method). This version of SetInputRange allows the programmer to perform a piecewise linear stretch. That is,"minimum:0.0 middle:0.5 maximum:1.0". The pixels from the input cube between minimum and middle are mapped to 0.0 and 0.5 linearly, while pixels between middle and maximum are mapped to 0.5 and 1.0 linearly. Those outside the range of minimum and maximum are mapped to 0.0 and 1.0 respectively. If you are uncertain about how stretches operate see the Stretch object. If the input range is never set, no stretch will occur.
minimum | Minimum pixel value in the input cube to be mapped to the minimum value in the Buffer |
middle | Middle pixel value in the input cube to be mapped to the (minimum+maximum)/2.0 value in the Buffer |
maximum | Maximum pixel value in the input cube to be mapped to the maximum value in the Buffer |
index | The index of the channel you are setting |
Isis::iException::Message |
Definition at line 201 of file ProcessExport.cpp.
References Isis::Process::InputCubes, Isis::ProcessExport::p_inputMaximum, Isis::ProcessExport::p_inputMiddle, Isis::ProcessExport::p_inputMinimum, and Isis::IException::Programmer.
|
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 309 of file Process.cpp.
References 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().
|
virtualinherited |
Allocates a user-specified output cube whose size matches the first input cube.
parameter | User specified output file. For example, "TO" is a popular user parameter. If the user specified TO=output.cub, then this routine would allocate the file output.cub with size specified by the first opened input cube. The output pixel type will be propagated from the first loaded input cube or will use the value in the application XML file for pixelType. |
Isis::iException::Message |
Reimplemented in Isis::ProcessMosaic, Isis::ProcessImport, and Isis::ProcessMapMosaic.
Definition at line 160 of file Process.cpp.
Referenced by Isis::FileTool::saveAsEnlargedCube(), and Isis::ProcessImport::SetOutputCube().
|
virtualinherited |
Allocates a user specified output cube whose size is specified by the programmer.
parameter | User specified output file. For example, "TO" is a popular user parameter. If the user specified TO=output.cub, then this routine would allocate the file output.cub with size specified by the first opened input cube. The output pixel type will be propagated from the first loaded input cube or will use the value in the application XML file for pixelType. |
ns | Number of samples to allocate |
nl | Number of lines to allocate |
nb | Number of bands to allocate |
Isis::iException::Message |
Definition at line 229 of file Process.cpp.
|
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 |
ui | A user interface used to get the attributes needed. If null, the user interface will be obtained from the application. |
Isis::iException::Message |
Definition at line 270 of file Process.cpp.
References IsisAml::GetFileName(), and IsisAml::GetOutputAttribute().
|
virtualinherited |
Allocates a user-specified output cube whose size matches the first input cube.
parameter | User specified output file. For example, "TO" is a popular user parameter. If the user specified TO=output.cub, then this routine would allocate the file output.cub with size specified by the first opened input cube. The output pixel type will be propagated from the first loaded input cube or will use the value in the application XML file for pixelType. |
ui | A user interface used to get the attributes needed for SetOutputCube. |
Isis::iException::Message |
Definition at line 193 of file Process.cpp.
|
inherited |
Set byte endianness of the output cube.
This method allows the programmer to specify whether the first byte of data output from the ProcessExport will be the most significant byte or the least significant byte. If the user does not explicitly set the endianness, it will default to that of the current system architecture
byteOrderIn | enumeration of the endianness (MSB or LSB) |
Definition at line 649 of file ProcessExport.cpp.
References Isis::ProcessExport::p_endianSwap, and Isis::ProcessExport::p_endianType.
Referenced by Isis::ProcessExport::ProcessExport().
|
inherited |
Set output special pixel value for HIS.
Sets the value for output special pixel HISs. HIS pixels values from the input cube will be set to this value. Be default this value will be set to the maximum out value set with SetOutputRange
value | The output pixel value for all HIS pixels |
Definition at line 521 of file ProcessExport.cpp.
References Isis::ProcessExport::p_His, and Isis::ProcessExport::p_His_Set.
|
inherited |
Set output special pixel value for HRS.
Sets the value for output special pixel HRSs. HRS pixels values from the input cube will be set to this value. Be default this value will be set to the maximum out value set with SetOutputRange
value | The output pixel value for all HRS pixels |
Definition at line 536 of file ProcessExport.cpp.
References Isis::ProcessExport::p_Hrs, and Isis::ProcessExport::p_Hrs_Set.
|
inherited |
Set output special pixel value for LIS.
Sets the value for output special pixel LISs. LIS pixels values from the input cube will be set to this value. Be default this value will be set to the minimum out value set with SetOutputRange
value | The output pixel value for all LIS pixels |
Definition at line 491 of file ProcessExport.cpp.
References Isis::ProcessExport::p_Lis, and Isis::ProcessExport::p_Lis_Set.
|
inherited |
Set output special pixel value for LRS.
Sets the value for output special pixel LRSs. LRS8 pixels values from the input cube will be set to this value. Be default this value will be set to the minimum out value set with SetOutputRange
value | The output pixel value for all LRS pixels |
Definition at line 506 of file ProcessExport.cpp.
References Isis::ProcessExport::p_Lrs, and Isis::ProcessExport::p_Lrs_Set.
|
inherited |
Set output special pixel value for NULL.
Sets the value for output special pixel NULLs. NULL pixels values from the input cube will be set to this value. Be default this value will be set to the minimum out value set with SetOutputRange
value | The output pixel value for all NULL pixels |
Definition at line 476 of file ProcessExport.cpp.
References Isis::ProcessExport::p_Null, and Isis::ProcessExport::p_Null_Set.
Referenced by Isis::ImageExporter::initializeProcess().
|
inherited |
Set output pixel range in Buffer.
This method allows the programmer to specify the acceptable range of values contained in the Buffer. If this method is never invoked, all pixel values received in the Buffer of the export function will be in the range of 0.0 to 1.0. However, this can be overridden, for example, to 0.0 and 255.0, by invoking this method.
minimum | Desired minimum pixel value in the Buffer |
maximum | Desired maximum pixel value in the Buffer |
Isis::iException::Message |
Definition at line 454 of file ProcessExport.cpp.
References Isis::ProcessExport::p_outputMaximum, Isis::ProcessExport::p_outputMiddle, Isis::ProcessExport::p_outputMinimum, and Isis::IException::Programmer.
Referenced by Isis::ImageExporter::initializeProcess(), and Isis::ProcessExport::SetOutputType().
|
inherited |
Set output pixel bit type in Buffer.
This method specifies the type of pixel data that is going to be output. Essentially, it is a convenience method that will automatically calculate the necessary output range based on the minimum and maximum values of the bit type that is specified. Currently, the method only supported data types are Isis::UnsignedByte (Range of 0 to 255), Isis::SignedWord (Range of -32768 to 32767), Isis::UnsignedWord (Range of 0 to 65535), and Isis::Real (Range from the minimum floating-point value to the maximum floating-point value supported in C++; -FLT_MAX to FLT_MAX), since these are the only formats that can be output by ProcessExport. If neither this method nor the SetOutputRange method is invoked, all pixel values received in the Buffer of the export function will be in the range of 0.0 to 1.0.
NOTE: You must set the format type of the output data with SetFormat before calling this method. Otherwise, you will get an error.
pixelIn | this is an enumeration of the different pixel types. The only values that are recognized as valid are Isis::UnsignedByte, Isis::SignedWord, Isis::UnsignedWord, and Isis::Real. |
Isis::iException::Message |
Definition at line 608 of file ProcessExport.cpp.
References Isis::ProcessExport::JP2, Isis::ProcessExport::p_format, Isis::ProcessExport::p_pixelType, Isis::IException::Programmer, and Isis::ProcessExport::SetOutputRange().
Referenced by Isis::ImageExporter::initializeProcess(), and Isis::ProcessExport::ProcessExport().
void Isis::ProcessExportPds::SetPdsResolution | ( | PdsResolution | resolutionUnits | ) |
Mutator method to set the output PDS image resolution to meters per pixel or kilometers per pixel.
resolutionUnits | Enumerated value for the units type to be set. |
Definition at line 1101 of file ProcessExportPds.cpp.
void Isis::ProcessExportPds::StandardAllMapping | ( | Pvl & | outputPvl | ) |
Create the standard keywords for the IMAGE_MAP_PROJECTION group in a PDS label.
mainPvl |
Isis::IException::Message |
Definition at line 674 of file ProcessExportPds.cpp.
References Isis::PvlToPvlTranslationManager::Auto(), Isis::PvlObject::findGroup(), Isis::PvlObject::findKeyword(), Isis::PvlContainer::findKeyword(), Isis::PvlObject::findObject(), Isis::PvlObject::hasKeyword(), Isis::PvlContainer::hasKeyword(), Isis::PvlObject::hasObject(), Isis::PvlKeyword::setValue(), Isis::toString(), and Isis::PvlKeyword::unit().
void Isis::ProcessExportPds::StandardImageImage | ( | Pvl & | mainPvl | ) |
Create the standard keywords for an IMAGE object in a PDS IMAGE file.
This should not be called until after all settings have been made. The labels may contain the wrong data if it is.
mainPvl |
Isis::IException::Message |
Definition at line 390 of file ProcessExportPds.cpp.
References Isis::PvlToPvlTranslationManager::Auto(), Isis::PvlContainer::deleteKeyword(), Isis::FileName::expanded(), Isis::PvlObject::findObject(), Isis::PvlObject::hasKeyword(), and Isis::toString().
void Isis::ProcessExportPds::StandardJP2Image | ( | Pvl & | mainPvl | ) |
Create the standard keywords for an IMAGE object in a PDS JP2 IMAGE file.
This should not be called until after all settings have been made. The labels may contain the wrong data if it is.
mainPvl |
Isis::IException::Message |
Definition at line 531 of file ProcessExportPds.cpp.
References Isis::PvlToPvlTranslationManager::Auto(), Isis::PvlContainer::deleteKeyword(), Isis::FileName::expanded(), Isis::PvlObject::findObject(), Isis::PvlObject::hasKeyword(), and Isis::toString().
|
virtual |
Create a standard PDS label of the type specified.
Create a standard PDS label of the type specified. The type must be Image. Qube and SpectralQube are not supported.
NOTE: This method should not be called until all setting have been finished. For example ProcessExport::SetOutputEndian
type | The type of PDS label to be created. |
Isis::iException::Message |
Definition at line 92 of file ProcessExportPds.cpp.
void Isis::ProcessExport::StartProcess |
Write an entire cube to an output file stream.
Just as with the other invocation of the StartProcess method, this will process an input cube buffer by buffer. Unlike the other invocation, this method takes care of writing the input data to an output file stream specified by the user instead of relying on an external function.
&fout | An open stream to which the pixel data will be written. After calling this method once, the stream will contain all of the pixel data from the input cube. |
Definition at line 128 of file ProcessExport.cpp.
|
virtual |
This method fills the image data of the PDS file using the parent class ProcessExport::StartProcess, then appends any attached tables.
fout | Output file stream to be filled with the PDS data. |
Reimplemented from Isis::ProcessExport.
Definition at line 1320 of file ProcessExportPds.cpp.
|
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 |
|
virtualinherited |
This method invokes the process operation over a single input cube.
In the cases of BSQ and BIL this is a process by line. In the case of BIP, this is a process by band. A single buffer of input data will be padd to the buffer processing function. Note the data will be stretched based on the invocations of the SetInputRange and SetpOutputRange methods.
funct | (Isis::Buffer &b) Name of your buffer processing function. The buffer in will contain stretched input cube pixels for an entire buffer. These pixels must be written to the foreign output file (e.g, jpg, tif, etc). |
Definition at line 790 of file ProcessExport.cpp.
References Isis::BufferManager::begin(), Isis::ProcessExport::BIL, Isis::ProcessExport::BIP, Isis::ProcessExport::BSQ, Isis::Progress::CheckStatus(), Isis::BufferManager::end(), Isis::ProcessExport::InitProcess(), Isis::Process::InputCubes, Isis::ProcessExport::JP2, Isis::BufferManager::next(), Isis::ProcessExport::p_format, Isis::Process::p_progress, Isis::ProcessExport::p_str, Isis::IException::Programmer, and Isis::Buffer::size().
void Isis::ProcessExport::StartProcess |
This method invokes the process operation over a single input cube.
In the cases of BSQ and BIL this is a process by line. In the case of BIP, this is a process by band. A single buffer of input data will be padd to the buffer processing function. Note the data will be stretched based on the invocations of the SetInputRange and SetpOutputRange methods.
funct | (Isis::Buffer &b) Name of your buffer processing function. The buffer in will contain stretched input cube pixels for an entire buffer. These pixels must be written to the foreign output file (e.g, jpg, tif, etc). |
Definition at line 126 of file ProcessExport.cpp.
void Isis::ProcessExportPds::StreamImageRoot | ( | Pvl & | mainPvl | ) |
Create the standard keywords for the ROOT object in a PDS IMAGE file.
mainPvl |
Definition at line 205 of file ProcessExportPds.cpp.
References Isis::FileName::name().
void Isis::ProcessExportPds::StreamJP2ImageRoot | ( | Pvl & | mainPvl | ) |
Create the standard keywords for the ROOT object in a PDS JP2 IMAGE file.
mainPvl |
Definition at line 239 of file ProcessExportPds.cpp.
References Isis::PvlObject::addObject(), Isis::FileName::name(), and Isis::toString().
void Isis::ProcessExportPds::updateChecksumInLabel | ( | std::ofstream & | pdsFileStream | ) |
Updates the CHECKSUM value on the label and rewrites to the output file.
std::ofstream | &pdsFileStream Output file to write the label to. |
Definition at line 953 of file ProcessExportPds.cpp.
|
inherited |
Writes out the History blob to the cube.
Definition at line 789 of file Process.cpp.
References Isis::History::AddEntry(), Isis::PvlContainer::isNamed(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Cube::readHistory(), 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 185 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::ProcessExport::StartProcess(), and Isis::ProcessByQuickFilter::StartProcess().
|
protectedinherited |
Flag to determine if a file checksum will be generated.
Definition at line 270 of file ProcessExport.h.
Referenced by Isis::ProcessExport::canGenerateChecksum(), Isis::ProcessExport::checksum(), Isis::ProcessExport::ProcessExport(), Isis::ProcessExport::setCanGenerateChecksum(), and Isis::ProcessExport::StartProcess().
|
protectedinherited |
A cryptographic hash that will generate an MD5 checksum of the image data.
Definition at line 268 of file ProcessExport.h.
Referenced by Isis::ProcessExport::checksum(), Isis::ProcessExport::ProcessExport(), Isis::ProcessExport::StartProcess(), and Isis::ProcessExport::~ProcessExport().
|
private |
Indicates whether the PDS file will be detached.
Definition at line 225 of file ProcessExportPds.h.
|
private |
The name of the detached PDS label file.
Definition at line 227 of file ProcessExportPds.h.
|
private |
Meters or kilometers.
Definition at line 185 of file ProcessExportPds.h.
|
protected |
Stream or Fixed.
Definition at line 182 of file ProcessExportPds.h.
|
private |
Indicates whether to keep the BAND_NAME keyword in the PDS labels.
Definition at line 188 of file ProcessExportPds.h.
|
private |
Indicates whether to keep the BANDS keyword in the PDS labels.
Definition at line 186 of file ProcessExportPds.h.
|
private |
Indicates whether to add the BAND_STORAGE_TYPE keyword in the PDS labels.
Definition at line 195 of file ProcessExportPds.h.
|
private |
Indicates whether to keep the BANDWIDTH keyword in the PDS labels.
Definition at line 193 of file ProcessExportPds.h.
|
private |
Indicates whether to keep the CENTER_FILTER_WAVELENGTH keyword in the PDS labels.
Definition at line 190 of file ProcessExportPds.h.
|
private |
Indicates whether to add the CORE_HIGH_INSTR_SATURATION keyword in the PDS labels.
Definition at line 222 of file ProcessExportPds.h.
|
private |
Indicates whether to add the CORE_HIGH_REPR_SATURATION keyword in the PDS labels.
Definition at line 219 of file ProcessExportPds.h.
|
private |
Indicates whether to add the CORE_LOW_INSTR_SATURATION keyword in the PDS labels.
Definition at line 216 of file ProcessExportPds.h.
|
private |
Indicates whether to add the CORE_LOW_REPR_SATURATION keyword in the PDS labels.
Definition at line 213 of file ProcessExportPds.h.
|
private |
Indicates whether to add the CORE_NULL keyword in the PDS labels.
Definition at line 211 of file ProcessExportPds.h.
|
private |
Indicates whether to add the OFFSET keyword in the PDS labels.
Definition at line 198 of file ProcessExportPds.h.
|
private |
Indicates whether to add the SAMPLE_BIT_MASK keyword in the PDS labels.
Definition at line 205 of file ProcessExportPds.h.
|
private |
Indicates whether to add the SAMPLE_BITS keyword in the PDS labels.
Definition at line 203 of file ProcessExportPds.h.
|
private |
Indicates whether to add the SAMPLE_TYPE keyword in the PDS labels.
Definition at line 208 of file ProcessExportPds.h.
|
private |
Indicates whether to add the SCALING_FACTOR keyword in the PDS labels.
Definition at line 200 of file ProcessExportPds.h.
|
protected |
Used to determine how to format the keyword values in the PDS file.
Definition at line 179 of file ProcessExportPds.h.
|
protected |
Exported PDS label.
Definition at line 181 of file ProcessExportPds.h.
|
protectedinherited |
|
private |
Image, Qube, Spectral Qube, or JP2 Image.
Definition at line 229 of file ProcessExportPds.h.
|
private |
Vector containing the binary table data for each of the added tables.
The order of the tables represented in this vector corresponds to the order of the table data in m_tableRecords.
Definition at line 242 of file ProcessExportPds.h.
|
private |
Number of records in each added table.
The order of the tables represented in this vector corresponds to the order of the table data in m_tableBuffers.
Definition at line 237 of file ProcessExportPds.h.
|
private |
Record number where the added table data begins.
The order of the tables represented in this vector corresponds to the order of the table data in m_tableBuffers
Definition at line 232 of file ProcessExportPds.h.
|
protectedinherited |
A vector of pointers to allocated Cube objects.
The pointers are established in the SetOutputCube method.
Definition at line 191 of file Process.h.
Referenced by Isis::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 172 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 179 of file Process.h.
Referenced by Isis::Process::CubeStatistics().
|
protectedinherited |
Object to swap the endianness of the raw output to either MSB or LSB.
Definition at line 237 of file ProcessExport.h.
Referenced by Isis::ProcessExport::isisOut16s(), Isis::ProcessExport::isisOut16u(), Isis::ProcessExport::isisOut32(), Isis::ProcessExport::ProcessExport(), Isis::ProcessExport::SetOutputEndian(), and Isis::ProcessExport::~ProcessExport().
|
protectedinherited |
The byte order of the output file.
Definition at line 239 of file ProcessExport.h.
Referenced by Isis::ProcessExport::SetOutputEndian().
|
protectedinherited |
Current storage order.
Definition at line 215 of file ProcessExport.h.
Referenced by Isis::ProcessExport::InitProcess(), Isis::ProcessExport::setFormat(), Isis::ProcessExport::SetOutputType(), and Isis::ProcessExport::StartProcess().
|
protectedinherited |
The output value for pixels whose input DNs are High Instrument Saturation values.
Definition at line 252 of file ProcessExport.h.
Referenced by Isis::ProcessExport::OutputHis(), and Isis::ProcessExport::SetOutputHis().
|
protectedinherited |
Indicates whether p_His has been set (i.e.
if setHis() has been called).
Definition at line 263 of file ProcessExport.h.
Referenced by Isis::ProcessExport::OutputHis(), Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetOutputHis().
|
protectedinherited |
The output value for pixels whose input DNs are High Representation Saturation values.
Definition at line 254 of file ProcessExport.h.
Referenced by Isis::ProcessExport::OutputHrs(), and Isis::ProcessExport::SetOutputHrs().
|
protectedinherited |
Indicates whether p_Hrs has been set (i.e.
if setHrs() has been called).
Definition at line 265 of file ProcessExport.h.
Referenced by Isis::ProcessExport::OutputHrs(), Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetOutputHrs().
|
protectedinherited |
Maximum pixel value in the input cube to be mapped to the maximum value in the Buffer.
Definition at line 234 of file ProcessExport.h.
Referenced by Isis::ProcessExport::GetInputMaximum(), Isis::ProcessExport::InitProcess(), Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetInputRange().
|
protectedinherited |
Middle pixel value in the input cube to be mapped to the (minimum+maximum)/2.0 value in the Buffer.
Definition at line 230 of file ProcessExport.h.
Referenced by Isis::ProcessExport::InitProcess(), Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetInputRange().
|
protectedinherited |
Minimum pixel value in the input cube to be mapped to the minimum value in the Buffer.
Definition at line 227 of file ProcessExport.h.
Referenced by Isis::ProcessExport::GetInputMinimum(), Isis::ProcessExport::InitProcess(), Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetInputRange().
|
protectedinherited |
The output value for pixels whose input DNs are Low Instrument Saturation values.
Definition at line 248 of file ProcessExport.h.
Referenced by Isis::ProcessExport::OutputLis(), and Isis::ProcessExport::SetOutputLis().
|
protectedinherited |
Indicates whether p_Lis has been set (i.e.
if setLis() has been called).
Definition at line 259 of file ProcessExport.h.
Referenced by Isis::ProcessExport::OutputLis(), Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetOutputLis().
|
protectedinherited |
The output value for pixels whose input DNs are Low Representation Saturation values.
Definition at line 250 of file ProcessExport.h.
Referenced by Isis::ProcessExport::OutputLrs(), and Isis::ProcessExport::SetOutputLrs().
|
protectedinherited |
Indicates whether p_Lrs has been set (i.e.
if setLrs() has been called).
Definition at line 261 of file ProcessExport.h.
Referenced by Isis::ProcessExport::OutputLrs(), Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetOutputLrs().
|
protectedinherited |
The output value for pixels whose input DNs are Null values.
Definition at line 247 of file ProcessExport.h.
Referenced by Isis::ProcessExport::OutputNull(), and Isis::ProcessExport::SetOutputNull().
|
protectedinherited |
Indicates whether p_Null has been set (i.e.
if setNull() has been called).
Definition at line 257 of file ProcessExport.h.
Referenced by Isis::ProcessExport::OutputNull(), Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetOutputNull().
|
protectedinherited |
Desired maximum pixel value in the Buffer.
Definition at line 225 of file ProcessExport.h.
Referenced by Isis::ProcessExport::GetOutputMaximum(), Isis::ProcessExport::InitProcess(), Isis::ProcessExport::OutputHis(), Isis::ProcessExport::OutputHrs(), Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetOutputRange().
|
protectedinherited |
Middle pixel value (minimum+maximun)/2.0 in the Buffer.
Definition at line 223 of file ProcessExport.h.
Referenced by Isis::ProcessExport::InitProcess(), Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetOutputRange().
|
protectedinherited |
Desired minimum pixel value in the Buffer.
Definition at line 222 of file ProcessExport.h.
Referenced by Isis::ProcessExport::GetOutputMinimum(), Isis::ProcessExport::InitProcess(), Isis::ProcessExport::OutputLis(), Isis::ProcessExport::OutputLrs(), Isis::ProcessExport::OutputNull(), Isis::ProcessExport::ProcessExport(), and Isis::ProcessExport::SetOutputRange().
|
protectedinherited |
The bits per pixel of the output image.
Definition at line 241 of file ProcessExport.h.
Referenced by Isis::ProcessExport::SetOutputType(), and Isis::ProcessExport::StartProcess().
|
protectedinherited |
Pointer to a Progress object.
Definition at line 145 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::ProcessExport::StartProcess(), and Isis::ProcessByQuickFilter::StartProcess().
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
Stretch object to ensure a reasonable range of pixel values in the output data.
Definition at line 243 of file ProcessExport.h.
Referenced by Isis::ProcessExport::InitProcess(), Isis::ProcessExport::StartProcess(), and Isis::ProcessExport::~ProcessExport().
U.S. Department of the Interior | U.S. Geological Survey ISIS | Privacy & Disclaimers | Astrogeology Research Program To contact us, please post comments and questions on the USGS Astrogeology Discussion Board To report a bug, or suggest a feature go to: ISIS Github File Modified: 03/21/2022 06:58:18 |