libimage  0.25.4
 All Classes Namespaces Files Functions Variables Enumerations Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FileImage Class Reference

#include <FileImage.h>

Inheritance diagram for FileImage:
Inheritance graph
Collaboration diagram for FileImage:
Collaboration graph

Public Member Functions

void unassociateAlpha (uint8_t *buffer)
virtual int getline (uint8_t *buffer, int line)=0
virtual int getline (float *buffer, int line)=0
virtual int getline (uint16_t *buffer, int line)=0
virtual int writeImage (Image *pIn)=0
virtual int writeImage (uint8_t *buffer)=0
virtual int writeImage (uint16_t *buffer)=0
virtual int writeImage (float *buffer)=0
virtual int writeLine (uint8_t *buffer, int line)=0
virtual int writeLine (uint16_t *buffer, int line)=0
virtual int writeLine (float *buffer, int line)=0
char * getFilename ()
 Return the path to image file.
int getBitsPerSample ()
 Return number of bits per sample.
Photometric::ePhotometric getPhotometric ()
 Return data photometric (rgb, gray...)
ExtraSample::eExtraSample getExtraSample ()
 Return extra sample type.
void setExtraSample (ExtraSample::eExtraSample es)
 Modify extra sample type.
Compression::eCompression getCompression ()
 Return data compression.
SampleFormat::eSampleFormat getSampleFormat ()
 Return sample format (integer, float)
int getPixelSize ()
 Return the pixel's byte size.
 ~FileImage ()
 Default destructor.
void print ()
 File image description output.
- Public Member Functions inherited from Image
void makeMask ()
 Define the image as a mask.
int getWidth ()
 Return the image's width.
int getHeight ()
 Return the image's height.
void setBbox (BoundingBox< double > box)
 Define the image's bounding box and calculate resolutions.
bool setDimensions (int w, int h, BoundingBox< double > box, double rx, double ry)
 Define the image's bounding box and calculate resolutions.
BoundingBox< double > getBbox () const
 Return the image's bounding box.
void setCRS (CRS srs)
 Define the CRS of the image's bounding box.
CRS getCRS () const
 Return the image's bounding box's CRS.
double getXmin () const
 Return bounding box's xmin.
double getYmax () const
 Return bounding box's ymax.
double getXmax () const
 Return bounding box's xmax.
double getYmin () const
 Return bounding box's ymin.
double getResX () const
 Return the X wise resolution.
double getResY () const
 Return the Y wise resolution.
ImagegetMask ()
 Return the associated mask.
bool setMask (Image *newMask)
 Defined data mask and check consistency.
int x2c (double x)
 Conversion from terrain coordinate X to image column indice.
int y2l (double y)
 Conversion from terrain coordinate Y to image line indice.
double c2x (int c)
 Conversion from image column indice to terrain coordinate X (pixel's center)
double l2y (int l)
 Conversion from image line indice to terrain coordinate X (pixel's center)
double getPhaseX ()
 Phasis calculation, X wise.
double getPhaseY ()
 Phasis calculation, Y wise.
bool isCompatibleWith (Image *pImage)
 Determine compatibility with another image, comparing CRS, phasis and resolutions.
 Image (int width, int height, int channels, double resx, double resy, BoundingBox< double > bbox)
 Create an Image object, from all attributes.
 Image (int width, int height, int channels)
 Create an Image without providing georeferencement, neither resolutions nor bounding box.
 Image (int width, int height, int channels, BoundingBox< double > bbox)
 Create an Image without providing resolutions.
 Image (int width, int height, int channels, double resx, double resy)
 Create an Image object without providing bbox.
virtual ~Image ()
 Default destructor.
virtual void printTFW ()
 Image TFW output.

Protected Member Functions

 FileImage (int width, int height, double resx, double resy, int channels, BoundingBox< double > bbox, char *name, SampleFormat::eSampleFormat sampleformat, int bitspersample, Photometric::ePhotometric photometric, Compression::eCompression compression, ExtraSample::eExtraSample esType=ExtraSample::ALPHA_UNASSOC)
 Create a FileImage object, from all attributes.
- Protected Member Functions inherited from Image
void computeResolutions ()
 Resolutions calculation, from pixel size and bounding box.

Protected Attributes

char * filename
 Path to the image file.
Photometric::ePhotometric photometric
 Data photometric (rgb, gray...)
ExtraSample::eExtraSample esType
 extra sample type (if exists)
Compression::eCompression compression
 Data compression (jpeg, packbits...)
SampleFormat::eSampleFormat sampleformat
 Sample format.
int bitspersample
 Number of bits per sample.
int pixelSize
 Byte pixel's size.
- Protected Attributes inherited from Image
int width
 Image's width, in pixel.
int height
 Image's height, in pixel.
bool isMask
 Is this image a mask ?
BoundingBox< double > bbox
 Image's bounding box.
CRS crs
 Bounding box's CRS.
Imagemask
 Mask associated to the image, optionnal.
double resx
 Image's resolution, X wise.
double resy
 Image's resolution, Y wise.

Additional Inherited Members

- Static Public Member Functions inherited from Image
static bool dimensionsAreConsistent (double resolution_x, double resolution_y, int w, int h, BoundingBox< double > bounding_box)
 Check provided dimensions' consistency.
- Public Attributes inherited from Image
const int channels
 Number of samples per pixel.

Detailed Description

Author
Institut national de l'information géographique et forestière

Constructor & Destructor Documentation

FileImage::FileImage ( int  width,
int  height,
double  resx,
double  resy,
int  channels,
BoundingBox< double >  bbox,
char *  name,
SampleFormat::eSampleFormat  sampleformat,
int  bitspersample,
Photometric::ePhotometric  photometric,
Compression::eCompression  compression,
ExtraSample::eExtraSample  esType = ExtraSample::ALPHA_UNASSOC 
)
protected

Create a FileImage object, from all attributes.

Parameters
[in]widthimage width, in pixel
[in]heightimage height, in pixel
[in]resxX wise resolution
[in]resyY wise resolution
[in]channelnumber of samples per pixel
[in]bboxbounding box
[in]namepath to image file
[in]sampleformatsamples' format
[in]bitspersamplenumber of bits per sample
[in]photometricdata photometric
[in]compressiondata compression
[in]esTypeextra sample type

Member Function Documentation

int FileImage::getBitsPerSample ( )
inline

Return number of bits per sample.

Returns
number of bits per sample

Here is the caller graph for this function:

Compression::eCompression FileImage::getCompression ( )
inline

Return data compression.

Returns
compression

Here is the caller graph for this function:

ExtraSample::eExtraSample FileImage::getExtraSample ( )
inline

Return extra sample type.

Returns
esType
char* FileImage::getFilename ( )
inline

Return the path to image file.

Returns
image's path
Photometric::ePhotometric FileImage::getPhotometric ( )
inline

Return data photometric (rgb, gray...)

Returns
photometric

Here is the caller graph for this function:

SampleFormat::eSampleFormat FileImage::getSampleFormat ( )
inline

Return sample format (integer, float)

Returns
sample format

Here is the caller graph for this function:


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