Isis 3 Programmer Reference
Isis::ProcessImportVicar Class Reference

Import a Vicar file. More...

#include <ProcessImportVicar.h>

Inheritance diagram for Isis::ProcessImportVicar:
Inheritance graph
Collaboration diagram for Isis::ProcessImportVicar:
Collaboration graph

Public Types

enum  VAXDataType { VAX_REAL, VAX_INT }
 
enum  VAXSpecialPixel {
  VAX_MIN4, VAX_NULL4, VAX_LRS4, VAX_LIS4,
  VAX_HIS4, VAX_HRS4
}
 
enum  Interleave {
  InterleaveUndefined, JP2, BSQ, BIL,
  BIP
}
 This enum includes how the document should be read: by BSQ, BIL, BIP, JP2, or InterleaveUndefined. More...
 

Public Member Functions

void SetVicarFile (const QString &vicarFile, Pvl &vicarLab)
 Opens a vicar file which can then be immediately imported by invoking the inherited StartProcess method. More...
 
virtual void StartProcess ()
 Process the input file and write it to the output. More...
 
virtual void StartProcess (void funct(Isis::Buffer &out))
 Process the input file and send data to method. More...
 
virtual void StartProcess (void funct())
 In the base class, this method will invoked a user-specified function exactly one time. More...
 
void SetInputFile (const QString &file)
 Sets the name of the input file to be read in the import StartProcess method and verifies its existance. More...
 
QString InputFile ()
 Sets the name of the input file to be read in the import StartProcess method and verifies its existance. More...
 
Isis::CubeSetOutputCube (const QString &parameter)
 Create the output file. More...
 
virtual Isis::CubeSetOutputCube (const QString &fname, Isis::CubeAttributeOutput &att)
 Create the output file. More...
 
virtual Isis::CubeSetOutputCube (const QString &parameter, 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::CubeSetOutputCube (const QString &fname, const Isis::CubeAttributeOutput &att, const int nsamps, const int nlines, const int nbands=1)
 Allocates a output cube whose name and size is specified by the programmer. More...
 
void SetPixelType (const Isis::PixelType type)
 Sets the pixel type of the input file. More...
 
Isis::PixelType PixelType ()
 Returns the pixel type. More...
 
void SetDimensions (const int ns, const int nl, const int nb)
 Sets the physical size of the input cube. More...
 
int Samples ()
 Returns the number of samples. More...
 
int Lines ()
 Returns the number of lines. More...
 
int Bands ()
 Returns the number of bands. More...
 
void SetByteOrder (const Isis::ByteOrder order)
 Sets the byte order of the input file. More...
 
Isis::ByteOrder ByteOrder ()
 Returns the byte order. More...
 
bool IsVAXSpecial (unsigned int *vax, VAXSpecialPixel pix)
 Determines if the VAX encoded pixel value is special or not. More...
 
double VAXConversion (void *ibuf)
 Conversion routine which translates VAX_REAL to IEEE_REAL. More...
 
void SetSuffixOffset (int samples, int lines, int coreBands, int itemBytes)
 
void SetSuffixPixelType (const Isis::PixelType type)
 
void SetVAXConvert (const bool vax_convert)
 Sets the VAX flag of the input cube. More...
 
void SetFileHeaderBytes (const int bytes)
 This method sets the number of bytes in the header of a file. More...
 
void SetFileTrailerBytes (const int bytes)
 This method sets the number of bytes in the trailer of a file. More...
 
void SetDataHeaderBytes (const int bytes)
 This method sets the number of bytes in the header of each datablock of a file. More...
 
void SetDataTrailerBytes (const int bytes)
 This method sets the number of bytes in the trailer of each datablock of a file. More...
 
void SetDataPrefixBytes (const int bytes)
 This method sets the number of bytes at the beginning of each data record of a file. More...
 
void SetDataSuffixBytes (const int bytes)
 This method sets the number of bytes at the end of each data record of a file. More...
 
void SaveFileHeader ()
 This method marks the file header to be saved. More...
 
void SaveFileTrailer ()
 This method marks the file trailer to be saved. More...
 
void SaveDataHeader ()
 This method marks the data block headers to be saved. More...
 
void SaveDataTrailer ()
 This method marks the data block trailers to be saved. More...
 
void SaveDataPrefix ()
 This method marks the data prefix to be saved. More...
 
void SaveDataSuffix ()
 This method marks the data suffix to be saved. More...
 
int FileHeaderBytes () const
 This method returns the number of file header bytes. More...
 
int FileTrailerBytes () const
 This method returns the number of file trailer bytes. More...
 
int DataHeaderBytes () const
 This method returns the number of data header bytes. More...
 
int DataTrailerBytes () const
 This method returns the number of data trailer bytes. More...
 
int DataPrefixBytes () const
 This method returns the number of data prefix bytes. More...
 
int DataSuffixBytes () const
 This method returns the number of data duffix bytes. More...
 
char * FileHeader ()
 This method returns a pointer to the file header. More...
 
char * FileTrailer ()
 This method returns a pointer to the file trailer. More...
 
std::vector< char * > DataHeader ()
 This method returns a pointer to the data header. More...
 
std::vector< char * > DataTrailer ()
 This method returns a pointer to the data trailer. More...
 
std::vector< std::vector< char * > > DataPrefix ()
 This method returns a pointer to the data prefix. More...
 
std::vector< std::vector< char * > > DataSuffix ()
 This method returns a pointer to the data suffix. More...
 
void SetOrganization (const ProcessImport::Interleave org)
 Sets the organization of the input cube. More...
 
Interleave Organization () const
 Gets the organization of the input cube. More...
 
void SetBase (const double base)
 Sets the core base of the input cube. More...
 
void SetBase (const std::vector< double > base)
 Sets band dependent core base. More...
 
void SetMultiplier (const double mult)
 Sets the core multiplier of the input cube. More...
 
void SetMultiplier (const std::vector< double > mult)
 Sets band dependent core multiplier. More...
 
void SetSpecialValues (const double null, const double lrs, const double lis, const double hrs, const double his)
 Sets a mapping of input pixel values to output special pixel values. More...
 
void SetNull (const double null_min, const double null_max)
 Sets the range that will be considered Isis::Null. More...
 
void SetLRS (const double lrs_min, const double lrs_max)
 Sets the range that will be considered Isis::Null. More...
 
void SetLIS (const double lis_min, const double lis_max)
 Sets the range that will be considered Isis::Null. More...
 
void SetHRS (const double hrs_min, const double hrs_max)
 Sets the range that will be considered Isis::Null. More...
 
void SetHIS (const double his_min, const double his_max)
 Sets the range that will be considered Isis::Null. More...
 
double TestPixel (const double pixel)
 Tests the pixel. More...
 
void ProcessBsq (void funct(Isis::Buffer &out)=NULL)
 Process the import data as a band sequential file. More...
 
void ProcessBil (void funct(Isis::Buffer &out)=NULL)
 Function to process files stored as Band Interleaved by Line. More...
 
void ProcessBip (void funct(Isis::Buffer &out)=NULL)
 Function to process files stored as Band Interleaved by Pixel. More...
 
void ProcessJp2 (void funct(Isis::Buffer &out)=NULL)
 Function to process files containing compressed JPEG2000 data (which is always BSQ but is processed as BIL with one or more lines stored sequentially for each band). More...
 
void CheckPixelRange (QString pixelName, double min, double max)
 Checks the special pixel range of the given against all other special pixel value ranges, making sure none overlap. More...
 
virtual void 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::CubeSetInputCube (const QString &parameter, const int requirements=0)
 Opens an input cube specified by the user and verifies requirements are met. More...
 
virtual Isis::CubeSetInputCube (const QString &fname, const Isis::CubeAttributeInput &att, int requirements=0)
 Opens an input cube specified by the programmer and verifies requirements are met. More...
 
virtual void SetInputCube (Isis::Cube *inCube)
 Set the InputCube vector to an opened Cube which was dynamically allocated. More...
 
void AddInputCube (Cube *cube, bool owned=true)
 
void AddOutputCube (Cube *cube, bool owned=true)
 
void ClearCubes ()
 Close owned cubes from the list and clear the list. More...
 
void ClearInputCubes ()
 Close owned input cubes from the list and clear the list. More...
 
void ClearOutputCubes ()
 Close owned output cubes from the list and clear the list. More...
 
void PropagateLabels (const bool prop)
 This method allows the programmer to turn on/off the propagation of labels from the 1st input cube to any of the output cubes. More...
 
void PropagateLabels (const QString &cube)
 This method allows the programmer to propagate labels from a specific secondary cube. More...
 
void PropagateTables (const bool prop)
 This method allows the programmer to propagate input tables to the output cube (default is true) More...
 
void PropagateTables (const QString &fromName, const QList< QString > &tableNames=QList< QString >())
 Propagate the tables from the cube with the given filename to the output cube. More...
 
void PropagatePolygons (const bool prop)
 This method allows the programmer to propagate input blobs to the output cube (default is true) More...
 
void PropagateHistory (const bool prop)
 This method allows the programmer to propagate history to the output cube (default is true) More...
 
void PropagateOriginalLabel (const bool prop)
 This method allows the programmer to propagate original labels to the output cube (default is true) More...
 
Isis::ProgressProgress ()
 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::StatisticsCubeStatistics (const unsigned index)
 Get the Statistics object for all bands of a specified input cube. More...
 

Protected Attributes

Isis::Progressp_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

QString ExtractPvlLabel (int startPos, std::ifstream &vicarFile) const
 Returns a valid PVL label based on the start position in the VICAR file. More...
 

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
History:

2005-02-11 Elizabeth Ribelin - Modified file to support Doxygen documentation

2008-06-26 Christopher Austin - Added the termination char to SetVicarFile's buf

2011-01-27 Jai Rideout - Fixed to handle VICAR files that have end labels

2016-04-21 Makayla Shepherd - Added UnsignedWord pixel type handling.

Definition at line 63 of file ProcessImportVicar.h.

Member Enumeration Documentation

◆ Interleave

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

Enumerator
InterleaveUndefined 

Undefined.

JP2 

Jpeg 2000 Format (always band sequential).

BSQ 

Band Sequential Format (i.e.

Band Interleaved). The first line of data is followed immediately by the next line in the same spectral band.

BIL 

Band Interleaved By Line Format (i.e.

Row Interleaved). The first line of data is followed immediately by the first line of data in the next band.

BIP 

Band Interleaved By Pixel Format (i.e.

Pixel Interleaved). The first pixel for all bands is followed by the second pixel for all bands.

Definition at line 291 of file ProcessImport.h.

Member Function Documentation

◆ Bands()

int Isis::ProcessImport::Bands ( )
inlineinherited

Returns the number of bands.

Returns
The number of bands

Definition at line 239 of file ProcessImport.h.

References Isis::ProcessImport::p_nb.

◆ BandStatistics()

std::vector<Isis::Statistics *> Isis::Process::BandStatistics ( const unsigned  index)
inlineinherited

Get the vector of Statistics objects for each band separately of a specified input cube.

Parameters
indexThe index of the input cube in InputCubes
Returns
vector<Statistics*> A list of statistics ordered by band

Definition at line 290 of file Process.h.

References Isis::Process::p_bandStats.

◆ ByteOrder()

Isis::ByteOrder Isis::ProcessImport::ByteOrder ( )
inlineinherited

Returns the byte order.

Returns
Byte order of the data

Definition at line 250 of file ProcessImport.h.

References Isis::ProcessImport::p_byteOrder.

◆ CalculateStatistics()

void Isis::Process::CalculateStatistics ( )
inherited

Calculates and stores off statistics on every band of every cube added to this process via the SetInputCube method.

The newly calculated statistics are stored in two ways: as a vector where each entry is a single Statistics object for every band of a particular input cube, and as a vector where each entry is a vector of Statistics objects, for each band separately, of a particular input cube.

Definition at line 737 of file Process.cpp.

References Isis::Statistics::AddData(), Isis::Cube::bandCount(), Isis::Progress::CheckStatus(), Isis::Buffer::DoubleBuffer(), Isis::Cube::lineCount(), Isis::Cube::read(), Isis::LineManager::SetLine(), Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), Isis::Buffer::size(), and Isis::toString().

◆ CheckPixelRange()

void Isis::ProcessImport::CheckPixelRange ( QString  pixelName,
double  pixelMin,
double  pixelMax 
)
inherited

Checks the special pixel range of the given against all other special pixel value ranges, making sure none overlap.

Parameters
pixelNameName of the special pixel type to be displayed in the error message.
pixelMinThe minimum value of the special pixel range
pixelMaxThe maximum value of the special pixel range

Definition at line 1112 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_his_max, Isis::ProcessImport::p_his_min, Isis::ProcessImport::p_hrs_max, Isis::ProcessImport::p_hrs_min, Isis::ProcessImport::p_lis_max, Isis::ProcessImport::p_lis_min, Isis::ProcessImport::p_lrs_max, Isis::ProcessImport::p_lrs_min, Isis::ProcessImport::p_null_max, Isis::ProcessImport::p_null_min, Isis::toString(), and Isis::IException::User.

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

◆ ClearCubes()

void Isis::Process::ClearCubes ( )
inherited

Close owned cubes from the list and clear the list.

Definition at line 509 of file Process.cpp.

◆ ClearInputCubes()

void Isis::Process::ClearInputCubes ( )
inherited

Close owned input cubes from the list and clear the list.

Definition at line 519 of file Process.cpp.

Referenced by Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::FileTool::saveAsReducedCube(), and Isis::ProcessMapMosaic::SetOutputCube().

◆ ClearOutputCubes()

void Isis::Process::ClearOutputCubes ( )
inherited

Close owned output cubes from the list and clear the list.

Definition at line 533 of file Process.cpp.

◆ CubeStatistics()

Isis::Statistics* Isis::Process::CubeStatistics ( const unsigned  index)
inlineinherited

Get the Statistics object for all bands of a specified input cube.

Parameters
indexThe index of the input cube in InputCubes
Returns
Statistics* Collections of statistics gathered on all bands

Definition at line 304 of file Process.h.

References Isis::Process::p_cubeStats.

◆ DataHeader()

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 821 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_dataHeader, Isis::ProcessImport::p_saveDataHeader, and Isis::IException::Programmer.

◆ DataHeaderBytes()

int Isis::ProcessImport::DataHeaderBytes ( ) const
inherited

This method returns the number of data header bytes.

Definition at line 719 of file ProcessImport.cpp.

References Isis::ProcessImport::p_dataHeaderBytes.

◆ DataPrefix()

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 877 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_dataPre, Isis::ProcessImport::p_saveDataPre, and Isis::IException::Programmer.

◆ DataPrefixBytes()

int Isis::ProcessImport::DataPrefixBytes ( ) const
inherited

This method returns the number of data prefix bytes.

Definition at line 735 of file ProcessImport.cpp.

References Isis::ProcessImport::p_dataPreBytes.

Referenced by Isis::ProcessImportFits::setProcessFileStructure().

◆ DataSuffix()

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 905 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_dataPost, Isis::ProcessImport::p_saveDataPost, and Isis::IException::Programmer.

◆ DataSuffixBytes()

int Isis::ProcessImport::DataSuffixBytes ( ) const
inherited

This method returns the number of data duffix bytes.

Definition at line 743 of file ProcessImport.cpp.

References Isis::ProcessImport::p_dataPostBytes.

Referenced by Isis::ProcessImportFits::setProcessFileStructure().

◆ DataTrailer()

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 849 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_dataTrailer, Isis::ProcessImport::p_saveDataTrailer, and Isis::IException::Programmer.

◆ DataTrailerBytes()

int Isis::ProcessImport::DataTrailerBytes ( ) const
inherited

This method returns the number of data trailer bytes.

Definition at line 727 of file ProcessImport.cpp.

References Isis::ProcessImport::p_dataTrailerBytes.

◆ EndProcess()

void Isis::Process::EndProcess ( )
virtualinherited

◆ ExtractPvlLabel()

QString Isis::ProcessImportVicar::ExtractPvlLabel ( int  startPos,
std::ifstream &  vicarFile 
) const
private

Returns a valid PVL label based on the start position in the VICAR file.

Parameters
startPosthe position to start reading the label
vicarFilethe file stream to read from
Returns
a valid PVL label

Definition at line 155 of file ProcessImportVicar.cpp.

References _FILEINFO_, and Isis::IString::ToInteger().

◆ FileHeader()

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 767 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_fileHeader, Isis::ProcessImport::p_saveFileHeader, and Isis::IException::Programmer.

◆ FileHeaderBytes()

int Isis::ProcessImport::FileHeaderBytes ( ) const
inherited

This method returns the number of file header bytes.

Definition at line 702 of file ProcessImport.cpp.

References Isis::ProcessImport::p_fileHeaderBytes.

◆ FileTrailer()

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 793 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_fileTrailer, Isis::ProcessImport::p_saveFileTrailer, and Isis::IException::Programmer.

◆ FileTrailerBytes()

int Isis::ProcessImport::FileTrailerBytes ( ) const
inherited

This method returns the number of file trailer bytes.

Definition at line 711 of file ProcessImport.cpp.

References Isis::ProcessImport::p_fileTrailerBytes.

◆ Finalize()

void Isis::Process::Finalize ( )
virtualinherited

Cleans up by closing cubes and freeing memory for owned cubes.

Clears the lists for all cubes.

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

Definition at line 491 of file Process.cpp.

Referenced by Isis::ProcessByBoxcar::Finalize().

◆ InputFile()

QString Isis::ProcessImport::InputFile ( )
inherited

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

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

Definition at line 2308 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_inFile, and Isis::IException::Programmer.

Referenced by Isis::ProcessImportFits::setProcessFileStructure().

◆ IsVAXSpecial()

bool Isis::ProcessImport::IsVAXSpecial ( unsigned int *  vax,
VAXSpecialPixel  pix 
)
inherited

Determines if the VAX encoded pixel value is special or not.

Parameters
vaxA pointer to a VAX pixel
pixAn enumerated value indicating the VAX pixel type
Returns
bool Returns true if the bit pattern for the enumerated type matches that pointed to by vax. Returns false otherwise.

Definition at line 132 of file ProcessImport.cpp.

Referenced by Isis::ProcessImport::VAXConversion().

◆ Lines()

int Isis::ProcessImport::Lines ( )
inlineinherited

Returns the number of lines.

Returns
The number of lines

Definition at line 230 of file ProcessImport.h.

References Isis::ProcessImport::p_nl.

◆ MissionData()

QString Isis::Process::MissionData ( const QString &  mission,
const QString &  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
missionName of the mission data directory
fileName of the file to attach to the end of the directory
highestVersionIf set to true the method will return the highest version number of the given file. Therefore, file must contain question marks such as "file???.dat". See the FileName class for more information on versioned files. Defaults to false.

Definition at line 682 of file Process.cpp.

References _FILEINFO_, Isis::FileName::expanded(), Isis::FileName::fileExists(), Isis::PvlObject::findGroup(), and Isis::FileName::highestVersion().

◆ Organization()

ProcessImport::Interleave Isis::ProcessImport::Organization ( ) const
inherited

Gets the organization of the input cube.

Definition at line 942 of file ProcessImport.cpp.

References Isis::ProcessImport::p_organization.

Referenced by Isis::ProcessImportFits::setProcessFileStructure().

◆ PixelType()

Isis::PixelType Isis::ProcessImport::PixelType ( )
inlineinherited

Returns the pixel type.

Returns
The pixel type of input data

Definition at line 210 of file ProcessImport.h.

References Isis::ProcessImport::p_pixelType.

◆ ProcessBil()

void Isis::ProcessImport::ProcessBil ( void   functIsis::Buffer &out = NULL)
inherited

Function to process files stored as Band Interleaved by Line.

Parameters
functMethod that accepts Isis::Buffer as an input parameter, processes the image, and has no return value.
Exceptions
Isis::iException::Message"Cannot open input file."
Isis::iException::Message"Cannot read file. Position[]. Byte count[]"

Definition at line 1615 of file ProcessImport.cpp.

References _FILEINFO_, Isis::Progress::CheckStatus(), Isis::EndianSwapper::Double(), Isis::FileName::expanded(), Isis::EndianSwapper::Float(), Isis::EndianSwapper::Int(), Isis::IException::Io, Isis::IsValidPixel(), Isis::Process::OutputCubes, Isis::ProcessImport::p_base, Isis::ProcessImport::p_byteOrder, Isis::ProcessImport::p_dataHeaderBytes, Isis::ProcessImport::p_dataPost, Isis::ProcessImport::p_dataPostBytes, Isis::ProcessImport::p_dataPre, Isis::ProcessImport::p_dataPreBytes, Isis::ProcessImport::p_fileHeader, Isis::ProcessImport::p_fileHeaderBytes, Isis::ProcessImport::p_fileTrailer, Isis::ProcessImport::p_fileTrailerBytes, Isis::ProcessImport::p_inFile, Isis::ProcessImport::p_mult, Isis::ProcessImport::p_nb, Isis::ProcessImport::p_nl, Isis::ProcessImport::p_ns, Isis::ProcessImport::p_pixelType, Isis::Process::p_progress, Isis::ProcessImport::p_saveDataPost, Isis::ProcessImport::p_saveDataPre, Isis::ProcessImport::p_saveFileHeader, Isis::ProcessImport::p_saveFileTrailer, Isis::ProcessImport::p_suffixData, Isis::Progress::SetMaximumSteps(), Isis::EndianSwapper::ShortInt(), Isis::SizeOf(), Isis::ProcessImport::TestPixel(), Isis::toString(), Isis::EndianSwapper::Uint32_t(), Isis::EndianSwapper::UnsignedShortInt(), and Isis::ProcessImport::VAXConversion().

Referenced by Isis::ProcessImport::StartProcess().

◆ ProcessBip()

void Isis::ProcessImport::ProcessBip ( void   functIsis::Buffer &out = NULL)
inherited

Function to process files stored as Band Interleaved by Pixel.

Parameters
functMethod that accepts Isis::Buffer as an input parameter, processes the image, and has no return value.
Exceptions
Isis::iException::Message"Cannot open input file."
Isis::iException::Message"Cannot read file. Position[]. Byte count[]"

Definition at line 1860 of file ProcessImport.cpp.

References _FILEINFO_, Isis::Progress::CheckStatus(), Isis::EndianSwapper::Double(), Isis::FileName::expanded(), Isis::EndianSwapper::Float(), Isis::EndianSwapper::Int(), Isis::IException::Io, Isis::IsValidPixel(), Isis::Process::OutputCubes, Isis::ProcessImport::p_base, Isis::ProcessImport::p_byteOrder, Isis::ProcessImport::p_dataHeaderBytes, Isis::ProcessImport::p_dataPost, Isis::ProcessImport::p_dataPostBytes, Isis::ProcessImport::p_dataPre, Isis::ProcessImport::p_dataPreBytes, Isis::ProcessImport::p_dataTrailer, Isis::ProcessImport::p_dataTrailerBytes, Isis::ProcessImport::p_fileHeader, Isis::ProcessImport::p_fileHeaderBytes, Isis::ProcessImport::p_fileTrailer, Isis::ProcessImport::p_fileTrailerBytes, Isis::ProcessImport::p_inFile, Isis::ProcessImport::p_mult, Isis::ProcessImport::p_nb, Isis::ProcessImport::p_nl, Isis::ProcessImport::p_ns, Isis::ProcessImport::p_pixelType, Isis::Process::p_progress, Isis::ProcessImport::p_saveDataPost, Isis::ProcessImport::p_saveDataPre, Isis::ProcessImport::p_saveDataTrailer, Isis::ProcessImport::p_saveFileHeader, Isis::ProcessImport::p_saveFileTrailer, Isis::ProcessImport::p_suffixData, Isis::Progress::SetMaximumSteps(), Isis::EndianSwapper::ShortInt(), Isis::SizeOf(), Isis::ProcessImport::TestPixel(), Isis::toString(), Isis::EndianSwapper::Uint32_t(), Isis::EndianSwapper::UnsignedShortInt(), and Isis::ProcessImport::VAXConversion().

Referenced by Isis::ProcessImport::StartProcess().

◆ ProcessBsq()

void Isis::ProcessImport::ProcessBsq ( void   functIsis::Buffer &out = NULL)
inherited

Process the import data as a band sequential file.

Parameters
functMethod that accepts Isis::Buffer as an input parameter, processes the image, and has no return value.
Exceptions
Isis::iException::Message"Cannot open input file."
Isis::iException::Message"Cannot read file. Position[]. Byte count[]"

Definition at line 1352 of file ProcessImport.cpp.

References _FILEINFO_, Isis::Progress::CheckStatus(), Isis::EndianSwapper::Double(), Isis::FileName::expanded(), Isis::EndianSwapper::Float(), Isis::EndianSwapper::Int(), Isis::IException::Io, Isis::IsValidPixel(), Isis::Process::OutputCubes, Isis::ProcessImport::p_base, Isis::ProcessImport::p_byteOrder, Isis::ProcessImport::p_dataHeader, Isis::ProcessImport::p_dataHeaderBytes, Isis::ProcessImport::p_dataPost, Isis::ProcessImport::p_dataPostBytes, Isis::ProcessImport::p_dataPre, Isis::ProcessImport::p_dataPreBytes, Isis::ProcessImport::p_dataTrailer, Isis::ProcessImport::p_dataTrailerBytes, Isis::ProcessImport::p_fileHeader, Isis::ProcessImport::p_fileHeaderBytes, Isis::ProcessImport::p_fileTrailer, Isis::ProcessImport::p_fileTrailerBytes, Isis::ProcessImport::p_inFile, Isis::ProcessImport::p_mult, Isis::ProcessImport::p_nb, Isis::ProcessImport::p_nl, Isis::ProcessImport::p_ns, Isis::ProcessImport::p_pixelType, Isis::Process::p_progress, Isis::ProcessImport::p_saveDataHeader, Isis::ProcessImport::p_saveDataPost, Isis::ProcessImport::p_saveDataPre, Isis::ProcessImport::p_saveDataTrailer, Isis::ProcessImport::p_saveFileHeader, Isis::ProcessImport::p_saveFileTrailer, Isis::ProcessImport::p_suffixData, Isis::Progress::SetMaximumSteps(), Isis::EndianSwapper::ShortInt(), Isis::SizeOf(), Isis::ProcessImport::TestPixel(), Isis::toString(), Isis::EndianSwapper::Uint32_t(), Isis::EndianSwapper::UnsignedShortInt(), and Isis::ProcessImport::VAXConversion().

Referenced by Isis::ProcessImport::StartProcess().

◆ ProcessJp2()

void Isis::ProcessImport::ProcessJp2 ( void   functIsis::Buffer &out = NULL)
inherited

Function to process files containing compressed JPEG2000 data (which is always BSQ but is processed as BIL with one or more lines stored sequentially for each band).

There is no need to set up an Isis::EndianSwapper because JP2 data is always assumed to be in MSB format. The Kakadu library does an automatic byte swap for the current architecture.

Parameters
functMethod that accepts Isis::Buffer as an input parameter, processes the image, and has no return value.
Exceptions
Isis::iException::Message"Cannot open input file."
Isis::iException::Message"Cannot read file. Position[]. Byte count[]"

Definition at line 2112 of file ProcessImport.cpp.

References Isis::Progress::CheckStatus(), Isis::IsValidPixel(), Isis::JP2Decoder::OpenFile(), Isis::Process::OutputCubes, Isis::ProcessImport::p_base, Isis::ProcessImport::p_dataPost, Isis::ProcessImport::p_dataPostBytes, Isis::ProcessImport::p_dataPre, Isis::ProcessImport::p_dataPreBytes, Isis::ProcessImport::p_inFile, Isis::ProcessImport::p_mult, Isis::ProcessImport::p_nb, Isis::ProcessImport::p_nl, Isis::ProcessImport::p_ns, Isis::ProcessImport::p_pixelType, Isis::Process::p_progress, Isis::ProcessImport::p_saveDataPost, Isis::ProcessImport::p_saveDataPre, Isis::JP2Decoder::Read(), Isis::Progress::SetMaximumSteps(), Isis::SizeOf(), and Isis::ProcessImport::TestPixel().

Referenced by Isis::ProcessImport::StartProcess().

◆ Progress()

◆ PropagateHistory()

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

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

Parameters
propFlag indicating if history is to be propagated to output cubes.

Definition at line 651 of file Process.cpp.

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

◆ PropagateLabels() [1/2]

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
propFlag indicating if labels are be propagated to output cubes.

Definition at line 555 of file Process.cpp.

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

◆ PropagateLabels() [2/2]

void Isis::Process::PropagateLabels ( const QString &  cube)
inherited

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

Parameters
cubeIString containing the name of the cube containing the labels to propagate.

Definition at line 566 of file Process.cpp.

References Isis::PvlObject::addGroup(), Isis::PvlObject::addObject(), Isis::PvlObject::findObject(), Isis::PvlObject::group(), Isis::PvlObject::groups(), and Isis::PvlObject::hasObject().

◆ PropagateOriginalLabel()

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
propFlag indicating if original labels is to be propagated to output cubes.

Definition at line 662 of file Process.cpp.

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

◆ PropagatePolygons()

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
propFlag indicating if input blobs are to be propagated to output cubes.

Definition at line 641 of file Process.cpp.

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

◆ PropagateTables() [1/2]

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
propFlag indicating if input tables are to be propagated to output cubes.

Definition at line 594 of file Process.cpp.

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

◆ PropagateTables() [2/2]

void Isis::Process::PropagateTables ( const QString &  fromName,
const QList< QString > &  tableNames = QList<QString>() 
)
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.

Parameters
fromNameQString of the name of the cube containing the tables to propagate.
tableNamesList of QStrings of the names of the tables to propagate; default is empty, which indicates that all tables will be propagated.
History:
2016-11-30 Ian Humphrey - Added tableNames parameter so that only specified tables will be propagated when calling this method. Note that a default of an empty QList is used to propagate all tables. References #4433.

Definition at line 614 of file Process.cpp.

References Isis::Cube::label(), Isis::PvlObject::object(), Isis::PvlObject::objects(), Isis::Cube::open(), and Isis::Cube::read().

◆ Samples()

int Isis::ProcessImport::Samples ( )
inlineinherited

Returns the number of samples.

Returns
The number of samples

Definition at line 221 of file ProcessImport.h.

References Isis::ProcessImport::p_ns.

◆ SaveDataHeader()

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 602 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_dataHeaderBytes, Isis::ProcessImport::p_saveDataHeader, and Isis::IException::Programmer.

◆ SaveDataPrefix()

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 659 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_dataPreBytes, Isis::ProcessImport::p_saveDataPre, and Isis::IException::Programmer.

◆ SaveDataSuffix()

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 688 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_dataPostBytes, Isis::ProcessImport::p_saveDataPost, and Isis::IException::Programmer.

◆ SaveDataTrailer()

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 631 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_dataTrailerBytes, Isis::ProcessImport::p_saveDataTrailer, and Isis::IException::Programmer.

◆ SaveFileHeader()

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 546 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_fileHeaderBytes, Isis::ProcessImport::p_saveFileHeader, and Isis::IException::Programmer.

◆ SaveFileTrailer()

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 573 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_fileTrailerBytes, Isis::ProcessImport::p_saveFileTrailer, and Isis::IException::Programmer.

◆ SetBase() [1/2]

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

Sets the core base of the input cube.

Defaults to zero if not invoked.

Parameters
baseCore base

Definition at line 952 of file ProcessImport.cpp.

References Isis::ProcessImport::p_base.

Referenced by Isis::ProcessImportFits::setProcessFileStructure().

◆ SetBase() [2/2]

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

Sets band dependent core base.

Parameters
baseA vector containing the base for each band.

Definition at line 963 of file ProcessImport.cpp.

References Isis::ProcessImport::p_base.

◆ SetByteOrder()

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
orderThe enumerated byte order Isis::Lsb or Isis::Msb

Definition at line 338 of file ProcessImport.cpp.

References Isis::ProcessImport::p_byteOrder.

Referenced by Isis::ProcessImportFits::setProcessFileStructure().

◆ SetDataHeaderBytes()

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
bytesNumber of bytes
Exceptions
Isis::iException::Message"Illegal data header size." (when bytes < 0)
See also
SaveDataHeader()
DataHeader()

Definition at line 422 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_dataHeaderBytes, Isis::IException::Programmer, and Isis::toString().

◆ SetDataPrefixBytes()

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
bytesNumber of bytes
Exceptions
Isis::iException::Message"Illegal data prefix size." (when bytes < 0)
See also
SaveDataPrefix()
DataPrefix()

Definition at line 487 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_dataPreBytes, Isis::IException::Programmer, and Isis::toString().

◆ SetDataSuffixBytes()

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
bytesNumber of bytes
Exceptions
Isis::iException::Message"Illegal data suffix size." (when bytes < 0)
See also
SaveDataSuffix()
DataSuffix()

Definition at line 517 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_dataPostBytes, Isis::IException::Programmer, and Isis::toString().

◆ SetDataTrailerBytes()

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
bytesNumber of bytes
Exceptions
Isis::iException::Message"Illegal data trailer size." (when bytes < 0)
See also
SaveDataTrailer()
DataTrailer()

Definition at line 457 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_dataTrailerBytes, Isis::IException::Programmer, and Isis::toString().

◆ SetDimensions()

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
nsNumber of samples
nlNumber of lines
nbNumber of bands
Exceptions
Isis::iException::Message"Illegal dimension."

Definition at line 318 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_nb, Isis::ProcessImport::p_nl, Isis::ProcessImport::p_ns, Isis::IException::Programmer, and Isis::toString().

Referenced by Isis::ProcessImportFits::setProcessFileStructure().

◆ SetFileHeaderBytes()

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
bytesNumber of bytes
Exceptions
Isis::iException::Message"Illegal file header size." (when bytes < 0)
See also
SaveFileHeader()
FileHeader()

Definition at line 363 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_fileHeaderBytes, Isis::IException::Programmer, and Isis::toString().

Referenced by Isis::ProcessImportFits::setProcessFileStructure().

◆ SetFileTrailerBytes()

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
bytesNumber 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 393 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_fileTrailerBytes, Isis::IException::Programmer, and Isis::toString().

◆ SetHIS()

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

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

Parameters
his_minThe double precision value used to identify the min range of his pixels in the image being imported.
his_maxThe double precision value used to identify the max range of his pixels in the image being imported.

Definition at line 1096 of file ProcessImport.cpp.

References Isis::ProcessImport::CheckPixelRange(), Isis::ProcessImport::p_his_max, and Isis::ProcessImport::p_his_min.

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

◆ SetHRS()

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

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

Parameters
hrs_minThe double precision value used to identify the min range of hrs pixels in the image being imported.
hrs_maxThe double precision value used to identify the max range of hrs pixels in the image being imported.

Definition at line 1079 of file ProcessImport.cpp.

References Isis::ProcessImport::CheckPixelRange(), Isis::ProcessImport::p_hrs_max, and Isis::ProcessImport::p_hrs_min.

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

◆ SetInputCube() [1/3]

Isis::Cube * Isis::Process::SetInputCube ( const QString &  parameter,
const int  requirements = 0 
)
virtualinherited

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

Returns
Cube*
Parameters
parameterUser 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".
requirementsUse 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::ProcessByLine, Isis::ProcessByBrick, Isis::ProcessBySpectra, and Isis::ProcessBySample.

Definition at line 243 of file Process.cpp.

Referenced by Isis::ImageExporter::addChannel(), Isis::JigsawRunWidget::on_JigsawAcceptButton_clicked(), Isis::FileTool::saveAsEnlargedCube(), and Isis::ProcessGroundPolygons::SetStatCubes().

◆ SetInputCube() [2/3]

Isis::Cube * Isis::Process::SetInputCube ( const QString &  fname,
const Isis::CubeAttributeInput att,
int  requirements = 0 
)
virtualinherited

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

Parameters
fnameProgrammer specified work file. For example, "myfile.cub".
attThe cube attributes to use when opening the input cube.
requirementsSame 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 82 of file Process.cpp.

References _FILEINFO_, Isis::Cube::bandCount(), Isis::CubeAttributeInput::bands(), Isis::Cube::lineCount(), Isis::Cube::open(), Isis::Cube::sampleCount(), and Isis::Cube::setVirtualBands().

◆ SetInputCube() [3/3]

void Isis::Process::SetInputCube ( Isis::Cube inCube)
virtualinherited

Set the InputCube vector to an opened Cube which was dynamically allocated.

This is used if there already exists a valid opened cube

Author
Sharmila Prasad (5/7/2011)
Parameters
inCube- Pointer to input Cube

Reimplemented in Isis::ProcessByLine.

Definition at line 201 of file Process.cpp.

References _FILEINFO_, and Isis::Cube::isOpen().

◆ SetInputFile()

void Isis::ProcessImport::SetInputFile ( const QString &  file)
inherited

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

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

Definition at line 2291 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_inFile, and Isis::IException::User.

Referenced by Isis::ProcessImportFits::setFitsFile().

◆ SetLIS()

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

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

Parameters
lis_minThe double precision value used to identify the min range of lis pixels in the image being imported.
lis_maxThe double precision value used to identify the max range of lis pixels in the image being imported.

Definition at line 1062 of file ProcessImport.cpp.

References Isis::ProcessImport::CheckPixelRange(), Isis::ProcessImport::p_lis_max, and Isis::ProcessImport::p_lis_min.

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

◆ SetLRS()

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

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

Parameters
lrs_minThe double precision value used to identify the min range of lrs pixels in the image being imported.
lrs_maxThe double precision value used to identify the max range of lrs pixels in the image being imported.

Definition at line 1045 of file ProcessImport.cpp.

References Isis::ProcessImport::CheckPixelRange(), Isis::ProcessImport::p_lrs_max, and Isis::ProcessImport::p_lrs_min.

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

◆ SetMultiplier() [1/2]

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

Sets the core multiplier of the input cube.

Defaults to one if not invoked.

Parameters
multCore base

Definition at line 973 of file ProcessImport.cpp.

References Isis::ProcessImport::p_mult.

Referenced by Isis::ProcessImportFits::setProcessFileStructure().

◆ SetMultiplier() [2/2]

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

Sets band dependent core multiplier.

Parameters
multA vector containing the multiplier for each band.

Definition at line 984 of file ProcessImport.cpp.

References Isis::ProcessImport::p_mult.

◆ SetNull()

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

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

Parameters
null_minThe double precision value used to identify the min range of null pixels in the image being imported.
null_maxThe double precision value used to identify the max range of null pixels in the image being imported.

Definition at line 1028 of file ProcessImport.cpp.

References Isis::ProcessImport::CheckPixelRange(), Isis::ProcessImport::p_null_max, and Isis::ProcessImport::p_null_min.

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

◆ SetOrganization()

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
orgThe enumerated organizations either Isis::Import::Bsq Isis::Import::Bil or Isis::Import::Bip

Definition at line 921 of file ProcessImport.cpp.

References Isis::ProcessImport::p_organization.

◆ SetOutputCube() [1/4]

Isis::Cube * Isis::ProcessImport::SetOutputCube ( const QString &  parameter)
virtualinherited

Create the output file.

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

Parameters
parameterThe parameter name that holds the output file name.
Returns
Isis::Cube Output cube.
Exceptions
Isis::iException::Message"Unsupported pixel type."

Reimplemented from Isis::Process.

Definition at line 1213 of file ProcessImport.cpp.

References _FILEINFO_, IsisAml::GetOutputAttribute(), Isis::Application::GetUserInterface(), Isis::ProcessImport::p_base, Isis::ProcessImport::p_mult, Isis::ProcessImport::p_nb, Isis::ProcessImport::p_nl, Isis::ProcessImport::p_ns, Isis::ProcessImport::p_pixelType, Isis::PixelTypeName(), Isis::IException::Programmer, Isis::CubeAttributeOutput::propagateMinimumMaximum(), Isis::CubeAttributeOutput::propagatePixelType(), Isis::CubeAttributeOutput::setMaximum(), Isis::CubeAttributeOutput::setMinimum(), Isis::Process::SetOutputCube(), and Isis::CubeAttributeOutput::setPixelType().

◆ SetOutputCube() [2/4]

Isis::Cube * Isis::ProcessImport::SetOutputCube ( const QString &  fname,
Isis::CubeAttributeOutput att 
)
virtualinherited

Create the output file.

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

Parameters
fnameThe output file name.
attAn output cube attribute to define the characteristics of the output cube.
Returns
Isis::Cube Output cube.
Exceptions
Isis::iException::Message"File is not in a supported organization."

Definition at line 1284 of file ProcessImport.cpp.

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

◆ SetOutputCube() [3/4]

Isis::Cube * Isis::Process::SetOutputCube ( const QString &  parameter,
const int  ns,
const int  nl,
const int  nb = 1 
)
virtualinherited

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

Returns
Cube*
Parameters
parameterUser 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.
nsNumber of samples to allocate
nlNumber of lines to allocate
nbNumber of bands to allocate
Exceptions
Isis::iException::Message

Definition at line 302 of file Process.cpp.

References _FILEINFO_.

◆ SetOutputCube() [4/4]

Isis::Cube * Isis::Process::SetOutputCube ( const QString &  fname,
const Isis::CubeAttributeOutput att,
const int  ns,
const int  nl,
const int  nb = 1 
)
virtualinherited

◆ SetPixelType()

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

Sets the pixel type of the input file.

Parameters
typeThe 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 278 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::p_pixelType, Isis::PixelTypeName(), and Isis::IException::Programmer.

Referenced by Isis::ProcessImportFits::setProcessFileStructure().

◆ SetSpecialValues()

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
nullThe double precision value used to identify null pixels in the image being imported.
lrsThe double precisiion value used to identify low representation saturation LRS pixels in the image being imported.
lisThe double precision value used to identify low instrument saturation LIS pixels in the image being imported.
hrsThe double precision value used to identify high representation saturation HRS pixels in the image being imported.
hisThe double precision value used to identify high instrument saturation HIS pixels in the image being imported.

Definition at line 1007 of file ProcessImport.cpp.

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

◆ SetVAXConvert()

void Isis::ProcessImport::SetVAXConvert ( const bool  vax_convert)
inherited

Sets the VAX flag of the input cube.

If true, then the core pixel type of the input cube is VAX, and VAX conversion routines need to be run to convert the pixels to IEEE format.

Parameters
vax_convertFlag indicating whether or not to run VAX conersion methods

Definition at line 933 of file ProcessImport.cpp.

◆ SetVicarFile()

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

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

Parameters
vicarFileName of the vicar file to open
vicarLabA PVL object which will contain the vicar labels.

Definition at line 48 of file ProcessImportVicar.cpp.

References _FILEINFO_.

◆ StartProcess() [1/3]

◆ StartProcess() [2/3]

void Isis::ProcessImport::StartProcess ( void   functIsis::Buffer &out)
virtualinherited

Process the input file and send data to method.

Parameters
functMethod 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."

Reimplemented in Isis::ProcessImportPds.

Definition at line 1321 of file ProcessImport.cpp.

References _FILEINFO_, Isis::ProcessImport::BIL, Isis::ProcessImport::BIP, Isis::ProcessImport::BSQ, Isis::ProcessImport::JP2, Isis::ProcessImport::p_inFile, Isis::ProcessImport::p_organization, Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessImport::ProcessJp2(), and Isis::IException::Programmer.

◆ StartProcess() [3/3]

virtual void Isis::Process::StartProcess ( void   funct())
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.

Parameters
funct()Name of your processing function

Definition at line 228 of file Process.h.

◆ TestPixel()

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
pixelThe 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 1181 of file ProcessImport.cpp.

References Isis::ProcessImport::p_his_min, Isis::ProcessImport::p_hrs_min, Isis::ProcessImport::p_lis_min, Isis::ProcessImport::p_lrs_min, and Isis::ProcessImport::p_null_min.

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

◆ VAXConversion()

double Isis::ProcessImport::VAXConversion ( void *  ibuf)
inherited

Conversion routine which translates VAX_REAL to IEEE_REAL.

Parameters
ibufMemory buffer of input data to be converted
Returns
double the converted value

Definition at line 185 of file ProcessImport.cpp.

References Isis::IsLsb(), Isis::ProcessImport::IsVAXSpecial(), and Isis::ProcessImport::p_byteOrder.

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

◆ WriteHistory()

void Isis::Process::WriteHistory ( Cube cube)
inherited

Member Data Documentation

◆ InputCubes

◆ m_ownedCubes

QSet<Isis::Cube *>* Isis::Process::m_ownedCubes
protectedinherited

A list of cubes owned by this instant.

These cubes will be deleted on finalization. Process will not take ownership of cubes allocated outside of Process. It is the caller's responsibility to delete such cubes.

Definition at line 214 of file Process.h.

◆ OutputCubes

std::vector<Isis::Cube *> Isis::Process::OutputCubes
protectedinherited

◆ p_bandStats

std::vector< std::vector< Isis::Statistics * > > Isis::Process::p_bandStats
protectedinherited

Holds the calculated statistics for each band separately of every input cubei after the CalculateStatistics method is called.

Definition at line 187 of file Process.h.

Referenced by Isis::Process::BandStatistics().

◆ p_cubeStats

std::vector< Isis::Statistics * > Isis::Process::p_cubeStats
protectedinherited

Holds the calculated statistics for every band together of every input cubei after the CalculateStatistics method is called.

Definition at line 194 of file Process.h.

Referenced by Isis::Process::CubeStatistics().

◆ p_progress

◆ p_propagateHistory

bool Isis::Process::p_propagateHistory
protectedinherited

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

Definition at line 176 of file Process.h.

◆ p_propagateLabels

bool Isis::Process::p_propagateLabels
protectedinherited

Flag indicating if labels are be propagated to output cubes.

Definition at line 164 of file Process.h.

◆ p_propagateOriginalLabel

bool Isis::Process::p_propagateOriginalLabel
protectedinherited

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

Definition at line 180 of file Process.h.

◆ p_propagatePolygons

bool Isis::Process::p_propagatePolygons
protectedinherited

Flag indicating if blobs are be propagated to output cubes.

Definition at line 172 of file Process.h.

◆ p_propagateTables

bool Isis::Process::p_propagateTables
protectedinherited

Flag indicating if tables are be propagated to output cubes.

Definition at line 168 of file Process.h.


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