Isis Developer Reference
Cube.h
Go to the documentation of this file.
1#ifndef Cube_h
2#define Cube_h
8/* SPDX-License-Identifier: CC0-1.0 */
9
10#include <vector>
11
12// This is needed for the QVariant macro
13#include <QMetaType>
14#include <QList>
15#include <QMap>
16
17#include <nlohmann/json.hpp>
18
19#include "Endian.h"
20#include "PixelType.h"
21#include "PvlKeyword.h"
22
23class QFile;
24class QMutex;
25class QString;
26
27namespace Isis {
28 class Blob;
29 class Buffer;
30 class Camera;
31 class CubeAttributeOutput;
32 class CubeCachingAlgorithm;
33 class CubeIoHandler;
34 class CubeStretch;
35 class FileName;
36 class Projection;
37 class Pvl;
38 class PvlGroup;
39 class Statistics;
40 class Table;
41 class Histogram;
42 class History;
43 class OriginalLabel;
44 class OriginalXmlLabel;
45 class ImagePolygon;
46
47
168 class Cube {
169 public:
170 Cube();
171 Cube(const FileName &fileName, QString access = "r");
172
173 virtual ~Cube();
174
179 enum Format {
233 Tile
234 };
235
236 void fromIsd(const FileName &fileName, Pvl &label, nlohmann::json &isd, QString access);
237 void fromIsd(const FileName &fileName, FileName &labelFile, FileName &isdFile, QString access);
238
239 void fromLabel(const FileName &fileName, Pvl &label, QString access);
240
241 bool isOpen() const;
242 bool isProjected() const;
243 bool isReadOnly() const;
244 bool isReadWrite() const;
245 bool labelsAttached() const;
246
247 void attachSpiceFromIsd(nlohmann::json Isd);
248
249 void close(bool remove = false);
250 Cube *copy(FileName newFile, const CubeAttributeOutput &newFileAttributes);
251 void create(const QString &cfile);
252 void create(const QString &cfile, const CubeAttributeOutput &att);
253 void open(const QString &cfile, QString access = "r");
254 void reopen(QString access = "r");
255
256 void read(Blob &blob,
257 const std::vector<PvlKeyword> keywords = std::vector<PvlKeyword>()) const;
258 void read(Buffer &rbuf) const;
259 OriginalLabel readOriginalLabel(const QString &name="IsisCube") const;
260 CubeStretch readCubeStretch(QString name="CubeStretch",
261 const std::vector<PvlKeyword> keywords = std::vector<PvlKeyword>()) const;
263 History readHistory(const QString &name = "IsisCube") const;
265 Table readTable(const QString &name);
266 void write(Blob &blob, bool overwrite=true);
267 void write(const Table &table);
268 void write(const CubeStretch &cubeStretch);
269 void write(OriginalLabel &lab);
270 void write(const OriginalXmlLabel &lab);
271 void write(History &history, const QString &name = "IsisCube");
272 void write(const ImagePolygon &polygon);
273 void write(Buffer &wbuf);
274
275 void setBaseMultiplier(double base, double mult);
276 void setMinMax(double min, double max);
278 void setDimensions(int ns, int nl, int nb);
279 void setExternalDnData(FileName cubeFileWithDnData);
280 void setFormat(Format format);
281 void setLabelsAttached(bool attached);
282 void setLabelSize(int labelBytes);
284 void setVirtualBands(const QList<QString> &vbands);
285 void setVirtualBands(const std::vector<QString> &vbands);
286
287 void relocateDnData(FileName dnDataFile);
288// static void relocateDnData(FileName externalLabelFile, FileName dnDataFile);
289
290 virtual int bandCount() const;
291 double base() const;
292 ByteOrder byteOrder() const;
293 Camera *camera();
295 virtual QString fileName() const;
296 Format format() const;
297 virtual Histogram *histogram(const int &band = 1,
298 QString msg = "Gathering histogram");
299 virtual Histogram *histogram(const int &band, const double &validMin,
300 const double &validMax,
301 QString msg = "Gathering histogram");
302 Pvl *label() const;
303 int labelSize(bool actual = false) const;
304 int lineCount() const;
305 double multiplier() const;
306 PixelType pixelType() const;
307 virtual int physicalBand(const int &virtualBand) const;
309 int sampleCount() const;
310 Statistics *statistics(const int &band = 1,
311 QString msg = "Gathering statistics");
312 Statistics *statistics(const int &band, const double &validMin,
313 const double &validMax,
314 QString msg = "Gathering statistics");
315 bool storesDnData() const;
316
318 void clearIoCache();
319 bool deleteBlob(QString BlobName, QString BlobType);
320 void deleteGroup(const QString &group);
321 PvlGroup &group(const QString &group) const;
322 bool hasGroup(const QString &group) const;
323 bool hasTable(const QString &name);
324 bool hasBlob(const QString &name, const QString &type);
325 void putGroup(const PvlGroup &group);
326 void latLonRange(double &minLatitude, double &maxLatitude, double &minLongitude,
327 double &maxLongitude);
328
329
330 private:
331 void applyVirtualBandsToLabel();
332 void cleanUp(bool remove);
333
334 void construct();
335 QFile *dataFile() const;
336 FileName realDataFileName() const;
337
338 void initialize();
339 void initCoreFromLabel(const Pvl &label);
340 void initLabelFromFile(FileName labelFileName, bool readWrite);
341 void openCheck();
342 Pvl realDataFileLabel() const;
343 void reformatOldIsisLabel(const QString &oldCube);
344 void writeLabels();
345
346 private:
355 QFile *m_labelFile;
361 QFile *m_dataFile;
362
367 CubeIoHandler *m_ioHandler;
368
374 ByteOrder m_byteOrder;
375
381 Format m_format;
382
388 PixelType m_pixelType;
389
391 QMutex *m_mutex;
392
394 Camera *m_camera;
395
397 Projection *m_projection;
398
400 FileName *m_labelFileName;
401
403 FileName *m_dataFileName;
404
410 FileName *m_tempCube;
411
413 FileName *m_formatTemplateFile;
414
416 bool m_attached;
417
423 bool m_storesDnData;
424
426 Pvl *m_label;
427
429 int m_labelBytes;
430
432 int m_samples;
433
435 int m_lines;
436
438 int m_bands;
439
444 double m_base;
445
450 double m_multiplier;
451
453 QList<int> *m_virtualBandList;
454 };
455}
456
459
460#endif
Q_DECLARE_METATYPE(Isis::Cube *)
This allows Cube *'s to be stored in a QVariant.
Definition Blob.h:51
Buffer for reading and writing cube data.
Definition Buffer.h:53
Definition Camera.h:236
Manipulate and parse attributes of output cube filenames.
Definition CubeAttribute.h:473
This is the parent of the caching algorithms.
Definition CubeCachingAlgorithm.h:31
IO Handler for Isis Cubes.
Definition Cube.h:168
void addCachingAlgorithm(CubeCachingAlgorithm *)
This will add the given caching algorithm to the list of attempted caching algorithms.
Definition Cube.cpp:1929
void clearIoCache()
This will clear excess RAM used for quicker IO in the cube.
Definition Cube.cpp:1945
bool hasTable(const QString &name)
Check to see if the cube contains a pvl table by the provided name.
Definition Cube.cpp:2050
ImagePolygon readFootprint() const
Read the footprint polygon for the Cube.
Definition Cube.cpp:873
Cube()
Constructs a Cube object.
Definition Cube.cpp:50
void setPixelType(PixelType pixelType)
Used prior to the Create method, this will specify the output pixel type.
Definition Cube.cpp:1311
void latLonRange(double &minLatitude, double &maxLatitude, double &minLongitude, double &maxLongitude)
Returns the latitude and longitude range for the Cube.
Definition Cube.cpp:2517
void deleteGroup(const QString &group)
Deletes a group from the cube labels.
Definition Cube.cpp:1984
void setFormat(Format format)
Used prior to the Create method, this will specify the format of the cube, either band,...
Definition Cube.cpp:1273
bool deleteBlob(QString BlobName, QString BlobType)
This method will delete a blob label object from the cube as specified by the Blob type and name.
Definition Cube.cpp:1962
Format format() const
Definition Cube.cpp:1582
void relocateDnData(FileName dnDataFile)
Relocates the DN data for a cube to an external cube label file.
Definition Cube.cpp:1373
virtual Histogram * histogram(const int &band=1, QString msg="Gathering histogram")
This method returns a pointer to a Histogram object which allows the program to obtain and use variou...
Definition Cube.cpp:1606
int lineCount() const
Definition Cube.cpp:1741
double multiplier() const
Returns the multiplier value for converting 8-bit/16-bit pixels to 32-bit.
Definition Cube.cpp:1755
void setLabelsAttached(bool attached)
Use prior to calling create, this sets whether or not to use separate label and data files.
Definition Cube.cpp:1285
CubeStretch readCubeStretch(QString name="CubeStretch", const std::vector< PvlKeyword > keywords=std::vector< PvlKeyword >()) const
Read a Stretch from a cube.
Definition Cube.cpp:919
Statistics * statistics(const int &band=1, QString msg="Gathering statistics")
This method returns a pointer to a Statistics object which allows the program to obtain and use vario...
Definition Cube.cpp:1837
void setDimensions(int ns, int nl, int nb)
Used prior to the Create method to specify the size of the cube.
Definition Cube.cpp:1224
Camera * camera()
Return a camera associated with the cube.
Definition Cube.cpp:1458
FileName externalCubeFileName() const
If this is an external cube label file, this will give you the cube dn file that this label reference...
Definition Cube.cpp:1542
PvlGroup & group(const QString &group) const
Read a group from the cube into a Label.
Definition Cube.cpp:1998
int sampleCount() const
Definition Cube.cpp:1814
void putGroup(const PvlGroup &group)
Adds a group in a Label to the cube.
Definition Cube.cpp:2063
bool isOpen() const
Test if a cube file has been opened/created.
Definition Cube.cpp:183
void setBaseMultiplier(double base, double mult)
Used prior to the Create method, this will specify the base and multiplier for converting 8-bit/16-bi...
Definition Cube.cpp:1158
bool isReadOnly() const
Test if the opened cube is read-only, that is write operations will fail if this is true.
Definition Cube.cpp:209
double base() const
Returns the base value for converting 8-bit/16-bit pixels to 32-bit.
Definition Cube.cpp:1434
void fromIsd(const FileName &fileName, Pvl &label, nlohmann::json &isd, QString access)
Initialize Cube data from a PVL label and JSON ISD.
Definition Cube.cpp:99
void setMinMax(double min, double max)
Used prior to the Create method, this will compute a good base and multiplier value given the minimum...
Definition Cube.cpp:1175
void attachSpiceFromIsd(nlohmann::json Isd)
Definition Cube.cpp:1466
Cube * copy(FileName newFile, const CubeAttributeOutput &newFileAttributes)
Copies the cube to the new fileName.
Definition Cube.cpp:272
void create(const QString &cfile)
This method will create an isis cube for writing.
Definition Cube.cpp:410
bool hasBlob(const QString &name, const QString &type)
Check to see if the cube contains a BLOB.
Definition Cube.cpp:2026
ByteOrder byteOrder() const
Returns the byte order/endian-ness of the cube file.
Definition Cube.cpp:1446
bool labelsAttached() const
Test if labels are attached.
Definition Cube.cpp:244
void open(const QString &cfile, QString access="r")
This method will open an existing isis cube for reading or reading/writing.
Definition Cube.cpp:623
PixelType pixelType() const
Definition Cube.cpp:1765
bool storesDnData() const
This method returns a boolean value.
Definition Cube.cpp:1911
void setVirtualBands(const QList< QString > &vbands)
This allows the programmer to specify a subset of bands to work with.
Definition Cube.cpp:1328
void read(Blob &blob, const std::vector< PvlKeyword > keywords=std::vector< PvlKeyword >()) const
This method will read data from the specified Blob object.
Definition Cube.cpp:814
bool isProjected() const
Returns true if the labels of the cube appear to have a valid mapping group.
Definition Cube.cpp:198
OriginalLabel readOriginalLabel(const QString &name="IsisCube") const
Read the original PDS3 label from a cube.
Definition Cube.cpp:896
Format
These are the possible storage formats of ISIS cubes.
Definition Cube.h:179
@ Tile
Cubes are stored in tile format, that is the order of the pixels in the file (on disk) is BSQ within ...
Definition Cube.h:233
@ Bsq
Cubes are stored in band-sequential format, that is the order of the pixels in the file (on disk) is:
Definition Cube.h:200
virtual int physicalBand(const int &virtualBand) const
This method will return the physical band number given a virtual band number.
Definition Cube.cpp:1780
Table readTable(const QString &name)
Read a Table from the cube.
Definition Cube.cpp:959
bool hasGroup(const QString &group) const
Return if the cube has a specified group in the labels.
Definition Cube.cpp:2011
void setLabelSize(int labelBytes)
Used prior to the Create method, this will allocate a specific number of bytes in the label area for ...
Definition Cube.cpp:1298
OriginalXmlLabel readOriginalXmlLabel() const
Read the original PDS4 label from a cube.
Definition Cube.cpp:938
virtual QString fileName() const
Returns the opened cube's filename.
Definition Cube.cpp:1570
void fromLabel(const FileName &fileName, Pvl &label, QString access)
Initialize Cube data from a PVL label.
Definition Cube.cpp:76
virtual ~Cube()
Destroys the Cube object.
Definition Cube.cpp:160
void write(Blob &blob, bool overwrite=true)
This method will write a blob of data (e.g.
Definition Cube.cpp:978
bool isReadWrite() const
Test if the opened cube is read-write, that is read and write operations should succeed if this is tr...
Definition Cube.cpp:231
void setExternalDnData(FileName cubeFileWithDnData)
Used to set external dn data to cube.
Definition Cube.cpp:1241
void close(bool remove=false)
Closes the cube and updates the labels.
Definition Cube.cpp:256
History readHistory(const QString &name="IsisCube") const
Read the History from the Cube.
Definition Cube.cpp:854
int labelSize(bool actual=false) const
Returns the number of bytes used by the label.
Definition Cube.cpp:1720
Projection * projection()
Definition Cube.cpp:1801
virtual int bandCount() const
Returns the number of virtual bands for the cube.
Definition Cube.cpp:1417
Pvl * label() const
Returns a pointer to the IsisLabel object associated with the cube.
Definition Cube.cpp:1708
void reopen(QString access="r")
This method will reopen an isis sube for reading or reading/writing.
Definition Cube.cpp:781
void setByteOrder(ByteOrder byteOrder)
Used prior to the Create method, this will specify the byte order of pixels, either least or most sig...
Definition Cube.cpp:1209
Handles converting buffers to and from disk.
Definition CubeIoHandler.h:109
Stores stretch information for a cube.
Definition CubeStretch.h:27
File name manipulation and expansion.
Definition FileName.h:100
Container of a cube histogram.
Definition Histogram.h:74
Definition History.h:38
Create cube polygons, read/write polygons to blobs.
Definition ImagePolygon.h:153
Read and store original labels.
Definition OriginalLabel.h:35
Read and store original Xml labels.
Definition OriginalXmlLabel.h:32
Base class for Map Projections.
Definition Projection.h:155
Contains multiple PvlContainers.
Definition PvlGroup.h:41
Container for cube-like labels.
Definition Pvl.h:119
This class is used to accumulate statistics on double arrays.
Definition Statistics.h:93
Class for storing Table blobs information.
Definition Table.h:61
ByteOrder
Tests the current architecture for byte order.
Definition Endian.h:42
This is free and unencumbered software released into the public domain.
Definition Apollo.h:16
PixelType
Enumerations for Isis Pixel Types.
Definition PixelType.h:27