USGS

Isis 3.0 Object Programmers' Reference

 Home
Isis::ProcessImportVicar

Isis::ProcessImportVicar Class Reference
[High Level Cube I/O]

#include <ProcessImportVicar.h>

Inheritance diagram for Isis::ProcessImportVicar:

Inheritance graph
[legend]
Collaboration diagram for Isis::ProcessImportVicar:

Collaboration graph
[legend]
List of all members.

Detailed Description

Import a Vicar file.

This class allows a programmer to develop application programs which import Vicar cubes and mangles the the Vicar labels into appropriate ISIS labels.

Here is an example of how to use ProcessImportVicar 

   ImportVicar p;
   Pvl inlab;
   p.SetVicarFile("test.vic",inlab);
   CubeInfo *opack = p.SetOutputCube("TO"); 
   p.StartProcess(); 
   // extract vicar keywords ... 
   Pvl outLab;
   outLab.AddGroup("VICAR");
   outLab.AddKeyword("RecordSize")",inlab.GetInteger("RECSIZ"); opack->AddGroup(outLab,"VICAR");
   p.EndProcess();

Author:
2003-02-13 Jeff Anderson

For internal use only.

History:
2005-02-11 Elizabeth Ribelin - Modified file to support Doxygen documentation
History:
2008-06-26 Christopher Austin - Added the termination char to SetVicarFile's buf
Todo:
2005-02-11 Jeff Anderson - add implementation example to class documentation

2005-05-23 Jeff Anderson - Currently VICAR files can not exceed 2GB however, they may in the future so we should remember to look at this

Definition at line 65 of file ProcessImportVicar.h.

Public Types

 InterleaveUndefined
 Undefined.
 BSQ
 Band Sequential Format (i.e.
 BIL
 Band Interleaved By Line Format (i.e.
 BIP
 Band Interleaved By Pixel Format (i.e.
enum  Interleave { InterleaveUndefined, BSQ, BIL, BIP }
 This enum includes how the document should be read: by BSQ, BIL, BIP or InterleaveUndefined. More...

Public Member Functions

void SetVicarFile (const std::string &vicarFile, Isis::Pvl &vicarLab)
 Opens a vicar file which can then be immediately imported by invoking the inherited StartProcess method.
void StartProcess ()
 Process the input file and write it to the output.
void StartProcess (void funct(Isis::Buffer &out))
 Process the input file and send data to method.
void StartProcess (void funct())
 In the base class, this method will invoked a user-specified function exactly one time.
void SetInputFile (const std::string &file)
 Sets the name of the input file to be read in the import StartProcess method and verifies its existance.
Isis::Cube * SetOutputCube (const std::string &parameter)
 Create the output file.
Isis::Cube * SetOutputCube (const std::string &parameter, Isis::CubeAttributeOutput &att)
 Create the output file.
Isis::Cube * SetOutputCube (const std::string &parameter, const int nsamps, const int nlines, const int nbands=1)
 Allocates a user specified output cube whose size is specified by the programmer.
Isis::Cube * SetOutputCube (const std::string &fname, const Isis::CubeAttributeOutput &att, const int nsamps, const int nlines, const int nbands=1)
 Allocates a output cube whose name and size is specified by the programmer.
void SetPixelType (const Isis::PixelType type)
 Sets the pixel type of the input file.
Isis::PixelType PixelType ()
 Returns the pixel type.
void SetDimensions (const int ns, const int nl, const int nb)
 Sets the physical size of the input cube.
int Samples ()
 Returns the number of samples.
int Lines ()
 Returns the number of lines.
int Bands ()
 Returns the number of bands.
void SetByteOrder (const Isis::ByteOrder order)
 Sets the byte order of the input file.
Isis::ByteOrder ByteOrder ()
 Returns the byte order.
void SetFileHeaderBytes (const int bytes)
 This method sets the number of bytes in the header of a file.
void SetFileTrailerBytes (const int bytes)
 This method sets the number of bytes in the trailer of a file.
void SetDataHeaderBytes (const int bytes)
 This method sets the number of bytes in the header of each datablock of a file.
void SetDataTrailerBytes (const int bytes)
 This method sets the number of bytes in the trailer of each datablock of a file.
void SetDataPrefixBytes (const int bytes)
 This method sets the number of bytes at the beginning of each data record of a file.
void SetDataSuffixBytes (const int bytes)
 This method sets the number of bytes at the end of each data record of a file.
void SaveFileHeader ()
 This method marks the file header to be saved.
void SaveFileTrailer ()
 This method marks the file trailer to be saved.
void SaveDataHeader ()
 This method marks the data block headers to be saved.
void SaveDataTrailer ()
 This method marks the data block trailers to be saved.
void SaveDataPrefix ()
 This method marks the data prefix to be saved.
void SaveDataSuffix ()
 This method marks the data suffix to be saved.
char * FileHeader ()
 This method returns a pointer to the file header.
char * FileTrailer ()
 This method returns a pointer to the file trailer.
std::vector< char * > DataHeader ()
 This method returns a pointer to the data header.
std::vector< char * > DataTrailer ()
 This method returns a pointer to the data trailer.
std::vector< std::vector<
char * > > 		DataPrefix ()
 This method returns a pointer to the data prefix.
std::vector< std::vector<
char * > > 		DataSuffix ()
 This method returns a pointer to the data suffix.
void SetOrganization (const ProcessImport::Interleave org)
 Sets the organization of the input cube.
void SetBase (const double base)
 Sets the core base of the input cube.
void SetBase (const std::vector< double > base)
 Sets band dependent core base.
void SetMultiplier (const double mult)
 Sets the core multiplier of the input cube.
void SetMultiplier (const std::vector< double > mult)
 Sets band dependent core multiplier.
void SetSpecialValues (const double null, const double lrs, const double lis, const double hrs, const double his)
 Sets a mapping of input pixel values to output special pixel values.
void SetNull (const double null_min, const double null_max)
 Sets the range that will be considered Isis::Null.
void SetLRS (const double lrs_min, const double lrs_max)
 Sets the range that will be considered Isis::Null.
void SetLIS (const double lis_min, const double lis_max)
 Sets the range that will be considered Isis::Null.
void SetHRS (const double hrs_min, const double hrs_max)
 Sets the range that will be considered Isis::Null.
void SetHIS (const double his_min, const double his_max)
 Sets the range that will be considered Isis::Null.
double TestPixel (const double pixel)
 Tests the pixel.
virtual void EndProcess ()
 End the processing sequence and cleans up by closing cubes, freeing memory, etc.
Isis::Cube * SetInputCube (const std::string &parameter, const int requirements=0)
 Opens an input cube specified by the user and verifies requirements are met.
Isis::Cube * SetInputCube (const std::string &fname, const Isis::CubeAttributeInput &att, int requirements=0)
 Opens an input cube specified by the programmer and verifies requirements are met.
void ClearInputCubes ()
 This method clears the input cube list.
void PropagateLabels (const bool prop)
 This method allows the programmer to turn on/off the propagation of labels from the 1st input cube to any of the output cubes.
void PropagateLabels (const std::string &cube)
 This method allows the programmer to propagate labels from a specific secondary cube.
void PropagateTables (const bool prop)
 This method allows the programmer to propagate input tables to the output cube (default is true).
void PropagatePolygons (const bool prop)
 This method allows the programmer to propagate input blobs to the output cube (default is true).
void PropagateHistory (const bool prop)
 This method allows the programmer to propagate history to the output cube (default is true).
void PropagateOriginalLabel (const bool prop)
 This method allows the programmer to propagate original labels to the output cube (default is true).
Isis::Progress * Progress ()
 This method returns a pointer to a Progress object.
std::string MissionData (const std::string &mission, const std::string &file, bool highestVersion=false)
 This method reads the mission specific data directory from the user preference file, makes sure that mission is available in the Isis installation, and the attaches the provided input file to the directory in order to create a full file specification.
void WriteHistory (Cube &cube)
 Writes out the History blob to the cube.

Protected Attributes

Isis::Progress * p_progress
 Pointer to a Progress object.
bool p_propagateLabels
 Flag indicating if labels are be propagated to output cubes.
bool p_propagateTables
 Flag indicating if tables are be propagated to output cubes.
bool p_propagatePolygons
 Flag indicating if blobs are be propagated to output cubes.
bool p_propagateHistory
 Flag indicating if history is to be propagated to output cubes.
bool p_propagateOriginalLabel
 Flag indicating if original lable is to be propagated to output cubes.
std::vector< Isis::Cube * > InputCubes
 A vector of pointers to opened Cube objects.
std::vector< Isis::Cube * > OutputCubes
 A vector of pointers to allocated Cube objects.

Private Attributes

Isis::Pvl p_vicLab
 A PVL object which will contain the vicar labels.

Member Enumeration Documentation

enum Isis::ProcessImport::Interleave [inherited]

This enum includes how the document should be read: by BSQ, BIL, BIP or InterleaveUndefined.

Enumerator:
InterleaveUndefined  Undefined.
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 205 of file ProcessImport.h.

Member Function Documentation

int Isis::ProcessImport::Bands (  )  [inline, inherited]

Returns the number of bands.

Returns:
The number of bands

Definition at line 172 of file ProcessImport.h.

References Isis::ProcessImport::p_nb.

Isis::ByteOrder Isis::ProcessImport::ByteOrder (  )  [inline, inherited]

Returns the byte order.

Returns:
Byte order of the data

Definition at line 180 of file ProcessImport.h.

References Isis::ProcessImport::p_byteOrder.

void Isis::Process::ClearInputCubes (  )  [inherited]

This method clears the input cube list.

It is most commonly used in applications which need to generate an output cube without an input cube, however, propogation of input characteristics are known. For example, creating the initial cube for a mosaic.

Definition at line 579 of file Process.cpp.

References Isis::Process::InputCubes.

Referenced by Isis::ProcessMapMosaic::SetOutputCube(), Isis::ProcessGroundPolygons::SetOutputCube(), and Isis::ProcessMapMosaic::StartProcess().

std::vector< char * > Isis::ProcessImport::DataHeader (  )  [inherited]

This method returns a pointer to the data header.

A data header is a block of non-image data at the beginning of each data block (for BSQ data blocks are bands). This is not included in the file header and does not include any record headers, such as line prefixes. In order to retrieve this data, the data header bytes must be set and the data header must be saved via SetDataHeaderBytes() and SaveDataHeader(), respectively. This method must be called only after StartProcess() has returned and before EndProcess() is called.

Returns:
vector <char*> Vector of pointers to data headers for each block, if saved.
Exceptions:
Isis::iException::Message "Data header was not saved. Use SaveDataHeader()."
See also:
SetDataHeaderBytes()

SaveDataHeader()

Definition at line 568 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), Isis::ProcessImport::p_dataHeader, and Isis::ProcessImport::p_saveDataHeader.

std::vector< std::vector< char * > > Isis::ProcessImport::DataPrefix (  )  [inherited]

This method returns a pointer to the data prefix.

A data prefix is a block of non-image data at the beginning of each data record (for BSQ data records are lines). This is not included in the file header or the data header. In order to retrieve this data, the data prefix bytes must be set and the data prefix must be saved via SetDataPrefixBytes() and SaveDataPrefix(), respectively. This method must be called only after StartProcess() has returned and before EndProcess() is called.

Returns:
vector <vector <char*> > Two-dimensional vector of pointers to data prefixes for each record, if saved.
Exceptions:
Isis::iException::Message "Data prefix was not saved. Use SaveDataPrefix()."
See also:
SetDataPrefixBytes()

SaveDataPrefix()

Definition at line 622 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), Isis::ProcessImport::p_dataPre, and Isis::ProcessImport::p_saveDataPre.

std::vector< std::vector< char * > > Isis::ProcessImport::DataSuffix (  )  [inherited]

This method returns a pointer to the data suffix.

A data suffix is a block of non-image data at the end of each data record (for BSQ data records are lines). This is not included in the file trailer or the data trailer. In order to retrieve this data, the data suffix bytes must be set and the data suffix must be saved via SetDataSuffixBytes() and SaveDataSuffix(), respectively. This method must be called only after StartProcess() has returned and before EndProcess() is called.

Returns:
vector <vector <char*> > Two-dimensional vector of pointers to data suffixes for each record, if saved.
Exceptions:
Isis::iException::Message "Data suffix was not saved. Use SaveDataSuffix()."
See also:
SetDataSuffixBytes()

SaveDataSuffix()

Definition at line 649 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), Isis::ProcessImport::p_dataPost, and Isis::ProcessImport::p_saveDataPost.

std::vector< char * > Isis::ProcessImport::DataTrailer (  )  [inherited]

This method returns a pointer to the data trailer.

A data trailer is a block of non-image data at the end each data block (for BSQ data blocks are bands). This is not included in the file trailer and does not include any record trailers, such as line suffixes. In order to retrieve this data, the data trailer bytes must be set and the data trailer must be saved via SetDataTrailerBytes() and SaveDataTrailer(), respectively. This method must be called only after StartProcess() has returned and before EndProcess() is called.

Returns:
vector <char*> Vector of pointers to data trailers for each block, if saved.
Exceptions:
Isis::iException::Message "Data trailer was not saved. Use SaveDataTrailer()."
See also:
SetDataTrailerBytes()

SaveDataTrailer()

Definition at line 595 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), Isis::ProcessImport::p_dataTrailer, and Isis::ProcessImport::p_saveDataTrailer.

void Isis::Process::EndProcess (  )  [virtual, inherited]

End the processing sequence and cleans up by closing cubes, freeing memory, etc.

Reimplemented in Isis::ProcessByBoxcar, Isis::ProcessByBrick, Isis::ProcessByTile, Isis::ProcessGroundPolygons, Isis::ProcessImportPds, and Isis::ProcessPolygons.

Definition at line 444 of file Process.cpp.

References Isis::Process::InputCubes, and Isis::Process::OutputCubes.

Referenced by Isis::ProcessPolygons::EndProcess(), Isis::ProcessImportPds::EndProcess(), Isis::ProcessByBrick::EndProcess(), Isis::ProcessByBoxcar::EndProcess(), and Isis::Process::~Process().

char * Isis::ProcessImport::FileHeader (  )  [inherited]

This method returns a pointer to the file header.

A file header is a block of non-image data at the beginning of the entire file. This does not include any section headers, such as band headers or line prefixes. In order to retrieve this data, the file header bytes must be set and the file header must be saved via SetFileHeaderBytes() and SaveFileHeader(), respectively. This method must be called only after StartProcess() has returned and before EndProcess() is called.

Returns:
char* Pointer to file header, if saved.
Exceptions:
Isis::iException::Message "File header was not saved. Use SaveFileHeader()."
See also:
SetFileHeaderBytes()

SaveFileHeader()

Definition at line 515 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), Isis::ProcessImport::p_fileHeader, and Isis::ProcessImport::p_saveFileHeader.

char * Isis::ProcessImport::FileTrailer (  )  [inherited]

This method returns a pointer to the file trailer.

A file trailer is a block of non-image data at the end of the entire file. This does not include any section trailers, such as band trailers or line suffixes. In order to retrieve this data, the file trailer bytes must be set and the file trailer must be saved via SetFileTrailerBytes() and SaveFileTrailer(), respectively. This method must be called only after StartProcess() has returned and before EndProcess() is called.

Returns:
char* Pointer to file trailer, if saved.
Exceptions:
Isis::iException::Message "File trailer was not saved. Use SaveFileTrailer()."
See also:
SetFileTrailerBytes()

SaveFileTrailer()

Definition at line 540 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), Isis::ProcessImport::p_fileTrailer, and Isis::ProcessImport::p_saveFileTrailer.

int Isis::ProcessImport::Lines (  )  [inline, inherited]

Returns the number of lines.

Returns:
The number of lines

Definition at line 166 of file ProcessImport.h.

References Isis::ProcessImport::p_nl.

string Isis::Process::MissionData ( const std::string &  mission,
const std::string &  file,
bool  highestVersion = false 
) [inherited]

This method reads the mission specific data directory from the user preference file, makes sure that mission is available in the Isis installation, and the attaches the provided input file to the directory in order to create a full file specification.

Parameters:
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 555 of file Process.cpp.

References _FILEINFO_, Isis::Filename::Exists(), Isis::Filename::Expanded(), Isis::PvlObject::FindGroup(), Isis::Filename::HighestVersion(), Isis::iException::Message(), and Isis::Preference::Preferences().

Isis::PixelType Isis::ProcessImport::PixelType (  )  [inline, inherited]

Returns the pixel type.

Returns:
The pixel type of input data

Definition at line 153 of file ProcessImport.h.

References Isis::ProcessImport::p_pixelType.

Isis::Progress* Isis::Process::Progress (  )  [inline, inherited]

This method returns a pointer to a Progress object.

Returns:
Progress*

Definition at line 211 of file Process.h.

References Isis::Process::p_progress.

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

void Isis::Process::PropagateHistory ( const bool  prop  )  [inherited]

This method allows the programmer to propagate history to the output cube (default is true).

Parameters:
prop Flag indicating if history is to be propagated to output cubes.

Definition at line 524 of file Process.cpp.

References Isis::Process::p_propagateHistory.

Referenced by Isis::ProcessMapMosaic::SetOutputCube().

void Isis::Process::PropagateLabels ( const std::string &  cube  )  [inherited]

This method allows the programmer to propagate labels from a specific secondary cube.

Parameters:
cube iString containing the name of the cube containing the labels to propagate.

Definition at line 482 of file Process.cpp.

References Isis::PvlObject::AddGroup(), g, incube, Isis::Process::OutputCubes, and pvl().

void Isis::Process::PropagateLabels ( const bool  prop  )  [inherited]

This method allows the programmer to turn on/off the propagation of labels from the 1st input cube to any of the output cubes.

By default, propagation occurs automatically in the Process class when a call to either of the SetOutputCube methods is invoked. If the program * requires no propagation then utilize this method. This method can be invoked between successive calls of SetOutputCube so that some cube will have labels propagated while others will not.

Parameters:
prop Flag indicating if labels are be propagated to output cubes.

Definition at line 471 of file Process.cpp.

References Isis::Process::p_propagateLabels.

Referenced by Isis::ProcessMapMosaic::SetOutputCube().

void Isis::Process::PropagateOriginalLabel ( const bool  prop  )  [inherited]

This method allows the programmer to propagate original labels to the output cube (default is true).

Parameters:
prop Flag indicating if original labels is to be propagated to output cubes.

Definition at line 535 of file Process.cpp.

References Isis::Process::p_propagateOriginalLabel.

Referenced by Isis::ProcessMapMosaic::SetOutputCube().

void Isis::Process::PropagatePolygons ( const bool  prop  )  [inherited]

This method allows the programmer to propagate input blobs to the output cube (default is true).

Parameters:
prop Flag indicating if input blobs are to be propagated to output cubes.

Definition at line 514 of file Process.cpp.

References Isis::Process::p_propagatePolygons.

Referenced by Isis::ProcessMapMosaic::SetOutputCube().

void Isis::Process::PropagateTables ( const bool  prop  )  [inherited]

This method allows the programmer to propagate input tables to the output cube (default is true).

Parameters:
prop Flag indicating if input tables are to be propagated to output cubes.

Definition at line 503 of file Process.cpp.

References Isis::Process::p_propagateTables.

Referenced by Isis::ProcessMapMosaic::SetOutputCube().

int Isis::ProcessImport::Samples (  )  [inline, inherited]

Returns the number of samples.

Returns:
The number of samples

Definition at line 160 of file ProcessImport.h.

References Isis::ProcessImport::p_ns.

void Isis::ProcessImport::SaveDataHeader (  )  [inherited]

This method marks the data block headers to be saved.

A data header is a block of non-image data at the beginning of each data block (for BSQ data blocks are bands). This is not included in the file header and does not include any record headers, such as line prefixes. Each of the header blocks will be saved inside StartProcess(). It must be called after setting the size with SetDataHeaderBytes() and before StartProcess() is called. This data will only be available via DataHeader() after StartProcess() has returned and before EndProcess() is called.

Exceptions:
Isis::iException::Message "Data header bytes equals 0. There is nothing to save. Use SetDataHeaderBytes() first."
See also:
SetDataHeaderBytes()

DataHeader()

Definition at line 412 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), Isis::ProcessImport::p_dataHeaderBytes, and Isis::ProcessImport::p_saveDataHeader.

void Isis::ProcessImport::SaveDataPrefix (  )  [inherited]

This method marks the data prefix to be saved.

A data prefix is a block of non-image data at the beginning of each data record (for BSQ data records are lines). This is not included in the file header or the data header. Each of the data prefixes will be saved inside StartProcess(). It must be called after setting the size with SetDataPrefixBytes() and before StartProcess() is called. This data will only be available via DataPrefix() after StartProcess() has returned and before EndProcess() is called.

Exceptions:
Isis::iException::Message "Data prefix bytes equals 0. There is nothing to save. Use SetDataPrefixBytes() first."
See also:
SetDataPrefixBytes()

DataPrefix()

Definition at line 463 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), Isis::ProcessImport::p_dataPreBytes, and Isis::ProcessImport::p_saveDataPre.

void Isis::ProcessImport::SaveDataSuffix (  )  [inherited]

This method marks the data suffix to be saved.

A data suffix is a block of non-image data at the end of each data record (for BSQ data records are lines). This is not included in the file trailer or the data trailer. Each of the data suffixes will be saved inside StartProcess(). It must be called after setting the size with SetDataPrefixBytes() and before StartProcess() is called. This data will only be available via DataPrefix() after StartProcess() has returned and before EndProcess() is called.

Exceptions:
Isis::iException::Message "Data suffix bytes equals 0. There is nothing to save. Use SetDataSuffixBytes() first."
See also:
SetDataSuffixBytes()

DataSuffix()

Definition at line 489 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), Isis::ProcessImport::p_dataPostBytes, and Isis::ProcessImport::p_saveDataPost.

void Isis::ProcessImport::SaveDataTrailer (  )  [inherited]

This method marks the data block trailers to be saved.

A data trailer is a block of non-image data at the end of each data block (for BSQ data blocks are bands). This is not included in the file trailer and does not include any record trailers, such as line suffixes. Each of the trailer blocks will be saved inside StartProcess(). It must be called after setting the size with SetDataTrailerBytes() and before StartProcess() is called. This data will only be available via DataTrailer() after StartProcess() has returned and before EndProcess() is called.

Exceptions:
Isis::iException::Message "Data trailer bytes equals 0. There is nothing to save. Use SetDataTrailerBytes() first."
See also:
SetDataTrailerBytes()

DataTrailer()

Definition at line 438 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), Isis::ProcessImport::p_dataTrailerBytes, and Isis::ProcessImport::p_saveDataTrailer.

void Isis::ProcessImport::SaveFileHeader (  )  [inherited]

This method marks the file header to be saved.

A file header is a block of non-image data at the beginning of the entire file. This does not include any section headers, such as band headers or line prefixes. The file header will be saved inside StartProcess(). It must be called after setting the size with SetFileHeaderBytes() and before StartProcess() is called. This data will only be available via FileHeader() after StartProcess() has returned and before EndProcess() is called.

Exceptions:
Isis::iException::Message "File header bytes equals 0. There is nothing to save. Use SetFileHeaderBytes() first."
See also:
SetFileHeaderBytes()

FileHeader()

Definition at line 361 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), Isis::ProcessImport::p_fileHeaderBytes, and Isis::ProcessImport::p_saveFileHeader.

void Isis::ProcessImport::SaveFileTrailer (  )  [inherited]

This method marks the file trailer to be saved.

A file trailer is a block of non-image data at the end of the entire file. This does not include any section trailers, such as band trailers or line suffixes. The file trailer will be saved inside StartProcess(). It must be called after setting the size with SetFileTrailerBytes() and before StartProcess() is called. This data will only be available via FileTrailer() after StartProcess() has returned and before EndProcess() is called.

Exceptions:
Isis::iException::Message "File trailer bytes equals 0. There is nothing to save. Use SetFileTrailerBytes() first."
See also:
SetFileTrailerBytes()

FileTrailer()

Definition at line 386 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), Isis::ProcessImport::p_fileTrailerBytes, and Isis::ProcessImport::p_saveFileTrailer.

void Isis::ProcessImport::SetBase ( const std::vector< double >  base  )  [inherited]

Sets band dependent core base.

Parameters:
base A vector containing the base for each band.

Definition at line 683 of file ProcessImport.cpp.

References Isis::ProcessImport::p_base.

void Isis::ProcessImport::SetBase ( const double  base  )  [inherited]

Sets the core base of the input cube.

Defaults to zero if not invoked.

Parameters:
base Core base

Definition at line 673 of file ProcessImport.cpp.

References Isis::ProcessImport::p_base.

Referenced by Isis::ProcessImportPds::ProcessPdsImageLabel(), and Isis::ProcessImportPds::ProcessPdsQubeLabel().

void Isis::ProcessImport::SetByteOrder ( const Isis::ByteOrder  order  )  [inherited]

Sets the byte order of the input file.

This must be invoked prior to SetOutputCube.

Parameters:
order The enumerated byte order Isis::Lsb or Isis::Msb

Definition at line 165 of file ProcessImport.cpp.

References Isis::ProcessImport::p_byteOrder.

Referenced by Isis::ProcessImportPds::ProcessPdsImageLabel(), Isis::ProcessImportPds::ProcessPdsQubeLabel(), and SetVicarFile().

void Isis::ProcessImport::SetDataHeaderBytes ( const int  bytes  )  [inherited]

This method sets the number of bytes in the header of each datablock of a file.

A data header is a block of non-image data at the beginning of each data block (for BSQ data blocks are bands). This is not included in the file header and does not include any record headers, such as line prefixes. It must be called before StartProcess(). This data will only be available if saved via SaveDataHeader() and may be accessed via DataHeader() after StartProcess() has returned and before EndProcess() is called. If not invoked the default is 0.

Parameters:
bytes Number of bytes
Exceptions:
Isis::iException::Message "Illegal data header size." (when bytes < 0)
See also:
SaveDataHeader()

DataHeader()

Definition at line 246 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), and Isis::ProcessImport::p_dataHeaderBytes.

Referenced by SetVicarFile().

void Isis::ProcessImport::SetDataPrefixBytes ( const int  bytes  )  [inherited]

This method sets the number of bytes at the beginning of each data record of a file.

A data prefix is a block of non-image data at the beginning of each data record (for BSQ data records are lines). This is not included in the file header or the data header. It must be called before StartProcess(). This data will only be available if saved via SaveDataPrefix() and may be accessed via DataPrefix() after StartProcess() has returned and before EndProcess() is called. If not invoked the default is 0.

Parameters:
bytes Number of bytes
Exceptions:
Isis::iException::Message "Illegal data prefix size." (when bytes < 0)
See also:
SaveDataPrefix()

DataPrefix()

Definition at line 304 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), and Isis::ProcessImport::p_dataPreBytes.

Referenced by Isis::ProcessImportPds::ProcessPdsImageLabel(), Isis::ProcessImportPds::ProcessPdsQubeLabel(), and SetVicarFile().

void Isis::ProcessImport::SetDataSuffixBytes ( const int  bytes  )  [inherited]

This method sets the number of bytes at the end of each data record of a file.

A data suffix is a block of non-image data at the end of each data record (for BSQ data records are lines). This is not included in the file trailer or the data trailer. It must be called before StartProcess(). This data will only be available if saved via SaveDataSuffix() and may be accessed via DataSuffix() after StartProcess() has returned and before EndProcess() is called. If not invoked the default is 0.

Parameters:
bytes Number of bytes
Exceptions:
Isis::iException::Message "Illegal data suffix size." (when bytes < 0)
See also:
SaveDataSuffix()

DataSuffix()

Definition at line 333 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), and Isis::ProcessImport::p_dataPostBytes.

Referenced by Isis::ProcessImportPds::ProcessPdsImageLabel(), Isis::ProcessImportPds::ProcessPdsQubeLabel(), and SetVicarFile().

void Isis::ProcessImport::SetDataTrailerBytes ( const int  bytes  )  [inherited]

This method sets the number of bytes in the trailer of each datablock of a file.

A data trailer is a block of non-image data at the end of each data block (for BSQ data blocks are bands). This is not included in the file trailer and does not include any record trailers, such as line suffixes. It must be called before StartProcess(). This data will only be available if saved via SaveDataTrailer() and may be accessed via DataTrailer() after StartProcess() has returned and before EndProcess() is called. If not invoked the default is 0.

Parameters:
bytes Number of bytes
Exceptions:
Isis::iException::Message "Illegal data trailer size." (when bytes < 0)
See also:
SaveDataTrailer()

DataTrailer()

Definition at line 275 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), and Isis::ProcessImport::p_dataTrailerBytes.

Referenced by Isis::ProcessImportPds::ProcessPdsQubeLabel().

void Isis::ProcessImport::SetDimensions ( const int  ns,
const int  nl,
const int  nb 
) [inherited]

Sets the physical size of the input cube.

This must be invoked prior to setOutputCube.

Parameters:
ns Number of samples
nl Number of lines
nb Number of bands
Exceptions:
Isis::iException::Message "Illegal dimension."

Definition at line 146 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), Isis::ProcessImport::p_nb, Isis::ProcessImport::p_nl, and Isis::ProcessImport::p_ns.

Referenced by Isis::ProcessImportPds::ProcessPdsImageLabel(), Isis::ProcessImportPds::ProcessPdsQubeLabel(), and SetVicarFile().

void Isis::ProcessImport::SetFileHeaderBytes ( const int  bytes  )  [inherited]

This method sets the number of bytes in the header of a file.

The file header is a block of non-image data at the beginning of the entire file. This does not include any section headers, such as band headers or line prefixes. Typically it is used to delineate the boundary of the binary or ascii labels. It must be called before StartProcess(). This data will only be available if saved via SaveFileHeader() and may be accessed via FileHeader() after StartProcess() has returned and before EndProcess() is called. If not invoked the default is 0.

Parameters:
bytes Number of bytes
Exceptions:
Isis::iException::Message "Illegal file header size." (when bytes < 0)
See also:
SaveFileHeader()

FileHeader()

Definition at line 189 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), and Isis::ProcessImport::p_fileHeaderBytes.

Referenced by Isis::ProcessImportPds::ProcessPdsImageLabel(), Isis::ProcessImportPds::ProcessPdsQubeLabel(), and SetVicarFile().

void Isis::ProcessImport::SetFileTrailerBytes ( const int  bytes  )  [inherited]

This method sets the number of bytes in the trailer of a file.

The trailer is a block of non-image data at the end of the entire file. This does not include any section trailers, such as band trailers or line suffixes. It must be called before StartProcess(). This data will only be available if saved via SaveFileTrailer() and may be accessed via FileTrailer() after StartProcess() has returned and before EndProcess() is called. If not invoked the default is 0.

Parameters:
bytes Number of bytes
Exceptions:
Isis::iException::Message "Illegal file trailer size." (when bytes < 0)
See also:
SaveFileTrailer()

FileTrailer()

History:
2008-08-12 Jeannie Walldren, Method created

Definition at line 218 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), and Isis::ProcessImport::p_fileTrailerBytes.

void Isis::ProcessImport::SetHIS ( const double  his_min,
const double  his_max 
) [inherited]

Sets the range that will be considered Isis::Null.

Parameters:
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 808 of file ProcessImport.cpp.

References Isis::ProcessImport::p_his_max, and Isis::ProcessImport::p_his_min.

Referenced by Isis::ProcessImport::ProcessImport(), and Isis::ProcessImport::SetSpecialValues().

void Isis::ProcessImport::SetHRS ( const double  hrs_min,
const double  hrs_max 
) [inherited]

Sets the range that will be considered Isis::Null.

Parameters:
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 792 of file ProcessImport.cpp.

References Isis::ProcessImport::p_hrs_max, and Isis::ProcessImport::p_hrs_min.

Referenced by Isis::ProcessImport::ProcessImport(), and Isis::ProcessImport::SetSpecialValues().

Isis::Cube * Isis::Process::SetInputCube ( const std::string &  fname,
const Isis::CubeAttributeInput &  att,
int  requirements = 0 
) [inherited]

Opens an input cube specified by the programmer and verifies requirements are met.

Parameters:
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
Returns:
Cube*
Exceptions:
Isis::iException::Message 

Reimplemented in Isis::ProcessByBrick.

Definition at line 72 of file Process.cpp.

References _FILEINFO_, Isis::AllMatchOrOne, Isis::BandMatchOrOne, Isis::Cube::Bands(), Isis::CubeAttributeInput::Bands(), cube, e, Isis::Process::InputCubes, Isis::Cube::Lines(), Isis::iException::Message(), Isis::OneBand, Isis::Cube::Open(), Isis::ReadWrite, Isis::Cube::Samples(), Isis::Cube::SetVirtualBands(), Isis::SizeMatch, and Isis::SpatialMatch.

Isis::Cube * Isis::Process::SetInputCube ( const std::string &  parameter,
const int  requirements = 0 
) [inherited]

Opens an input cube specified by the user and verifies requirements are met.

Returns:
Cube*
Parameters:
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
Exceptions:
Isis::iException::Message 

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

Definition at line 214 of file Process.cpp.

References IsisAml::GetFilename(), IsisAml::GetInputAttribute(), and Isis::Application::GetUserInterface().

Referenced by Isis::ProcessMosaic::SetInputCube(), Isis::ProcessBySample::SetInputCube(), Isis::ProcessByLine::SetInputCube(), Isis::ProcessByBrick::SetInputCube(), and Isis::ProcessGroundPolygons::SetOutputCube().

void Isis::ProcessImport::SetInputFile ( const std::string &  file  )  [inherited]

Sets the name of the input file to be read in the import StartProcess method and verifies its existance.

Parameters:
file The name of the input file to import.
Exceptions:
Isis::iException::Message "File does not exist."

Definition at line 1772 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), and Isis::ProcessImport::p_inFile.

Referenced by Isis::ProcessImportPds::ProcessPdsImageLabel(), Isis::ProcessImportPds::ProcessPdsQubeLabel(), and SetVicarFile().

void Isis::ProcessImport::SetLIS ( const double  lis_min,
const double  lis_max 
) [inherited]

Sets the range that will be considered Isis::Null.

Parameters:
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 776 of file ProcessImport.cpp.

References Isis::ProcessImport::p_lis_max, and Isis::ProcessImport::p_lis_min.

Referenced by Isis::ProcessImport::ProcessImport(), and Isis::ProcessImport::SetSpecialValues().

void Isis::ProcessImport::SetLRS ( const double  lrs_min,
const double  lrs_max 
) [inherited]

Sets the range that will be considered Isis::Null.

Parameters:
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 760 of file ProcessImport.cpp.

References Isis::ProcessImport::p_lrs_max, and Isis::ProcessImport::p_lrs_min.

Referenced by Isis::ProcessImport::ProcessImport(), and Isis::ProcessImport::SetSpecialValues().

void Isis::ProcessImport::SetMultiplier ( const std::vector< double >  mult  )  [inherited]

Sets band dependent core multiplier.

Parameters:
mult A vector containing the multiplier for each band.

Definition at line 702 of file ProcessImport.cpp.

References Isis::ProcessImport::p_mult.

void Isis::ProcessImport::SetMultiplier ( const double  mult  )  [inherited]

Sets the core multiplier of the input cube.

Defaults to one if not invoked.

Parameters:
mult Core base

Definition at line 692 of file ProcessImport.cpp.

References Isis::ProcessImport::p_mult.

Referenced by Isis::ProcessImportPds::ProcessPdsImageLabel(), and Isis::ProcessImportPds::ProcessPdsQubeLabel().

void Isis::ProcessImport::SetNull ( const double  null_min,
const double  null_max 
) [inherited]

Sets the range that will be considered Isis::Null.

Parameters:
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 744 of file ProcessImport.cpp.

References Isis::ProcessImport::p_null_max, and Isis::ProcessImport::p_null_min.

Referenced by Isis::ProcessImport::ProcessImport(), and Isis::ProcessImport::SetSpecialValues().

void Isis::ProcessImport::SetOrganization ( const ProcessImport::Interleave  org  )  [inherited]

Sets the organization of the input cube.

If not invoked it is assumed Isis::Import::Bsq.

Parameters:
org The enumerated organizations either Isis::Import::Bsq Isis::Import::Bil or Isis::Import::Bip

Definition at line 664 of file ProcessImport.cpp.

References Isis::ProcessImport::p_organization.

Referenced by Isis::ProcessImportPds::ProcessPdsImageLabel(), Isis::ProcessImportPds::ProcessPdsQubeLabel(), and SetVicarFile().

Isis::Cube * Isis::Process::SetOutputCube ( const std::string &  fname,
const Isis::CubeAttributeOutput &  att,
const int  ns,
const int  nl,
const int  nb = 1 
) [inherited]

Allocates a output cube whose name and size is specified by the programmer.

Returns:
Cube*
Parameters:
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
Exceptions:
Isis::iException::Message 

Definition at line 305 of file Process.cpp.

References _FILEINFO_, Isis::PvlObject::AddGroup(), Isis::CubeAttributeOutput::AttachedLabel(), base, Isis::CubeAttributeOutput::ByteOrder(), cube, Isis::CubeAttributeOutput::DetachedLabel(), e, Isis::CubeAttributeOutput::FileFormat(), incube, Isis::Process::InputCubes, Isis::PvlContainer::IsNamed(), Isis::CubeAttributeOutput::Maximum(), Isis::iException::Message(), Isis::CubeAttributeOutput::Minimum(), mult, Isis::PvlContainer::Name(), Isis::PvlObject::Object(), Isis::PvlObject::Objects(), Isis::Process::OutputCubes, Isis::Process::p_propagateLabels, Isis::Process::p_propagateOriginalLabel, Isis::Process::p_propagatePolygons, Isis::Process::p_propagateTables, Isis::CubeAttributeOutput::PixelType(), Isis::CubeAttributeOutput::PropagateMinimumMaximum(), Isis::CubeAttributeOutput::PropagatePixelType(), Isis::Cube::SetDimensions(), and Isis::Process::WriteHistory().

Isis::Cube * Isis::Process::SetOutputCube ( const std::string &  parameter,
const int  ns,
const int  nl,
const int  nb = 1 
) [inherited]

Allocates a user specified output cube whose size is specified by the programmer.

Returns:
Cube*
Parameters:
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
Exceptions:
Isis::iException::Message 

Reimplemented in Isis::ProcessPolygons.

Definition at line 273 of file Process.cpp.

References _FILEINFO_, IsisAml::GetFilename(), IsisAml::GetOutputAttribute(), Isis::Application::GetUserInterface(), Isis::iException::Message(), and Isis::Process::SetOutputCube().

Isis::Cube * Isis::ProcessImport::SetOutputCube ( const std::string &  parameter,
Isis::CubeAttributeOutput &  att 
) [inherited]

Create the output file.

Note that all the appropiate calls to at least SetDimensions should be invoked prior to calling this method.

Parameters:
parameter The parameter name that holds the output file name.
att An output cube attribute to define the characteristics of the output cube.
Exceptions:
Isis::iException::Message "File is not in a supported organization."

Definition at line 973 of file ProcessImport.cpp.

References Isis::ProcessImport::p_nb, Isis::ProcessImport::p_nl, Isis::ProcessImport::p_ns, and Isis::Process::SetOutputCube().

Isis::Cube * Isis::ProcessImport::SetOutputCube ( const std::string &  parameter  )  [inherited]

Create the output file.

Note that all the appropiate calls to at least SetDimensions and SetPixelType should be made prior to calling this method.

Parameters:
parameter The parameter name that holds the output file name.
Exceptions:
Isis::iException::Message "Unsupported pixel type."

Reimplemented from Isis::Process.

Definition at line 914 of file ProcessImport.cpp.

References _FILEINFO_, IsisAml::GetOutputAttribute(), Isis::Application::GetUserInterface(), Isis::CubeAttributeOutput::Maximum(), Isis::iException::Message(), Isis::CubeAttributeOutput::Minimum(), Isis::ProcessImport::p_base, Isis::ProcessImport::p_mult, Isis::ProcessImport::p_nb, Isis::ProcessImport::p_nl, Isis::ProcessImport::p_ns, Isis::ProcessImport::p_pixelType, Isis::CubeAttributeOutput::PixelType(), Isis::PixelTypeName(), Isis::CubeAttributeOutput::PropagateMinimumMaximum(), Isis::CubeAttributeOutput::PropagatePixelType(), Isis::Process::SetOutputCube(), Isis::VALID_MAX1, Isis::VALID_MAX2, Isis::VALID_MAX4, Isis::VALID_MAXU2, Isis::VALID_MIN1, Isis::VALID_MIN2, Isis::VALID_MIN4, and Isis::VALID_MINU2.

void Isis::ProcessImport::SetPixelType ( const Isis::PixelType  type  )  [inherited]

Sets the pixel type of the input file.

Parameters:
type The enumerated pixel type Isis::Real, Isis::SignedWord, or Isis::UnsignedByte. This must be invoked prior to setOutputCube
Exceptions:
Isis::iException::Message "Unsupported pixel type."

Definition at line 120 of file ProcessImport.cpp.

References _FILEINFO_, Isis::iException::Message(), Isis::ProcessImport::p_pixelType, and Isis::PixelTypeName().

Referenced by Isis::ProcessImportPds::ProcessPdsImageLabel(), Isis::ProcessImportPds::ProcessPdsQubeLabel(), and SetVicarFile().

void Isis::ProcessImport::SetSpecialValues ( const double  null,
const double  lrs,
const double  lis,
const double  hrs,
const double  his 
) [inherited]

Sets a mapping of input pixel values to output special pixel values.

Parameters:
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 724 of file ProcessImport.cpp.

References Isis::ProcessImport::SetHIS(), Isis::ProcessImport::SetHRS(), Isis::ProcessImport::SetLIS(), Isis::ProcessImport::SetLRS(), and Isis::ProcessImport::SetNull().

Referenced by Isis::ProcessImportPds::ProcessPdsImageLabel(), and Isis::ProcessImportPds::ProcessPdsQubeLabel().

void Isis::ProcessImportVicar::SetVicarFile ( const std::string &  vicarFile,
Isis::Pvl &  vicarLab 
)

Opens a vicar file which can then be immediately imported by invoking the inherited StartProcess method.

Parameters:
vicarFile Name of the vicar file to open
vicarLab A PVL object which will contain the vicar labels.
Exceptions:
Isis::iException::Message 

Definition at line 53 of file ProcessImportVicar.cpp.

References _FILEINFO_, Isis::ProcessImport::BIL, Isis::ProcessImport::BIP, Isis::ProcessImport::BSQ, e, Isis::PvlTokenizer::GetTokenList(), in, Isis::PvlTokenizer::Load(), Isis::iException::Message(), order, Isis::ProcessImport::SetByteOrder(), Isis::ProcessImport::SetDataHeaderBytes(), Isis::ProcessImport::SetDataPrefixBytes(), Isis::ProcessImport::SetDataSuffixBytes(), Isis::ProcessImport::SetDimensions(), Isis::ProcessImport::SetFileHeaderBytes(), Isis::ProcessImport::SetInputFile(), Isis::ProcessImport::SetOrganization(), Isis::ProcessImport::SetPixelType(), and Isis::iString::ToInteger().

void Isis::Process::StartProcess ( void   funct()  )  [inline, inherited]

In the base class, this method will invoked a user-specified function exactly one time.

In derived classes such as ProcessByLine, the StartProcess will invoke a user-specified function for every line in a cube.

Parameters:
funct() Name of your processing function

Definition at line 180 of file Process.h.

void Isis::ProcessImport::StartProcess ( void   funct(Isis::Buffer &out)  )  [inherited]

Process the input file and send data to method.

Parameters:
funct Method that accepts Isis::Buffer as an input parameter, processes the image, and has no return value.
Exceptions:
Isis::iException::Message "File is not a supported organization."

Definition at line 1006 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::BIL, Isis::ProcessImport::BIP, Isis::ProcessImport::BSQ, Isis::iException::Message(), Isis::ProcessImport::p_inFile, Isis::ProcessImport::p_organization, Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), and Isis::ProcessImport::ProcessBsq().

void Isis::ProcessImport::StartProcess (  )  [inherited]

Process the input file and write it to the output.

Definition at line 980 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::BIL, Isis::ProcessImport::BIP, Isis::ProcessImport::BSQ, Isis::iException::Message(), Isis::ProcessImport::p_inFile, Isis::ProcessImport::p_organization, Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), and Isis::ProcessImport::ProcessBsq().

double Isis::ProcessImport::TestPixel ( const double  pixel  )  [inherited]

Tests the pixel.

If it is valid it will return the dn value, otherwise it will return the Isis special pixel value that corresponds to it

Parameters:
pixel The double precision value that represents a pixel.
Returns:
double The double precision value representing the pixel will return as a valid dn or changed to an isis special pixel.

Definition at line 890 of file ProcessImport.cpp.

References Isis::HIGH_INSTR_SAT8, Isis::HIGH_REPR_SAT8, Isis::LOW_INSTR_SAT8, Isis::LOW_REPR_SAT8, Isis::NULL8, Isis::ProcessImport::p_his_min, Isis::ProcessImport::p_hrs_min, Isis::ProcessImport::p_lis_min, Isis::ProcessImport::p_lrs_min, and Isis::ProcessImport::p_null_min.

Referenced by Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), and Isis::ProcessImport::ProcessBsq().

void Isis::Process::WriteHistory ( Cube &  cube  )  [inherited]

Writes out the History blob to the cube.

Definition at line 591 of file Process.cpp.

References Isis::History::AddEntry(), cube, Isis::Process::InputCubes, Isis::Process::p_propagateHistory, and Isis::Cube::Write().

Referenced by Isis::Process::SetOutputCube(), and Isis::ProcessMapMosaic::StartProcess().

Member Data Documentation

std::vector<Isis::Cube *> Isis::Process::InputCubes [protected, inherited]

A vector of pointers to opened Cube objects.

The pointers are established in the SetInputCube/SetInputWorkCube methods.

Definition at line 160 of file Process.h.

Referenced by Isis::Process::ClearInputCubes(), Isis::ProcessExport::CreateWorldFile(), Isis::Process::EndProcess(), Isis::ProcessExport::InitProcess(), Isis::ProcessExportPds::LineBytes(), Isis::ProcessExportPds::OutputLabel(), Isis::ProcessRubberSheet::QuadTree(), Isis::ProcessByBrick::SetBrickSize(), Isis::ProcessByBrick::SetInputBrickSize(), Isis::ProcessMosaic::SetInputCube(), Isis::Process::SetInputCube(), Isis::ProcessExport::SetInputRange(), Isis::ProcessGroundPolygons::SetOutputCube(), Isis::Process::SetOutputCube(), Isis::ProcessRubberSheet::SlowGeom(), Isis::ProcessRubberSheet::SlowQuad(), Isis::ProcessExportPds::StandardAllMapping(), Isis::ProcessExportPds::StandardImageImage(), Isis::ProcessRubberSheet::StartProcess(), Isis::ProcessMosaic::StartProcess(), Isis::ProcessMapMosaic::StartProcess(), Isis::ProcessExport::StartProcess(), Isis::ProcessByTile::StartProcess(), Isis::ProcessBySpectra::StartProcess(), Isis::ProcessBySample::StartProcess(), Isis::ProcessByQuickFilter::StartProcess(), Isis::ProcessByLine::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessByBoxcar::StartProcess(), Isis::ProcessExport::StartProcessBIL(), Isis::ProcessExport::StartProcessBIP(), Isis::ProcessExport::StartProcessBSQ(), and Isis::Process::WriteHistory().

std::vector<Isis::Cube *> Isis::Process::OutputCubes [protected, inherited]

A vector of pointers to allocated Cube objects.

The pointers are established in the SetOutputCube method.

Definition at line 166 of file Process.h.

Referenced by Isis::ProcessPolygons::AppendOutputCube(), Isis::ProcessPolygons::DoWork(), Isis::ProcessImportPds::EndProcess(), Isis::Process::EndProcess(), Isis::ProcessPolygons::FillPolygon(), Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::Process::PropagateLabels(), Isis::ProcessByBrick::SetBrickSize(), Isis::ProcessByBrick::SetOutputBrickSize(), Isis::ProcessPolygons::SetOutputCube(), Isis::ProcessMosaic::SetOutputCube(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::ProcessGroundPolygons::SetOutputCube(), Isis::Process::SetOutputCube(), Isis::ProcessRubberSheet::StartProcess(), Isis::ProcessMosaic::StartProcess(), Isis::ProcessMapMosaic::StartProcess(), Isis::ProcessByTile::StartProcess(), Isis::ProcessBySpectra::StartProcess(), Isis::ProcessBySample::StartProcess(), Isis::ProcessByQuickFilter::StartProcess(), Isis::ProcessByLine::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessByBoxcar::StartProcess(), and Isis::ProcessImportPds::TranslatePdsProjection().

Isis::Progress* Isis::Process::p_progress [protected, inherited]

Pointer to a Progress object.

Definition at line 134 of file Process.h.

Referenced by Isis::ProcessExport::InitProcess(), Isis::Process::Process(), Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessExport::ProcessExport(), Isis::ProcessImport::ProcessImport(), Isis::Process::Progress(), Isis::ProcessRubberSheet::StartProcess(), Isis::ProcessMosaic::StartProcess(), Isis::ProcessExport::StartProcess(), Isis::ProcessByQuickFilter::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessByBoxcar::StartProcess(), Isis::ProcessExport::StartProcessBIL(), Isis::ProcessExport::StartProcessBIP(), Isis::ProcessExport::StartProcessBSQ(), and Isis::Process::~Process().

bool Isis::Process::p_propagateHistory [protected, inherited]

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

Definition at line 150 of file Process.h.

Referenced by Isis::Process::Process(), Isis::Process::PropagateHistory(), Isis::ProcessMapMosaic::StartProcess(), and Isis::Process::WriteHistory().

bool Isis::Process::p_propagateLabels [protected, inherited]

Flag indicating if labels are be propagated to output cubes.

Definition at line 138 of file Process.h.

Referenced by Isis::Process::Process(), Isis::Process::PropagateLabels(), and Isis::Process::SetOutputCube().

bool Isis::Process::p_propagateOriginalLabel [protected, inherited]

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

Definition at line 154 of file Process.h.

Referenced by Isis::Process::Process(), Isis::Process::PropagateOriginalLabel(), and Isis::Process::SetOutputCube().

bool Isis::Process::p_propagatePolygons [protected, inherited]

Flag indicating if blobs are be propagated to output cubes.

Definition at line 146 of file Process.h.

Referenced by Isis::Process::Process(), Isis::Process::PropagatePolygons(), and Isis::Process::SetOutputCube().

bool Isis::Process::p_propagateTables [protected, inherited]

Flag indicating if tables are be propagated to output cubes.

Definition at line 142 of file Process.h.

Referenced by Isis::Process::Process(), Isis::Process::PropagateTables(), and Isis::Process::SetOutputCube().

Isis::Pvl Isis::ProcessImportVicar::p_vicLab [private]

A PVL object which will contain the vicar labels.

Definition at line 71 of file ProcessImportVicar.h.

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