|
Isis Developer Reference
|
Go to the documentation of this file. 1 #ifndef ProcessExportPds_h
2 #define ProcessExportPds_h
188 bool m_forceBandName;
190 bool m_forceCenterFilterWavelength;
193 bool m_forceBandwidth;
195 bool m_forceBandStorageType;
200 bool m_forceScalingFactor;
203 bool m_forceSampleBits;
205 bool m_forceSampleBitMask;
208 bool m_forceSampleType;
211 bool m_forceCoreNull;
225 bool m_detachedLabel;
227 QString m_detachedPdsLabelFile;
232 std::vector<int> m_tableStartRecord;
237 std::vector<int> m_tableRecords;
242 std::vector<char *> m_tableBuffers;
int SizeOf(Isis::PixelType pixelType)
Returns the number of bytes of the specified PixelType.
Definition: PixelType.h:46
void ForceCenterFilterWavelength(bool force)
Mutator method to set how the CENTER_FILTER_WAVELENGTH keyword will be handled.
Definition: ProcessExportPds.cpp:1150
void ForceBandName(bool force)
Mutator method to set how the BAND_NAME keyword will be handled.
Definition: ProcessExportPds.cpp:1137
void SetExportType(PdsExportType recordFormat)
Mutator method to set the output PDS image record type to stream or fixed.
Definition: ProcessExportPds.cpp:1112
const int ILOW_INSTR_SAT4
Definition: SpecialPixel.h:139
void ForceCoreLrs(bool force)
Mutator method to set how the CORE_LOW_REPR_SATURATION keyword will be handled.
Definition: ProcessExportPds.cpp:1267
Export a PDS table from an ISIS Table.
Definition: ExportPdsTable.h:52
PvlGroupIterator findGroup(const QString &name, PvlGroupIterator beg, PvlGroupIterator end)
Find a group with the specified name, within these indexes.
Definition: PvlObject.h:129
int LineBytes()
Return the line bytes (record size) for the input cube, at present this is based on the number of sam...
Definition: ProcessExportPds.cpp:837
Contains Pvl Groups and Pvl Objects.
Definition: PvlObject.h:61
void FixedJP2ImageRoot(Pvl &mainPvl)
Create the fixed keywords for the ROOT object in a PDS JP2 IMAGE file.
Definition: ProcessExportPds.cpp:330
void ForceSampleBitMask(bool force)
Mutator method to set how the SAMPLE_BIT_MASK keyword will be handled.
Definition: ProcessExportPds.cpp:1228
A single keyword-value pair.
Definition: PvlKeyword.h:82
PdsExportType m_exportType
Stream or Fixed.
Definition: ProcessExportPds.h:182
ProcessExportPds()
Default Constructor - Set to default the data members.
Definition: ProcessExportPds.cpp:36
void StreamImageRoot(Pvl &mainPvl)
Create the standard keywords for the ROOT object in a PDS IMAGE file.
Definition: ProcessExportPds.cpp:205
QString name() const
Returns the name of the file excluding the path and the attributes in the file name.
Definition: FileName.cpp:162
const int IHIGH_REPR_SAT4
Definition: SpecialPixel.h:145
void StandardImageImage(Pvl &mainPvl)
Create the standard keywords for an IMAGE object in a PDS IMAGE file.
Definition: ProcessExportPds.cpp:390
@ JP2Image
Image coding system JPEG 2000 formatted image.
Definition: ProcessExportPds.h:93
File name manipulation and expansion.
Definition: FileName.h:100
void FixedImageRoot(Pvl &mainPvl)
Create the fixed keywords for the ROOT object in a PDS IMAGE file.
Definition: ProcessExportPds.cpp:295
PdsExportType
Record format type of exported PDS file.
Definition: ProcessExportPds.h:110
void ForceSampleType(bool force)
Mutator method to set how the SAMPLE_TYPE keyword will be handled.
Definition: ProcessExportPds.cpp:1241
Pvl * m_label
Exported PDS label.
Definition: ProcessExportPds.h:181
@ UnsignedWord
Definition: PixelType.h:31
void CreateQubeLabel()
Create a standard PDS label for type QUBE.
Definition: ProcessExportPds.cpp:161
virtual QString Name() const =0
This method returns the name of the map projection.
void SetPdsResolution(PdsResolution resolutionUnits)
Mutator method to set the output PDS image resolution to meters per pixel or kilometers per pixel.
Definition: ProcessExportPds.cpp:1101
void StandardJP2Image(Pvl &mainPvl)
Create the standard keywords for an IMAGE object in a PDS JP2 IMAGE file.
Definition: ProcessExportPds.cpp:531
bool hasKeyword(const QString &name) const
Check to see if a keyword exists.
Definition: PvlContainer.cpp:159
Container for cube-like labels.
Definition: Pvl.h:119
PdsResolution
Resolution units per pixel of the exported PDS file.
Definition: ProcessExportPds.h:100
void addObject(const PvlObject &object)
Add a PvlObject.
Definition: PvlObject.h:307
@ SignedWord
Definition: PixelType.h:32
void ForceBandwidth(bool force)
Mutator method to set how the BANDWIDTH keyword will be handled.
Definition: ProcessExportPds.cpp:1163
void updateChecksumInLabel(std::ofstream &pdsFileStream)
Updates the CHECKSUM value on the label and rewrites to the output file.
Definition: ProcessExportPds.cpp:953
void ForceCoreLis(bool force)
Mutator method to set how the CORE_LOW_INSTR_SATURATION keyword will be handled.
Definition: ProcessExportPds.cpp:1281
QString toString(bool boolToConvert)
Global function to convert a boolean to a string.
Definition: IString.cpp:211
void ForceSampleBits(bool force)
Mutator method to set how the SAMPLE_BITS keyword will be handled.
Definition: ProcessExportPds.cpp:1215
void SetDetached(QString detachedLabelFile)
Mutator method to set the output PDS file to detached.
Definition: ProcessExportPds.cpp:1061
QString formatPdsTableName()
Format the PDS table object name using the ISIS table name.
Definition: ExportPdsTable.cpp:205
const int IHIGH_INSTR_SAT4
Definition: SpecialPixel.h:142
@ Meter
Meters per pixel.
Definition: ProcessExportPds.h:101
@ Image
Two dimensional array of line/sample values.
Definition: ProcessExportPds.h:85
Allows applications to translate simple text files.
Definition: PvlToPvlTranslationManager.h:65
PvlObject exportTable(char *pdsTableBuffer, int pdsFileRecordBytes, QString pdsByteOrder)
This methods fills the given buffer with the binary PDS table data and returns label information.
Definition: ExportPdsTable.cpp:67
QString expanded() const
Returns a QString of the full file name including the file path, excluding the attributes.
Definition: FileName.cpp:196
~ProcessExportPds()
Destructor.
Definition: ProcessExportPds.cpp:68
Contains multiple PvlContainers.
Definition: PvlGroup.h:41
QString ProjectionName(Pvl &inputLabel)
Return a projection name.
Definition: ProcessExportPds.cpp:823
#define _FILEINFO_
Macro for the filename and line number.
Definition: IException.h:24
@ Kilometer
Kilometers per pixel.
Definition: ProcessExportPds.h:102
virtual void StartProcess(void funct(Isis::Buffer &in))
This method invokes the process operation over a single input cube.
Definition: ProcessExport.cpp:790
bool Attached()
Accessor function returns true if the output PDS file is set to attached.
Definition: ProcessExportPds.cpp:1091
bool hasKeyword(const QString &kname, FindOptions opts) const
See if a keyword is in the current PvlObject, or deeper inside other PvlObjects and Pvlgroups within ...
Definition: PvlObject.cpp:236
Class for storing Table blobs information.
Definition: Table.h:61
long long int BigInt
Big int.
Definition: Constants.h:49
void OutputLabel(std::ofstream &pdsFileStream)
Write the PDS label to the supplied stream.
Definition: ProcessExportPds.cpp:885
PvlObjectIterator findObject(const QString &name, PvlObjectIterator beg, PvlObjectIterator end)
Find the index of object with a specified name, between two indexes.
Definition: PvlObject.h:274
void OutputDetachedLabel()
Write the PDS label to the a detached file.
Definition: ProcessExportPds.cpp:866
int sampleCount() const
Definition: Cube.cpp:1807
@ Msb
Definition: Endian.h:45
void StreamJP2ImageRoot(Pvl &mainPvl)
Create the standard keywords for the ROOT object in a PDS JP2 IMAGE file.
Definition: ProcessExportPds.cpp:239
IO Handler for Isis Cubes.
Definition: Cube.h:167
This represents a cube in a project-based GUI interface.
Definition: Image.h:107
Isis exception class.
Definition: IException.h:91
const int ILOW_REPR_SAT4
Definition: SpecialPixel.h:136
void setValue(QString value, QString unit="")
Sets new values.
Definition: PvlKeyword.cpp:155
void ForceScalingFactor(bool force)
Mutator method to set how the SCALING_FACTOR keyword will be handled.
Definition: ProcessExportPds.cpp:1202
bool hasObject(const QString &name) const
Returns a boolean value based on whether the object exists in the current PvlObject or not.
Definition: PvlObject.h:323
PvlFormat * format()
Definition: PvlContainer.h:248
void SetAttached()
Mutator method to set the output PDS file to attached.
Definition: ProcessExportPds.cpp:1072
void ExportTable(Isis::Table isisTable, QString detachedPdsTableFileName="")
This method will add a table to be exported to PDS.
Definition: ProcessExportPds.cpp:996
virtual void CreateImageLabel()
Create a standard PDS label for type IMAGE.
Definition: ProcessExportPds.cpp:119
void deleteKeyword(const QString &name)
Remove a specified keyword.
Definition: PvlContainer.cpp:97
int LabelSize()
Return the size of the output PDS label.
Definition: ProcessExportPds.cpp:850
void CreateSpectralQubeLabel()
Create a standard PDS label for type SPECTRAL_QUBE.
Definition: ProcessExportPds.cpp:182
void ForceBands(bool force)
Mutator method to set how the the BANDS keyword will be handled.
Definition: ProcessExportPds.cpp:1124
Namespace for the standard library.
void StandardAllMapping(Pvl &mainPvl)
Create the standard keywords for the IMAGE_MAP_PROJECTION group in a PDS label.
Definition: ProcessExportPds.cpp:674
const int INULL4
Definition: SpecialPixel.h:133
PvlFormatPds * m_formatter
Used to determine how to format the keyword values in the PDS file.
Definition: ProcessExportPds.h:179
@ Qube
Multi-dimensional array (1-3 dimensional) whose axes may be interpreted as line/sample/band.
Definition: ProcessExportPds.h:87
@ Stream
Stream Records. This type is generally used for ASCII files.
Definition: ProcessExportPds.h:111
QString unit(const int index=0) const
Returns the units of measurement of the element of the array of values for the object at the specifie...
Definition: PvlKeyword.cpp:357
void ForceCoreHis(bool force)
Mutator method to set how the CORE_HIGH_INSTR_SATURATION keyword will be handled.
Definition: ProcessExportPds.cpp:1309
@ Fixed
Fixed length records.
Definition: ProcessExportPds.h:112
PvlKeyword & findKeyword(const QString &kname, FindOptions opts)
Finds a keyword in the current PvlObject, or deeper inside other PvlObjects and Pvlgroups within this...
Definition: PvlObject.cpp:177
QString ByteOrderName(Isis::ByteOrder byteOrder)
Definition: Endian.h:48
PvlKeyword & findKeyword(const QString &name)
Find a keyword with a specified name.
Definition: PvlContainer.cpp:62
Process class for exporting cubes to PDS standards.
Definition: ProcessExportPds.h:78
virtual Pvl & StandardPdsLabel(ProcessExportPds::PdsFileType type)
Create a standard PDS label of the type specified.
Definition: ProcessExportPds.cpp:92
void ForceCoreHrs(bool force)
Mutator method to set how the CORE_HIGH_REPR_SATURATION keyword will be handled.
Definition: ProcessExportPds.cpp:1295
int Records() const
Returns the number of records.
Definition: Table.cpp:313
PdsFileType
File type to be exported.
Definition: ProcessExportPds.h:84
void ForceOffset(bool force)
Mutator method to set how the OFFSET keyword will be handled.
Definition: ProcessExportPds.cpp:1189
@ Lsb
Definition: Endian.h:44
Base class for Map Projections.
Definition: Projection.h:155
@ UnsignedByte
Definition: PixelType.h:29
bool Detached()
Accessor function returns true if the output PDS file is set to detached.
Definition: ProcessExportPds.cpp:1082
void ForceBandStorageType(bool force)
Mutator method to set how the BAND_STORAGE_TYPE keyword will be handled.
Definition: ProcessExportPds.cpp:1176
@ SpectralQube
Three dimensional objects with two spatial dimensions and one spectral dimension.
Definition: ProcessExportPds.h:90
void Auto(Pvl &outputLabel)
Automatically translate all the output names found in the translation table If a output name does not...
Definition: PvlToPvlTranslationManager.cpp:199
Process class for exporting cubes.
Definition: ProcessExport.h:111
QString path() const
Returns the path of the file name.
Definition: FileName.cpp:103
This is free and unencumbered software released into the public domain.
Definition: Apollo.h:16
virtual void StartProcess(void funct(Isis::Buffer &in))
This method invokes the process operation over a single input cube.
Definition: ProcessExport.cpp:790
void ForceCoreNull(bool force)
Mutator method to set how the CORE_NULL keyword will be handled.
Definition: ProcessExportPds.cpp:1254
@ Real
Definition: PixelType.h:35