|
Isis Developer Reference
|
Go to the documentation of this file. 1 #ifndef ImageImporter_h
2 #define ImageImporter_h
14 class CubeAttributeOutput;
int SampleDimension() const
Returns the number of samples in the shape buffer.
Definition: Buffer.h:70
virtual int convertRgbToGray(int pixel) const
Convert the current pixel, taken from an RGB/A image, and blend its RGB components into a single gray...
Definition: ImageImporter.cpp:399
Contains Pvl Groups and Pvl Objects.
Definition: PvlObject.h:61
virtual int getPixel(int s, int l) const =0
Pure virtual method that returns a representation of a pixel for the input format that can then be br...
void setSamples(int s)
Set the sample dimension (width) of the output image.
Definition: ImageImporter.cpp:241
A single keyword-value pair.
Definition: PvlKeyword.h:82
int(ImageImporter::* GetChannelMethod)(int pixel) const
Friendly alias for a method used to get a particular color channel.
Definition: ImageImporter.h:97
virtual bool isRgb() const =0
Pure virtual method for returning true if the image is RGB (no alpha).
void WriteHistory(Cube &cube)
Writes out the History blob to the cube.
Definition: Process.cpp:789
void setLrsRange(double min, double max)
Set the range of DN values within which a pixel from the input image will be set to LRS in the output...
Definition: ImageImporter.cpp:217
File name manipulation and expansion.
Definition: FileName.h:100
virtual bool isArgb() const =0
Pure virtual method for returning true if the image is RGBA.
virtual int getGreen(int pixel) const =0
Pure virtual method for retrieving the green component of the given pixel.
virtual void updateRawBuffer(int line, int band) const =0
Pure virtual method that updates the buffer used to store chunks of the input data at a time.
void setNullRange(double min, double max)
Set the range of DN values within which a pixel from the input image will be set to Null in the outpu...
Definition: ImageImporter.cpp:204
Imports JPEG 2000 images as Isis cubes.
Definition: JP2Importer.h:30
Container for cube-like labels.
Definition: Pvl.h:119
Manipulate and parse attributes of output cube filenames.
Definition: CubeAttribute.h:473
Imports images with standard formats into Isis as cubes.
Definition: ImageImporter.h:39
const double HIGH_REPR_SAT8
Definition: SpecialPixel.h:116
Process cubes by line.
Definition: ProcessByLine.h:97
virtual int getBlue(int pixel) const =0
Pure virtual method for retrieving the blue component of the given pixel.
Buffer for reading and writing cube data.
Definition: Buffer.h:53
int bands() const
The band dimension (depth) of the output image.
Definition: ImageImporter.cpp:298
void ProcessCubeInPlace(const Functor &funct, bool threaded=true)
Same functionality as StartProcess(void funct(Isis::Buffer &inout)) using Functors.
Definition: ProcessByLine.h:133
QString expanded() const
Returns a QString of the full file name including the file path, excluding the attributes.
Definition: FileName.cpp:196
void setDefaultBands()
Set the number of bands to be created for the output cube based on the number of color channels in th...
Definition: ImageImporter.cpp:192
Contains multiple PvlContainers.
Definition: PvlGroup.h:41
#define _FILEINFO_
Macro for the filename and line number.
Definition: IException.h:24
void setDimensions(int ns, int nl, int nb)
Used prior to the Create method to specify the size of the cube.
Definition: Cube.cpp:1217
void create(const QString &cfile)
This method will create an isis cube for writing.
Definition: Cube.cpp:414
int samples() const
The sample dimension (width) of the output image.
Definition: ImageImporter.cpp:278
const double NULL8
Definition: SpecialPixel.h:94
void setBands(int b)
Set the band dimension (depth) of the output image.
Definition: ImageImporter.cpp:263
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
virtual PvlGroup convertProjection() const
Pure virtual method for converting projection information in the file being imported to an ISIS Mappi...
Definition: ImageImporter.cpp:66
IO Handler for Isis Cubes.
Definition: Cube.h:167
virtual int getAlpha(int pixel) const =0
Pure virtual method for retrieving the alpha component of the given pixel.
Isis exception class.
Definition: IException.h:91
void setLines(int l)
Set the line dimension (height) of the output image.
Definition: ImageImporter.cpp:251
void operator()(Buffer &out) const
The method for processing the output cube in place, called for each line of the output image.
Definition: ImageImporter.cpp:84
virtual ~ImageImporter()
Destruct the importer.
Definition: ImageImporter.cpp:51
void setHrsRange(double min, double max)
Set the range of DN values within which a pixel from the input image will be set to HRS in the output...
Definition: ImageImporter.cpp:230
double testSpecial(double pixel) const
Tests a pixel against the Null, HRS, and LRS ranges defined by the importer's handler.
Definition: ImageImporter.cpp:325
void addGroup(const Isis::PvlGroup &group)
Add a group to the object.
Definition: PvlObject.h:186
int lines() const
The line dimension (height) of the output image.
Definition: ImageImporter.cpp:288
virtual bool isGrayscale() const =0
Pure virtual method for returning true if the image is grayscale.
int Band(const int index=0) const
Returns the band position associated with a shape buffer index.
Definition: Buffer.cpp:162
@ BandsFirst
Definition: ProcessByBrick.h:95
Imports TIFF images as Isis cubes.
Definition: TiffImporter.h:45
Cube * import(FileName outputName)
Import the image with default output attributes.
Definition: ImageImporter.cpp:108
@ Programmer
This error is for when a programmer made an API call that was illegal.
Definition: IException.h:146
static ImageImporter * fromFileName(FileName inputName)
A static (factory) method for constructing an ImageImporter instance from an input filename.
Definition: ImageImporter.cpp:420
FileName filename() const
The filename of the input image this instance was constructed with.
Definition: ImageImporter.cpp:308
Pvl * label() const
Returns a pointer to the IsisLabel object associated with the cube.
Definition: Cube.cpp:1701
virtual GetChannelMethod getBandChannel(int band) const
Retrieve the method responsible for fetching the color channel from the input image corresponding to ...
Definition: ImageImporter.cpp:354
void SetProcessingDirection(ProcessingDirection direction)
Set the direction the data will be read, either all lines in a single band proceeding to the next ban...
Definition: ProcessByBrick.cpp:380
ImageImporter(FileName inputName)
Construct the importer.
Definition: ImageImporter.cpp:32
int keywords() const
Returns the number of keywords contained in the PvlContainer.
Definition: PvlContainer.h:86
Imports a series of standard image formats with Qt facilities.
Definition: QtImporter.h:39
Adds specific functionality to C++ strings.
Definition: IString.h:165
const double LOW_REPR_SAT8
Definition: SpecialPixel.h:98
static bool IsJP2(QString filename)
Definition: JP2Decoder.cpp:228
void EndProcess()
End the processing sequence and cleans up by closing cubes, freeing memory, etc.
Definition: ProcessByBrick.cpp:669
Isis::Cube * SetInputCube(const QString ¶meter, const int requirements=0)
Opens an input cube specified by the user and verifies requirements are met.
Definition: ProcessByLine.cpp:41
int Line(const int index=0) const
Returns the line position associated with a shape buffer index.
Definition: Buffer.cpp:145
This is free and unencumbered software released into the public domain.
Definition: Apollo.h:16
Cube * createOutput(FileName outputName, CubeAttributeOutput &att)
Create the output cube from the given filename and attributes.
Definition: ImageImporter.cpp:179
virtual int getRed(int pixel) const =0
Pure virtual method for retrieving the red component of the given pixel.
virtual int getGray(int pixel) const =0
Pure virtual method for retrieving the gray component of the given pixel.