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

Import a Vicar file. More...

#include <ProcessImportVicar.h>

Public Types
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 std::string &vicarFile, 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	SetInputCube (Isis::Cube *inCube)
	Set the InputCube vector to an opened Cube which was dynamically allocated.
void	ClearInputCubes ()
	This method clears the input cube list.
void	ClearOutputCubes ()
	Close output cubes from the list and clear the list.
void	PropagateLabels (const bool prop)
	This method allows the programmer to turn on/off the propagation of labels from the 1st input cube to any of the output cubes.
void	PropagateLabels (const 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.
void	CalculateStatistics ()
	Calculates and stores off statistics on every band of every cube added to this process via the SetInputCube method.
std::vector< Isis::Statistics * >	BandStatistics (const unsigned index)
	Get the vector of Statistics objects for each band separately of a specified input cube.
Isis::Statistics *	CubeStatistics (const unsigned index)
	Get the Statistics object for all bands of a specified input cube.
Protected Attributes
Isis::Progress *	p_progress
	Pointer to a Progress object.
bool	p_propagateLabels
	Flag indicating if labels are be propagated to output cubes.
bool	p_propagateTables
	Flag indicating if tables are be propagated to output cubes.
bool	p_propagatePolygons
	Flag indicating if blobs are be propagated to output cubes.
bool	p_propagateHistory
	Flag indicating if history is to be propagated to output cubes.
bool	p_propagateOriginalLabel
	Flag indicating if original lable is to be propagated to output cubes.
std::vector< std::vector < Isis::Statistics * > >	p_bandStats
	Holds the calculated statistics for each band separately of every input cubei after the CalculateStatistics method is called.
std::vector< Isis::Statistics * >	p_cubeStats
	Holds the calculated statistics for every band together of every input cubei after the CalculateStatistics method is called.
std::vector< Isis::Cube * >	InputCubes
	A vector of pointers to opened Cube objects.
std::vector< Isis::Cube * >	OutputCubes
	A vector of pointers to allocated Cube objects.

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

Member Enumeration Documentation

enum Isis::ProcessImport::Interleave [inherited]

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

Enumerator:

InterleaveUndefined	Undefined.
JP2	Jpeg 2000 Format (always band sequential).
BSQ	Band Sequential Format (i.e. Band Interleaved). The first line of data is followed immediately by the next line in the same spectral band.
BIL	Band Interleaved By Line Format (i.e. Row Interleaved). The first line of data is followed immediately by the first line of data in the next band.
BIP	Band Interleaved By Pixel Format (i.e. Pixel Interleaved). The first pixel for all bands is followed by the second pixel for all bands.

Member Function Documentation

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

Returns the number of bands.

Returns:: The number of bands

std::vector<Isis::Statistics *> Isis::Process::BandStatistics ( const unsigned index ) [inline, inherited]

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

Parameters:

index

The index of the input cube in InputCubes

Returns:: vector<Statistics*> A list of statistics ordered by band

References Isis::Process::p_bandStats.

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

Returns the byte order.

Returns:: Byte order of the data

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.

References Isis::Statistics::AddData(), Isis::Progress::CheckStatus(), cube, Isis::Cube::getBandCount(), Isis::Cube::getLineCount(), Isis::Process::InputCubes, line, Isis::Process::p_bandStats, Isis::Process::p_cubeStats, Isis::Cube::read(), Isis::Progress::SetMaximumSteps(), and Isis::Progress::SetText().

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.

References Isis::Process::InputCubes.

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

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

Close output cubes from the list and clear the list.

Author:: Sharmila Prasad (5/7/2011)

References Isis::Process::OutputCubes.

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

Isis::Statistics* Isis::Process::CubeStatistics ( const unsigned index ) [inline, inherited]

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

Parameters:

index

The index of the input cube in InputCubes

Returns:: Statistics* Collections of statistics gathered on all bands

References Isis::Process::p_cubeStats.

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()

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

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()

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

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()

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

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()

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

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.

References Isis::Process::ClearInputCubes(), and Isis::Process::ClearOutputCubes().

Referenced by 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()

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

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()

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

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

Returns the number of lines.

Returns:: The number of lines

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.

References _FILEINFO_, Isis::Filename::Exists(), Isis::Filename::Expanded(), Isis::PvlObject::FindGroup(), Isis::Filename::HighestVersion(), Isis::iException::Io, 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

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

This method returns a pointer to a Progress object.

Returns:: Progress*

References Isis::Process::p_progress.

Referenced by Isis::HiEqualization::calculateStatistics(), Isis::Equalization::calculateStatistics(), Isis::Process::Process(), 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.

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.

References Isis::PvlObject::AddGroup(), Isis::PvlObject::AddObject(), Isis::PvlObject::FindObject(), g, Isis::PvlObject::Group(), Isis::PvlObject::Groups(), Isis::PvlObject::HasObject(), and Isis::Process::OutputCubes.

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.

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.

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.

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.

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

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()

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

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()

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

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()

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

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()

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

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()

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

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()

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

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.

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

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

Referenced by 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()

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

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()

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

Referenced by 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()

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

Referenced by 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()

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

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

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

Referenced by 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()

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

Referenced by 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

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

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.

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.

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

void Isis::Process::SetInputCube ( Isis::Cube * inCube ) [inherited]

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

This is used if there already exists a valid opened cube

Note: This requires that the cube was dynamically allocated because ClearInputCubes deletes the cube.

Author:: Sharmila Prasad (5/7/2011)

Parameters:

inCube

- Pointer to input Cube

Reimplemented in Isis::ProcessByLine.

References _FILEINFO_, Isis::Process::InputCubes, Isis::Cube::isOpen(), Isis::iException::Message(), and Isis::iException::User.

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.

References _FILEINFO_, Isis::AllMatchOrOne, Isis::BandMatchOrOne, Isis::CubeAttributeInput::Bands(), cube, Isis::Cube::getBandCount(), Isis::Cube::getLineCount(), Isis::Cube::getSampleCount(), Isis::Process::InputCubes, Isis::iException::Message(), Isis::OneBand, Isis::Cube::open(), Isis::ReadWrite, Isis::Cube::setVirtualBands(), Isis::SizeMatch, Isis::SpatialMatch, and Isis::iException::User.

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.

Referenced by 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."

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::User.

Referenced by 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.

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.

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.

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

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.

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

Referenced by 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

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.

References _FILEINFO_, Isis::iException::Message(), Isis::iException::Programmer, 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.

Returns:: Isis::Cube Output cube.

Exceptions:

Isis::iException::Message

"File is not in a supported organization."

References Isis::ProcessImport::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.

Returns:: Isis::Cube Output cube.

Exceptions:

Isis::iException::Message

"Unsupported pixel type."

Reimplemented from Isis::Process.

References _FILEINFO_, Isis::CubeAttributeOutput::Maximum(), Isis::iException::Message(), min(), Isis::CubeAttributeOutput::Minimum(), Isis::CubeAttributeOutput::PixelType(), Isis::PixelTypeName(), Isis::iException::Programmer, Isis::CubeAttributeOutput::PropagateMinimumMaximum(), Isis::CubeAttributeOutput::PropagatePixelType(), Isis::Real, Isis::SignedWord, Isis::UnsignedByte, Isis::UnsignedWord, 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.

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

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

References _FILEINFO_, Isis::iException::Message(), Isis::PixelTypeName(), Isis::iException::Programmer, Isis::Real, Isis::SignedWord, Isis::UnsignedByte, and Isis::UnsignedWord.

Referenced by 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.

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

void Isis::ProcessImportVicar::SetVicarFile	(	const std::string &	vicarFile,
		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.

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

void Isis::ProcessImport::StartProcess ( void functIsis::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."

References _FILEINFO_, Isis::ProcessImport::BIL, Isis::ProcessImport::BIP, Isis::ProcessImport::BSQ, Isis::ProcessImport::JP2, Isis::iException::Message(), and Isis::iException::Programmer.

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

Process the input file and write it to the output.

References _FILEINFO_, Isis::ProcessImport::BIL, Isis::ProcessImport::BIP, Isis::ProcessImport::BSQ, Isis::ProcessImport::JP2, Isis::iException::Message(), and Isis::iException::Programmer.

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.

References Isis::HIGH_INSTR_SAT8, Isis::HIGH_REPR_SAT8, Isis::LOW_INSTR_SAT8, Isis::LOW_REPR_SAT8, and Isis::NULL8.

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

Writes out the History blob to the cube.

References Isis::iApp, Isis::Process::InputCubes, Isis::PvlContainer::IsNamed(), Isis::PvlObject::Object(), Isis::PvlObject::Objects(), 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.

Referenced by Isis::ProcessMosaic::AddBandBinGroup(), Isis::ProcessMosaic::BandComparison(), Isis::Process::CalculateStatistics(), Isis::Process::ClearInputCubes(), Isis::ProcessExport::CreateWorldFile(), Isis::ProcessMosaic::GetBandIndex(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::ProcessMosaic::MatchDEMShapeModel(), Isis::ProcessByBrick::ProcessInPlace(), Isis::ProcessByBrick::ProcessIO(), Isis::ProcessByBrick::SetBrickSize(), Isis::ProcessByBrick::SetInputBrickSize(), Isis::ProcessMosaic::SetInputCube(), Isis::Process::SetInputCube(), Isis::ProcessExport::SetInputRange(), Isis::ProcessMosaic::SetMosaicOrigin(), Isis::ProcessGroundPolygons::SetOutputCube(), Isis::Process::SetOutputCube(), Isis::ProcessRubberSheet::StartProcess(), Isis::ProcessMosaic::StartProcess(), Isis::ProcessMapMosaic::StartProcess(), Isis::ProcessExport::StartProcess(), Isis::ProcessByTile::StartProcess(), Isis::ProcessBySpectra::StartProcess(), Isis::ProcessBySample::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessByBoxcar::StartProcess(), Isis::ProcessExport::StartProcessBIL(), Isis::ProcessExport::StartProcessBIP(), Isis::ProcessExport::StartProcessBSQ(), Isis::ProcessByBrick::StartProcessIO(), Isis::ProcessByBrick::StartProcessIOList(), Isis::ProcessByLine::VerifyCubeInPlace(), Isis::ProcessByLine::VerifyCubeIO(), Isis::ProcessByLine::VerifyCubeIOList(), 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.

std::vector< std::vector< Isis::Statistics * > > Isis::Process::p_bandStats [protected, inherited]

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

Referenced by Isis::Process::BandStatistics(), and Isis::Process::CalculateStatistics().

std::vector< Isis::Statistics * > Isis::Process::p_cubeStats [protected, inherited]

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

Referenced by Isis::Process::CalculateStatistics(), and Isis::Process::CubeStatistics().

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

Pointer to a Progress object.

Referenced by Isis::Process::Process(), Isis::ProcessExport::ProcessExport(), Isis::ProcessImport::ProcessImport(), Isis::Process::Progress(), Isis::ProcessRubberSheet::StartProcess(), Isis::ProcessMosaic::StartProcess(), Isis::ProcessExport::StartProcess(), Isis::ProcessByBrick::StartProcess(), Isis::ProcessByBoxcar::StartProcess(), Isis::ProcessExport::StartProcessBIL(), Isis::ProcessExport::StartProcessBIP(), Isis::ProcessExport::StartProcessBSQ(), Isis::ProcessByBrick::StartProcessInPlace(), Isis::ProcessByBrick::StartProcessIO(), Isis::ProcessByBrick::StartProcessIOList(), and Isis::Process::~Process().

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

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

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.

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.

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.

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.

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

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

src/base/objs/ProcessImportVicar/ProcessImportVicar.h
src/base/objs/ProcessImportVicar/ProcessImportVicar.cpp

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

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation

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